pulumi-gcp-kotlin/com.pulumi.gcp.compute.kotlin/Interconnect

Interconnect

class Interconnect : KotlinCustomResource

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.name}/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.name}/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.Name)}/global/interconnectLocations/iad-zone1-1",
        RequestedLinkCount = 1,
    });
});

package main
import (
	"fmt"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi-gcp/sdk/v8/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.Name),
			RequestedLinkCount: pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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.List;
import java.util.ArrayList;
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.name()))
            .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.name}/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}}

Properties

adminEnabled

val adminEnabled: Output<Boolean>?

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.

availableFeatures

val availableFeatures: Output<List<String>>

interconnects.list of features available for this Interconnect connection. Can take the value: MACSEC. If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails).

circuitInfos

val circuitInfos: Output<List<InterconnectCircuitInfo>>

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

creationTimestamp

val creationTimestamp: Output<String>

Creation timestamp in RFC3339 text format.

customerName

val 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.

description

val description: Output<String>?

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

effectiveLabels

val 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.

expectedOutages

val expectedOutages: Output<List<InterconnectExpectedOutage>>

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

googleIpAddress

val googleIpAddress: Output<String>

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

googleReferenceId

val googleReferenceId: Output<String>

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

val id: Output<String>

interconnectAttachments

val interconnectAttachments: Output<List<String>>

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

interconnectType

val 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:

labelFingerprint

val 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.

labels

val 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. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

linkType

val 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:

location

val location: Output<String>

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

macsec

val 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.

macsecEnabled

val macsecEnabled: Output<Boolean>?

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

name

val 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.

nocContactEmail

val 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.

operationalStatus

val operationalStatus: Output<String>

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

peerIpAddress

val 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.

project

val project: Output<String>

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

provisionedLinkCount

val provisionedLinkCount: Output<Int>

Number of links actually provisioned in this interconnect.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiLabels

val pulumiLabels: Output<Map<String, String>>

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

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

remoteLocation

val 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.

requestedFeatures

val requestedFeatures: Output<List<String>>?

interconnects.list of features requested for this Interconnect connection. Options: IF_MACSEC ( If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available). Note that MACSEC is still technically allowed for compatibility reasons, but it does not work with the API, and will be removed in an upcoming major version. Each value may be one of: MACSEC, IF_MACSEC.

requestedLinkCount

val requestedLinkCount: Output<Int>

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

satisfiesPzs

val satisfiesPzs: Output<Boolean>

Reserved for future use.

state

val 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:

urn

val urn: Output<String>