InterconnectGroup class

An interconnect group resource allows customers to create, analyze, and expand their redundant connections.

To get more information about InterconnectGroup, see:

• API documentation
• How-to Guides
• Create a Dedicated Interconnect

Example Usage

Interconnect Group Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const example_interconnect_group = new gcp.compute.InterconnectGroup("example-interconnect-group", {
    name: "example-interconnect-group",
    intent: {
        topologyCapability: "NO_SLA",
    },
});

import pulumi
import pulumi_gcp as gcp

example_interconnect_group = gcp.compute.InterconnectGroup("example-interconnect-group",
    name="example-interconnect-group",
    intent={
        "topology_capability": "NO_SLA",
    })

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var example_interconnect_group = new Gcp.Compute.InterconnectGroup("example-interconnect-group", new()
    {
        Name = "example-interconnect-group",
        Intent = new Gcp.Compute.Inputs.InterconnectGroupIntentArgs
        {
            TopologyCapability = "NO_SLA",
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewInterconnectGroup(ctx, "example-interconnect-group", &compute.InterconnectGroupArgs{
			Name: pulumi.String("example-interconnect-group"),
			Intent: &compute.InterconnectGroupIntentArgs{
				TopologyCapability: pulumi.String("NO_SLA"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_compute_interconnectgroup" "example-interconnect-group" {
  name = "example-interconnect-group"
  intent = {
    topology_capability = "NO_SLA"
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.InterconnectGroup;
import com.pulumi.gcp.compute.InterconnectGroupArgs;
import com.pulumi.gcp.compute.inputs.InterconnectGroupIntentArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example_interconnect_group = new InterconnectGroup("example-interconnect-group", InterconnectGroupArgs.builder()
            .name("example-interconnect-group")
            .intent(InterconnectGroupIntentArgs.builder()
                .topologyCapability("NO_SLA")
                .build())
            .build());

    }
}

resources:
  example-interconnect-group:
    type: gcp:compute:InterconnectGroup
    properties:
      name: example-interconnect-group
      intent:
        topologyCapability: NO_SLA

Import

InterconnectGroup can be imported using any of these accepted formats:

• projects/{{project}}/global/interconnectGroups/{{name}}
• {{project}}/{{name}}
• {{name}}

When using the pulumi import command, InterconnectGroup can be imported using one of the formats above. For example:

$ pulumi import gcp:compute/interconnectGroup:InterconnectGroup default projects/{{project}}/global/interconnectGroups/{{name}}
$ pulumi import gcp:compute/interconnectGroup:InterconnectGroup default {{project}}/{{name}}
$ pulumi import gcp:compute/interconnectGroup:InterconnectGroup default {{name}}

Constructors

InterconnectGroup(String name, {InterconnectGroupArgs? args, CustomResourceOptions? options})

Creates a new InterconnectGroup. name The Pulumi resource name. args Arguments used to configure this InterconnectGroup. The set of arguments for InterconnectGroup. options Resource options controlling this resource's behavior.

InterconnectGroup.reference(String urn)

Creates a typed reference to an existing InterconnectGroup resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

configureds ↔ Output<List<InterconnectGroupConfigured>>

The status of the group as configured. This has the same structure as the operational field reported by the OperationalStatus method, but does not take into account the operational status of each resource. Structure is documented below.

late, final

creationTimestamp ↔ Output<String>

Creation timestamp in RFC3339 text format.

late, final

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

description ↔ Output<String?>

An optional description of this resource. Provide this property when you create the resource.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

intent ↔ Output<InterconnectGroupIntent>

The user's intent for this group. This is the only required field besides the name that must be specified on group creation. Structure is documented below.

late, final

interconnects ↔ Output<List<InterconnectGroupInterconnect>?>

Interconnects in the InterconnectGroup. Keys are arbitrary user-specified strings. Users are encouraged, but not required, to use their preferred format for resource links as keys. Note that there are add-members and remove-members methods in gcloud. The size of this map is limited by an "Interconnects per group" quota. Structure is documented below.

late, final

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

name ↔ Output<String>

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

late, final

physicalStructures ↔ Output<List<InterconnectGroupPhysicalStructure>>

An analysis of the physical layout of Interconnects in this group. Every Interconnect in the group is shown once in this structure. Structure is documented below.

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {InterconnectGroupState? state, CustomResourceOptions? options}) → InterconnectGroup

Gets an existing InterconnectGroup resource's state with the given name and id.