1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. compute
  5. Interconnect
Google Cloud v8.25.1 published on Wednesday, Apr 9, 2025 by Pulumi

gcp.compute.Interconnect

Explore with Pulumi AI

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:

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,
});
Copy
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)
Copy
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
	})
}
Copy
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,
    });

});
Copy
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());

    }
}
Copy
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: {}
Copy

Create Interconnect Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Interconnect(name: string, args: InterconnectArgs, opts?: CustomResourceOptions);
@overload
def Interconnect(resource_name: str,
                 args: InterconnectArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def Interconnect(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 interconnect_type: Optional[str] = None,
                 requested_link_count: Optional[int] = None,
                 link_type: Optional[str] = None,
                 location: Optional[str] = None,
                 labels: Optional[Mapping[str, str]] = None,
                 description: Optional[str] = None,
                 admin_enabled: Optional[bool] = None,
                 macsec: Optional[InterconnectMacsecArgs] = None,
                 macsec_enabled: Optional[bool] = None,
                 name: Optional[str] = None,
                 noc_contact_email: Optional[str] = None,
                 project: Optional[str] = None,
                 remote_location: Optional[str] = None,
                 requested_features: Optional[Sequence[str]] = None,
                 customer_name: Optional[str] = None)
func NewInterconnect(ctx *Context, name string, args InterconnectArgs, opts ...ResourceOption) (*Interconnect, error)
public Interconnect(string name, InterconnectArgs args, CustomResourceOptions? opts = null)
public Interconnect(String name, InterconnectArgs args)
public Interconnect(String name, InterconnectArgs args, CustomResourceOptions options)
type: gcp:compute:Interconnect
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. InterconnectArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. InterconnectArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. InterconnectArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. InterconnectArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. InterconnectArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var interconnectResource = new Gcp.Compute.Interconnect("interconnectResource", new()
{
    InterconnectType = "string",
    RequestedLinkCount = 0,
    LinkType = "string",
    Location = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Description = "string",
    AdminEnabled = false,
    Macsec = new Gcp.Compute.Inputs.InterconnectMacsecArgs
    {
        PreSharedKeys = new[]
        {
            new Gcp.Compute.Inputs.InterconnectMacsecPreSharedKeyArgs
            {
                Name = "string",
                StartTime = "string",
            },
        },
        FailOpen = false,
    },
    MacsecEnabled = false,
    Name = "string",
    NocContactEmail = "string",
    Project = "string",
    RemoteLocation = "string",
    RequestedFeatures = new[]
    {
        "string",
    },
    CustomerName = "string",
});
Copy
example, err := compute.NewInterconnect(ctx, "interconnectResource", &compute.InterconnectArgs{
	InterconnectType:   pulumi.String("string"),
	RequestedLinkCount: pulumi.Int(0),
	LinkType:           pulumi.String("string"),
	Location:           pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description:  pulumi.String("string"),
	AdminEnabled: pulumi.Bool(false),
	Macsec: &compute.InterconnectMacsecArgs{
		PreSharedKeys: compute.InterconnectMacsecPreSharedKeyArray{
			&compute.InterconnectMacsecPreSharedKeyArgs{
				Name:      pulumi.String("string"),
				StartTime: pulumi.String("string"),
			},
		},
		FailOpen: pulumi.Bool(false),
	},
	MacsecEnabled:   pulumi.Bool(false),
	Name:            pulumi.String("string"),
	NocContactEmail: pulumi.String("string"),
	Project:         pulumi.String("string"),
	RemoteLocation:  pulumi.String("string"),
	RequestedFeatures: pulumi.StringArray{
		pulumi.String("string"),
	},
	CustomerName: pulumi.String("string"),
})
Copy
var interconnectResource = new Interconnect("interconnectResource", InterconnectArgs.builder()
    .interconnectType("string")
    .requestedLinkCount(0)
    .linkType("string")
    .location("string")
    .labels(Map.of("string", "string"))
    .description("string")
    .adminEnabled(false)
    .macsec(InterconnectMacsecArgs.builder()
        .preSharedKeys(InterconnectMacsecPreSharedKeyArgs.builder()
            .name("string")
            .startTime("string")
            .build())
        .failOpen(false)
        .build())
    .macsecEnabled(false)
    .name("string")
    .nocContactEmail("string")
    .project("string")
    .remoteLocation("string")
    .requestedFeatures("string")
    .customerName("string")
    .build());
Copy
interconnect_resource = gcp.compute.Interconnect("interconnectResource",
    interconnect_type="string",
    requested_link_count=0,
    link_type="string",
    location="string",
    labels={
        "string": "string",
    },
    description="string",
    admin_enabled=False,
    macsec={
        "pre_shared_keys": [{
            "name": "string",
            "start_time": "string",
        }],
        "fail_open": False,
    },
    macsec_enabled=False,
    name="string",
    noc_contact_email="string",
    project="string",
    remote_location="string",
    requested_features=["string"],
    customer_name="string")
Copy
const interconnectResource = new gcp.compute.Interconnect("interconnectResource", {
    interconnectType: "string",
    requestedLinkCount: 0,
    linkType: "string",
    location: "string",
    labels: {
        string: "string",
    },
    description: "string",
    adminEnabled: false,
    macsec: {
        preSharedKeys: [{
            name: "string",
            startTime: "string",
        }],
        failOpen: false,
    },
    macsecEnabled: false,
    name: "string",
    nocContactEmail: "string",
    project: "string",
    remoteLocation: "string",
    requestedFeatures: ["string"],
    customerName: "string",
});
Copy
type: gcp:compute:Interconnect
properties:
    adminEnabled: false
    customerName: string
    description: string
    interconnectType: string
    labels:
        string: string
    linkType: string
    location: string
    macsec:
        failOpen: false
        preSharedKeys:
            - name: string
              startTime: string
    macsecEnabled: false
    name: string
    nocContactEmail: string
    project: string
    remoteLocation: string
    requestedFeatures:
        - string
    requestedLinkCount: 0
Copy

Interconnect Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Interconnect resource accepts the following input properties:

InterconnectType
This property is required.
Changes to this property will trigger replacement.
string
Type of interconnect. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. Can take one of the following values:

  • PARTNER: A partner-managed interconnection shared between customers though a partner.
  • DEDICATED: A dedicated physical interconnection with the customer. Possible values are: DEDICATED, PARTNER, IT_PRIVATE.

LinkType
This property is required.
Changes to this property will trigger replacement.
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:

  • LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics.
  • LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.
  • LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics Possible values are: LINK_TYPE_ETHERNET_10G_LR, LINK_TYPE_ETHERNET_100G_LR, LINK_TYPE_ETHERNET_400G_LR4.
RequestedLinkCount
This property is required.
Changes to this property will trigger replacement.
int
Target number of physical links in the link bundle, as requested by the customer.
AdminEnabled 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.
CustomerName Changes to this property will trigger replacement. 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 string
An optional description of this resource. Provide this property when you create the resource.
Labels Dictionary<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.

Location Changes to this property will trigger replacement. string
URL of the InterconnectLocation object that represents where this connection is to be provisioned. Specifies the location inside Google's Networks, should not be passed in case of cross-cloud interconnect.
Macsec 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 bool
Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.
Name Changes to this property will trigger replacement. 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 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.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RemoteLocation Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.
InterconnectType
This property is required.
Changes to this property will trigger replacement.
string
Type of interconnect. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. Can take one of the following values:

  • PARTNER: A partner-managed interconnection shared between customers though a partner.
  • DEDICATED: A dedicated physical interconnection with the customer. Possible values are: DEDICATED, PARTNER, IT_PRIVATE.

LinkType
This property is required.
Changes to this property will trigger replacement.
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:

  • LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics.
  • LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.
  • LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics Possible values are: LINK_TYPE_ETHERNET_10G_LR, LINK_TYPE_ETHERNET_100G_LR, LINK_TYPE_ETHERNET_400G_LR4.
RequestedLinkCount
This property is required.
Changes to this property will trigger replacement.
int
Target number of physical links in the link bundle, as requested by the customer.
AdminEnabled 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.
CustomerName Changes to this property will trigger replacement. 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 string
An optional description of this resource. Provide this property when you create the resource.
Labels 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.

Location Changes to this property will trigger replacement. string
URL of the InterconnectLocation object that represents where this connection is to be provisioned. Specifies the location inside Google's Networks, should not be passed in case of cross-cloud interconnect.
Macsec InterconnectMacsecArgs
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 bool
Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.
Name Changes to this property will trigger replacement. 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 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.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RemoteLocation Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. []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.
interconnectType
This property is required.
Changes to this property will trigger replacement.
String
Type of interconnect. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. Can take one of the following values:

  • PARTNER: A partner-managed interconnection shared between customers though a partner.
  • DEDICATED: A dedicated physical interconnection with the customer. Possible values are: DEDICATED, PARTNER, IT_PRIVATE.

linkType
This property is required.
Changes to this property will trigger replacement.
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:

  • LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics.
  • LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.
  • LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics Possible values are: LINK_TYPE_ETHERNET_10G_LR, LINK_TYPE_ETHERNET_100G_LR, LINK_TYPE_ETHERNET_400G_LR4.
requestedLinkCount
This property is required.
Changes to this property will trigger replacement.
Integer
Target number of physical links in the link bundle, as requested by the customer.
adminEnabled 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.
customerName Changes to this property will trigger replacement. 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 String
An optional description of this resource. Provide this property when you create the resource.
labels 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.

location Changes to this property will trigger replacement. String
URL of the InterconnectLocation object that represents where this connection is to be provisioned. Specifies the location inside Google's Networks, should not be passed in case of cross-cloud interconnect.
macsec 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 Boolean
Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.
name Changes to this property will trigger replacement. 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 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.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
remoteLocation Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.
interconnectType
This property is required.
Changes to this property will trigger replacement.
string
Type of interconnect. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. Can take one of the following values:

  • PARTNER: A partner-managed interconnection shared between customers though a partner.
  • DEDICATED: A dedicated physical interconnection with the customer. Possible values are: DEDICATED, PARTNER, IT_PRIVATE.

linkType
This property is required.
Changes to this property will trigger replacement.
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:

  • LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics.
  • LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.
  • LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics Possible values are: LINK_TYPE_ETHERNET_10G_LR, LINK_TYPE_ETHERNET_100G_LR, LINK_TYPE_ETHERNET_400G_LR4.
requestedLinkCount
This property is required.
Changes to this property will trigger replacement.
number
Target number of physical links in the link bundle, as requested by the customer.
adminEnabled 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.
customerName Changes to this property will trigger replacement. 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 string
An optional description of this resource. Provide this property when you create the resource.
labels {[key: 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.

location Changes to this property will trigger replacement. string
URL of the InterconnectLocation object that represents where this connection is to be provisioned. Specifies the location inside Google's Networks, should not be passed in case of cross-cloud interconnect.
macsec 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 boolean
Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.
name Changes to this property will trigger replacement. 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 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.
project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
remoteLocation Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.
interconnect_type
This property is required.
Changes to this property will trigger replacement.
str
Type of interconnect. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. Can take one of the following values:

  • PARTNER: A partner-managed interconnection shared between customers though a partner.
  • DEDICATED: A dedicated physical interconnection with the customer. Possible values are: DEDICATED, PARTNER, IT_PRIVATE.

link_type
This property is required.
Changes to this property will trigger replacement.
str
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:

  • LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics.
  • LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.
  • LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics Possible values are: LINK_TYPE_ETHERNET_10G_LR, LINK_TYPE_ETHERNET_100G_LR, LINK_TYPE_ETHERNET_400G_LR4.
requested_link_count
This property is required.
Changes to this property will trigger replacement.
int
Target number of physical links in the link bundle, as requested by the customer.
admin_enabled 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.
customer_name Changes to this property will trigger replacement. str
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 str
An optional description of this resource. Provide this property when you create the resource.
labels Mapping[str, str]

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.

location Changes to this property will trigger replacement. str
URL of the InterconnectLocation object that represents where this connection is to be provisioned. Specifies the location inside Google's Networks, should not be passed in case of cross-cloud interconnect.
macsec InterconnectMacsecArgs
Configuration that enables Media Access Control security (MACsec) on the Cloud Interconnect connection between Google and your on-premises router. Structure is documented below.
macsec_enabled bool
Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.
name Changes to this property will trigger replacement. str
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.
noc_contact_email str
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.
project Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
remote_location Changes to this property will trigger replacement. str
Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to.
requested_features Changes to this property will trigger replacement. Sequence[str]
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.
interconnectType
This property is required.
Changes to this property will trigger replacement.
String
Type of interconnect. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. Can take one of the following values:

  • PARTNER: A partner-managed interconnection shared between customers though a partner.
  • DEDICATED: A dedicated physical interconnection with the customer. Possible values are: DEDICATED, PARTNER, IT_PRIVATE.

linkType
This property is required.
Changes to this property will trigger replacement.
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:

  • LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics.
  • LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.
  • LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics Possible values are: LINK_TYPE_ETHERNET_10G_LR, LINK_TYPE_ETHERNET_100G_LR, LINK_TYPE_ETHERNET_400G_LR4.
requestedLinkCount
This property is required.
Changes to this property will trigger replacement.
Number
Target number of physical links in the link bundle, as requested by the customer.
adminEnabled 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.
customerName Changes to this property will trigger replacement. 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 String
An optional description of this resource. Provide this property when you create the resource.
labels Map<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.

location Changes to this property will trigger replacement. String
URL of the InterconnectLocation object that represents where this connection is to be provisioned. Specifies the location inside Google's Networks, should not be passed in case of cross-cloud interconnect.
macsec Property Map
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 Boolean
Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.
name Changes to this property will trigger replacement. 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 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.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
remoteLocation Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.

Outputs

All input properties are implicitly available as output properties. Additionally, the Interconnect resource produces the following output properties:

AvailableFeatures 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 List<InterconnectCircuitInfo>
A list of CircuitInfo objects, that describe the individual circuits in this LAG. Structure is documented below.
CreationTimestamp string
Creation timestamp in RFC3339 text format.
EffectiveLabels Dictionary<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 List<InterconnectExpectedOutage>
A list of outages expected for this Interconnect. Structure is documented below.
GoogleIpAddress string
IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
GoogleReferenceId string
Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
Id string
The provider-assigned unique ID for this managed resource.
InterconnectAttachments List<string>
A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
LabelFingerprint 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.
OperationalStatus string
The current status of this Interconnect's functionality, which can take one of the following:

  • OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.
  • OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.
  • OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
PeerIpAddress 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.
ProvisionedLinkCount int
Number of links actually provisioned in this interconnect.
PulumiLabels Dictionary<string, string>
The combination of labels configured directly on the resource and default labels configured on the provider.
SatisfiesPzs bool
Reserved for future use.
State 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:

  • ACTIVE: This outage notification is active. The event could be in the past, present, or future. See startTime and endTime for scheduling.
  • CANCELLED: The outage associated with this notification was cancelled before the outage was due to start.
  • COMPLETED: The outage associated with this notification is complete.
AvailableFeatures []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 []InterconnectCircuitInfo
A list of CircuitInfo objects, that describe the individual circuits in this LAG. Structure is documented below.
CreationTimestamp string
Creation timestamp in RFC3339 text format.
EffectiveLabels 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 []InterconnectExpectedOutage
A list of outages expected for this Interconnect. Structure is documented below.
GoogleIpAddress string
IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
GoogleReferenceId string
Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
Id string
The provider-assigned unique ID for this managed resource.
InterconnectAttachments []string
A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
LabelFingerprint 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.
OperationalStatus string
The current status of this Interconnect's functionality, which can take one of the following:

  • OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.
  • OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.
  • OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
PeerIpAddress 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.
ProvisionedLinkCount int
Number of links actually provisioned in this interconnect.
PulumiLabels map[string]string
The combination of labels configured directly on the resource and default labels configured on the provider.
SatisfiesPzs bool
Reserved for future use.
State 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:

  • ACTIVE: This outage notification is active. The event could be in the past, present, or future. See startTime and endTime for scheduling.
  • CANCELLED: The outage associated with this notification was cancelled before the outage was due to start.
  • COMPLETED: The outage associated with this notification is complete.
availableFeatures 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 List<InterconnectCircuitInfo>
A list of CircuitInfo objects, that describe the individual circuits in this LAG. Structure is documented below.
creationTimestamp String
Creation timestamp in RFC3339 text format.
effectiveLabels 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 List<InterconnectExpectedOutage>
A list of outages expected for this Interconnect. Structure is documented below.
googleIpAddress String
IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
googleReferenceId String
Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
id String
The provider-assigned unique ID for this managed resource.
interconnectAttachments List<String>
A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
labelFingerprint 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.
operationalStatus String
The current status of this Interconnect's functionality, which can take one of the following:

  • OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.
  • OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.
  • OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
peerIpAddress 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.
provisionedLinkCount Integer
Number of links actually provisioned in this interconnect.
pulumiLabels Map<String,String>
The combination of labels configured directly on the resource and default labels configured on the provider.
satisfiesPzs Boolean
Reserved for future use.
state 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:

  • ACTIVE: This outage notification is active. The event could be in the past, present, or future. See startTime and endTime for scheduling.
  • CANCELLED: The outage associated with this notification was cancelled before the outage was due to start.
  • COMPLETED: The outage associated with this notification is complete.
availableFeatures 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 InterconnectCircuitInfo[]
A list of CircuitInfo objects, that describe the individual circuits in this LAG. Structure is documented below.
creationTimestamp string
Creation timestamp in RFC3339 text format.
effectiveLabels {[key: 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 InterconnectExpectedOutage[]
A list of outages expected for this Interconnect. Structure is documented below.
googleIpAddress string
IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
googleReferenceId string
Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
id string
The provider-assigned unique ID for this managed resource.
interconnectAttachments string[]
A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
labelFingerprint 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.
operationalStatus string
The current status of this Interconnect's functionality, which can take one of the following:

  • OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.
  • OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.
  • OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
peerIpAddress 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.
provisionedLinkCount number
Number of links actually provisioned in this interconnect.
pulumiLabels {[key: string]: string}
The combination of labels configured directly on the resource and default labels configured on the provider.
satisfiesPzs boolean
Reserved for future use.
state 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:

  • ACTIVE: This outage notification is active. The event could be in the past, present, or future. See startTime and endTime for scheduling.
  • CANCELLED: The outage associated with this notification was cancelled before the outage was due to start.
  • COMPLETED: The outage associated with this notification is complete.
available_features Sequence[str]
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).
circuit_infos Sequence[InterconnectCircuitInfo]
A list of CircuitInfo objects, that describe the individual circuits in this LAG. Structure is documented below.
creation_timestamp str
Creation timestamp in RFC3339 text format.
effective_labels Mapping[str, str]
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
expected_outages Sequence[InterconnectExpectedOutage]
A list of outages expected for this Interconnect. Structure is documented below.
google_ip_address str
IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
google_reference_id str
Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
id str
The provider-assigned unique ID for this managed resource.
interconnect_attachments Sequence[str]
A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
label_fingerprint str
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.
operational_status str
The current status of this Interconnect's functionality, which can take one of the following:

  • OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.
  • OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.
  • OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
peer_ip_address str
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.
provisioned_link_count int
Number of links actually provisioned in this interconnect.
pulumi_labels Mapping[str, str]
The combination of labels configured directly on the resource and default labels configured on the provider.
satisfies_pzs bool
Reserved for future use.
state str
(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:

  • ACTIVE: This outage notification is active. The event could be in the past, present, or future. See startTime and endTime for scheduling.
  • CANCELLED: The outage associated with this notification was cancelled before the outage was due to start.
  • COMPLETED: The outage associated with this notification is complete.
availableFeatures 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 List<Property Map>
A list of CircuitInfo objects, that describe the individual circuits in this LAG. Structure is documented below.
creationTimestamp String
Creation timestamp in RFC3339 text format.
effectiveLabels Map<String>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
expectedOutages List<Property Map>
A list of outages expected for this Interconnect. Structure is documented below.
googleIpAddress String
IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
googleReferenceId String
Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
id String
The provider-assigned unique ID for this managed resource.
interconnectAttachments List<String>
A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
labelFingerprint 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.
operationalStatus String
The current status of this Interconnect's functionality, which can take one of the following:

  • OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.
  • OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.
  • OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
peerIpAddress 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.
provisionedLinkCount Number
Number of links actually provisioned in this interconnect.
pulumiLabels Map<String>
The combination of labels configured directly on the resource and default labels configured on the provider.
satisfiesPzs Boolean
Reserved for future use.
state 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:

  • ACTIVE: This outage notification is active. The event could be in the past, present, or future. See startTime and endTime for scheduling.
  • CANCELLED: The outage associated with this notification was cancelled before the outage was due to start.
  • COMPLETED: The outage associated with this notification is complete.

Look up Existing Interconnect Resource

Get an existing Interconnect resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: InterconnectState, opts?: CustomResourceOptions): Interconnect
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin_enabled: Optional[bool] = None,
        available_features: Optional[Sequence[str]] = None,
        circuit_infos: Optional[Sequence[InterconnectCircuitInfoArgs]] = None,
        creation_timestamp: Optional[str] = None,
        customer_name: Optional[str] = None,
        description: Optional[str] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        expected_outages: Optional[Sequence[InterconnectExpectedOutageArgs]] = None,
        google_ip_address: Optional[str] = None,
        google_reference_id: Optional[str] = None,
        interconnect_attachments: Optional[Sequence[str]] = None,
        interconnect_type: Optional[str] = None,
        label_fingerprint: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        link_type: Optional[str] = None,
        location: Optional[str] = None,
        macsec: Optional[InterconnectMacsecArgs] = None,
        macsec_enabled: Optional[bool] = None,
        name: Optional[str] = None,
        noc_contact_email: Optional[str] = None,
        operational_status: Optional[str] = None,
        peer_ip_address: Optional[str] = None,
        project: Optional[str] = None,
        provisioned_link_count: Optional[int] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None,
        remote_location: Optional[str] = None,
        requested_features: Optional[Sequence[str]] = None,
        requested_link_count: Optional[int] = None,
        satisfies_pzs: Optional[bool] = None,
        state: Optional[str] = None) -> Interconnect
func GetInterconnect(ctx *Context, name string, id IDInput, state *InterconnectState, opts ...ResourceOption) (*Interconnect, error)
public static Interconnect Get(string name, Input<string> id, InterconnectState? state, CustomResourceOptions? opts = null)
public static Interconnect get(String name, Output<String> id, InterconnectState state, CustomResourceOptions options)
resources:  _:    type: gcp:compute:Interconnect    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AdminEnabled 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.
AvailableFeatures 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 List<InterconnectCircuitInfo>
A list of CircuitInfo objects, that describe the individual circuits in this LAG. Structure is documented below.
CreationTimestamp string
Creation timestamp in RFC3339 text format.
CustomerName Changes to this property will trigger replacement. 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 string
An optional description of this resource. Provide this property when you create the resource.
EffectiveLabels Dictionary<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 List<InterconnectExpectedOutage>
A list of outages expected for this Interconnect. Structure is documented below.
GoogleIpAddress string
IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
GoogleReferenceId string
Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
InterconnectAttachments List<string>
A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
InterconnectType Changes to this property will trigger replacement. string
Type of interconnect. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. Can take one of the following values:

  • PARTNER: A partner-managed interconnection shared between customers though a partner.
  • DEDICATED: A dedicated physical interconnection with the customer. Possible values are: DEDICATED, PARTNER, IT_PRIVATE.

LabelFingerprint 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 Dictionary<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 Changes to this property will trigger replacement. 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:

  • LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics.
  • LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.
  • LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics Possible values are: LINK_TYPE_ETHERNET_10G_LR, LINK_TYPE_ETHERNET_100G_LR, LINK_TYPE_ETHERNET_400G_LR4.
Location Changes to this property will trigger replacement. string
URL of the InterconnectLocation object that represents where this connection is to be provisioned. Specifies the location inside Google's Networks, should not be passed in case of cross-cloud interconnect.
Macsec 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 bool
Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.
Name Changes to this property will trigger replacement. 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 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 string
The current status of this Interconnect's functionality, which can take one of the following:

  • OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.
  • OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.
  • OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
PeerIpAddress 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 Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
ProvisionedLinkCount int
Number of links actually provisioned in this interconnect.
PulumiLabels Dictionary<string, string>
The combination of labels configured directly on the resource and default labels configured on the provider.
RemoteLocation Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. int
Target number of physical links in the link bundle, as requested by the customer.
SatisfiesPzs bool
Reserved for future use.
State 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:

  • ACTIVE: This outage notification is active. The event could be in the past, present, or future. See startTime and endTime for scheduling.
  • CANCELLED: The outage associated with this notification was cancelled before the outage was due to start.
  • COMPLETED: The outage associated with this notification is complete.
AdminEnabled 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.
AvailableFeatures []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 []InterconnectCircuitInfoArgs
A list of CircuitInfo objects, that describe the individual circuits in this LAG. Structure is documented below.
CreationTimestamp string
Creation timestamp in RFC3339 text format.
CustomerName Changes to this property will trigger replacement. 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 string
An optional description of this resource. Provide this property when you create the resource.
EffectiveLabels 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 []InterconnectExpectedOutageArgs
A list of outages expected for this Interconnect. Structure is documented below.
GoogleIpAddress string
IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
GoogleReferenceId string
Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
InterconnectAttachments []string
A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
InterconnectType Changes to this property will trigger replacement. string
Type of interconnect. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. Can take one of the following values:

  • PARTNER: A partner-managed interconnection shared between customers though a partner.
  • DEDICATED: A dedicated physical interconnection with the customer. Possible values are: DEDICATED, PARTNER, IT_PRIVATE.

LabelFingerprint 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 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 Changes to this property will trigger replacement. 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:

  • LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics.
  • LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.
  • LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics Possible values are: LINK_TYPE_ETHERNET_10G_LR, LINK_TYPE_ETHERNET_100G_LR, LINK_TYPE_ETHERNET_400G_LR4.
Location Changes to this property will trigger replacement. string
URL of the InterconnectLocation object that represents where this connection is to be provisioned. Specifies the location inside Google's Networks, should not be passed in case of cross-cloud interconnect.
Macsec InterconnectMacsecArgs
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 bool
Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.
Name Changes to this property will trigger replacement. 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 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 string
The current status of this Interconnect's functionality, which can take one of the following:

  • OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.
  • OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.
  • OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
PeerIpAddress 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 Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
ProvisionedLinkCount int
Number of links actually provisioned in this interconnect.
PulumiLabels map[string]string
The combination of labels configured directly on the resource and default labels configured on the provider.
RemoteLocation Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. []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 Changes to this property will trigger replacement. int
Target number of physical links in the link bundle, as requested by the customer.
SatisfiesPzs bool
Reserved for future use.
State 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:

  • ACTIVE: This outage notification is active. The event could be in the past, present, or future. See startTime and endTime for scheduling.
  • CANCELLED: The outage associated with this notification was cancelled before the outage was due to start.
  • COMPLETED: The outage associated with this notification is complete.
adminEnabled 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 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 List<InterconnectCircuitInfo>
A list of CircuitInfo objects, that describe the individual circuits in this LAG. Structure is documented below.
creationTimestamp String
Creation timestamp in RFC3339 text format.
customerName Changes to this property will trigger replacement. 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 String
An optional description of this resource. Provide this property when you create the resource.
effectiveLabels 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 List<InterconnectExpectedOutage>
A list of outages expected for this Interconnect. Structure is documented below.
googleIpAddress String
IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
googleReferenceId String
Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
interconnectAttachments List<String>
A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
interconnectType Changes to this property will trigger replacement. String
Type of interconnect. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. Can take one of the following values:

  • PARTNER: A partner-managed interconnection shared between customers though a partner.
  • DEDICATED: A dedicated physical interconnection with the customer. Possible values are: DEDICATED, PARTNER, IT_PRIVATE.

labelFingerprint 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 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 Changes to this property will trigger replacement. 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:

  • LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics.
  • LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.
  • LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics Possible values are: LINK_TYPE_ETHERNET_10G_LR, LINK_TYPE_ETHERNET_100G_LR, LINK_TYPE_ETHERNET_400G_LR4.
location Changes to this property will trigger replacement. String
URL of the InterconnectLocation object that represents where this connection is to be provisioned. Specifies the location inside Google's Networks, should not be passed in case of cross-cloud interconnect.
macsec 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 Boolean
Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.
name Changes to this property will trigger replacement. 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 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 String
The current status of this Interconnect's functionality, which can take one of the following:

  • OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.
  • OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.
  • OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
peerIpAddress 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 Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
provisionedLinkCount Integer
Number of links actually provisioned in this interconnect.
pulumiLabels Map<String,String>
The combination of labels configured directly on the resource and default labels configured on the provider.
remoteLocation Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. Integer
Target number of physical links in the link bundle, as requested by the customer.
satisfiesPzs Boolean
Reserved for future use.
state 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:

  • ACTIVE: This outage notification is active. The event could be in the past, present, or future. See startTime and endTime for scheduling.
  • CANCELLED: The outage associated with this notification was cancelled before the outage was due to start.
  • COMPLETED: The outage associated with this notification is complete.
adminEnabled 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 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 InterconnectCircuitInfo[]
A list of CircuitInfo objects, that describe the individual circuits in this LAG. Structure is documented below.
creationTimestamp string
Creation timestamp in RFC3339 text format.
customerName Changes to this property will trigger replacement. 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 string
An optional description of this resource. Provide this property when you create the resource.
effectiveLabels {[key: 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 InterconnectExpectedOutage[]
A list of outages expected for this Interconnect. Structure is documented below.
googleIpAddress string
IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
googleReferenceId string
Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
interconnectAttachments string[]
A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
interconnectType Changes to this property will trigger replacement. string
Type of interconnect. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. Can take one of the following values:

  • PARTNER: A partner-managed interconnection shared between customers though a partner.
  • DEDICATED: A dedicated physical interconnection with the customer. Possible values are: DEDICATED, PARTNER, IT_PRIVATE.

labelFingerprint 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 {[key: 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 Changes to this property will trigger replacement. 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:

  • LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics.
  • LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.
  • LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics Possible values are: LINK_TYPE_ETHERNET_10G_LR, LINK_TYPE_ETHERNET_100G_LR, LINK_TYPE_ETHERNET_400G_LR4.
location Changes to this property will trigger replacement. string
URL of the InterconnectLocation object that represents where this connection is to be provisioned. Specifies the location inside Google's Networks, should not be passed in case of cross-cloud interconnect.
macsec 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 boolean
Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.
name Changes to this property will trigger replacement. 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 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 string
The current status of this Interconnect's functionality, which can take one of the following:

  • OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.
  • OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.
  • OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
peerIpAddress 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 Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
provisionedLinkCount number
Number of links actually provisioned in this interconnect.
pulumiLabels {[key: string]: string}
The combination of labels configured directly on the resource and default labels configured on the provider.
remoteLocation Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. number
Target number of physical links in the link bundle, as requested by the customer.
satisfiesPzs boolean
Reserved for future use.
state 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:

  • ACTIVE: This outage notification is active. The event could be in the past, present, or future. See startTime and endTime for scheduling.
  • CANCELLED: The outage associated with this notification was cancelled before the outage was due to start.
  • COMPLETED: The outage associated with this notification is complete.
admin_enabled 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.
available_features Sequence[str]
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).
circuit_infos Sequence[InterconnectCircuitInfoArgs]
A list of CircuitInfo objects, that describe the individual circuits in this LAG. Structure is documented below.
creation_timestamp str
Creation timestamp in RFC3339 text format.
customer_name Changes to this property will trigger replacement. str
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 str
An optional description of this resource. Provide this property when you create the resource.
effective_labels Mapping[str, str]
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
expected_outages Sequence[InterconnectExpectedOutageArgs]
A list of outages expected for this Interconnect. Structure is documented below.
google_ip_address str
IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
google_reference_id str
Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
interconnect_attachments Sequence[str]
A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
interconnect_type Changes to this property will trigger replacement. str
Type of interconnect. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. Can take one of the following values:

  • PARTNER: A partner-managed interconnection shared between customers though a partner.
  • DEDICATED: A dedicated physical interconnection with the customer. Possible values are: DEDICATED, PARTNER, IT_PRIVATE.

label_fingerprint str
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 Mapping[str, str]

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.

link_type Changes to this property will trigger replacement. str
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:

  • LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics.
  • LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.
  • LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics Possible values are: LINK_TYPE_ETHERNET_10G_LR, LINK_TYPE_ETHERNET_100G_LR, LINK_TYPE_ETHERNET_400G_LR4.
location Changes to this property will trigger replacement. str
URL of the InterconnectLocation object that represents where this connection is to be provisioned. Specifies the location inside Google's Networks, should not be passed in case of cross-cloud interconnect.
macsec InterconnectMacsecArgs
Configuration that enables Media Access Control security (MACsec) on the Cloud Interconnect connection between Google and your on-premises router. Structure is documented below.
macsec_enabled bool
Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.
name Changes to this property will trigger replacement. str
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.
noc_contact_email str
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.
operational_status str
The current status of this Interconnect's functionality, which can take one of the following:

  • OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.
  • OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.
  • OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
peer_ip_address str
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 Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
provisioned_link_count int
Number of links actually provisioned in this interconnect.
pulumi_labels Mapping[str, str]
The combination of labels configured directly on the resource and default labels configured on the provider.
remote_location Changes to this property will trigger replacement. str
Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to.
requested_features Changes to this property will trigger replacement. Sequence[str]
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.
requested_link_count Changes to this property will trigger replacement. int
Target number of physical links in the link bundle, as requested by the customer.
satisfies_pzs bool
Reserved for future use.
state str
(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:

  • ACTIVE: This outage notification is active. The event could be in the past, present, or future. See startTime and endTime for scheduling.
  • CANCELLED: The outage associated with this notification was cancelled before the outage was due to start.
  • COMPLETED: The outage associated with this notification is complete.
adminEnabled 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 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 List<Property Map>
A list of CircuitInfo objects, that describe the individual circuits in this LAG. Structure is documented below.
creationTimestamp String
Creation timestamp in RFC3339 text format.
customerName Changes to this property will trigger replacement. 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 String
An optional description of this resource. Provide this property when you create the resource.
effectiveLabels Map<String>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
expectedOutages List<Property Map>
A list of outages expected for this Interconnect. Structure is documented below.
googleIpAddress String
IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.
googleReferenceId String
Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.
interconnectAttachments List<String>
A list of the URLs of all InterconnectAttachments configured to use this Interconnect.
interconnectType Changes to this property will trigger replacement. String
Type of interconnect. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. Can take one of the following values:

  • PARTNER: A partner-managed interconnection shared between customers though a partner.
  • DEDICATED: A dedicated physical interconnection with the customer. Possible values are: DEDICATED, PARTNER, IT_PRIVATE.

labelFingerprint 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 Map<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 Changes to this property will trigger replacement. 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:

  • LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics.
  • LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.
  • LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics Possible values are: LINK_TYPE_ETHERNET_10G_LR, LINK_TYPE_ETHERNET_100G_LR, LINK_TYPE_ETHERNET_400G_LR4.
location Changes to this property will trigger replacement. String
URL of the InterconnectLocation object that represents where this connection is to be provisioned. Specifies the location inside Google's Networks, should not be passed in case of cross-cloud interconnect.
macsec Property Map
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 Boolean
Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.
name Changes to this property will trigger replacement. 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 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 String
The current status of this Interconnect's functionality, which can take one of the following:

  • OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect.
  • OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect.
  • OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.
peerIpAddress 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 Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
provisionedLinkCount Number
Number of links actually provisioned in this interconnect.
pulumiLabels Map<String>
The combination of labels configured directly on the resource and default labels configured on the provider.
remoteLocation Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. Number
Target number of physical links in the link bundle, as requested by the customer.
satisfiesPzs Boolean
Reserved for future use.
state 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:

  • ACTIVE: This outage notification is active. The event could be in the past, present, or future. See startTime and endTime for scheduling.
  • CANCELLED: The outage associated with this notification was cancelled before the outage was due to start.
  • COMPLETED: The outage associated with this notification is complete.

Supporting Types

InterconnectCircuitInfo
, InterconnectCircuitInfoArgs

CustomerDemarcId string
(Output) Customer-side demarc ID for this circuit.
GoogleCircuitId string
(Output) Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
GoogleDemarcId string
(Output) Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA.
CustomerDemarcId string
(Output) Customer-side demarc ID for this circuit.
GoogleCircuitId string
(Output) Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
GoogleDemarcId string
(Output) Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA.
customerDemarcId String
(Output) Customer-side demarc ID for this circuit.
googleCircuitId String
(Output) Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
googleDemarcId String
(Output) Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA.
customerDemarcId string
(Output) Customer-side demarc ID for this circuit.
googleCircuitId string
(Output) Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
googleDemarcId string
(Output) Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA.
customer_demarc_id str
(Output) Customer-side demarc ID for this circuit.
google_circuit_id str
(Output) Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
google_demarc_id str
(Output) Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA.
customerDemarcId String
(Output) Customer-side demarc ID for this circuit.
googleCircuitId String
(Output) Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
googleDemarcId String
(Output) Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA.

InterconnectExpectedOutage
, InterconnectExpectedOutageArgs

AffectedCircuits List<string>
(Output) If issueType is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.
Description string
An optional description of this resource. Provide this property when you create the resource.
EndTime string
(Output) Scheduled end time for the outage (milliseconds since Unix epoch).
IssueType string
(Output) Form this outage is expected to take. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values. Can take one of the following values:

  • OUTAGE: The Interconnect may be completely out of service for some or all of the specified window.
  • PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth.
Name 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.
Source string
(Output) The party that generated this notification. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE. Can take the following value:

  • GOOGLE: this notification as generated by Google.
StartTime string
(Output) Scheduled start time for the outage (milliseconds since Unix epoch).
State 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:

  • ACTIVE: This outage notification is active. The event could be in the past, present, or future. See startTime and endTime for scheduling.
  • CANCELLED: The outage associated with this notification was cancelled before the outage was due to start.
  • COMPLETED: The outage associated with this notification is complete.
AffectedCircuits []string
(Output) If issueType is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.
Description string
An optional description of this resource. Provide this property when you create the resource.
EndTime string
(Output) Scheduled end time for the outage (milliseconds since Unix epoch).
IssueType string
(Output) Form this outage is expected to take. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values. Can take one of the following values:

  • OUTAGE: The Interconnect may be completely out of service for some or all of the specified window.
  • PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth.
Name 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.
Source string
(Output) The party that generated this notification. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE. Can take the following value:

  • GOOGLE: this notification as generated by Google.
StartTime string
(Output) Scheduled start time for the outage (milliseconds since Unix epoch).
State 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:

  • ACTIVE: This outage notification is active. The event could be in the past, present, or future. See startTime and endTime for scheduling.
  • CANCELLED: The outage associated with this notification was cancelled before the outage was due to start.
  • COMPLETED: The outage associated with this notification is complete.
affectedCircuits List<String>
(Output) If issueType is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.
description String
An optional description of this resource. Provide this property when you create the resource.
endTime String
(Output) Scheduled end time for the outage (milliseconds since Unix epoch).
issueType String
(Output) Form this outage is expected to take. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values. Can take one of the following values:

  • OUTAGE: The Interconnect may be completely out of service for some or all of the specified window.
  • PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth.
name 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.
source String
(Output) The party that generated this notification. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE. Can take the following value:

  • GOOGLE: this notification as generated by Google.
startTime String
(Output) Scheduled start time for the outage (milliseconds since Unix epoch).
state 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:

  • ACTIVE: This outage notification is active. The event could be in the past, present, or future. See startTime and endTime for scheduling.
  • CANCELLED: The outage associated with this notification was cancelled before the outage was due to start.
  • COMPLETED: The outage associated with this notification is complete.
affectedCircuits string[]
(Output) If issueType is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.
description string
An optional description of this resource. Provide this property when you create the resource.
endTime string
(Output) Scheduled end time for the outage (milliseconds since Unix epoch).
issueType string
(Output) Form this outage is expected to take. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values. Can take one of the following values:

  • OUTAGE: The Interconnect may be completely out of service for some or all of the specified window.
  • PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth.
name 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.
source string
(Output) The party that generated this notification. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE. Can take the following value:

  • GOOGLE: this notification as generated by Google.
startTime string
(Output) Scheduled start time for the outage (milliseconds since Unix epoch).
state 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:

  • ACTIVE: This outage notification is active. The event could be in the past, present, or future. See startTime and endTime for scheduling.
  • CANCELLED: The outage associated with this notification was cancelled before the outage was due to start.
  • COMPLETED: The outage associated with this notification is complete.
affected_circuits Sequence[str]
(Output) If issueType is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.
description str
An optional description of this resource. Provide this property when you create the resource.
end_time str
(Output) Scheduled end time for the outage (milliseconds since Unix epoch).
issue_type str
(Output) Form this outage is expected to take. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values. Can take one of the following values:

  • OUTAGE: The Interconnect may be completely out of service for some or all of the specified window.
  • PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth.
name str
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.
source str
(Output) The party that generated this notification. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE. Can take the following value:

  • GOOGLE: this notification as generated by Google.
start_time str
(Output) Scheduled start time for the outage (milliseconds since Unix epoch).
state str
(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:

  • ACTIVE: This outage notification is active. The event could be in the past, present, or future. See startTime and endTime for scheduling.
  • CANCELLED: The outage associated with this notification was cancelled before the outage was due to start.
  • COMPLETED: The outage associated with this notification is complete.
affectedCircuits List<String>
(Output) If issueType is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.
description String
An optional description of this resource. Provide this property when you create the resource.
endTime String
(Output) Scheduled end time for the outage (milliseconds since Unix epoch).
issueType String
(Output) Form this outage is expected to take. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values. Can take one of the following values:

  • OUTAGE: The Interconnect may be completely out of service for some or all of the specified window.
  • PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth.
name 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.
source String
(Output) The party that generated this notification. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE. Can take the following value:

  • GOOGLE: this notification as generated by Google.
startTime String
(Output) Scheduled start time for the outage (milliseconds since Unix epoch).
state 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:

  • ACTIVE: This outage notification is active. The event could be in the past, present, or future. See startTime and endTime for scheduling.
  • CANCELLED: The outage associated with this notification was cancelled before the outage was due to start.
  • COMPLETED: The outage associated with this notification is complete.

InterconnectMacsec
, InterconnectMacsecArgs

PreSharedKeys This property is required. List<InterconnectMacsecPreSharedKey>
A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK is generated for each key in the key chain. Google router automatically picks the key with the most recent startTime when establishing or re-establishing a MACsec secure link. Structure is documented below.
FailOpen bool
If set to true, the Interconnect connection is configured with a should-secure MACsec security policy, that allows the Google router to fallback to cleartext traffic if the MKA session cannot be established. By default, the Interconnect connection is configured with a must-secure security policy that drops all traffic if the MKA session cannot be established with your router.
PreSharedKeys This property is required. []InterconnectMacsecPreSharedKey
A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK is generated for each key in the key chain. Google router automatically picks the key with the most recent startTime when establishing or re-establishing a MACsec secure link. Structure is documented below.
FailOpen bool
If set to true, the Interconnect connection is configured with a should-secure MACsec security policy, that allows the Google router to fallback to cleartext traffic if the MKA session cannot be established. By default, the Interconnect connection is configured with a must-secure security policy that drops all traffic if the MKA session cannot be established with your router.
preSharedKeys This property is required. List<InterconnectMacsecPreSharedKey>
A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK is generated for each key in the key chain. Google router automatically picks the key with the most recent startTime when establishing or re-establishing a MACsec secure link. Structure is documented below.
failOpen Boolean
If set to true, the Interconnect connection is configured with a should-secure MACsec security policy, that allows the Google router to fallback to cleartext traffic if the MKA session cannot be established. By default, the Interconnect connection is configured with a must-secure security policy that drops all traffic if the MKA session cannot be established with your router.
preSharedKeys This property is required. InterconnectMacsecPreSharedKey[]
A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK is generated for each key in the key chain. Google router automatically picks the key with the most recent startTime when establishing or re-establishing a MACsec secure link. Structure is documented below.
failOpen boolean
If set to true, the Interconnect connection is configured with a should-secure MACsec security policy, that allows the Google router to fallback to cleartext traffic if the MKA session cannot be established. By default, the Interconnect connection is configured with a must-secure security policy that drops all traffic if the MKA session cannot be established with your router.
pre_shared_keys This property is required. Sequence[InterconnectMacsecPreSharedKey]
A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK is generated for each key in the key chain. Google router automatically picks the key with the most recent startTime when establishing or re-establishing a MACsec secure link. Structure is documented below.
fail_open bool
If set to true, the Interconnect connection is configured with a should-secure MACsec security policy, that allows the Google router to fallback to cleartext traffic if the MKA session cannot be established. By default, the Interconnect connection is configured with a must-secure security policy that drops all traffic if the MKA session cannot be established with your router.
preSharedKeys This property is required. List<Property Map>
A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK is generated for each key in the key chain. Google router automatically picks the key with the most recent startTime when establishing or re-establishing a MACsec secure link. Structure is documented below.
failOpen Boolean
If set to true, the Interconnect connection is configured with a should-secure MACsec security policy, that allows the Google router to fallback to cleartext traffic if the MKA session cannot be established. By default, the Interconnect connection is configured with a must-secure security policy that drops all traffic if the MKA session cannot be established with your router.

InterconnectMacsecPreSharedKey
, InterconnectMacsecPreSharedKeyArgs

Name This property is required. string
A name for this pre-shared key. 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.
FailOpen bool

(Optional, Deprecated) If set to true, the Interconnect connection is configured with a should-secure MACsec security policy, that allows the Google router to fallback to cleartext traffic if the MKA session cannot be established. By default, the Interconnect connection is configured with a must-secure security policy that drops all traffic if the MKA session cannot be established with your router.

Warning: failOpen is deprecated and will be removed in a future major release. Use other failOpen instead.

Deprecated: failOpen is deprecated and will be removed in a future major release. Use other failOpen instead.

StartTime string
A RFC3339 timestamp on or after which the key is valid. startTime can be in the future. If the keychain has a single key, startTime can be omitted. If the keychain has multiple keys, startTime is mandatory for each key. The start times of keys must be in increasing order. The start times of two consecutive keys must be at least 6 hours apart.
Name This property is required. string
A name for this pre-shared key. 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.
FailOpen bool

(Optional, Deprecated) If set to true, the Interconnect connection is configured with a should-secure MACsec security policy, that allows the Google router to fallback to cleartext traffic if the MKA session cannot be established. By default, the Interconnect connection is configured with a must-secure security policy that drops all traffic if the MKA session cannot be established with your router.

Warning: failOpen is deprecated and will be removed in a future major release. Use other failOpen instead.

Deprecated: failOpen is deprecated and will be removed in a future major release. Use other failOpen instead.

StartTime string
A RFC3339 timestamp on or after which the key is valid. startTime can be in the future. If the keychain has a single key, startTime can be omitted. If the keychain has multiple keys, startTime is mandatory for each key. The start times of keys must be in increasing order. The start times of two consecutive keys must be at least 6 hours apart.
name This property is required. String
A name for this pre-shared key. 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.
failOpen Boolean

(Optional, Deprecated) If set to true, the Interconnect connection is configured with a should-secure MACsec security policy, that allows the Google router to fallback to cleartext traffic if the MKA session cannot be established. By default, the Interconnect connection is configured with a must-secure security policy that drops all traffic if the MKA session cannot be established with your router.

Warning: failOpen is deprecated and will be removed in a future major release. Use other failOpen instead.

Deprecated: failOpen is deprecated and will be removed in a future major release. Use other failOpen instead.

startTime String
A RFC3339 timestamp on or after which the key is valid. startTime can be in the future. If the keychain has a single key, startTime can be omitted. If the keychain has multiple keys, startTime is mandatory for each key. The start times of keys must be in increasing order. The start times of two consecutive keys must be at least 6 hours apart.
name This property is required. string
A name for this pre-shared key. 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.
failOpen boolean

(Optional, Deprecated) If set to true, the Interconnect connection is configured with a should-secure MACsec security policy, that allows the Google router to fallback to cleartext traffic if the MKA session cannot be established. By default, the Interconnect connection is configured with a must-secure security policy that drops all traffic if the MKA session cannot be established with your router.

Warning: failOpen is deprecated and will be removed in a future major release. Use other failOpen instead.

Deprecated: failOpen is deprecated and will be removed in a future major release. Use other failOpen instead.

startTime string
A RFC3339 timestamp on or after which the key is valid. startTime can be in the future. If the keychain has a single key, startTime can be omitted. If the keychain has multiple keys, startTime is mandatory for each key. The start times of keys must be in increasing order. The start times of two consecutive keys must be at least 6 hours apart.
name This property is required. str
A name for this pre-shared key. 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.
fail_open bool

(Optional, Deprecated) If set to true, the Interconnect connection is configured with a should-secure MACsec security policy, that allows the Google router to fallback to cleartext traffic if the MKA session cannot be established. By default, the Interconnect connection is configured with a must-secure security policy that drops all traffic if the MKA session cannot be established with your router.

Warning: failOpen is deprecated and will be removed in a future major release. Use other failOpen instead.

Deprecated: failOpen is deprecated and will be removed in a future major release. Use other failOpen instead.

start_time str
A RFC3339 timestamp on or after which the key is valid. startTime can be in the future. If the keychain has a single key, startTime can be omitted. If the keychain has multiple keys, startTime is mandatory for each key. The start times of keys must be in increasing order. The start times of two consecutive keys must be at least 6 hours apart.
name This property is required. String
A name for this pre-shared key. 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.
failOpen Boolean

(Optional, Deprecated) If set to true, the Interconnect connection is configured with a should-secure MACsec security policy, that allows the Google router to fallback to cleartext traffic if the MKA session cannot be established. By default, the Interconnect connection is configured with a must-secure security policy that drops all traffic if the MKA session cannot be established with your router.

Warning: failOpen is deprecated and will be removed in a future major release. Use other failOpen instead.

Deprecated: failOpen is deprecated and will be removed in a future major release. Use other failOpen instead.

startTime String
A RFC3339 timestamp on or after which the key is valid. startTime can be in the future. If the keychain has a single key, startTime can be omitted. If the keychain has multiple keys, startTime is mandatory for each key. The start times of keys must be in increasing order. The start times of two consecutive keys must be at least 6 hours apart.

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}}
Copy
$ pulumi import gcp:compute/interconnect:Interconnect default {{project}}/{{name}}
Copy
$ pulumi import gcp:compute/interconnect:Interconnect default {{name}}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Google Cloud (GCP) Classic pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.