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.

directconnect¶

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.

class pulumi_aws.directconnect.AwaitableGetGatewayResult(amazon_side_asn=None, id=None, name=None, owner_account_id=None)¶

class pulumi_aws.directconnect.BgpPeer(resource_name, opts=None, address_family=None, amazon_address=None, bgp_asn=None, bgp_auth_key=None, customer_address=None, virtual_interface_id=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Direct Connect BGP peer resource.

import pulumi
import pulumi_aws as aws

peer = aws.directconnect.BgpPeer("peer",
    address_family="ipv6",
    bgp_asn=65351,
    virtual_interface_id=aws_dx_private_virtual_interface["foo"]["id"])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
address_family (pulumi.Input[str]) – The address family for the BGP peer. ipv4 or ipv6.
amazon_address (pulumi.Input[str]) – The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers on public virtual interfaces.
bgp_asn (pulumi.Input[float]) – The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
bgp_auth_key (pulumi.Input[str]) – The authentication key for BGP configuration.
customer_address (pulumi.Input[str]) – The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers on public virtual interfaces.
virtual_interface_id (pulumi.Input[str]) – The ID of the Direct Connect virtual interface on which to create the BGP peer.

address_family: pulumi.Output[str] = None¶: The address family for the BGP peer. ipv4 or ipv6.

amazon_address: pulumi.Output[str] = None¶: The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers on public virtual interfaces.

aws_device: pulumi.Output[str] = None¶: The Direct Connect endpoint on which the BGP peer terminates.

bgp_asn: pulumi.Output[float] = None¶: The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

bgp_auth_key: pulumi.Output[str] = None¶: The authentication key for BGP configuration.

bgp_peer_id: pulumi.Output[str] = None¶: The ID of the BGP peer.

bgp_status: pulumi.Output[str] = None¶: The Up/Down state of the BGP peer.

customer_address: pulumi.Output[str] = None¶: The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers on public virtual interfaces.

virtual_interface_id: pulumi.Output[str] = None¶: The ID of the Direct Connect virtual interface on which to create the BGP peer.

static get(resource_name, id, opts=None, address_family=None, amazon_address=None, aws_device=None, bgp_asn=None, bgp_auth_key=None, bgp_peer_id=None, bgp_status=None, customer_address=None, virtual_interface_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
address_family (pulumi.Input[str]) – The address family for the BGP peer. ipv4 or ipv6.
amazon_address (pulumi.Input[str]) – The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers on public virtual interfaces.
aws_device (pulumi.Input[str]) – The Direct Connect endpoint on which the BGP peer terminates.
bgp_asn (pulumi.Input[float]) – The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
bgp_auth_key (pulumi.Input[str]) – The authentication key for BGP configuration.
bgp_peer_id (pulumi.Input[str]) – The ID of the BGP peer.
bgp_status (pulumi.Input[str]) – The Up/Down state of the BGP peer.
customer_address (pulumi.Input[str]) – The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers on public virtual interfaces.
virtual_interface_id (pulumi.Input[str]) – The ID of the Direct Connect virtual interface on which to create the BGP peer.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.directconnect.Connection(resource_name, opts=None, bandwidth=None, location=None, name=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Connection of Direct Connect.

import pulumi
import pulumi_aws as aws

hoge = aws.directconnect.Connection("hoge",
    bandwidth="1Gbps",
    location="EqDC2")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
bandwidth (pulumi.Input[str]) – The bandwidth of the connection. Valid values for dedicated connections: 1Gbps, 10Gbps. Valid values for hosted connections: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps and 10Gbps. Case sensitive.
location (pulumi.Input[str]) – The AWS Direct Connect location where the connection is located. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.
name (pulumi.Input[str]) – The name of the connection.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.

arn: pulumi.Output[str] = None¶: The ARN of the connection.

aws_device: pulumi.Output[str] = None¶: The Direct Connect endpoint on which the physical connection terminates.

bandwidth: pulumi.Output[str] = None¶: 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.

has_logical_redundancy: pulumi.Output[str] = None¶: Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

jumbo_frame_capable: pulumi.Output[bool] = None¶: Boolean value representing if jumbo frames have been enabled for this connection.

location: pulumi.Output[str] = None¶: The AWS Direct Connect location where the connection is located. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

name: pulumi.Output[str] = None¶: The name of the connection.

tags: pulumi.Output[dict] = None¶: A map of tags to assign to the resource.

static get(resource_name, id, opts=None, arn=None, aws_device=None, bandwidth=None, has_logical_redundancy=None, jumbo_frame_capable=None, location=None, name=None, tags=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The ARN of the connection.
aws_device (pulumi.Input[str]) – The Direct Connect endpoint on which the physical connection terminates.
bandwidth (pulumi.Input[str]) – The bandwidth of the connection. Valid values for dedicated connections: 1Gbps, 10Gbps. Valid values for hosted connections: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps and 10Gbps. Case sensitive.
has_logical_redundancy (pulumi.Input[str]) – Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
jumbo_frame_capable (pulumi.Input[bool]) – Boolean value representing if jumbo frames have been enabled for this connection.
location (pulumi.Input[str]) –
The AWS Direct Connect location where the connection is located. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.
name (pulumi.Input[str]) – The name of the connection.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.directconnect.ConnectionAssociation(resource_name, opts=None, connection_id=None, lag_id=None, __props__=None, __name__=None, __opts__=None)¶

Associates a Direct Connect Connection with a LAG.

import pulumi
import pulumi_aws as aws

example_connection = aws.directconnect.Connection("exampleConnection",
    bandwidth="1Gbps",
    location="EqSe2")
example_link_aggregation_group = aws.directconnect.LinkAggregationGroup("exampleLinkAggregationGroup",
    connections_bandwidth="1Gbps",
    location="EqSe2")
example_connection_association = aws.directconnect.ConnectionAssociation("exampleConnectionAssociation",
    connection_id=example_connection.id,
    lag_id=example_link_aggregation_group.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
connection_id (pulumi.Input[str]) – The ID of the connection.
lag_id (pulumi.Input[str]) – The ID of the LAG with which to associate the connection.

connection_id: pulumi.Output[str] = None¶: The ID of the connection.

lag_id: pulumi.Output[str] = None¶: The ID of the LAG with which to associate the connection.

static get(resource_name, id, opts=None, connection_id=None, lag_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
connection_id (pulumi.Input[str]) – The ID of the connection.
lag_id (pulumi.Input[str]) – The ID of the LAG with which to associate the connection.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.directconnect.Gateway(resource_name, opts=None, amazon_side_asn=None, name=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Direct Connect Gateway.

import pulumi
import pulumi_aws as aws

example = aws.directconnect.Gateway("example", amazon_side_asn="64512")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
amazon_side_asn (pulumi.Input[str]) – 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.
name (pulumi.Input[str]) – The name of the connection.

amazon_side_asn: pulumi.Output[str] = None¶: 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.

name: pulumi.Output[str] = None¶: The name of the connection.

owner_account_id: pulumi.Output[str] = None¶: AWS Account ID of the gateway.

static get(resource_name, id, opts=None, amazon_side_asn=None, name=None, owner_account_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
amazon_side_asn (pulumi.Input[str]) – 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.
name (pulumi.Input[str]) – The name of the connection.
owner_account_id (pulumi.Input[str]) – AWS Account ID of the gateway.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.directconnect.GatewayAssociation(resource_name, opts=None, allowed_prefixes=None, associated_gateway_id=None, associated_gateway_owner_account_id=None, dx_gateway_id=None, proposal_id=None, vpn_gateway_id=None, __props__=None, __name__=None, __opts__=None)¶

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

To create a cross-account association, create an 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 directconnect.GatewayAssociation resource with the proposal_id and associated_gateway_owner_account_id attributes set.

import pulumi
import pulumi_aws as aws

example_gateway = aws.directconnect.Gateway("exampleGateway", amazon_side_asn="64512")
example_vpc = aws.ec2.Vpc("exampleVpc", cidr_block="10.255.255.0/28")
example_vpn_gateway = aws.ec2.VpnGateway("exampleVpnGateway", vpc_id=example_vpc.id)
example_gateway_association = aws.directconnect.GatewayAssociation("exampleGatewayAssociation",
    associated_gateway_id=example_vpn_gateway.id,
    dx_gateway_id=example_gateway.id)

import pulumi
import pulumi_aws as aws

example_gateway = aws.directconnect.Gateway("exampleGateway", amazon_side_asn="64512")
example_transit_gateway = aws.ec2transitgateway.TransitGateway("exampleTransitGateway")
example_gateway_association = aws.directconnect.GatewayAssociation("exampleGatewayAssociation",
    allowed_prefixes=[
        "10.255.255.0/30",
        "10.255.255.8/30",
    ],
    associated_gateway_id=example_transit_gateway.id,
    dx_gateway_id=example_gateway.id)

import pulumi
import pulumi_aws as aws

example_gateway = aws.directconnect.Gateway("exampleGateway", amazon_side_asn="64512")
example_vpc = aws.ec2.Vpc("exampleVpc", cidr_block="10.255.255.0/28")
example_vpn_gateway = aws.ec2.VpnGateway("exampleVpnGateway", vpc_id=example_vpc.id)
example_gateway_association = aws.directconnect.GatewayAssociation("exampleGatewayAssociation",
    allowed_prefixes=[
        "210.52.109.0/24",
        "175.45.176.0/22",
    ],
    associated_gateway_id=example_vpn_gateway.id,
    dx_gateway_id=example_gateway.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
allowed_prefixes (pulumi.Input[list]) – 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.
associated_gateway_id (pulumi.Input[str]) – The ID of the VGW or transit gateway with which to associate the Direct Connect gateway. Used for single account Direct Connect gateway associations.
associated_gateway_owner_account_id (pulumi.Input[str]) – 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.
dx_gateway_id (pulumi.Input[str]) – The ID of the Direct Connect gateway.
proposal_id (pulumi.Input[str]) – The ID of the Direct Connect gateway association proposal. Used for cross-account Direct Connect gateway associations.
vpn_gateway_id (pulumi.Input[str]) – Deprecated: Use associated_gateway_id instead. The ID of the VGW with which to associate the gateway. Used for single account Direct Connect gateway associations.

allowed_prefixes: pulumi.Output[list] = None¶: 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.

associated_gateway_id: pulumi.Output[str] = None¶: The ID of the VGW or transit gateway with which to associate the Direct Connect gateway. Used for single account Direct Connect gateway associations.

associated_gateway_owner_account_id: pulumi.Output[str] = None¶: 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.

associated_gateway_type: pulumi.Output[str] = None¶: The type of the associated gateway, transitGateway or virtualPrivateGateway.

dx_gateway_association_id: pulumi.Output[str] = None¶: The ID of the Direct Connect gateway association.

dx_gateway_id: pulumi.Output[str] = None¶: The ID of the Direct Connect gateway.

dx_gateway_owner_account_id: pulumi.Output[str] = None¶: The ID of the AWS account that owns the Direct Connect gateway.

proposal_id: pulumi.Output[str] = None¶: The ID of the Direct Connect gateway association proposal. Used for cross-account Direct Connect gateway associations.

vpn_gateway_id: pulumi.Output[str] = None¶: Deprecated: Use associated_gateway_id instead. The ID of the VGW with which to associate the gateway. Used for single account Direct Connect gateway associations.

static get(resource_name, id, opts=None, allowed_prefixes=None, associated_gateway_id=None, associated_gateway_owner_account_id=None, associated_gateway_type=None, dx_gateway_association_id=None, dx_gateway_id=None, dx_gateway_owner_account_id=None, proposal_id=None, vpn_gateway_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
allowed_prefixes (pulumi.Input[list]) – 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.
associated_gateway_id (pulumi.Input[str]) – The ID of the VGW or transit gateway with which to associate the Direct Connect gateway. Used for single account Direct Connect gateway associations.
associated_gateway_owner_account_id (pulumi.Input[str]) – 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.
associated_gateway_type (pulumi.Input[str]) – The type of the associated gateway, transitGateway or virtualPrivateGateway.
dx_gateway_association_id (pulumi.Input[str]) – The ID of the Direct Connect gateway association.
dx_gateway_id (pulumi.Input[str]) – The ID of the Direct Connect gateway.
dx_gateway_owner_account_id (pulumi.Input[str]) – The ID of the AWS account that owns the Direct Connect gateway.
proposal_id (pulumi.Input[str]) – The ID of the Direct Connect gateway association proposal. Used for cross-account Direct Connect gateway associations.
vpn_gateway_id (pulumi.Input[str]) – Deprecated: Use associated_gateway_id instead. The ID of the VGW with which to associate the gateway. Used for single account Direct Connect gateway associations.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.directconnect.GatewayAssociationProposal(resource_name, opts=None, allowed_prefixes=None, associated_gateway_id=None, dx_gateway_id=None, dx_gateway_owner_account_id=None, vpn_gateway_id=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_aws as aws

example = aws.directconnect.GatewayAssociationProposal("example",
    associated_gateway_id=aws_vpn_gateway["example"]["id"],
    dx_gateway_id=aws_dx_gateway["example"]["id"],
    dx_gateway_owner_account_id=aws_dx_gateway["example"]["owner_account_id"])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
allowed_prefixes (pulumi.Input[list]) – 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.
associated_gateway_id (pulumi.Input[str]) – The ID of the VGW or transit gateway with which to associate the Direct Connect gateway.
dx_gateway_id (pulumi.Input[str]) – Direct Connect Gateway identifier.
dx_gateway_owner_account_id (pulumi.Input[str]) – AWS Account identifier of the Direct Connect Gateway’s owner.
vpn_gateway_id (pulumi.Input[str]) – Deprecated: Use associated_gateway_id instead. Virtual Gateway identifier to associate with the Direct Connect Gateway.

allowed_prefixes: pulumi.Output[list] = None¶: 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.

associated_gateway_id: pulumi.Output[str] = None¶: The ID of the VGW or transit gateway with which to associate the Direct Connect gateway.

associated_gateway_owner_account_id: pulumi.Output[str] = None¶: The ID of the AWS account that owns the VGW or transit gateway with which to associate the Direct Connect gateway.

associated_gateway_type: pulumi.Output[str] = None¶: The type of the associated gateway, transitGateway or virtualPrivateGateway.

dx_gateway_id: pulumi.Output[str] = None¶: Direct Connect Gateway identifier.

dx_gateway_owner_account_id: pulumi.Output[str] = None¶: AWS Account identifier of the Direct Connect Gateway’s owner.

vpn_gateway_id: pulumi.Output[str] = None¶: Deprecated: Use associated_gateway_id instead. Virtual Gateway identifier to associate with the Direct Connect Gateway.

static get(resource_name, id, opts=None, allowed_prefixes=None, associated_gateway_id=None, associated_gateway_owner_account_id=None, associated_gateway_type=None, dx_gateway_id=None, dx_gateway_owner_account_id=None, vpn_gateway_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
allowed_prefixes (pulumi.Input[list]) – 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.
associated_gateway_id (pulumi.Input[str]) – The ID of the VGW or transit gateway with which to associate the Direct Connect gateway.
associated_gateway_owner_account_id (pulumi.Input[str]) – The ID of the AWS account that owns the VGW or transit gateway with which to associate the Direct Connect gateway.
associated_gateway_type (pulumi.Input[str]) – The type of the associated gateway, transitGateway or virtualPrivateGateway.
dx_gateway_id (pulumi.Input[str]) – Direct Connect Gateway identifier.
dx_gateway_owner_account_id (pulumi.Input[str]) – AWS Account identifier of the Direct Connect Gateway’s owner.
vpn_gateway_id (pulumi.Input[str]) – Deprecated: Use associated_gateway_id instead. Virtual Gateway identifier to associate with the Direct Connect Gateway.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.directconnect.GetGatewayResult(amazon_side_asn=None, id=None, name=None, owner_account_id=None)¶

A collection of values returned by getGateway.

amazon_side_asn = None¶: The ASN on the Amazon side of the connection.

id = None¶: The provider-assigned unique ID for this managed resource.

owner_account_id = None¶: AWS Account ID of the gateway.

class pulumi_aws.directconnect.HostedPrivateVirtualInterface(resource_name, opts=None, address_family=None, amazon_address=None, bgp_asn=None, bgp_auth_key=None, connection_id=None, customer_address=None, mtu=None, name=None, owner_account_id=None, vlan=None, __props__=None, __name__=None, __opts__=None)¶

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.

import pulumi
import pulumi_aws as aws

foo = aws.directconnect.HostedPrivateVirtualInterface("foo",
    address_family="ipv4",
    bgp_asn=65352,
    connection_id="dxcon-zzzzzzzz",
    vlan=4094)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
address_family (pulumi.Input[str]) – The address family for the BGP peer. ipv4 or ipv6.
amazon_address (pulumi.Input[str]) – The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
bgp_asn (pulumi.Input[float]) – The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
bgp_auth_key (pulumi.Input[str]) – The authentication key for BGP configuration.
connection_id (pulumi.Input[str]) – The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
customer_address (pulumi.Input[str]) – The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
mtu (pulumi.Input[float]) – 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.
name (pulumi.Input[str]) – The name for the virtual interface.
owner_account_id (pulumi.Input[str]) – The AWS account that will own the new virtual interface.
vlan (pulumi.Input[float]) – The VLAN ID.

address_family: pulumi.Output[str] = None¶: The address family for the BGP peer. ipv4 or ipv6.

amazon_address: pulumi.Output[str] = None¶: The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.

arn: pulumi.Output[str] = None¶: The ARN of the virtual interface.

aws_device: pulumi.Output[str] = None¶: The Direct Connect endpoint on which the virtual interface terminates.

bgp_asn: pulumi.Output[float] = None¶: The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

bgp_auth_key: pulumi.Output[str] = None¶: The authentication key for BGP configuration.

connection_id: pulumi.Output[str] = None¶: The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.

customer_address: pulumi.Output[str] = None¶: The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.

jumbo_frame_capable: pulumi.Output[bool] = None¶: Indicates whether jumbo frames (9001 MTU) are supported.

mtu: pulumi.Output[float] = None¶: 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.

name: pulumi.Output[str] = None¶: The name for the virtual interface.

owner_account_id: pulumi.Output[str] = None¶: The AWS account that will own the new virtual interface.

vlan: pulumi.Output[float] = None¶: The VLAN ID.

static get(resource_name, id, opts=None, address_family=None, amazon_address=None, amazon_side_asn=None, arn=None, aws_device=None, bgp_asn=None, bgp_auth_key=None, connection_id=None, customer_address=None, jumbo_frame_capable=None, mtu=None, name=None, owner_account_id=None, vlan=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
address_family (pulumi.Input[str]) – The address family for the BGP peer. ipv4 or ipv6.
amazon_address (pulumi.Input[str]) – The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
arn (pulumi.Input[str]) – The ARN of the virtual interface.
aws_device (pulumi.Input[str]) – The Direct Connect endpoint on which the virtual interface terminates.
bgp_asn (pulumi.Input[float]) – The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
bgp_auth_key (pulumi.Input[str]) – The authentication key for BGP configuration.
connection_id (pulumi.Input[str]) – The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
customer_address (pulumi.Input[str]) – The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
jumbo_frame_capable (pulumi.Input[bool]) – Indicates whether jumbo frames (9001 MTU) are supported.
mtu (pulumi.Input[float]) – 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.
name (pulumi.Input[str]) – The name for the virtual interface.
owner_account_id (pulumi.Input[str]) – The AWS account that will own the new virtual interface.
vlan (pulumi.Input[float]) – The VLAN ID.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.directconnect.HostedPrivateVirtualInterfaceAccepter(resource_name, opts=None, dx_gateway_id=None, tags=None, virtual_interface_id=None, vpn_gateway_id=None, __props__=None, __name__=None, __opts__=None)¶

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.

import pulumi
import pulumi_aws as aws
import pulumi_pulumi as pulumi

accepter = pulumi.providers.Aws("accepter")
accepter_caller_identity = aws.get_caller_identity()
# Creator's side of the VIF
creator = aws.directconnect.HostedPrivateVirtualInterface("creator",
    address_family="ipv4",
    bgp_asn=65352,
    connection_id="dxcon-zzzzzzzz",
    owner_account_id=accepter_caller_identity.account_id,
    vlan=4094)
# Accepter's side of the VIF.
vpn_gw = aws.ec2.VpnGateway("vpnGw")
accepter_hosted_private_virtual_interface_accepter = aws.directconnect.HostedPrivateVirtualInterfaceAccepter("accepterHostedPrivateVirtualInterfaceAccepter",
    tags={
        "Side": "Accepter",
    },
    virtual_interface_id=creator.id,
    vpn_gateway_id=vpn_gw.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
dx_gateway_id (pulumi.Input[str]) – The ID of the Direct Connect gateway to which to connect the virtual interface.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.
virtual_interface_id (pulumi.Input[str]) – The ID of the Direct Connect virtual interface to accept.
vpn_gateway_id (pulumi.Input[str]) – The ID of the virtual private gateway to which to connect the virtual interface.

arn: pulumi.Output[str] = None¶: The ARN of the virtual interface.

dx_gateway_id: pulumi.Output[str] = None¶: The ID of the Direct Connect gateway to which to connect the virtual interface.

tags: pulumi.Output[dict] = None¶: A map of tags to assign to the resource.

virtual_interface_id: pulumi.Output[str] = None¶: The ID of the Direct Connect virtual interface to accept.

vpn_gateway_id: pulumi.Output[str] = None¶: The ID of the virtual private gateway to which to connect the virtual interface.

static get(resource_name, id, opts=None, arn=None, dx_gateway_id=None, tags=None, virtual_interface_id=None, vpn_gateway_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The ARN of the virtual interface.
dx_gateway_id (pulumi.Input[str]) – The ID of the Direct Connect gateway to which to connect the virtual interface.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.
virtual_interface_id (pulumi.Input[str]) – The ID of the Direct Connect virtual interface to accept.
vpn_gateway_id (pulumi.Input[str]) – The ID of the virtual private gateway to which to connect the virtual interface.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.directconnect.HostedPublicVirtualInterface(resource_name, opts=None, address_family=None, amazon_address=None, bgp_asn=None, bgp_auth_key=None, connection_id=None, customer_address=None, name=None, owner_account_id=None, route_filter_prefixes=None, vlan=None, __props__=None, __name__=None, __opts__=None)¶

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.

import pulumi
import pulumi_aws as aws

foo = aws.directconnect.HostedPublicVirtualInterface("foo",
    address_family="ipv4",
    amazon_address="175.45.176.2/30",
    bgp_asn=65352,
    connection_id="dxcon-zzzzzzzz",
    customer_address="175.45.176.1/30",
    route_filter_prefixes=[
        "210.52.109.0/24",
        "175.45.176.0/22",
    ],
    vlan=4094)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
address_family (pulumi.Input[str]) – The address family for the BGP peer. ipv4 or ipv6.
amazon_address (pulumi.Input[str]) – The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
bgp_asn (pulumi.Input[float]) – The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
bgp_auth_key (pulumi.Input[str]) – The authentication key for BGP configuration.
connection_id (pulumi.Input[str]) – The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
customer_address (pulumi.Input[str]) – The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
name (pulumi.Input[str]) – The name for the virtual interface.
owner_account_id (pulumi.Input[str]) – The AWS account that will own the new virtual interface.
route_filter_prefixes (pulumi.Input[list]) – A list of routes to be advertised to the AWS network in this region.
vlan (pulumi.Input[float]) – The VLAN ID.

address_family: pulumi.Output[str] = None¶: The address family for the BGP peer. ipv4 or ipv6.

amazon_address: pulumi.Output[str] = None¶: The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.

arn: pulumi.Output[str] = None¶: The ARN of the virtual interface.

aws_device: pulumi.Output[str] = None¶: The Direct Connect endpoint on which the virtual interface terminates.

bgp_asn: pulumi.Output[float] = None¶: The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

bgp_auth_key: pulumi.Output[str] = None¶: The authentication key for BGP configuration.

connection_id: pulumi.Output[str] = None¶: The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.

customer_address: pulumi.Output[str] = None¶: The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.

name: pulumi.Output[str] = None¶: The name for the virtual interface.

owner_account_id: pulumi.Output[str] = None¶: The AWS account that will own the new virtual interface.

route_filter_prefixes: pulumi.Output[list] = None¶: A list of routes to be advertised to the AWS network in this region.

vlan: pulumi.Output[float] = None¶: The VLAN ID.

static get(resource_name, id, opts=None, address_family=None, amazon_address=None, amazon_side_asn=None, arn=None, aws_device=None, bgp_asn=None, bgp_auth_key=None, connection_id=None, customer_address=None, name=None, owner_account_id=None, route_filter_prefixes=None, vlan=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
address_family (pulumi.Input[str]) – The address family for the BGP peer. ipv4 or ipv6.
amazon_address (pulumi.Input[str]) – The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
arn (pulumi.Input[str]) – The ARN of the virtual interface.
aws_device (pulumi.Input[str]) – The Direct Connect endpoint on which the virtual interface terminates.
bgp_asn (pulumi.Input[float]) – The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
bgp_auth_key (pulumi.Input[str]) – The authentication key for BGP configuration.
connection_id (pulumi.Input[str]) – The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
customer_address (pulumi.Input[str]) – The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
name (pulumi.Input[str]) – The name for the virtual interface.
owner_account_id (pulumi.Input[str]) – The AWS account that will own the new virtual interface.
route_filter_prefixes (pulumi.Input[list]) – A list of routes to be advertised to the AWS network in this region.
vlan (pulumi.Input[float]) – The VLAN ID.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.directconnect.HostedPublicVirtualInterfaceAccepter(resource_name, opts=None, tags=None, virtual_interface_id=None, __props__=None, __name__=None, __opts__=None)¶

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.

import pulumi
import pulumi_aws as aws
import pulumi_pulumi as pulumi

accepter = pulumi.providers.Aws("accepter")
accepter_caller_identity = aws.get_caller_identity()
# Creator's side of the VIF
creator = aws.directconnect.HostedPublicVirtualInterface("creator",
    address_family="ipv4",
    amazon_address="175.45.176.2/30",
    bgp_asn=65352,
    connection_id="dxcon-zzzzzzzz",
    customer_address="175.45.176.1/30",
    owner_account_id=accepter_caller_identity.account_id,
    route_filter_prefixes=[
        "210.52.109.0/24",
        "175.45.176.0/22",
    ],
    vlan=4094)
# Accepter's side of the VIF.
accepter_hosted_public_virtual_interface_accepter = aws.directconnect.HostedPublicVirtualInterfaceAccepter("accepterHostedPublicVirtualInterfaceAccepter",
    tags={
        "Side": "Accepter",
    },
    virtual_interface_id=creator.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.
virtual_interface_id (pulumi.Input[str]) – The ID of the Direct Connect virtual interface to accept.

arn: pulumi.Output[str] = None¶: The ARN of the virtual interface.

tags: pulumi.Output[dict] = None¶: A map of tags to assign to the resource.

virtual_interface_id: pulumi.Output[str] = None¶: The ID of the Direct Connect virtual interface to accept.

static get(resource_name, id, opts=None, arn=None, tags=None, virtual_interface_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The ARN of the virtual interface.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.
virtual_interface_id (pulumi.Input[str]) – The ID of the Direct Connect virtual interface to accept.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.directconnect.HostedTransitVirtualInterface(resource_name, opts=None, address_family=None, amazon_address=None, bgp_asn=None, bgp_auth_key=None, connection_id=None, customer_address=None, mtu=None, name=None, owner_account_id=None, vlan=None, __props__=None, __name__=None, __opts__=None)¶

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.

import pulumi
import pulumi_aws as aws

example = aws.directconnect.HostedTransitVirtualInterface("example",
    address_family="ipv4",
    bgp_asn=65352,
    connection_id=aws_dx_connection["example"]["id"],
    vlan=4094)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
address_family (pulumi.Input[str]) – The address family for the BGP peer. ipv4 or ipv6.
amazon_address (pulumi.Input[str]) – The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
bgp_asn (pulumi.Input[float]) – The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
bgp_auth_key (pulumi.Input[str]) – The authentication key for BGP configuration.
connection_id (pulumi.Input[str]) – The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
customer_address (pulumi.Input[str]) – The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
mtu (pulumi.Input[float]) – 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.
name (pulumi.Input[str]) – The name for the virtual interface.
owner_account_id (pulumi.Input[str]) – The AWS account that will own the new virtual interface.
vlan (pulumi.Input[float]) – The VLAN ID.

address_family: pulumi.Output[str] = None¶: The address family for the BGP peer. ipv4 or ipv6.

amazon_address: pulumi.Output[str] = None¶: The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.

arn: pulumi.Output[str] = None¶: The ARN of the virtual interface.

aws_device: pulumi.Output[str] = None¶: The Direct Connect endpoint on which the virtual interface terminates.

bgp_asn: pulumi.Output[float] = None¶: The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

bgp_auth_key: pulumi.Output[str] = None¶: The authentication key for BGP configuration.

connection_id: pulumi.Output[str] = None¶: The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.

customer_address: pulumi.Output[str] = None¶: The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.

jumbo_frame_capable: pulumi.Output[bool] = None¶: Indicates whether jumbo frames (8500 MTU) are supported.

mtu: pulumi.Output[float] = None¶: 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.

name: pulumi.Output[str] = None¶: The name for the virtual interface.

owner_account_id: pulumi.Output[str] = None¶: The AWS account that will own the new virtual interface.

vlan: pulumi.Output[float] = None¶: The VLAN ID.

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
address_family (pulumi.Input[str]) – The address family for the BGP peer. ipv4 or ipv6.
amazon_address (pulumi.Input[str]) – The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
arn (pulumi.Input[str]) – The ARN of the virtual interface.
aws_device (pulumi.Input[str]) – The Direct Connect endpoint on which the virtual interface terminates.
bgp_asn (pulumi.Input[float]) – The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
bgp_auth_key (pulumi.Input[str]) – The authentication key for BGP configuration.
connection_id (pulumi.Input[str]) – The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
customer_address (pulumi.Input[str]) – The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
jumbo_frame_capable (pulumi.Input[bool]) – Indicates whether jumbo frames (8500 MTU) are supported.
mtu (pulumi.Input[float]) – 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.
name (pulumi.Input[str]) – The name for the virtual interface.
owner_account_id (pulumi.Input[str]) – The AWS account that will own the new virtual interface.
vlan (pulumi.Input[float]) – The VLAN ID.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.directconnect.HostedTransitVirtualInterfaceAcceptor(resource_name, opts=None, dx_gateway_id=None, tags=None, virtual_interface_id=None, __props__=None, __name__=None, __opts__=None)¶

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 directconnect.HostedTransitVirtualInterface resource from your configuration. Removing a directconnect.HostedTransitVirtualInterfaceAcceptor resource from your configuration will remove it from your statefile and management, but will not delete the Direct Connect virtual interface.

import pulumi
import pulumi_aws as aws
import pulumi_pulumi as pulumi

accepter = pulumi.providers.Aws("accepter")
accepter_caller_identity = aws.get_caller_identity()
# Creator's side of the VIF
creator = aws.directconnect.HostedTransitVirtualInterface("creator",
    address_family="ipv4",
    bgp_asn=65352,
    connection_id="dxcon-zzzzzzzz",
    owner_account_id=accepter_caller_identity.account_id,
    vlan=4094)
# Accepter's side of the VIF.
example = aws.directconnect.Gateway("example", amazon_side_asn=64512)
accepter_hosted_transit_virtual_interface_acceptor = aws.directconnect.HostedTransitVirtualInterfaceAcceptor("accepterHostedTransitVirtualInterfaceAcceptor",
    dx_gateway_id=example.id,
    tags={
        "Side": "Accepter",
    },
    virtual_interface_id=creator.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
dx_gateway_id (pulumi.Input[str]) – The ID of the Direct Connect gateway to which to connect the virtual interface.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.
virtual_interface_id (pulumi.Input[str]) – The ID of the Direct Connect virtual interface to accept.

arn: pulumi.Output[str] = None¶: The ARN of the virtual interface.

dx_gateway_id: pulumi.Output[str] = None¶: The ID of the Direct Connect gateway to which to connect the virtual interface.

tags: pulumi.Output[dict] = None¶: A map of tags to assign to the resource.

virtual_interface_id: pulumi.Output[str] = None¶: The ID of the Direct Connect virtual interface to accept.

static get(resource_name, id, opts=None, arn=None, dx_gateway_id=None, tags=None, virtual_interface_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The ARN of the virtual interface.
dx_gateway_id (pulumi.Input[str]) – The ID of the Direct Connect gateway to which to connect the virtual interface.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.
virtual_interface_id (pulumi.Input[str]) – The ID of the Direct Connect virtual interface to accept.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.directconnect.LinkAggregationGroup(resource_name, opts=None, connections_bandwidth=None, force_destroy=None, location=None, name=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

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

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

import pulumi
import pulumi_aws as aws

hoge = aws.directconnect.LinkAggregationGroup("hoge",
    connections_bandwidth="1Gbps",
    force_destroy=True,
    location="EqDC2")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
connections_bandwidth (pulumi.Input[str]) – 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.
force_destroy (pulumi.Input[bool]) – 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.
location (pulumi.Input[str]) –
The AWS Direct Connect location in which the LAG should be allocated. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.
name (pulumi.Input[str]) – The name of the LAG.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.

arn: pulumi.Output[str] = None¶

The ARN of the LAG.

jumbo_frame_capable -Indicates whether jumbo frames (9001 MTU) are supported.

connections_bandwidth: pulumi.Output[str] = None¶: 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.

force_destroy: pulumi.Output[bool] = None¶: 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.

has_logical_redundancy: pulumi.Output[str] = None¶: Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

location: pulumi.Output[str] = None¶: The AWS Direct Connect location in which the LAG should be allocated. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.

name: pulumi.Output[str] = None¶: The name of the LAG.

tags: pulumi.Output[dict] = None¶: A map of tags to assign to the resource.

static get(resource_name, id, opts=None, arn=None, connections_bandwidth=None, force_destroy=None, has_logical_redundancy=None, jumbo_frame_capable=None, location=None, name=None, tags=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The ARN of the LAG.

* `jumbo_frame_capable` -Indicates whether jumbo frames (9001 MTU) are supported.

Parameters

connections_bandwidth (pulumi.Input[str]) – 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.
force_destroy (pulumi.Input[bool]) – 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.
has_logical_redundancy (pulumi.Input[str]) – Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).
location (pulumi.Input[str]) –
The AWS Direct Connect location in which the LAG should be allocated. See DescribeLocations for the list of AWS Direct Connect locations. Use locationCode.
name (pulumi.Input[str]) – The name of the LAG.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.directconnect.PrivateVirtualInterface(resource_name, opts=None, address_family=None, amazon_address=None, bgp_asn=None, bgp_auth_key=None, connection_id=None, customer_address=None, dx_gateway_id=None, mtu=None, name=None, tags=None, vlan=None, vpn_gateway_id=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Direct Connect private virtual interface resource.

import pulumi
import pulumi_aws as aws

foo = aws.directconnect.PrivateVirtualInterface("foo",
    address_family="ipv4",
    bgp_asn=65352,
    connection_id="dxcon-zzzzzzzz",
    vlan=4094)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
address_family (pulumi.Input[str]) – The address family for the BGP peer. ipv4 or ipv6.
amazon_address (pulumi.Input[str]) – The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
bgp_asn (pulumi.Input[float]) – The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
bgp_auth_key (pulumi.Input[str]) – The authentication key for BGP configuration.
connection_id (pulumi.Input[str]) – The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
customer_address (pulumi.Input[str]) – The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
dx_gateway_id (pulumi.Input[str]) – The ID of the Direct Connect gateway to which to connect the virtual interface.
mtu (pulumi.Input[float]) – 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.
name (pulumi.Input[str]) – The name for the virtual interface.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.
vlan (pulumi.Input[float]) – The VLAN ID.
vpn_gateway_id (pulumi.Input[str]) – The ID of the virtual private gateway to which to connect the virtual interface.

address_family: pulumi.Output[str] = None¶: The address family for the BGP peer. ipv4 or ipv6.

amazon_address: pulumi.Output[str] = None¶: The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.

arn: pulumi.Output[str] = None¶: The ARN of the virtual interface.

aws_device: pulumi.Output[str] = None¶: The Direct Connect endpoint on which the virtual interface terminates.

bgp_asn: pulumi.Output[float] = None¶: The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

bgp_auth_key: pulumi.Output[str] = None¶: The authentication key for BGP configuration.

connection_id: pulumi.Output[str] = None¶: The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.

customer_address: pulumi.Output[str] = None¶: The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.

dx_gateway_id: pulumi.Output[str] = None¶: The ID of the Direct Connect gateway to which to connect the virtual interface.

jumbo_frame_capable: pulumi.Output[bool] = None¶: Indicates whether jumbo frames (9001 MTU) are supported.

mtu: pulumi.Output[float] = None¶: 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.

name: pulumi.Output[str] = None¶: The name for the virtual interface.

tags: pulumi.Output[dict] = None¶: A map of tags to assign to the resource.

vlan: pulumi.Output[float] = None¶: The VLAN ID.

vpn_gateway_id: pulumi.Output[str] = None¶: The ID of the virtual private gateway to which to connect the virtual interface.

static get(resource_name, id, opts=None, address_family=None, amazon_address=None, amazon_side_asn=None, arn=None, aws_device=None, bgp_asn=None, bgp_auth_key=None, connection_id=None, customer_address=None, dx_gateway_id=None, jumbo_frame_capable=None, mtu=None, name=None, tags=None, vlan=None, vpn_gateway_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
address_family (pulumi.Input[str]) – The address family for the BGP peer. ipv4 or ipv6.
amazon_address (pulumi.Input[str]) – The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
arn (pulumi.Input[str]) – The ARN of the virtual interface.
aws_device (pulumi.Input[str]) – The Direct Connect endpoint on which the virtual interface terminates.
bgp_asn (pulumi.Input[float]) – The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
bgp_auth_key (pulumi.Input[str]) – The authentication key for BGP configuration.
connection_id (pulumi.Input[str]) – The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
customer_address (pulumi.Input[str]) – The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
dx_gateway_id (pulumi.Input[str]) – The ID of the Direct Connect gateway to which to connect the virtual interface.
jumbo_frame_capable (pulumi.Input[bool]) – Indicates whether jumbo frames (9001 MTU) are supported.
mtu (pulumi.Input[float]) – 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.
name (pulumi.Input[str]) – The name for the virtual interface.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.
vlan (pulumi.Input[float]) – The VLAN ID.
vpn_gateway_id (pulumi.Input[str]) – The ID of the virtual private gateway to which to connect the virtual interface.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.directconnect.PublicVirtualInterface(resource_name, opts=None, address_family=None, amazon_address=None, bgp_asn=None, bgp_auth_key=None, connection_id=None, customer_address=None, name=None, route_filter_prefixes=None, tags=None, vlan=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Direct Connect public virtual interface resource.

import pulumi
import pulumi_aws as aws

foo = aws.directconnect.PublicVirtualInterface("foo",
    address_family="ipv4",
    amazon_address="175.45.176.2/30",
    bgp_asn=65352,
    connection_id="dxcon-zzzzzzzz",
    customer_address="175.45.176.1/30",
    route_filter_prefixes=[
        "210.52.109.0/24",
        "175.45.176.0/22",
    ],
    vlan=4094)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
address_family (pulumi.Input[str]) – The address family for the BGP peer. ipv4 or ipv6.
amazon_address (pulumi.Input[str]) – The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
bgp_asn (pulumi.Input[float]) – The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
bgp_auth_key (pulumi.Input[str]) – The authentication key for BGP configuration.
connection_id (pulumi.Input[str]) – The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
customer_address (pulumi.Input[str]) – The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
name (pulumi.Input[str]) – The name for the virtual interface.
route_filter_prefixes (pulumi.Input[list]) – A list of routes to be advertised to the AWS network in this region.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.
vlan (pulumi.Input[float]) – The VLAN ID.

address_family: pulumi.Output[str] = None¶: The address family for the BGP peer. ipv4 or ipv6.

amazon_address: pulumi.Output[str] = None¶: The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.

arn: pulumi.Output[str] = None¶: The ARN of the virtual interface.

aws_device: pulumi.Output[str] = None¶: The Direct Connect endpoint on which the virtual interface terminates.

bgp_asn: pulumi.Output[float] = None¶: The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

bgp_auth_key: pulumi.Output[str] = None¶: The authentication key for BGP configuration.

connection_id: pulumi.Output[str] = None¶: The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.

customer_address: pulumi.Output[str] = None¶: The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.

name: pulumi.Output[str] = None¶: The name for the virtual interface.

route_filter_prefixes: pulumi.Output[list] = None¶: A list of routes to be advertised to the AWS network in this region.

tags: pulumi.Output[dict] = None¶: A map of tags to assign to the resource.

vlan: pulumi.Output[float] = None¶: The VLAN ID.

static get(resource_name, id, opts=None, address_family=None, amazon_address=None, amazon_side_asn=None, arn=None, aws_device=None, bgp_asn=None, bgp_auth_key=None, connection_id=None, customer_address=None, name=None, route_filter_prefixes=None, tags=None, vlan=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
address_family (pulumi.Input[str]) – The address family for the BGP peer. ipv4 or ipv6.
amazon_address (pulumi.Input[str]) – The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
arn (pulumi.Input[str]) – The ARN of the virtual interface.
aws_device (pulumi.Input[str]) – The Direct Connect endpoint on which the virtual interface terminates.
bgp_asn (pulumi.Input[float]) – The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
bgp_auth_key (pulumi.Input[str]) – The authentication key for BGP configuration.
connection_id (pulumi.Input[str]) – The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
customer_address (pulumi.Input[str]) – The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
name (pulumi.Input[str]) – The name for the virtual interface.
route_filter_prefixes (pulumi.Input[list]) – A list of routes to be advertised to the AWS network in this region.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.
vlan (pulumi.Input[float]) – The VLAN ID.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.directconnect.TransitVirtualInterface(resource_name, opts=None, address_family=None, amazon_address=None, bgp_asn=None, bgp_auth_key=None, connection_id=None, customer_address=None, dx_gateway_id=None, mtu=None, name=None, tags=None, vlan=None, __props__=None, __name__=None, __opts__=None)¶

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.

import pulumi
import pulumi_aws as aws

example_gateway = aws.directconnect.Gateway("exampleGateway", amazon_side_asn=64512)
example_transit_virtual_interface = aws.directconnect.TransitVirtualInterface("exampleTransitVirtualInterface",
    address_family="ipv4",
    bgp_asn=65352,
    connection_id=aws_dx_connection["example"]["id"],
    dx_gateway_id=example_gateway.id,
    vlan=4094)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
address_family (pulumi.Input[str]) – The address family for the BGP peer. ipv4 or ipv6.
amazon_address (pulumi.Input[str]) – The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
bgp_asn (pulumi.Input[float]) – The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
bgp_auth_key (pulumi.Input[str]) – The authentication key for BGP configuration.
connection_id (pulumi.Input[str]) – The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
customer_address (pulumi.Input[str]) – The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
dx_gateway_id (pulumi.Input[str]) – The ID of the Direct Connect gateway to which to connect the virtual interface.
mtu (pulumi.Input[float]) – 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.
name (pulumi.Input[str]) – The name for the virtual interface.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.
vlan (pulumi.Input[float]) – The VLAN ID.

address_family: pulumi.Output[str] = None¶: The address family for the BGP peer. ipv4 or ipv6.

amazon_address: pulumi.Output[str] = None¶: The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.

arn: pulumi.Output[str] = None¶: The ARN of the virtual interface.

aws_device: pulumi.Output[str] = None¶: The Direct Connect endpoint on which the virtual interface terminates.

bgp_asn: pulumi.Output[float] = None¶: The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

bgp_auth_key: pulumi.Output[str] = None¶: The authentication key for BGP configuration.

connection_id: pulumi.Output[str] = None¶: The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.

customer_address: pulumi.Output[str] = None¶: The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.

dx_gateway_id: pulumi.Output[str] = None¶: The ID of the Direct Connect gateway to which to connect the virtual interface.

jumbo_frame_capable: pulumi.Output[bool] = None¶: Indicates whether jumbo frames (8500 MTU) are supported.

mtu: pulumi.Output[float] = None¶: 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.

name: pulumi.Output[str] = None¶: The name for the virtual interface.

tags: pulumi.Output[dict] = None¶: A map of tags to assign to the resource.

vlan: pulumi.Output[float] = None¶: The VLAN ID.

static get(resource_name, id, opts=None, address_family=None, amazon_address=None, amazon_side_asn=None, arn=None, aws_device=None, bgp_asn=None, bgp_auth_key=None, connection_id=None, customer_address=None, dx_gateway_id=None, jumbo_frame_capable=None, mtu=None, name=None, tags=None, vlan=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
address_family (pulumi.Input[str]) – The address family for the BGP peer. ipv4 or ipv6.
amazon_address (pulumi.Input[str]) – The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
arn (pulumi.Input[str]) – The ARN of the virtual interface.
aws_device (pulumi.Input[str]) – The Direct Connect endpoint on which the virtual interface terminates.
bgp_asn (pulumi.Input[float]) – The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
bgp_auth_key (pulumi.Input[str]) – The authentication key for BGP configuration.
connection_id (pulumi.Input[str]) – The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
customer_address (pulumi.Input[str]) – The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
dx_gateway_id (pulumi.Input[str]) – The ID of the Direct Connect gateway to which to connect the virtual interface.
jumbo_frame_capable (pulumi.Input[bool]) – Indicates whether jumbo frames (8500 MTU) are supported.
mtu (pulumi.Input[float]) – 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.
name (pulumi.Input[str]) – The name for the virtual interface.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.
vlan (pulumi.Input[float]) – The VLAN ID.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

pulumi_aws.directconnect.get_gateway(name=None, opts=None)¶

Retrieve information about a Direct Connect Gateway.

import pulumi
import pulumi_aws as aws

example = aws.directconnect.get_gateway(name="example")

Parameters: name (str) – The name of the gateway to retrieve.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

directconnect¶

On This Page