1. Packages
  2. AWS Classic
  3. API Docs
  4. directconnect
  5. Connection

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.2.0 published on Monday, Sep 18, 2023 by Pulumi

aws.directconnect.Connection

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.2.0 published on Monday, Sep 18, 2023 by Pulumi

    Provides a Connection of Direct Connect.

    Example Usage

    Create a connection

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var hoge = new Aws.DirectConnect.Connection("hoge", new()
        {
            Bandwidth = "1Gbps",
            Location = "EqDC2",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/directconnect"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := directconnect.NewConnection(ctx, "hoge", &directconnect.ConnectionArgs{
    			Bandwidth: pulumi.String("1Gbps"),
    			Location:  pulumi.String("EqDC2"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.directconnect.Connection;
    import com.pulumi.aws.directconnect.ConnectionArgs;
    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) {
            var hoge = new Connection("hoge", ConnectionArgs.builder()        
                .bandwidth("1Gbps")
                .location("EqDC2")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aws as aws
    
    hoge = aws.directconnect.Connection("hoge",
        bandwidth="1Gbps",
        location="EqDC2")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const hoge = new aws.directconnect.Connection("hoge", {
        bandwidth: "1Gbps",
        location: "EqDC2",
    });
    
    resources:
      hoge:
        type: aws:directconnect:Connection
        properties:
          bandwidth: 1Gbps
          location: EqDC2
    

    Request a MACsec-capable connection

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.DirectConnect.Connection("example", new()
        {
            Bandwidth = "10Gbps",
            Location = "EqDA2",
            RequestMacsec = true,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/directconnect"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := directconnect.NewConnection(ctx, "example", &directconnect.ConnectionArgs{
    			Bandwidth:     pulumi.String("10Gbps"),
    			Location:      pulumi.String("EqDA2"),
    			RequestMacsec: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.directconnect.Connection;
    import com.pulumi.aws.directconnect.ConnectionArgs;
    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) {
            var example = new Connection("example", ConnectionArgs.builder()        
                .bandwidth("10Gbps")
                .location("EqDA2")
                .requestMacsec(true)
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.directconnect.Connection("example",
        bandwidth="10Gbps",
        location="EqDA2",
        request_macsec=True)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.directconnect.Connection("example", {
        bandwidth: "10Gbps",
        location: "EqDA2",
        requestMacsec: true,
    });
    
    resources:
      example:
        type: aws:directconnect:Connection
        properties:
          bandwidth: 10Gbps
          location: EqDA2
          requestMacsec: true
    

    Configure encryption mode for MACsec-capable connections

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.DirectConnect.Connection("example", new()
        {
            Bandwidth = "10Gbps",
            EncryptionMode = "must_encrypt",
            Location = "EqDC2",
            RequestMacsec = true,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/directconnect"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := directconnect.NewConnection(ctx, "example", &directconnect.ConnectionArgs{
    			Bandwidth:      pulumi.String("10Gbps"),
    			EncryptionMode: pulumi.String("must_encrypt"),
    			Location:       pulumi.String("EqDC2"),
    			RequestMacsec:  pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.directconnect.Connection;
    import com.pulumi.aws.directconnect.ConnectionArgs;
    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) {
            var example = new Connection("example", ConnectionArgs.builder()        
                .bandwidth("10Gbps")
                .encryptionMode("must_encrypt")
                .location("EqDC2")
                .requestMacsec(true)
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.directconnect.Connection("example",
        bandwidth="10Gbps",
        encryption_mode="must_encrypt",
        location="EqDC2",
        request_macsec=True)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.directconnect.Connection("example", {
        bandwidth: "10Gbps",
        encryptionMode: "must_encrypt",
        location: "EqDC2",
        requestMacsec: true,
    });
    
    resources:
      example:
        type: aws:directconnect:Connection
        properties:
          bandwidth: 10Gbps
          encryptionMode: must_encrypt
          location: EqDC2
          requestMacsec: true
    

    Create Connection Resource

    new Connection(name: string, args: ConnectionArgs, opts?: CustomResourceOptions);
    @overload
    def Connection(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   bandwidth: Optional[str] = None,
                   encryption_mode: Optional[str] = None,
                   location: Optional[str] = None,
                   name: Optional[str] = None,
                   provider_name: Optional[str] = None,
                   request_macsec: Optional[bool] = None,
                   skip_destroy: Optional[bool] = None,
                   tags: Optional[Mapping[str, str]] = None)
    @overload
    def Connection(resource_name: str,
                   args: ConnectionArgs,
                   opts: Optional[ResourceOptions] = None)
    func NewConnection(ctx *Context, name string, args ConnectionArgs, opts ...ResourceOption) (*Connection, error)
    public Connection(string name, ConnectionArgs args, CustomResourceOptions? opts = null)
    public Connection(String name, ConnectionArgs args)
    public Connection(String name, ConnectionArgs args, CustomResourceOptions options)
    
    type: aws:directconnect:Connection
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args ConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ConnectionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Connection Resource Properties

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

    Inputs

    The Connection resource accepts the following input properties:

    Bandwidth string

    The bandwidth of the connection. Valid values for dedicated connections: 1Gbps, 10Gbps. Valid values for hosted connections: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps and 100Gbps. Case sensitive.

    Location string

    The AWS Direct Connect location where the connection is located. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

    EncryptionMode string

    The connection MAC Security (MACsec) encryption mode. MAC Security (MACsec) is only available on dedicated connections. Valid values are no_encrypt, should_encrypt, and must_encrypt.

    Name string

    The name of the connection.

    ProviderName string

    The name of the service provider associated with the connection.

    RequestMacsec bool

    Boolean value indicating whether you want the connection to support MAC Security (MACsec). MAC Security (MACsec) is only available on dedicated connections. See MACsec prerequisites for more information about MAC Security (MACsec) prerequisites. Default value: false.

    NOTE: Changing the value of request_macsec will cause the resource to be destroyed and re-created.

    SkipDestroy bool

    Set to true if you do not wish the connection to be deleted at destroy time, and instead just removed from the state.

    Tags Dictionary<string, string>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Bandwidth string

    The bandwidth of the connection. Valid values for dedicated connections: 1Gbps, 10Gbps. Valid values for hosted connections: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps and 100Gbps. Case sensitive.

    Location string

    The AWS Direct Connect location where the connection is located. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

    EncryptionMode string

    The connection MAC Security (MACsec) encryption mode. MAC Security (MACsec) is only available on dedicated connections. Valid values are no_encrypt, should_encrypt, and must_encrypt.

    Name string

    The name of the connection.

    ProviderName string

    The name of the service provider associated with the connection.

    RequestMacsec bool

    Boolean value indicating whether you want the connection to support MAC Security (MACsec). MAC Security (MACsec) is only available on dedicated connections. See MACsec prerequisites for more information about MAC Security (MACsec) prerequisites. Default value: false.

    NOTE: Changing the value of request_macsec will cause the resource to be destroyed and re-created.

    SkipDestroy bool

    Set to true if you do not wish the connection to be deleted at destroy time, and instead just removed from the state.

    Tags map[string]string

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    bandwidth String

    The bandwidth of the connection. Valid values for dedicated connections: 1Gbps, 10Gbps. Valid values for hosted connections: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps and 100Gbps. Case sensitive.

    location String

    The AWS Direct Connect location where the connection is located. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

    encryptionMode String

    The connection MAC Security (MACsec) encryption mode. MAC Security (MACsec) is only available on dedicated connections. Valid values are no_encrypt, should_encrypt, and must_encrypt.

    name String

    The name of the connection.

    providerName String

    The name of the service provider associated with the connection.

    requestMacsec Boolean

    Boolean value indicating whether you want the connection to support MAC Security (MACsec). MAC Security (MACsec) is only available on dedicated connections. See MACsec prerequisites for more information about MAC Security (MACsec) prerequisites. Default value: false.

    NOTE: Changing the value of request_macsec will cause the resource to be destroyed and re-created.

    skipDestroy Boolean

    Set to true if you do not wish the connection to be deleted at destroy time, and instead just removed from the state.

    tags Map<String,String>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    bandwidth string

    The bandwidth of the connection. Valid values for dedicated connections: 1Gbps, 10Gbps. Valid values for hosted connections: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps and 100Gbps. Case sensitive.

    location string

    The AWS Direct Connect location where the connection is located. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

    encryptionMode string

    The connection MAC Security (MACsec) encryption mode. MAC Security (MACsec) is only available on dedicated connections. Valid values are no_encrypt, should_encrypt, and must_encrypt.

    name string

    The name of the connection.

    providerName string

    The name of the service provider associated with the connection.

    requestMacsec boolean

    Boolean value indicating whether you want the connection to support MAC Security (MACsec). MAC Security (MACsec) is only available on dedicated connections. See MACsec prerequisites for more information about MAC Security (MACsec) prerequisites. Default value: false.

    NOTE: Changing the value of request_macsec will cause the resource to be destroyed and re-created.

    skipDestroy boolean

    Set to true if you do not wish the connection to be deleted at destroy time, and instead just removed from the state.

    tags {[key: string]: string}

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    bandwidth str

    The bandwidth of the connection. Valid values for dedicated connections: 1Gbps, 10Gbps. Valid values for hosted connections: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps and 100Gbps. Case sensitive.

    location str

    The AWS Direct Connect location where the connection is located. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

    encryption_mode str

    The connection MAC Security (MACsec) encryption mode. MAC Security (MACsec) is only available on dedicated connections. Valid values are no_encrypt, should_encrypt, and must_encrypt.

    name str

    The name of the connection.

    provider_name str

    The name of the service provider associated with the connection.

    request_macsec bool

    Boolean value indicating whether you want the connection to support MAC Security (MACsec). MAC Security (MACsec) is only available on dedicated connections. See MACsec prerequisites for more information about MAC Security (MACsec) prerequisites. Default value: false.

    NOTE: Changing the value of request_macsec will cause the resource to be destroyed and re-created.

    skip_destroy bool

    Set to true if you do not wish the connection to be deleted at destroy time, and instead just removed from the state.

    tags Mapping[str, str]

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    bandwidth String

    The bandwidth of the connection. Valid values for dedicated connections: 1Gbps, 10Gbps. Valid values for hosted connections: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps and 100Gbps. Case sensitive.

    location String

    The AWS Direct Connect location where the connection is located. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

    encryptionMode String

    The connection MAC Security (MACsec) encryption mode. MAC Security (MACsec) is only available on dedicated connections. Valid values are no_encrypt, should_encrypt, and must_encrypt.

    name String

    The name of the connection.

    providerName String

    The name of the service provider associated with the connection.

    requestMacsec Boolean

    Boolean value indicating whether you want the connection to support MAC Security (MACsec). MAC Security (MACsec) is only available on dedicated connections. See MACsec prerequisites for more information about MAC Security (MACsec) prerequisites. Default value: false.

    NOTE: Changing the value of request_macsec will cause the resource to be destroyed and re-created.

    skipDestroy Boolean

    Set to true if you do not wish the connection to be deleted at destroy time, and instead just removed from the state.

    tags Map<String>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string

    The ARN of the connection.

    AwsDevice string

    The Direct Connect endpoint on which the physical connection terminates.

    HasLogicalRedundancy string

    Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

    Id string

    The provider-assigned unique ID for this managed resource.

    JumboFrameCapable bool

    Boolean value representing if jumbo frames have been enabled for this connection.

    MacsecCapable bool

    Boolean value indicating whether the connection supports MAC Security (MACsec).

    OwnerAccountId string

    The ID of the AWS account that owns the connection.

    PartnerName string

    The name of the AWS Direct Connect service provider associated with the connection.

    PortEncryptionStatus string

    The MAC Security (MACsec) port link status of the connection.

    TagsAll Dictionary<string, string>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    VlanId int

    The VLAN ID.

    Arn string

    The ARN of the connection.

    AwsDevice string

    The Direct Connect endpoint on which the physical connection terminates.

    HasLogicalRedundancy string

    Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

    Id string

    The provider-assigned unique ID for this managed resource.

    JumboFrameCapable bool

    Boolean value representing if jumbo frames have been enabled for this connection.

    MacsecCapable bool

    Boolean value indicating whether the connection supports MAC Security (MACsec).

    OwnerAccountId string

    The ID of the AWS account that owns the connection.

    PartnerName string

    The name of the AWS Direct Connect service provider associated with the connection.

    PortEncryptionStatus string

    The MAC Security (MACsec) port link status of the connection.

    TagsAll map[string]string

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    VlanId int

    The VLAN ID.

    arn String

    The ARN of the connection.

    awsDevice String

    The Direct Connect endpoint on which the physical connection terminates.

    hasLogicalRedundancy String

    Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

    id String

    The provider-assigned unique ID for this managed resource.

    jumboFrameCapable Boolean

    Boolean value representing if jumbo frames have been enabled for this connection.

    macsecCapable Boolean

    Boolean value indicating whether the connection supports MAC Security (MACsec).

    ownerAccountId String

    The ID of the AWS account that owns the connection.

    partnerName String

    The name of the AWS Direct Connect service provider associated with the connection.

    portEncryptionStatus String

    The MAC Security (MACsec) port link status of the connection.

    tagsAll Map<String,String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    vlanId Integer

    The VLAN ID.

    arn string

    The ARN of the connection.

    awsDevice string

    The Direct Connect endpoint on which the physical connection terminates.

    hasLogicalRedundancy string

    Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

    id string

    The provider-assigned unique ID for this managed resource.

    jumboFrameCapable boolean

    Boolean value representing if jumbo frames have been enabled for this connection.

    macsecCapable boolean

    Boolean value indicating whether the connection supports MAC Security (MACsec).

    ownerAccountId string

    The ID of the AWS account that owns the connection.

    partnerName string

    The name of the AWS Direct Connect service provider associated with the connection.

    portEncryptionStatus string

    The MAC Security (MACsec) port link status of the connection.

    tagsAll {[key: string]: string}

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    vlanId number

    The VLAN ID.

    arn str

    The ARN of the connection.

    aws_device str

    The Direct Connect endpoint on which the physical connection terminates.

    has_logical_redundancy str

    Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

    id str

    The provider-assigned unique ID for this managed resource.

    jumbo_frame_capable bool

    Boolean value representing if jumbo frames have been enabled for this connection.

    macsec_capable bool

    Boolean value indicating whether the connection supports MAC Security (MACsec).

    owner_account_id str

    The ID of the AWS account that owns the connection.

    partner_name str

    The name of the AWS Direct Connect service provider associated with the connection.

    port_encryption_status str

    The MAC Security (MACsec) port link status of the connection.

    tags_all Mapping[str, str]

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    vlan_id int

    The VLAN ID.

    arn String

    The ARN of the connection.

    awsDevice String

    The Direct Connect endpoint on which the physical connection terminates.

    hasLogicalRedundancy String

    Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

    id String

    The provider-assigned unique ID for this managed resource.

    jumboFrameCapable Boolean

    Boolean value representing if jumbo frames have been enabled for this connection.

    macsecCapable Boolean

    Boolean value indicating whether the connection supports MAC Security (MACsec).

    ownerAccountId String

    The ID of the AWS account that owns the connection.

    partnerName String

    The name of the AWS Direct Connect service provider associated with the connection.

    portEncryptionStatus String

    The MAC Security (MACsec) port link status of the connection.

    tagsAll Map<String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    vlanId Number

    The VLAN ID.

    Look up Existing Connection Resource

    Get an existing Connection 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?: ConnectionState, opts?: CustomResourceOptions): Connection
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            aws_device: Optional[str] = None,
            bandwidth: Optional[str] = None,
            encryption_mode: Optional[str] = None,
            has_logical_redundancy: Optional[str] = None,
            jumbo_frame_capable: Optional[bool] = None,
            location: Optional[str] = None,
            macsec_capable: Optional[bool] = None,
            name: Optional[str] = None,
            owner_account_id: Optional[str] = None,
            partner_name: Optional[str] = None,
            port_encryption_status: Optional[str] = None,
            provider_name: Optional[str] = None,
            request_macsec: Optional[bool] = None,
            skip_destroy: Optional[bool] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            vlan_id: Optional[int] = None) -> Connection
    func GetConnection(ctx *Context, name string, id IDInput, state *ConnectionState, opts ...ResourceOption) (*Connection, error)
    public static Connection Get(string name, Input<string> id, ConnectionState? state, CustomResourceOptions? opts = null)
    public static Connection get(String name, Output<String> id, ConnectionState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    Arn string

    The ARN of the connection.

    AwsDevice string

    The Direct Connect endpoint on which the physical connection terminates.

    Bandwidth string

    The bandwidth of the connection. Valid values for dedicated connections: 1Gbps, 10Gbps. Valid values for hosted connections: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps and 100Gbps. Case sensitive.

    EncryptionMode string

    The connection MAC Security (MACsec) encryption mode. MAC Security (MACsec) is only available on dedicated connections. Valid values are no_encrypt, should_encrypt, and must_encrypt.

    HasLogicalRedundancy string

    Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

    JumboFrameCapable bool

    Boolean value representing if jumbo frames have been enabled for this connection.

    Location string

    The AWS Direct Connect location where the connection is located. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

    MacsecCapable bool

    Boolean value indicating whether the connection supports MAC Security (MACsec).

    Name string

    The name of the connection.

    OwnerAccountId string

    The ID of the AWS account that owns the connection.

    PartnerName string

    The name of the AWS Direct Connect service provider associated with the connection.

    PortEncryptionStatus string

    The MAC Security (MACsec) port link status of the connection.

    ProviderName string

    The name of the service provider associated with the connection.

    RequestMacsec bool

    Boolean value indicating whether you want the connection to support MAC Security (MACsec). MAC Security (MACsec) is only available on dedicated connections. See MACsec prerequisites for more information about MAC Security (MACsec) prerequisites. Default value: false.

    NOTE: Changing the value of request_macsec will cause the resource to be destroyed and re-created.

    SkipDestroy bool

    Set to true if you do not wish the connection to be deleted at destroy time, and instead just removed from the state.

    Tags Dictionary<string, string>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    TagsAll Dictionary<string, string>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    VlanId int

    The VLAN ID.

    Arn string

    The ARN of the connection.

    AwsDevice string

    The Direct Connect endpoint on which the physical connection terminates.

    Bandwidth string

    The bandwidth of the connection. Valid values for dedicated connections: 1Gbps, 10Gbps. Valid values for hosted connections: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps and 100Gbps. Case sensitive.

    EncryptionMode string

    The connection MAC Security (MACsec) encryption mode. MAC Security (MACsec) is only available on dedicated connections. Valid values are no_encrypt, should_encrypt, and must_encrypt.

    HasLogicalRedundancy string

    Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

    JumboFrameCapable bool

    Boolean value representing if jumbo frames have been enabled for this connection.

    Location string

    The AWS Direct Connect location where the connection is located. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

    MacsecCapable bool

    Boolean value indicating whether the connection supports MAC Security (MACsec).

    Name string

    The name of the connection.

    OwnerAccountId string

    The ID of the AWS account that owns the connection.

    PartnerName string

    The name of the AWS Direct Connect service provider associated with the connection.

    PortEncryptionStatus string

    The MAC Security (MACsec) port link status of the connection.

    ProviderName string

    The name of the service provider associated with the connection.

    RequestMacsec bool

    Boolean value indicating whether you want the connection to support MAC Security (MACsec). MAC Security (MACsec) is only available on dedicated connections. See MACsec prerequisites for more information about MAC Security (MACsec) prerequisites. Default value: false.

    NOTE: Changing the value of request_macsec will cause the resource to be destroyed and re-created.

    SkipDestroy bool

    Set to true if you do not wish the connection to be deleted at destroy time, and instead just removed from the state.

    Tags map[string]string

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    TagsAll map[string]string

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    VlanId int

    The VLAN ID.

    arn String

    The ARN of the connection.

    awsDevice String

    The Direct Connect endpoint on which the physical connection terminates.

    bandwidth String

    The bandwidth of the connection. Valid values for dedicated connections: 1Gbps, 10Gbps. Valid values for hosted connections: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps and 100Gbps. Case sensitive.

    encryptionMode String

    The connection MAC Security (MACsec) encryption mode. MAC Security (MACsec) is only available on dedicated connections. Valid values are no_encrypt, should_encrypt, and must_encrypt.

    hasLogicalRedundancy String

    Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

    jumboFrameCapable Boolean

    Boolean value representing if jumbo frames have been enabled for this connection.

    location String

    The AWS Direct Connect location where the connection is located. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

    macsecCapable Boolean

    Boolean value indicating whether the connection supports MAC Security (MACsec).

    name String

    The name of the connection.

    ownerAccountId String

    The ID of the AWS account that owns the connection.

    partnerName String

    The name of the AWS Direct Connect service provider associated with the connection.

    portEncryptionStatus String

    The MAC Security (MACsec) port link status of the connection.

    providerName String

    The name of the service provider associated with the connection.

    requestMacsec Boolean

    Boolean value indicating whether you want the connection to support MAC Security (MACsec). MAC Security (MACsec) is only available on dedicated connections. See MACsec prerequisites for more information about MAC Security (MACsec) prerequisites. Default value: false.

    NOTE: Changing the value of request_macsec will cause the resource to be destroyed and re-created.

    skipDestroy Boolean

    Set to true if you do not wish the connection to be deleted at destroy time, and instead just removed from the state.

    tags Map<String,String>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll Map<String,String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    vlanId Integer

    The VLAN ID.

    arn string

    The ARN of the connection.

    awsDevice string

    The Direct Connect endpoint on which the physical connection terminates.

    bandwidth string

    The bandwidth of the connection. Valid values for dedicated connections: 1Gbps, 10Gbps. Valid values for hosted connections: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps and 100Gbps. Case sensitive.

    encryptionMode string

    The connection MAC Security (MACsec) encryption mode. MAC Security (MACsec) is only available on dedicated connections. Valid values are no_encrypt, should_encrypt, and must_encrypt.

    hasLogicalRedundancy string

    Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

    jumboFrameCapable boolean

    Boolean value representing if jumbo frames have been enabled for this connection.

    location string

    The AWS Direct Connect location where the connection is located. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

    macsecCapable boolean

    Boolean value indicating whether the connection supports MAC Security (MACsec).

    name string

    The name of the connection.

    ownerAccountId string

    The ID of the AWS account that owns the connection.

    partnerName string

    The name of the AWS Direct Connect service provider associated with the connection.

    portEncryptionStatus string

    The MAC Security (MACsec) port link status of the connection.

    providerName string

    The name of the service provider associated with the connection.

    requestMacsec boolean

    Boolean value indicating whether you want the connection to support MAC Security (MACsec). MAC Security (MACsec) is only available on dedicated connections. See MACsec prerequisites for more information about MAC Security (MACsec) prerequisites. Default value: false.

    NOTE: Changing the value of request_macsec will cause the resource to be destroyed and re-created.

    skipDestroy boolean

    Set to true if you do not wish the connection to be deleted at destroy time, and instead just removed from the state.

    tags {[key: string]: string}

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll {[key: string]: string}

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    vlanId number

    The VLAN ID.

    arn str

    The ARN of the connection.

    aws_device str

    The Direct Connect endpoint on which the physical connection terminates.

    bandwidth str

    The bandwidth of the connection. Valid values for dedicated connections: 1Gbps, 10Gbps. Valid values for hosted connections: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps and 100Gbps. Case sensitive.

    encryption_mode str

    The connection MAC Security (MACsec) encryption mode. MAC Security (MACsec) is only available on dedicated connections. Valid values are no_encrypt, should_encrypt, and must_encrypt.

    has_logical_redundancy str

    Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

    jumbo_frame_capable bool

    Boolean value representing if jumbo frames have been enabled for this connection.

    location str

    The AWS Direct Connect location where the connection is located. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

    macsec_capable bool

    Boolean value indicating whether the connection supports MAC Security (MACsec).

    name str

    The name of the connection.

    owner_account_id str

    The ID of the AWS account that owns the connection.

    partner_name str

    The name of the AWS Direct Connect service provider associated with the connection.

    port_encryption_status str

    The MAC Security (MACsec) port link status of the connection.

    provider_name str

    The name of the service provider associated with the connection.

    request_macsec bool

    Boolean value indicating whether you want the connection to support MAC Security (MACsec). MAC Security (MACsec) is only available on dedicated connections. See MACsec prerequisites for more information about MAC Security (MACsec) prerequisites. Default value: false.

    NOTE: Changing the value of request_macsec will cause the resource to be destroyed and re-created.

    skip_destroy bool

    Set to true if you do not wish the connection to be deleted at destroy time, and instead just removed from the state.

    tags Mapping[str, str]

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tags_all Mapping[str, str]

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    vlan_id int

    The VLAN ID.

    arn String

    The ARN of the connection.

    awsDevice String

    The Direct Connect endpoint on which the physical connection terminates.

    bandwidth String

    The bandwidth of the connection. Valid values for dedicated connections: 1Gbps, 10Gbps. Valid values for hosted connections: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps and 100Gbps. Case sensitive.

    encryptionMode String

    The connection MAC Security (MACsec) encryption mode. MAC Security (MACsec) is only available on dedicated connections. Valid values are no_encrypt, should_encrypt, and must_encrypt.

    hasLogicalRedundancy String

    Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

    jumboFrameCapable Boolean

    Boolean value representing if jumbo frames have been enabled for this connection.

    location String

    The AWS Direct Connect location where the connection is located. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

    macsecCapable Boolean

    Boolean value indicating whether the connection supports MAC Security (MACsec).

    name String

    The name of the connection.

    ownerAccountId String

    The ID of the AWS account that owns the connection.

    partnerName String

    The name of the AWS Direct Connect service provider associated with the connection.

    portEncryptionStatus String

    The MAC Security (MACsec) port link status of the connection.

    providerName String

    The name of the service provider associated with the connection.

    requestMacsec Boolean

    Boolean value indicating whether you want the connection to support MAC Security (MACsec). MAC Security (MACsec) is only available on dedicated connections. See MACsec prerequisites for more information about MAC Security (MACsec) prerequisites. Default value: false.

    NOTE: Changing the value of request_macsec will cause the resource to be destroyed and re-created.

    skipDestroy Boolean

    Set to true if you do not wish the connection to be deleted at destroy time, and instead just removed from the state.

    tags Map<String>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll Map<String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    vlanId Number

    The VLAN ID.

    Import

    Using pulumi import, import Direct Connect connections using the connection id. For example:

     $ pulumi import aws:directconnect/connection:Connection test_connection dxcon-ffre0ec3
    

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the aws Terraform Provider.

    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.2.0 published on Monday, Sep 18, 2023 by Pulumi