Interconnect class

Represents an Interconnect resource. The Interconnect resource is a dedicated connection between Google's network and your on-premises network.

To get more information about Interconnect, see:

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

Example Usage

Compute Interconnect Basic

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

const project = gcp.organizations.getProject({});
const example_interconnect = new gcp.compute.Interconnect("example-interconnect", {
    name: "example-interconnect",
    customerName: "example_customer",
    interconnectType: "DEDICATED",
    linkType: "LINK_TYPE_ETHERNET_10G_LR",
    location: project.then(project => `https://www.googleapis.com/compute/v1/projects/${project.projectId}/global/interconnectLocations/iad-zone1-1`),
    requestedLinkCount: 1,
});

import pulumi
import pulumi_gcp as gcp

project = gcp.organizations.get_project()
example_interconnect = gcp.compute.Interconnect("example-interconnect",
    name="example-interconnect",
    customer_name="example_customer",
    interconnect_type="DEDICATED",
    link_type="LINK_TYPE_ETHERNET_10G_LR",
    location=f"https://www.googleapis.com/compute/v1/projects/{project.project_id}/global/interconnectLocations/iad-zone1-1",
    requested_link_count=1)

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

return await Deployment.RunAsync(() =>
{
    var project = Gcp.Organizations.GetProject.Invoke();

    var example_interconnect = new Gcp.Compute.Interconnect("example-interconnect", new()
    {
        Name = "example-interconnect",
        CustomerName = "example_customer",
        InterconnectType = "DEDICATED",
        LinkType = "LINK_TYPE_ETHERNET_10G_LR",
        Location = $"https://www.googleapis.com/compute/v1/projects/{project.Apply(getProjectResult => getProjectResult.ProjectId)}/global/interconnectLocations/iad-zone1-1",
        RequestedLinkCount = 1,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		project, err := organizations.LookupProject(ctx, &organizations.LookupProjectArgs{}, nil)
		if err != nil {
			return err
		}
		_, err = compute.NewInterconnect(ctx, "example-interconnect", &compute.InterconnectArgs{
			Name:               pulumi.String("example-interconnect"),
			CustomerName:       pulumi.String("example_customer"),
			InterconnectType:   pulumi.String("DEDICATED"),
			LinkType:           pulumi.String("LINK_TYPE_ETHERNET_10G_LR"),
			Location:           pulumi.Sprintf("https://www.googleapis.com/compute/v1/projects/%v/global/interconnectLocations/iad-zone1-1", project.ProjectId),
			RequestedLinkCount: pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

data "gcp_organizations_getproject" "project" {
}

resource "gcp_compute_interconnect" "example-interconnect" {
  name                 = "example-interconnect"
  customer_name        = "example_customer"
  interconnect_type    = "DEDICATED"
  link_type            = "LINK_TYPE_ETHERNET_10G_LR"
  location             ="https://www.googleapis.com/compute/v1/projects/${data.gcp_organizations_getproject.project.project_id}/global/interconnectLocations/iad-zone1-1"
  requested_link_count = 1
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
import com.pulumi.gcp.compute.Interconnect;
import com.pulumi.gcp.compute.InterconnectArgs;
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) {
        final var project = OrganizationsFunctions.getProject(GetProjectArgs.builder()
            .build());

        var example_interconnect = new Interconnect("example-interconnect", InterconnectArgs.builder()
            .name("example-interconnect")
            .customerName("example_customer")
            .interconnectType("DEDICATED")
            .linkType("LINK_TYPE_ETHERNET_10G_LR")
            .location(String.format("https://www.googleapis.com/compute/v1/projects/%s/global/interconnectLocations/iad-zone1-1", project.projectId()))
            .requestedLinkCount(1)
            .build());

    }
}

resources:
  example-interconnect:
    type: gcp:compute:Interconnect
    properties:
      name: example-interconnect
      customerName: example_customer
      interconnectType: DEDICATED
      linkType: LINK_TYPE_ETHERNET_10G_LR
      location: https://www.googleapis.com/compute/v1/projects/${project.projectId}/global/interconnectLocations/iad-zone1-1
      requestedLinkCount: 1
variables:
  project:
    fn::invoke:
      function: gcp:organizations:getProject
      arguments: {}

Import

Interconnect can be imported using any of these accepted formats:

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

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

$ pulumi import gcp:compute/interconnect:Interconnect default projects/{{project}}/global/interconnects/{{name}}
$ pulumi import gcp:compute/interconnect:Interconnect default {{project}}/{{name}}
$ pulumi import gcp:compute/interconnect:Interconnect default {{name}}

Constructors

Interconnect(String name, {InterconnectArgs? args, CustomResourceOptions? options})

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

Interconnect.reference(String urn)

Creates a typed reference to an existing Interconnect resource.

Properties

aaiEnabled ↔ Output<bool?>

(Optional, Beta) Enable or disable the Application Aware Interconnect(AAI) feature on this interconnect.

late, final

adminEnabled ↔ Output<bool?>

Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.

late, final

applicationAwareInterconnect ↔ Output<InterconnectApplicationAwareInterconnect?>

(Optional, Beta) Configuration that enables Media Access Control security (MACsec) on the Cloud Interconnect connection between Google and your on-premises router. Structure is documented below.

late, final

availableFeatures ↔ Output<List<String>>

Output Only List of features that are available on this Interconnect connection based on the provisioned hardware and configuration. Possible values include:

late, final

childResources → Set<Resource>

final, inherited

circuitInfos ↔ Output<List<InterconnectCircuitInfo>>

A list of CircuitInfo objects, that describe the individual circuits in this LAG. Structure is documented below.

late, final

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

creationTimestamp ↔ Output<String>

Creation timestamp in RFC3339 text format.

late, final

customerName ↔ Output<String?>

Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect. This field is required for Dedicated and Partner Interconnect, should not be specified for cross-cloud interconnect.

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

effectiveLabels ↔ Output<Map<String, String>>

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

late, final

effectiveLocation ↔ Output<String>

URL of the InterconnectLocation object that represents where this connection is to be provisioned. Specifies the location inside Google's Networks.

late, final

expectedOutages ↔ Output<List<InterconnectExpectedOutage>>

A list of outages expected for this Interconnect. Structure is documented below.

late, final

googleIpAddress ↔ Output<String>

IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.

late, final

googleReferenceId ↔ Output<String>

Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

interconnectAttachments ↔ Output<List<String>>

A list of the URLs of all InterconnectAttachments configured to use this Interconnect.

late, final

interconnectGroups ↔ Output<List<String>>

URLs of InterconnectGroups that include this Interconnect. Order is arbitrary and items are unique.

late, final

interconnectType ↔ Output<String>

Type of interconnect. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. Can take one of the following values:

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

labelFingerprint ↔ Output<String>

A fingerprint for the labels being applied to this Interconnect, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.

late, final

labels ↔ Output<Map<String, String>?>

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

late, final

linkType ↔ Output<String>

Type of link requested. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle. Can take one of the following values:

late, final

location ↔ Output<String>

URL of the InterconnectLocation object that represents where this connection is requested to be provisioned. Specifies the location inside Google's Networks.

late, final

macsec ↔ Output<InterconnectMacsec?>

Configuration that enables Media Access Control security (MACsec) on the Cloud Interconnect connection between Google and your on-premises router. Structure is documented below.

late, final

macsecEnabled ↔ Output<bool?>

Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.

late, final

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

nocContactEmail ↔ Output<String?>

Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation.

late, final

operationalStatus ↔ Output<String>

The current status of this Interconnect's functionality, which can take one of the following:

late, final

params ↔ Output<InterconnectParams?>

Additional params passed with the request, but not persisted as part of resource payload Structure is documented below.

late, final

peerIpAddress ↔ Output<String>

IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests.

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

provisionedLinkCount ↔ Output<int>

Number of links actually provisioned in this interconnect.

late, final

pulumiLabels ↔ Output<Map<String, String>>

The combination of labels configured directly on the resource and default labels configured on the provider.

late, final

remoteLocation ↔ Output<String?>

Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to.

late, final

requestedFeatures ↔ Output<List<String>?>

List of features to request for this Interconnect connection. This field is only applicable during Interconnect creation and cannot be modified later. Possible values include:

late, final

requestedLinkCount ↔ Output<int>

Target number of physical links in the link bundle, as requested by the customer.

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

satisfiesPzs ↔ Output<bool>

Reserved for future use.

late, final

state ↔ Output<String>

(Output) State of this notification. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values. Can take one of the following values:

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

wireGroups ↔ Output<List<String>>

A list of the URLs of all CrossSiteNetwork WireGroups configured to use this Interconnect. The Interconnect cannot be deleted if this list is non-empty.

late, final

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, {InterconnectState? state, CustomResourceOptions? options}) → Interconnect

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