Module directconnect

This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

Resources

Resource BgpPeer

class BgpPeer extends CustomResource

Provides a Direct Connect BGP peer resource.

Example Usage

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

const peer = new aws.directconnect.BgpPeer("peer", {
    addressFamily: "ipv6",
    bgpAsn: 65351,
    virtualInterfaceId: aws_dx_private_virtual_interface_foo.id,
});

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, opts?: pulumi.CustomResourceOptions): 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

public static isInstance(obj: any): obj is BgpPeer

Returns true if the given object is an instance of BgpPeer. 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 awsDevice

public awsDevice: pulumi.Output<string>;

The Direct Connect endpoint on which the BGP peer terminates.

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 bgpPeerId

public bgpPeerId: pulumi.Output<string>;

The ID of the BGP peer.

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.

Resource Connection

class Connection extends CustomResource

Provides a Connection of Direct Connect.

Example Usage

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

const hoge = new aws.directconnect.Connection("hoge", {
    bandwidth: "1Gbps",
    location: "EqDC2",
});

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, opts?: pulumi.CustomResourceOptions): 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

public static isInstance(obj: any): obj is Connection

Returns true if the given object is an instance of Connection. 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 awsDevice

public awsDevice: pulumi.Output<string>;

The Direct Connect endpoint on which the physical connection terminates.

property bandwidth

public bandwidth: pulumi.Output<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 and 10Gbps. Case sensitive.

property hasLogicalRedundancy

public hasLogicalRedundancy: pulumi.Output<string>;

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

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<{[key: string]: any} | undefined>;

A map 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.

Resource ConnectionAssociation

class ConnectionAssociation extends CustomResource

Associates a Direct Connect Connection with a LAG.

Example Usage

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

const exampleConnection = new aws.directconnect.Connection("example", {
    bandwidth: "1Gbps",
    location: "EqSe2",
});
const exampleLinkAggregationGroup = new aws.directconnect.LinkAggregationGroup("example", {
    connectionsBandwidth: "1Gbps",
    location: "EqSe2",
});
const exampleConnectionAssociation = new aws.directconnect.ConnectionAssociation("example", {
    connectionId: exampleConnection.id,
    lagId: exampleLinkAggregationGroup.id,
});

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, opts?: pulumi.CustomResourceOptions): 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

public static isInstance(obj: any): obj is ConnectionAssociation

Returns true if the given object is an instance of ConnectionAssociation. 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.

Resource Gateway

class Gateway extends CustomResource

Provides a Direct Connect Gateway.

Example Usage

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

const example = new aws.directconnect.Gateway("example", {
    amazonSideAsn: "64512",
});

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, opts?: pulumi.CustomResourceOptions): 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

public static isInstance(obj: any): obj is Gateway

Returns true if the given object is an instance of Gateway. 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 ownerAccountId

public ownerAccountId: pulumi.Output<string>;

AWS Account ID of the gateway.

property urn

urn: Output<URN>;

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

Resource GatewayAssociation

class GatewayAssociation extends CustomResource

Associates a Direct Connect Gateway with a VGW or transit gateway.

To create a cross-account association, create an aws.directconnect.GatewayAssociationProposal resource in the AWS account that owns the VGW or transit gateway and then accept the proposal in the AWS account that owns the Direct Connect Gateway by creating an aws.directconnect.GatewayAssociation resource with the proposalId and associatedGatewayOwnerAccountId attributes set.

Example Usage

VPN Gateway Association

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

const exampleGateway = new aws.directconnect.Gateway("example", {
    amazonSideAsn: "64512",
});
const exampleVpc = new aws.ec2.Vpc("example", {
    cidrBlock: "10.255.255.0/28",
});
const exampleVpnGateway = new aws.ec2.VpnGateway("example", {
    vpcId: exampleVpc.id,
});
const exampleGatewayAssociation = new aws.directconnect.GatewayAssociation("example", {
    associatedGatewayId: exampleVpnGateway.id,
    dxGatewayId: exampleGateway.id,
});

Transit Gateway Association

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

const exampleGateway = new aws.directconnect.Gateway("example", {
    amazonSideAsn: "64512",
});
const exampleTransitGateway = new aws.ec2transitgateway.TransitGateway("example", {});
const exampleGatewayAssociation = new aws.directconnect.GatewayAssociation("example", {
    allowedPrefixes: [
        "10.255.255.0/30",
        "10.255.255.8/30",
    ],
    associatedGatewayId: exampleTransitGateway.id,
    dxGatewayId: exampleGateway.id,
});

Allowed Prefixes

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

const exampleGateway = new aws.directconnect.Gateway("example", {
    amazonSideAsn: "64512",
});
const exampleVpc = new aws.ec2.Vpc("example", {
    cidrBlock: "10.255.255.0/28",
});
const exampleVpnGateway = new aws.ec2.VpnGateway("example", {
    vpcId: exampleVpc.id,
});
const exampleGatewayAssociation = new aws.directconnect.GatewayAssociation("example", {
    allowedPrefixes: [
        "210.52.109.0/24",
        "175.45.176.0/22",
    ],
    associatedGatewayId: exampleVpnGateway.id,
    dxGatewayId: exampleGateway.id,
});

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, opts?: pulumi.CustomResourceOptions): 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

public static isInstance(obj: any): obj is GatewayAssociation

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

property allowedPrefixes

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

VPC prefixes (CIDRs) to advertise to the Direct Connect gateway. Defaults to the CIDR block of the VPC associated with the Virtual Gateway. To enable drift detection, must be configured.

property associatedGatewayId

public associatedGatewayId: pulumi.Output<string>;

The ID of the VGW or transit gateway with which to associate the Direct Connect gateway. Used for single account Direct Connect gateway associations.

property associatedGatewayOwnerAccountId

public associatedGatewayOwnerAccountId: pulumi.Output<string>;

The ID of the AWS account that owns the VGW or transit gateway with which to associate the Direct Connect gateway. Used for cross-account Direct Connect gateway associations.

property associatedGatewayType

public associatedGatewayType: pulumi.Output<string>;

The type of the associated gateway, transitGateway or virtualPrivateGateway.

property dxGatewayAssociationId

public dxGatewayAssociationId: pulumi.Output<string>;

The ID of the Direct Connect gateway association.

property dxGatewayId

public dxGatewayId: pulumi.Output<string>;

The ID of the Direct Connect gateway.

property dxGatewayOwnerAccountId

public dxGatewayOwnerAccountId: pulumi.Output<string>;

The ID of the AWS account that owns 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 proposalId

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

The ID of the Direct Connect gateway association proposal. Used for cross-account Direct Connect gateway associations.

property urn

urn: Output<URN>;

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

property vpnGatewayId

DEPRECATED use 'associated_gateway_id' argument instead

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

Deprecated: Use associatedGatewayId instead. The ID of the VGW with which to associate the gateway. Used for single account Direct Connect gateway associations.

Resource GatewayAssociationProposal

class GatewayAssociationProposal extends CustomResource

Manages a Direct Connect Gateway Association Proposal, typically for enabling cross-account associations. For single account associations, see the aws.directconnect.GatewayAssociation resource.

Example Usage

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

const example = new aws.directconnect.GatewayAssociationProposal("example", {
    associatedGatewayId: aws_vpn_gateway_example.id,
    dxGatewayId: aws_dx_gateway_example.id,
    dxGatewayOwnerAccountId: aws_dx_gateway_example.ownerAccountId,
});

constructor

new GatewayAssociationProposal(name: string, args: GatewayAssociationProposalArgs, opts?: pulumi.CustomResourceOptions)

Create a GatewayAssociationProposal 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?: GatewayAssociationProposalState, opts?: pulumi.CustomResourceOptions): GatewayAssociationProposal

Get an existing GatewayAssociationProposal 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

public static isInstance(obj: any): obj is GatewayAssociationProposal

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

property allowedPrefixes

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

VPC prefixes (CIDRs) to advertise to the Direct Connect gateway. Defaults to the CIDR block of the VPC associated with the Virtual Gateway. To enable drift detection, must be configured.

property associatedGatewayId

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

The ID of the VGW or transit gateway with which to associate the Direct Connect gateway.

property associatedGatewayOwnerAccountId

public associatedGatewayOwnerAccountId: pulumi.Output<string>;

The ID of the AWS account that owns the VGW or transit gateway with which to associate the Direct Connect gateway.

property associatedGatewayType

public associatedGatewayType: pulumi.Output<string>;

The type of the associated gateway, transitGateway or virtualPrivateGateway.

property dxGatewayId

public dxGatewayId: pulumi.Output<string>;

Direct Connect Gateway identifier.

property dxGatewayOwnerAccountId

public dxGatewayOwnerAccountId: pulumi.Output<string>;

AWS Account identifier of the Direct Connect Gateway’s owner.

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

DEPRECATED use 'associated_gateway_id' argument instead

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

Deprecated: Use associatedGatewayId instead. Virtual Gateway identifier to associate with the Direct Connect Gateway.

Resource HostedPrivateVirtualInterface

class HostedPrivateVirtualInterface extends CustomResource

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.

Example Usage

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

const foo = new aws.directconnect.HostedPrivateVirtualInterface("foo", {
    addressFamily: "ipv4",
    bgpAsn: 65352,
    connectionId: "dxcon-zzzzzzzz",
    vlan: 4094,
});

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, opts?: pulumi.CustomResourceOptions): 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

public static isInstance(obj: any): obj is HostedPrivateVirtualInterface

Returns true if the given object is an instance of HostedPrivateVirtualInterface. 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 amazonSideAsn

public amazonSideAsn: pulumi.Output<string>;

property arn

public arn: pulumi.Output<string>;

The ARN of the virtual interface.

property awsDevice

public awsDevice: pulumi.Output<string>;

The Direct Connect endpoint on which the virtual interface terminates.

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.

Resource HostedPrivateVirtualInterfaceAccepter

class HostedPrivateVirtualInterfaceAccepter extends CustomResource

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.

Example Usage

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

const accepter = new aws.Provider("accepter", {});
const accepterCallerIdentity = pulumi.output(aws.getCallerIdentity({ provider: accepter, async: true }));
// Accepter's side of the VIF.
const vpnGw = new aws.ec2.VpnGateway("vpn_gw", {}, { provider: accepter });
// Creator's side of the VIF
const creator = new aws.directconnect.HostedPrivateVirtualInterface("creator", {
    addressFamily: "ipv4",
    bgpAsn: 65352,
    connectionId: "dxcon-zzzzzzzz",
    ownerAccountId: accepterCallerIdentity.accountId,
    vlan: 4094,
}, { dependsOn: [vpnGw] });
const accepterHostedPrivateVirtualInterfaceAccepter = new aws.directconnect.HostedPrivateVirtualInterfaceAccepter("accepter", {
    tags: {
        Side: "Accepter",
    },
    virtualInterfaceId: creator.id,
    vpnGatewayId: vpnGw.id,
}, { provider: accepter });

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, opts?: pulumi.CustomResourceOptions): 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

public static isInstance(obj: any): obj is HostedPrivateVirtualInterfaceAccepter

Returns true if the given object is an instance of HostedPrivateVirtualInterfaceAccepter. 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<{[key: string]: any} | undefined>;

A map 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.

Resource HostedPublicVirtualInterface

class HostedPublicVirtualInterface extends CustomResource

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.

Example Usage

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

const foo = new aws.directconnect.HostedPublicVirtualInterface("foo", {
    addressFamily: "ipv4",
    amazonAddress: "175.45.176.2/30",
    bgpAsn: 65352,
    connectionId: "dxcon-zzzzzzzz",
    customerAddress: "175.45.176.1/30",
    routeFilterPrefixes: [
        "210.52.109.0/24",
        "175.45.176.0/22",
    ],
    vlan: 4094,
});

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, opts?: pulumi.CustomResourceOptions): 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

public static isInstance(obj: any): obj is HostedPublicVirtualInterface

Returns true if the given object is an instance of HostedPublicVirtualInterface. 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 amazonSideAsn

public amazonSideAsn: pulumi.Output<string>;

property arn

public arn: pulumi.Output<string>;

The ARN of the virtual interface.

property awsDevice

public awsDevice: pulumi.Output<string>;

The Direct Connect endpoint on which the virtual interface terminates.

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.

Resource HostedPublicVirtualInterfaceAccepter

class HostedPublicVirtualInterfaceAccepter extends CustomResource

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.

Example Usage

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

const accepter = new aws.Provider("accepter", {});
const accepterCallerIdentity = pulumi.output(aws.getCallerIdentity({ provider: accepter, async: true }));
// Creator's side of the VIF
const creator = new aws.directconnect.HostedPublicVirtualInterface("creator", {
    addressFamily: "ipv4",
    amazonAddress: "175.45.176.2/30",
    bgpAsn: 65352,
    connectionId: "dxcon-zzzzzzzz",
    customerAddress: "175.45.176.1/30",
    ownerAccountId: accepterCallerIdentity.accountId,
    routeFilterPrefixes: [
        "210.52.109.0/24",
        "175.45.176.0/22",
    ],
    vlan: 4094,
});
// Accepter's side of the VIF.
const accepterHostedPublicVirtualInterfaceAccepter = new aws.directconnect.HostedPublicVirtualInterfaceAccepter("accepter", {
    tags: {
        Side: "Accepter",
    },
    virtualInterfaceId: creator.id,
}, { provider: accepter });

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, opts?: pulumi.CustomResourceOptions): 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

public static isInstance(obj: any): obj is HostedPublicVirtualInterfaceAccepter

Returns true if the given object is an instance of HostedPublicVirtualInterfaceAccepter. 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<{[key: string]: any} | undefined>;

A map 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.

Resource HostedTransitVirtualInterface

class HostedTransitVirtualInterface extends CustomResource

Provides a Direct Connect hosted transit 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.

Example Usage

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

const example = new aws.directconnect.HostedTransitVirtualInterface("example", {
    addressFamily: "ipv4",
    bgpAsn: 65352,
    connectionId: aws_dx_connection_example.id,
    vlan: 4094,
});

constructor

new HostedTransitVirtualInterface(name: string, args: HostedTransitVirtualInterfaceArgs, opts?: pulumi.CustomResourceOptions)

Create a HostedTransitVirtualInterface 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?: HostedTransitVirtualInterfaceState, opts?: pulumi.CustomResourceOptions): HostedTransitVirtualInterface

Get an existing HostedTransitVirtualInterface 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

public static isInstance(obj: any): obj is HostedTransitVirtualInterface

Returns true if the given object is an instance of HostedTransitVirtualInterface. 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 amazonSideAsn

public amazonSideAsn: pulumi.Output<string>;

property arn

public arn: pulumi.Output<string>;

The ARN of the virtual interface.

property awsDevice

public awsDevice: pulumi.Output<string>;

The Direct Connect endpoint on which the virtual interface terminates.

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 (8500 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 transit interface can be either 1500 or 8500 (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.

Resource HostedTransitVirtualInterfaceAcceptor

class HostedTransitVirtualInterfaceAcceptor extends CustomResource

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

NOTE: AWS allows a Direct Connect hosted transit virtual interface to be deleted from either the allocator’s or accepter’s side. However, this provider only allows the Direct Connect hosted transit virtual interface to be deleted from the allocator’s side by removing the corresponding aws.directconnect.HostedTransitVirtualInterface resource from your configuration. Removing a aws.directconnect.HostedTransitVirtualInterfaceAcceptor resource from your configuration will remove it from your statefile and management, but will not delete the Direct Connect virtual interface.

Example Usage

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

const accepter = new aws.Provider("accepter", {});
const accepterCallerIdentity = pulumi.output(aws.getCallerIdentity({ provider: accepter, async: true }));
// Accepter's side of the VIF.
const example = new aws.directconnect.Gateway("example", {
    amazonSideAsn: "64512",
}, { provider: accepter });
// Creator's side of the VIF
const creator = new aws.directconnect.HostedTransitVirtualInterface("creator", {
    addressFamily: "ipv4",
    bgpAsn: 65352,
    connectionId: "dxcon-zzzzzzzz",
    ownerAccountId: accepterCallerIdentity.accountId,
    vlan: 4094,
}, { dependsOn: [example] });
const accepterHostedTransitVirtualInterfaceAcceptor = new aws.directconnect.HostedTransitVirtualInterfaceAcceptor("accepter", {
    dxGatewayId: example.id,
    tags: {
        Side: "Accepter",
    },
    virtualInterfaceId: creator.id,
}, { provider: accepter });

constructor

new HostedTransitVirtualInterfaceAcceptor(name: string, args: HostedTransitVirtualInterfaceAcceptorArgs, opts?: pulumi.CustomResourceOptions)

Create a HostedTransitVirtualInterfaceAcceptor 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?: HostedTransitVirtualInterfaceAcceptorState, opts?: pulumi.CustomResourceOptions): HostedTransitVirtualInterfaceAcceptor

Get an existing HostedTransitVirtualInterfaceAcceptor 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

public static isInstance(obj: any): obj is HostedTransitVirtualInterfaceAcceptor

Returns true if the given object is an instance of HostedTransitVirtualInterfaceAcceptor. 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>;

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<{[key: string]: any} | undefined>;

A map 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.

Resource LinkAggregationGroup

class LinkAggregationGroup extends CustomResource

Provides a Direct Connect LAG. Connections can be added to the LAG via the aws.directconnect.Connection and aws.directconnect.ConnectionAssociation resources.

NOTE: When creating a LAG, Direct Connect requires creating a Connection. This provider will remove this unmanaged connection during resource creation.

Example Usage

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

const hoge = new aws.directconnect.LinkAggregationGroup("hoge", {
    connectionsBandwidth: "1Gbps",
    forceDestroy: true,
    location: "EqDC2",
});

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, opts?: pulumi.CustomResourceOptions): 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

public static isInstance(obj: any): obj is LinkAggregationGroup

Returns true if the given object is an instance of LinkAggregationGroup. 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. * jumboFrameCapable -Indicates whether jumbo frames (9001 MTU) are supported.

property connectionsBandwidth

public connectionsBandwidth: pulumi.Output<string>;

The bandwidth of the individual physical connections bundled by the LAG. Valid values: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps and 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 hasLogicalRedundancy

public hasLogicalRedundancy: pulumi.Output<string>;

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

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>;

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 tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map 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.

Resource PrivateVirtualInterface

class PrivateVirtualInterface extends CustomResource

Provides a Direct Connect private virtual interface resource.

Example Usage

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

const foo = new aws.directconnect.PrivateVirtualInterface("foo", {
    addressFamily: "ipv4",
    bgpAsn: 65352,
    connectionId: "dxcon-zzzzzzzz",
    vlan: 4094,
});

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, opts?: pulumi.CustomResourceOptions): 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

public static isInstance(obj: any): obj is PrivateVirtualInterface

Returns true if the given object is an instance of PrivateVirtualInterface. 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 amazonSideAsn

public amazonSideAsn: pulumi.Output<string>;

property arn

public arn: pulumi.Output<string>;

The ARN of the virtual interface.

property awsDevice

public awsDevice: pulumi.Output<string>;

The Direct Connect endpoint on which the virtual interface terminates.

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>;

property name

public name: pulumi.Output<string>;

The name for the virtual interface.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map 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.

Resource PublicVirtualInterface

class PublicVirtualInterface extends CustomResource

Provides a Direct Connect public virtual interface resource.

Example Usage

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

const foo = new aws.directconnect.PublicVirtualInterface("foo", {
    addressFamily: "ipv4",
    amazonAddress: "175.45.176.2/30",
    bgpAsn: 65352,
    connectionId: "dxcon-zzzzzzzz",
    customerAddress: "175.45.176.1/30",
    routeFilterPrefixes: [
        "210.52.109.0/24",
        "175.45.176.0/22",
    ],
    vlan: 4094,
});

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, opts?: pulumi.CustomResourceOptions): 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

public static isInstance(obj: any): obj is PublicVirtualInterface

Returns true if the given object is an instance of PublicVirtualInterface. 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 amazonSideAsn

public amazonSideAsn: pulumi.Output<string>;

property arn

public arn: pulumi.Output<string>;

The ARN of the virtual interface.

property awsDevice

public awsDevice: pulumi.Output<string>;

The Direct Connect endpoint on which the virtual interface terminates.

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<{[key: string]: any} | undefined>;

A map 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.

Resource TransitVirtualInterface

class TransitVirtualInterface extends CustomResource

Provides a Direct Connect transit virtual interface resource. A transit virtual interface is a VLAN that transports traffic from a Direct Connect gateway to one or more transit gateways.

Example Usage

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

const exampleGateway = new aws.directconnect.Gateway("example", {
    amazonSideAsn: "64512",
});
const exampleTransitVirtualInterface = new aws.directconnect.TransitVirtualInterface("example", {
    addressFamily: "ipv4",
    bgpAsn: 65352,
    connectionId: aws_dx_connection_example.id,
    dxGatewayId: exampleGateway.id,
    vlan: 4094,
});

constructor

new TransitVirtualInterface(name: string, args: TransitVirtualInterfaceArgs, opts?: pulumi.CustomResourceOptions)

Create a TransitVirtualInterface 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?: TransitVirtualInterfaceState, opts?: pulumi.CustomResourceOptions): TransitVirtualInterface

Get an existing TransitVirtualInterface 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

public static isInstance(obj: any): obj is TransitVirtualInterface

Returns true if the given object is an instance of TransitVirtualInterface. 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 amazonSideAsn

public amazonSideAsn: pulumi.Output<string>;

property arn

public arn: pulumi.Output<string>;

The ARN of the virtual interface.

property awsDevice

public awsDevice: pulumi.Output<string>;

The Direct Connect endpoint on which the virtual interface terminates.

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>;

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 (8500 MTU) are supported.

property mtu

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

property name

public name: pulumi.Output<string>;

The name for the virtual interface.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map 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.

Functions

Function getGateway

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

Retrieve information about a Direct Connect Gateway.

Example Usage

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

const example = pulumi.output(aws.directconnect.getGateway({
    name: "example",
}, { async: true }));

Others

interface BgpPeerArgs

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

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 awsDevice

awsDevice?: pulumi.Input<string>;

The Direct Connect endpoint on which the BGP peer terminates.

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 bgpPeerId

bgpPeerId?: pulumi.Input<string>;

The ID of the BGP peer.

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

interface ConnectionArgs

The set of arguments for constructing a Connection resource.

property bandwidth

bandwidth: pulumi.Input<string>;

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<{[key: string]: any}>;

A map of tags to assign to the resource.

interface ConnectionAssociationArgs

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

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

interface ConnectionState

Input properties used for looking up and filtering Connection resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the connection.

property awsDevice

awsDevice?: pulumi.Input<string>;

The Direct Connect endpoint on which the physical connection terminates.

property bandwidth

bandwidth?: pulumi.Input<string>;

property hasLogicalRedundancy

hasLogicalRedundancy?: pulumi.Input<string>;

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

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<{[key: string]: any}>;

A map of tags to assign to the resource.

interface GatewayArgs

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

interface GatewayAssociationArgs

The set of arguments for constructing a GatewayAssociation resource.

property allowedPrefixes

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

VPC prefixes (CIDRs) to advertise to the Direct Connect gateway. Defaults to the CIDR block of the VPC associated with the Virtual Gateway. To enable drift detection, must be configured.

property associatedGatewayId

associatedGatewayId?: pulumi.Input<string>;

The ID of the VGW or transit gateway with which to associate the Direct Connect gateway. Used for single account Direct Connect gateway associations.

property associatedGatewayOwnerAccountId

associatedGatewayOwnerAccountId?: pulumi.Input<string>;

The ID of the AWS account that owns the VGW or transit gateway with which to associate the Direct Connect gateway. Used for cross-account Direct Connect gateway associations.

property dxGatewayId

dxGatewayId: pulumi.Input<string>;

The ID of the Direct Connect gateway.

property proposalId

proposalId?: pulumi.Input<string>;

The ID of the Direct Connect gateway association proposal. Used for cross-account Direct Connect gateway associations.

property vpnGatewayId

DEPRECATED use 'associated_gateway_id' argument instead

vpnGatewayId?: pulumi.Input<string>;

Deprecated: Use associatedGatewayId instead. The ID of the VGW with which to associate the gateway. Used for single account Direct Connect gateway associations.

interface GatewayAssociationProposalArgs

interface GatewayAssociationProposalArgs

The set of arguments for constructing a GatewayAssociationProposal resource.

property allowedPrefixes

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

VPC prefixes (CIDRs) to advertise to the Direct Connect gateway. Defaults to the CIDR block of the VPC associated with the Virtual Gateway. To enable drift detection, must be configured.

property associatedGatewayId

associatedGatewayId?: pulumi.Input<string>;

The ID of the VGW or transit gateway with which to associate the Direct Connect gateway.

property dxGatewayId

dxGatewayId: pulumi.Input<string>;

Direct Connect Gateway identifier.

property dxGatewayOwnerAccountId

dxGatewayOwnerAccountId: pulumi.Input<string>;

AWS Account identifier of the Direct Connect Gateway’s owner.

property vpnGatewayId

DEPRECATED use 'associated_gateway_id' argument instead

vpnGatewayId?: pulumi.Input<string>;

Deprecated: Use associatedGatewayId instead. Virtual Gateway identifier to associate with the Direct Connect Gateway.

interface GatewayAssociationProposalState

interface GatewayAssociationProposalState

Input properties used for looking up and filtering GatewayAssociationProposal resources.

property allowedPrefixes

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

VPC prefixes (CIDRs) to advertise to the Direct Connect gateway. Defaults to the CIDR block of the VPC associated with the Virtual Gateway. To enable drift detection, must be configured.

property associatedGatewayId

associatedGatewayId?: pulumi.Input<string>;

The ID of the VGW or transit gateway with which to associate the Direct Connect gateway.

property associatedGatewayOwnerAccountId

associatedGatewayOwnerAccountId?: pulumi.Input<string>;

The ID of the AWS account that owns the VGW or transit gateway with which to associate the Direct Connect gateway.

property associatedGatewayType

associatedGatewayType?: pulumi.Input<string>;

The type of the associated gateway, transitGateway or virtualPrivateGateway.

property dxGatewayId

dxGatewayId?: pulumi.Input<string>;

Direct Connect Gateway identifier.

property dxGatewayOwnerAccountId

dxGatewayOwnerAccountId?: pulumi.Input<string>;

AWS Account identifier of the Direct Connect Gateway’s owner.

property vpnGatewayId

DEPRECATED use 'associated_gateway_id' argument instead

vpnGatewayId?: pulumi.Input<string>;

Deprecated: Use associatedGatewayId instead. Virtual Gateway identifier to associate with the Direct Connect Gateway.

interface GatewayAssociationState

interface GatewayAssociationState

Input properties used for looking up and filtering GatewayAssociation resources.

property allowedPrefixes

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

VPC prefixes (CIDRs) to advertise to the Direct Connect gateway. Defaults to the CIDR block of the VPC associated with the Virtual Gateway. To enable drift detection, must be configured.

property associatedGatewayId

associatedGatewayId?: pulumi.Input<string>;

The ID of the VGW or transit gateway with which to associate the Direct Connect gateway. Used for single account Direct Connect gateway associations.

property associatedGatewayOwnerAccountId

associatedGatewayOwnerAccountId?: pulumi.Input<string>;

The ID of the AWS account that owns the VGW or transit gateway with which to associate the Direct Connect gateway. Used for cross-account Direct Connect gateway associations.

property associatedGatewayType

associatedGatewayType?: pulumi.Input<string>;

The type of the associated gateway, transitGateway or virtualPrivateGateway.

property dxGatewayAssociationId

dxGatewayAssociationId?: pulumi.Input<string>;

The ID of the Direct Connect gateway association.

property dxGatewayId

dxGatewayId?: pulumi.Input<string>;

The ID of the Direct Connect gateway.

property dxGatewayOwnerAccountId

dxGatewayOwnerAccountId?: pulumi.Input<string>;

The ID of the AWS account that owns the Direct Connect gateway.

property proposalId

proposalId?: pulumi.Input<string>;

The ID of the Direct Connect gateway association proposal. Used for cross-account Direct Connect gateway associations.

property vpnGatewayId

DEPRECATED use 'associated_gateway_id' argument instead

vpnGatewayId?: pulumi.Input<string>;

Deprecated: Use associatedGatewayId instead. The ID of the VGW with which to associate the gateway. Used for single account Direct Connect gateway associations.

interface GatewayState

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.

property ownerAccountId

ownerAccountId?: pulumi.Input<string>;

AWS Account ID of the gateway.

interface GetGatewayArgs

interface GetGatewayArgs

A collection of arguments for invoking getGateway.

property name

name: string;

The name of the gateway to retrieve.

interface GetGatewayResult

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;

The provider-assigned unique ID for this managed resource.

property name

name: string;

property ownerAccountId

ownerAccountId: string;

AWS Account ID of the gateway.

interface HostedPrivateVirtualInterfaceAccepterArgs

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<{[key: string]: any}>;

A map 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

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<{[key: string]: any}>;

A map 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

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>;

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

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 amazonSideAsn

amazonSideAsn?: pulumi.Input<string>;

property arn

arn?: pulumi.Input<string>;

The ARN of the virtual interface.

property awsDevice

awsDevice?: pulumi.Input<string>;

The Direct Connect endpoint on which the virtual interface terminates.

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>;

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

interface HostedPublicVirtualInterfaceAccepterArgs

The set of arguments for constructing a HostedPublicVirtualInterfaceAccepter resource.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map 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

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<{[key: string]: any}>;

A map 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

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

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 amazonSideAsn

amazonSideAsn?: pulumi.Input<string>;

property arn

arn?: pulumi.Input<string>;

The ARN of the virtual interface.

property awsDevice

awsDevice?: pulumi.Input<string>;

The Direct Connect endpoint on which the virtual interface terminates.

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 HostedTransitVirtualInterfaceAcceptorArgs

interface HostedTransitVirtualInterfaceAcceptorArgs

The set of arguments for constructing a HostedTransitVirtualInterfaceAcceptor 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<{[key: string]: any}>;

A map of tags to assign to the resource.

property virtualInterfaceId

virtualInterfaceId: pulumi.Input<string>;

The ID of the Direct Connect virtual interface to accept.

interface HostedTransitVirtualInterfaceAcceptorState

interface HostedTransitVirtualInterfaceAcceptorState

Input properties used for looking up and filtering HostedTransitVirtualInterfaceAcceptor 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<{[key: string]: any}>;

A map of tags to assign to the resource.

property virtualInterfaceId

virtualInterfaceId?: pulumi.Input<string>;

The ID of the Direct Connect virtual interface to accept.

interface HostedTransitVirtualInterfaceArgs

interface HostedTransitVirtualInterfaceArgs

The set of arguments for constructing a HostedTransitVirtualInterface 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>;

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 HostedTransitVirtualInterfaceState

interface HostedTransitVirtualInterfaceState

Input properties used for looking up and filtering HostedTransitVirtualInterface 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 amazonSideAsn

amazonSideAsn?: pulumi.Input<string>;

property arn

arn?: pulumi.Input<string>;

The ARN of the virtual interface.

property awsDevice

awsDevice?: pulumi.Input<string>;

The Direct Connect endpoint on which the virtual interface terminates.

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 (8500 MTU) are supported.

property mtu

mtu?: pulumi.Input<number>;

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 LinkAggregationGroupArgs

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. Valid values: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps and 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 tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

interface LinkAggregationGroupState

interface LinkAggregationGroupState

Input properties used for looking up and filtering LinkAggregationGroup resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the LAG. * jumboFrameCapable -Indicates whether jumbo frames (9001 MTU) are supported.

property connectionsBandwidth

connectionsBandwidth?: pulumi.Input<string>;

The bandwidth of the individual physical connections bundled by the LAG. Valid values: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps and 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 hasLogicalRedundancy

hasLogicalRedundancy?: pulumi.Input<string>;

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

property jumboFrameCapable

jumboFrameCapable?: pulumi.Input<boolean>;

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 tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

interface PrivateVirtualInterfaceArgs

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>;

property name

name?: pulumi.Input<string>;

The name for the virtual interface.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map 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

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 amazonSideAsn

amazonSideAsn?: pulumi.Input<string>;

property arn

arn?: pulumi.Input<string>;

The ARN of the virtual interface.

property awsDevice

awsDevice?: pulumi.Input<string>;

The Direct Connect endpoint on which the virtual interface terminates.

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>;

property name

name?: pulumi.Input<string>;

The name for the virtual interface.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map 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

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<{[key: string]: any}>;

A map of tags to assign to the resource.

property vlan

vlan: pulumi.Input<number>;

The VLAN ID.

interface PublicVirtualInterfaceState

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 amazonSideAsn

amazonSideAsn?: pulumi.Input<string>;

property arn

arn?: pulumi.Input<string>;

The ARN of the virtual interface.

property awsDevice

awsDevice?: pulumi.Input<string>;

The Direct Connect endpoint on which the virtual interface terminates.

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<{[key: string]: any}>;

A map of tags to assign to the resource.

property vlan

vlan?: pulumi.Input<number>;

The VLAN ID.

interface TransitVirtualInterfaceArgs

interface TransitVirtualInterfaceArgs

The set of arguments for constructing a TransitVirtualInterface 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>;

property name

name?: pulumi.Input<string>;

The name for the virtual interface.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

property vlan

vlan: pulumi.Input<number>;

The VLAN ID.

interface TransitVirtualInterfaceState

interface TransitVirtualInterfaceState

Input properties used for looking up and filtering TransitVirtualInterface 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 amazonSideAsn

amazonSideAsn?: pulumi.Input<string>;

property arn

arn?: pulumi.Input<string>;

The ARN of the virtual interface.

property awsDevice

awsDevice?: pulumi.Input<string>;

The Direct Connect endpoint on which the virtual interface terminates.

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 (8500 MTU) are supported.

property mtu

mtu?: pulumi.Input<number>;

property name

name?: pulumi.Input<string>;

The name for the virtual interface.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

property vlan

vlan?: pulumi.Input<number>;

The VLAN ID.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module directconnect

Resources

Functions

Others

Resources

Example Usage

Example Usage

Example Usage

Example Usage

Example Usage

VPN Gateway Association

Transit Gateway Association

Allowed Prefixes

Example Usage

Example Usage

Example Usage

Example Usage