Module directconnect

@pulumi/aws > directconnect

Index

directconnect/bgpPeer.ts directconnect/connection.ts directconnect/connectionAssociation.ts directconnect/gateway.ts directconnect/gatewayAssociation.ts directconnect/getGateway.ts directconnect/hostedPrivateVirtualInterface.ts directconnect/hostedPrivateVirtualInterfaceAccepter.ts directconnect/hostedPublicVirtualInterface.ts directconnect/hostedPublicVirtualInterfaceAccepter.ts directconnect/linkAggregationGroup.ts directconnect/privateVirtualInterface.ts directconnect/publicVirtualInterface.ts

class BgpPeer

Provides a Direct Connect BGP peer resource.

constructor

new BgpPeer(name: string, args: BgpPeerArgs, opts?: pulumi.CustomResourceOptions)

Create a BgpPeer resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: BgpPeerState): BgpPeer

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property addressFamily

public addressFamily: pulumi.Output<string>;

The address family for the BGP peer. ipv4 or ipv6.

property amazonAddress

public amazonAddress: pulumi.Output<string>;

The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers on public virtual interfaces.

property bgpAsn

public bgpAsn: pulumi.Output<number>;

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

property bgpAuthKey

public bgpAuthKey: pulumi.Output<string>;

The authentication key for BGP configuration.

property bgpStatus

public bgpStatus: pulumi.Output<string>;

The Up/Down state of the BGP peer.

property customerAddress

public customerAddress: pulumi.Output<string>;

The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers on public virtual interfaces.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property virtualInterfaceId

public virtualInterfaceId: pulumi.Output<string>;

The ID of the Direct Connect virtual interface on which to create the BGP peer.

class Connection

Provides a Connection of Direct Connect.

constructor

new Connection(name: string, args: ConnectionArgs, opts?: pulumi.CustomResourceOptions)

Create a Connection resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ConnectionState): Connection

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the connection.

property bandwidth

public bandwidth: pulumi.Output<string>;

The bandwidth of the connection. Available values: 1Gbps, 10Gbps. Case sensitive.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property jumboFrameCapable

public jumboFrameCapable: pulumi.Output<boolean>;

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

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

The name of the connection.

property tags

public tags: pulumi.Output<Tags | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class ConnectionAssociation

Associates a Direct Connect Connection with a LAG.

constructor

new ConnectionAssociation(name: string, args: ConnectionAssociationArgs, opts?: pulumi.CustomResourceOptions)

Create a ConnectionAssociation resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ConnectionAssociationState): ConnectionAssociation

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property connectionId

public connectionId: pulumi.Output<string>;

The ID of the connection.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property lagId

public lagId: pulumi.Output<string>;

The ID of the LAG with which to associate the connection.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class Gateway

Provides a Direct Connect Gateway.

constructor

new Gateway(name: string, args: GatewayArgs, opts?: pulumi.CustomResourceOptions)

Create a Gateway resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GatewayState): Gateway

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property amazonSideAsn

public amazonSideAsn: pulumi.Output<string>;

The ASN to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the connection.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class GatewayAssociation

Associates a Direct Connect Gateway with a VGW.

constructor

new GatewayAssociation(name: string, args: GatewayAssociationArgs, opts?: pulumi.CustomResourceOptions)

Create a GatewayAssociation resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GatewayAssociationState): GatewayAssociation

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property dxGatewayId

public dxGatewayId: pulumi.Output<string>;

The ID of the Direct Connect Gateway.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpnGatewayId

public vpnGatewayId: pulumi.Output<string>;

The ID of the VGW with which to associate the gateway.

class HostedPrivateVirtualInterface

Provides a Direct Connect hosted private virtual interface resource. This resource represents the allocator’s side of the hosted virtual interface. A hosted virtual interface is a virtual interface that is owned by another AWS account.

constructor

new HostedPrivateVirtualInterface(name: string, args: HostedPrivateVirtualInterfaceArgs, opts?: pulumi.CustomResourceOptions)

Create a HostedPrivateVirtualInterface resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: HostedPrivateVirtualInterfaceState): HostedPrivateVirtualInterface

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property addressFamily

public addressFamily: pulumi.Output<string>;

The address family for the BGP peer. ipv4 or ipv6.

property amazonAddress

public amazonAddress: pulumi.Output<string>;

The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.

property arn

public arn: pulumi.Output<string>;

The ARN of the virtual interface.

property bgpAsn

public bgpAsn: pulumi.Output<number>;

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

property bgpAuthKey

public bgpAuthKey: pulumi.Output<string>;

The authentication key for BGP configuration.

property connectionId

public connectionId: pulumi.Output<string>;

The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.

property customerAddress

public customerAddress: pulumi.Output<string>;

The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property jumboFrameCapable

public jumboFrameCapable: pulumi.Output<boolean>;

Indicates whether jumbo frames (9001 MTU) are supported.

property mtu

public mtu: pulumi.Output<number | undefined>;

The maximum transmission unit (MTU) is the size, in bytes, of the largest permissible packet that can be passed over the connection. The MTU of a virtual private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.

property name

public name: pulumi.Output<string>;

The name for the virtual interface.

property ownerAccountId

public ownerAccountId: pulumi.Output<string>;

The AWS account that will own the new virtual interface.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vlan

public vlan: pulumi.Output<number>;

The VLAN ID.

class HostedPrivateVirtualInterfaceAccepter

Provides a resource to manage the accepter’s side of a Direct Connect hosted private virtual interface. This resource accepts ownership of a private virtual interface created by another AWS account.

constructor

new HostedPrivateVirtualInterfaceAccepter(name: string, args: HostedPrivateVirtualInterfaceAccepterArgs, opts?: pulumi.CustomResourceOptions)

Create a HostedPrivateVirtualInterfaceAccepter resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: HostedPrivateVirtualInterfaceAccepterState): HostedPrivateVirtualInterfaceAccepter

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the virtual interface.

property dxGatewayId

public dxGatewayId: pulumi.Output<string | undefined>;

The ID of the Direct Connect gateway to which to connect the virtual interface.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property tags

public tags: pulumi.Output<Tags | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property virtualInterfaceId

public virtualInterfaceId: pulumi.Output<string>;

The ID of the Direct Connect virtual interface to accept.

property vpnGatewayId

public vpnGatewayId: pulumi.Output<string | undefined>;

The ID of the virtual private gateway to which to connect the virtual interface.

class HostedPublicVirtualInterface

Provides a Direct Connect hosted public virtual interface resource. This resource represents the allocator’s side of the hosted virtual interface. A hosted virtual interface is a virtual interface that is owned by another AWS account.

constructor

new HostedPublicVirtualInterface(name: string, args: HostedPublicVirtualInterfaceArgs, opts?: pulumi.CustomResourceOptions)

Create a HostedPublicVirtualInterface resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: HostedPublicVirtualInterfaceState): HostedPublicVirtualInterface

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property addressFamily

public addressFamily: pulumi.Output<string>;

The address family for the BGP peer. ipv4 or ipv6.

property amazonAddress

public amazonAddress: pulumi.Output<string>;

The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.

property arn

public arn: pulumi.Output<string>;

The ARN of the virtual interface.

property bgpAsn

public bgpAsn: pulumi.Output<number>;

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

property bgpAuthKey

public bgpAuthKey: pulumi.Output<string>;

The authentication key for BGP configuration.

property connectionId

public connectionId: pulumi.Output<string>;

The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.

property customerAddress

public customerAddress: pulumi.Output<string>;

The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name for the virtual interface.

property ownerAccountId

public ownerAccountId: pulumi.Output<string>;

The AWS account that will own the new virtual interface.

property routeFilterPrefixes

public routeFilterPrefixes: pulumi.Output<string[]>;

A list of routes to be advertised to the AWS network in this region.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vlan

public vlan: pulumi.Output<number>;

The VLAN ID.

class HostedPublicVirtualInterfaceAccepter

Provides a resource to manage the accepter’s side of a Direct Connect hosted public virtual interface. This resource accepts ownership of a public virtual interface created by another AWS account.

constructor

new HostedPublicVirtualInterfaceAccepter(name: string, args: HostedPublicVirtualInterfaceAccepterArgs, opts?: pulumi.CustomResourceOptions)

Create a HostedPublicVirtualInterfaceAccepter resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: HostedPublicVirtualInterfaceAccepterState): HostedPublicVirtualInterfaceAccepter

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the virtual interface.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property tags

public tags: pulumi.Output<Tags | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property virtualInterfaceId

public virtualInterfaceId: pulumi.Output<string>;

The ID of the Direct Connect virtual interface to accept.

class LinkAggregationGroup

Provides a Direct Connect LAG.

constructor

new LinkAggregationGroup(name: string, args: LinkAggregationGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a LinkAggregationGroup resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: LinkAggregationGroupState): LinkAggregationGroup

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the LAG.

property connectionsBandwidth

public connectionsBandwidth: pulumi.Output<string>;

The bandwidth of the individual physical connections bundled by the LAG. Available values: 1Gbps, 10Gbps. Case sensitive.

property forceDestroy

public forceDestroy: pulumi.Output<boolean | undefined>;

A boolean that indicates all connections associated with the LAG should be deleted so that the LAG can be destroyed without error. These objects are not recoverable.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

The AWS Direct Connect location in which the LAG should be allocated. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

property name

public name: pulumi.Output<string>;

The name of the LAG.

property numberOfConnections

public numberOfConnections: pulumi.Output<number>;

The number of physical connections initially provisioned and bundled by the LAG. Use aws_dx_connection and aws_dx_connection_association resources instead. Default connections will be removed as part of LAG creation automatically in future versions.

property tags

public tags: pulumi.Output<Tags | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class PrivateVirtualInterface

Provides a Direct Connect private virtual interface resource.

constructor

new PrivateVirtualInterface(name: string, args: PrivateVirtualInterfaceArgs, opts?: pulumi.CustomResourceOptions)

Create a PrivateVirtualInterface resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PrivateVirtualInterfaceState): PrivateVirtualInterface

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property addressFamily

public addressFamily: pulumi.Output<string>;

The address family for the BGP peer. ipv4 or ipv6.

property amazonAddress

public amazonAddress: pulumi.Output<string>;

The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.

property arn

public arn: pulumi.Output<string>;

The ARN of the virtual interface.

property bgpAsn

public bgpAsn: pulumi.Output<number>;

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

property bgpAuthKey

public bgpAuthKey: pulumi.Output<string>;

The authentication key for BGP configuration.

property connectionId

public connectionId: pulumi.Output<string>;

The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.

property customerAddress

public customerAddress: pulumi.Output<string>;

The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.

property dxGatewayId

public dxGatewayId: pulumi.Output<string | undefined>;

The ID of the Direct Connect gateway to which to connect the virtual interface.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property jumboFrameCapable

public jumboFrameCapable: pulumi.Output<boolean>;

Indicates whether jumbo frames (9001 MTU) are supported.

property mtu

public mtu: pulumi.Output<number | undefined>;

The maximum transmission unit (MTU) is the size, in bytes, of the largest permissible packet that can be passed over the connection. The MTU of a virtual private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.

property name

public name: pulumi.Output<string>;

The name for the virtual interface.

property tags

public tags: pulumi.Output<Tags | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vlan

public vlan: pulumi.Output<number>;

The VLAN ID.

property vpnGatewayId

public vpnGatewayId: pulumi.Output<string | undefined>;

The ID of the virtual private gateway to which to connect the virtual interface.

class PublicVirtualInterface

Provides a Direct Connect public virtual interface resource.

constructor

new PublicVirtualInterface(name: string, args: PublicVirtualInterfaceArgs, opts?: pulumi.CustomResourceOptions)

Create a PublicVirtualInterface resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PublicVirtualInterfaceState): PublicVirtualInterface

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property addressFamily

public addressFamily: pulumi.Output<string>;

The address family for the BGP peer. ipv4 or ipv6.

property amazonAddress

public amazonAddress: pulumi.Output<string>;

The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.

property arn

public arn: pulumi.Output<string>;

The ARN of the virtual interface.

property bgpAsn

public bgpAsn: pulumi.Output<number>;

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

property bgpAuthKey

public bgpAuthKey: pulumi.Output<string>;

The authentication key for BGP configuration.

property connectionId

public connectionId: pulumi.Output<string>;

The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.

property customerAddress

public customerAddress: pulumi.Output<string>;

The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name for the virtual interface.

property routeFilterPrefixes

public routeFilterPrefixes: pulumi.Output<string[]>;

A list of routes to be advertised to the AWS network in this region.

property tags

public tags: pulumi.Output<{ ... } | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vlan

public vlan: pulumi.Output<number>;

The VLAN ID.

function getGateway

getGateway(args: GetGatewayArgs, opts?: pulumi.InvokeOptions): Promise<GetGatewayResult>

Retrieve information about a Direct Connect Gateway.

interface BgpPeerArgs

The set of arguments for constructing a BgpPeer resource.

property addressFamily

addressFamily: pulumi.Input<string>;

The address family for the BGP peer. ipv4 or ipv6.

property amazonAddress

amazonAddress?: pulumi.Input<string>;

The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers on public virtual interfaces.

property bgpAsn

bgpAsn: pulumi.Input<number>;

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

property bgpAuthKey

bgpAuthKey?: pulumi.Input<string>;

The authentication key for BGP configuration.

property customerAddress

customerAddress?: pulumi.Input<string>;

The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers on public virtual interfaces.

property virtualInterfaceId

virtualInterfaceId: pulumi.Input<string>;

The ID of the Direct Connect virtual interface on which to create the BGP peer.

interface BgpPeerState

Input properties used for looking up and filtering BgpPeer resources.

property addressFamily

addressFamily?: pulumi.Input<string>;

The address family for the BGP peer. ipv4 or ipv6.

property amazonAddress

amazonAddress?: pulumi.Input<string>;

The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers on public virtual interfaces.

property bgpAsn

bgpAsn?: pulumi.Input<number>;

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

property bgpAuthKey

bgpAuthKey?: pulumi.Input<string>;

The authentication key for BGP configuration.

property bgpStatus

bgpStatus?: pulumi.Input<string>;

The Up/Down state of the BGP peer.

property customerAddress

customerAddress?: pulumi.Input<string>;

The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers on public virtual interfaces.

property virtualInterfaceId

virtualInterfaceId?: pulumi.Input<string>;

The ID of the Direct Connect virtual interface on which to create the BGP peer.

interface ConnectionArgs

The set of arguments for constructing a Connection resource.

property bandwidth

bandwidth: pulumi.Input<string>;

The bandwidth of the connection. Available values: 1Gbps, 10Gbps. Case sensitive.

property location

location: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

The name of the connection.

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags to assign to the resource.

interface ConnectionAssociationArgs

The set of arguments for constructing a ConnectionAssociation resource.

property connectionId

connectionId: pulumi.Input<string>;

The ID of the connection.

property lagId

lagId: pulumi.Input<string>;

The ID of the LAG with which to associate the connection.

interface ConnectionAssociationState

Input properties used for looking up and filtering ConnectionAssociation resources.

property connectionId

connectionId?: pulumi.Input<string>;

The ID of the connection.

property lagId

lagId?: pulumi.Input<string>;

The ID of the LAG with which to associate the connection.

interface ConnectionState

Input properties used for looking up and filtering Connection resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the connection.

property bandwidth

bandwidth?: pulumi.Input<string>;

The bandwidth of the connection. Available values: 1Gbps, 10Gbps. Case sensitive.

property jumboFrameCapable

jumboFrameCapable?: pulumi.Input<boolean>;

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

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

The name of the connection.

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags to assign to the resource.

interface GatewayArgs

The set of arguments for constructing a Gateway resource.

property amazonSideAsn

amazonSideAsn: pulumi.Input<string>;

The ASN to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294.

property name

name?: pulumi.Input<string>;

The name of the connection.

interface GatewayAssociationArgs

The set of arguments for constructing a GatewayAssociation resource.

property dxGatewayId

dxGatewayId: pulumi.Input<string>;

The ID of the Direct Connect Gateway.

property vpnGatewayId

vpnGatewayId: pulumi.Input<string>;

The ID of the VGW with which to associate the gateway.

interface GatewayAssociationState

Input properties used for looking up and filtering GatewayAssociation resources.

property dxGatewayId

dxGatewayId?: pulumi.Input<string>;

The ID of the Direct Connect Gateway.

property vpnGatewayId

vpnGatewayId?: pulumi.Input<string>;

The ID of the VGW with which to associate the gateway.

interface GatewayState

Input properties used for looking up and filtering Gateway resources.

property amazonSideAsn

amazonSideAsn?: pulumi.Input<string>;

The ASN to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294.

property name

name?: pulumi.Input<string>;

The name of the connection.

interface GetGatewayArgs

A collection of arguments for invoking getGateway.

property name

name: string;

The name of the gateway to retrieve.

interface GetGatewayResult

A collection of values returned by getGateway.

property amazonSideAsn

amazonSideAsn: string;

The ASN on the Amazon side of the connection.

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

interface HostedPrivateVirtualInterfaceAccepterArgs

The set of arguments for constructing a HostedPrivateVirtualInterfaceAccepter resource.

property dxGatewayId

dxGatewayId?: pulumi.Input<string>;

The ID of the Direct Connect gateway to which to connect the virtual interface.

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags to assign to the resource.

property virtualInterfaceId

virtualInterfaceId: pulumi.Input<string>;

The ID of the Direct Connect virtual interface to accept.

property vpnGatewayId

vpnGatewayId?: pulumi.Input<string>;

The ID of the virtual private gateway to which to connect the virtual interface.

interface HostedPrivateVirtualInterfaceAccepterState

Input properties used for looking up and filtering HostedPrivateVirtualInterfaceAccepter resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the virtual interface.

property dxGatewayId

dxGatewayId?: pulumi.Input<string>;

The ID of the Direct Connect gateway to which to connect the virtual interface.

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags to assign to the resource.

property virtualInterfaceId

virtualInterfaceId?: pulumi.Input<string>;

The ID of the Direct Connect virtual interface to accept.

property vpnGatewayId

vpnGatewayId?: pulumi.Input<string>;

The ID of the virtual private gateway to which to connect the virtual interface.

interface HostedPrivateVirtualInterfaceArgs

The set of arguments for constructing a HostedPrivateVirtualInterface resource.

property addressFamily

addressFamily: pulumi.Input<string>;

The address family for the BGP peer. ipv4 or ipv6.

property amazonAddress

amazonAddress?: pulumi.Input<string>;

The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.

property bgpAsn

bgpAsn: pulumi.Input<number>;

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

property bgpAuthKey

bgpAuthKey?: pulumi.Input<string>;

The authentication key for BGP configuration.

property connectionId

connectionId: pulumi.Input<string>;

The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.

property customerAddress

customerAddress?: pulumi.Input<string>;

The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.

property mtu

mtu?: pulumi.Input<number>;

The maximum transmission unit (MTU) is the size, in bytes, of the largest permissible packet that can be passed over the connection. The MTU of a virtual private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.

property name

name?: pulumi.Input<string>;

The name for the virtual interface.

property ownerAccountId

ownerAccountId: pulumi.Input<string>;

The AWS account that will own the new virtual interface.

property vlan

vlan: pulumi.Input<number>;

The VLAN ID.

interface HostedPrivateVirtualInterfaceState

Input properties used for looking up and filtering HostedPrivateVirtualInterface resources.

property addressFamily

addressFamily?: pulumi.Input<string>;

The address family for the BGP peer. ipv4 or ipv6.

property amazonAddress

amazonAddress?: pulumi.Input<string>;

The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.

property arn

arn?: pulumi.Input<string>;

The ARN of the virtual interface.

property bgpAsn

bgpAsn?: pulumi.Input<number>;

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

property bgpAuthKey

bgpAuthKey?: pulumi.Input<string>;

The authentication key for BGP configuration.

property connectionId

connectionId?: pulumi.Input<string>;

The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.

property customerAddress

customerAddress?: pulumi.Input<string>;

The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.

property jumboFrameCapable

jumboFrameCapable?: pulumi.Input<boolean>;

Indicates whether jumbo frames (9001 MTU) are supported.

property mtu

mtu?: pulumi.Input<number>;

The maximum transmission unit (MTU) is the size, in bytes, of the largest permissible packet that can be passed over the connection. The MTU of a virtual private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.

property name

name?: pulumi.Input<string>;

The name for the virtual interface.

property ownerAccountId

ownerAccountId?: pulumi.Input<string>;

The AWS account that will own the new virtual interface.

property vlan

vlan?: pulumi.Input<number>;

The VLAN ID.

interface HostedPublicVirtualInterfaceAccepterArgs

The set of arguments for constructing a HostedPublicVirtualInterfaceAccepter resource.

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags to assign to the resource.

property virtualInterfaceId

virtualInterfaceId: pulumi.Input<string>;

The ID of the Direct Connect virtual interface to accept.

interface HostedPublicVirtualInterfaceAccepterState

Input properties used for looking up and filtering HostedPublicVirtualInterfaceAccepter resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the virtual interface.

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags to assign to the resource.

property virtualInterfaceId

virtualInterfaceId?: pulumi.Input<string>;

The ID of the Direct Connect virtual interface to accept.

interface HostedPublicVirtualInterfaceArgs

The set of arguments for constructing a HostedPublicVirtualInterface resource.

property addressFamily

addressFamily: pulumi.Input<string>;

The address family for the BGP peer. ipv4 or ipv6.

property amazonAddress

amazonAddress?: pulumi.Input<string>;

The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.

property bgpAsn

bgpAsn: pulumi.Input<number>;

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

property bgpAuthKey

bgpAuthKey?: pulumi.Input<string>;

The authentication key for BGP configuration.

property connectionId

connectionId: pulumi.Input<string>;

The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.

property customerAddress

customerAddress?: pulumi.Input<string>;

The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.

property name

name?: pulumi.Input<string>;

The name for the virtual interface.

property ownerAccountId

ownerAccountId: pulumi.Input<string>;

The AWS account that will own the new virtual interface.

property routeFilterPrefixes

routeFilterPrefixes: pulumi.Input<pulumi.Input<string>[]>;

A list of routes to be advertised to the AWS network in this region.

property vlan

vlan: pulumi.Input<number>;

The VLAN ID.

interface HostedPublicVirtualInterfaceState

Input properties used for looking up and filtering HostedPublicVirtualInterface resources.

property addressFamily

addressFamily?: pulumi.Input<string>;

The address family for the BGP peer. ipv4 or ipv6.

property amazonAddress

amazonAddress?: pulumi.Input<string>;

The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.

property arn

arn?: pulumi.Input<string>;

The ARN of the virtual interface.

property bgpAsn

bgpAsn?: pulumi.Input<number>;

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

property bgpAuthKey

bgpAuthKey?: pulumi.Input<string>;

The authentication key for BGP configuration.

property connectionId

connectionId?: pulumi.Input<string>;

The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.

property customerAddress

customerAddress?: pulumi.Input<string>;

The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.

property name

name?: pulumi.Input<string>;

The name for the virtual interface.

property ownerAccountId

ownerAccountId?: pulumi.Input<string>;

The AWS account that will own the new virtual interface.

property routeFilterPrefixes

routeFilterPrefixes?: pulumi.Input<pulumi.Input<string>[]>;

A list of routes to be advertised to the AWS network in this region.

property vlan

vlan?: pulumi.Input<number>;

The VLAN ID.

interface LinkAggregationGroupArgs

The set of arguments for constructing a LinkAggregationGroup resource.

property connectionsBandwidth

connectionsBandwidth: pulumi.Input<string>;

The bandwidth of the individual physical connections bundled by the LAG. Available values: 1Gbps, 10Gbps. Case sensitive.

property forceDestroy

forceDestroy?: pulumi.Input<boolean>;

A boolean that indicates all connections associated with the LAG should be deleted so that the LAG can be destroyed without error. These objects are not recoverable.

property location

location: pulumi.Input<string>;

The AWS Direct Connect location in which the LAG should be allocated. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

property name

name?: pulumi.Input<string>;

The name of the LAG.

property numberOfConnections

numberOfConnections?: pulumi.Input<number>;

The number of physical connections initially provisioned and bundled by the LAG. Use aws_dx_connection and aws_dx_connection_association resources instead. Default connections will be removed as part of LAG creation automatically in future versions.

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags to assign to the resource.

interface LinkAggregationGroupState

Input properties used for looking up and filtering LinkAggregationGroup resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the LAG.

property connectionsBandwidth

connectionsBandwidth?: pulumi.Input<string>;

The bandwidth of the individual physical connections bundled by the LAG. Available values: 1Gbps, 10Gbps. Case sensitive.

property forceDestroy

forceDestroy?: pulumi.Input<boolean>;

A boolean that indicates all connections associated with the LAG should be deleted so that the LAG can be destroyed without error. These objects are not recoverable.

property location

location?: pulumi.Input<string>;

The AWS Direct Connect location in which the LAG should be allocated. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

property name

name?: pulumi.Input<string>;

The name of the LAG.

property numberOfConnections

numberOfConnections?: pulumi.Input<number>;

The number of physical connections initially provisioned and bundled by the LAG. Use aws_dx_connection and aws_dx_connection_association resources instead. Default connections will be removed as part of LAG creation automatically in future versions.

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags to assign to the resource.

interface PrivateVirtualInterfaceArgs

The set of arguments for constructing a PrivateVirtualInterface resource.

property addressFamily

addressFamily: pulumi.Input<string>;

The address family for the BGP peer. ipv4 or ipv6.

property amazonAddress

amazonAddress?: pulumi.Input<string>;

The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.

property bgpAsn

bgpAsn: pulumi.Input<number>;

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

property bgpAuthKey

bgpAuthKey?: pulumi.Input<string>;

The authentication key for BGP configuration.

property connectionId

connectionId: pulumi.Input<string>;

The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.

property customerAddress

customerAddress?: pulumi.Input<string>;

The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.

property dxGatewayId

dxGatewayId?: pulumi.Input<string>;

The ID of the Direct Connect gateway to which to connect the virtual interface.

property mtu

mtu?: pulumi.Input<number>;

The maximum transmission unit (MTU) is the size, in bytes, of the largest permissible packet that can be passed over the connection. The MTU of a virtual private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.

property name

name?: pulumi.Input<string>;

The name for the virtual interface.

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags to assign to the resource.

property vlan

vlan: pulumi.Input<number>;

The VLAN ID.

property vpnGatewayId

vpnGatewayId?: pulumi.Input<string>;

The ID of the virtual private gateway to which to connect the virtual interface.

interface PrivateVirtualInterfaceState

Input properties used for looking up and filtering PrivateVirtualInterface resources.

property addressFamily

addressFamily?: pulumi.Input<string>;

The address family for the BGP peer. ipv4 or ipv6.

property amazonAddress

amazonAddress?: pulumi.Input<string>;

The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.

property arn

arn?: pulumi.Input<string>;

The ARN of the virtual interface.

property bgpAsn

bgpAsn?: pulumi.Input<number>;

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

property bgpAuthKey

bgpAuthKey?: pulumi.Input<string>;

The authentication key for BGP configuration.

property connectionId

connectionId?: pulumi.Input<string>;

The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.

property customerAddress

customerAddress?: pulumi.Input<string>;

The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.

property dxGatewayId

dxGatewayId?: pulumi.Input<string>;

The ID of the Direct Connect gateway to which to connect the virtual interface.

property jumboFrameCapable

jumboFrameCapable?: pulumi.Input<boolean>;

Indicates whether jumbo frames (9001 MTU) are supported.

property mtu

mtu?: pulumi.Input<number>;

The maximum transmission unit (MTU) is the size, in bytes, of the largest permissible packet that can be passed over the connection. The MTU of a virtual private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.

property name

name?: pulumi.Input<string>;

The name for the virtual interface.

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags to assign to the resource.

property vlan

vlan?: pulumi.Input<number>;

The VLAN ID.

property vpnGatewayId

vpnGatewayId?: pulumi.Input<string>;

The ID of the virtual private gateway to which to connect the virtual interface.

interface PublicVirtualInterfaceArgs

The set of arguments for constructing a PublicVirtualInterface resource.

property addressFamily

addressFamily: pulumi.Input<string>;

The address family for the BGP peer. ipv4 or ipv6.

property amazonAddress

amazonAddress?: pulumi.Input<string>;

The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.

property bgpAsn

bgpAsn: pulumi.Input<number>;

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

property bgpAuthKey

bgpAuthKey?: pulumi.Input<string>;

The authentication key for BGP configuration.

property connectionId

connectionId: pulumi.Input<string>;

The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.

property customerAddress

customerAddress?: pulumi.Input<string>;

The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.

property name

name?: pulumi.Input<string>;

The name for the virtual interface.

property routeFilterPrefixes

routeFilterPrefixes: pulumi.Input<pulumi.Input<string>[]>;

A list of routes to be advertised to the AWS network in this region.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

property vlan

vlan: pulumi.Input<number>;

The VLAN ID.

interface PublicVirtualInterfaceState

Input properties used for looking up and filtering PublicVirtualInterface resources.

property addressFamily

addressFamily?: pulumi.Input<string>;

The address family for the BGP peer. ipv4 or ipv6.

property amazonAddress

amazonAddress?: pulumi.Input<string>;

The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.

property arn

arn?: pulumi.Input<string>;

The ARN of the virtual interface.

property bgpAsn

bgpAsn?: pulumi.Input<number>;

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

property bgpAuthKey

bgpAuthKey?: pulumi.Input<string>;

The authentication key for BGP configuration.

property connectionId

connectionId?: pulumi.Input<string>;

The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.

property customerAddress

customerAddress?: pulumi.Input<string>;

The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.

property name

name?: pulumi.Input<string>;

The name for the virtual interface.

property routeFilterPrefixes

routeFilterPrefixes?: pulumi.Input<pulumi.Input<string>[]>;

A list of routes to be advertised to the AWS network in this region.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

property vlan

vlan?: pulumi.Input<number>;

The VLAN ID.