@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
272 lines (271 loc) • 10.4 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* 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
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.directconnect.Gateway("example", {
* name: "tf-dxg-example",
* amazonSideAsn: "64512",
* });
* const exampleTransitVirtualInterface = new aws.directconnect.TransitVirtualInterface("example", {
* connectionId: exampleAwsDxConnection.id,
* dxGatewayId: example.id,
* name: "tf-transit-vif-example",
* vlan: 4094,
* addressFamily: "ipv4",
* bgpAsn: 65352,
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import Direct Connect transit virtual interfaces using the VIF `id`. For example:
*
* ```sh
* $ pulumi import aws:directconnect/transitVirtualInterface:TransitVirtualInterface test dxvif-33cc44dd
* ```
*/
export declare class TransitVirtualInterface extends pulumi.CustomResource {
/**
* Get an existing TransitVirtualInterface resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TransitVirtualInterfaceState, opts?: pulumi.CustomResourceOptions): 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.
*/
static isInstance(obj: any): obj is TransitVirtualInterface;
/**
* The address family for the BGP peer. `ipv4 ` or `ipv6`.
*/
readonly addressFamily: pulumi.Output<string>;
/**
* The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
*/
readonly amazonAddress: pulumi.Output<string>;
readonly amazonSideAsn: pulumi.Output<string>;
/**
* The ARN of the virtual interface.
*/
readonly arn: pulumi.Output<string>;
/**
* The Direct Connect endpoint on which the virtual interface terminates.
*/
readonly awsDevice: pulumi.Output<string>;
/**
* The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
*/
readonly bgpAsn: pulumi.Output<number>;
/**
* The authentication key for BGP configuration.
*/
readonly bgpAuthKey: pulumi.Output<string>;
/**
* The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
*/
readonly connectionId: pulumi.Output<string>;
/**
* The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
*/
readonly customerAddress: pulumi.Output<string>;
/**
* The ID of the Direct Connect gateway to which to connect the virtual interface.
*/
readonly dxGatewayId: pulumi.Output<string>;
/**
* Indicates whether jumbo frames (8500 MTU) are supported.
*/
readonly jumboFrameCapable: pulumi.Output<boolean>;
/**
* 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`.
*/
readonly mtu: pulumi.Output<number | undefined>;
/**
* The name for the virtual interface.
*/
readonly name: pulumi.Output<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* Indicates whether to enable or disable SiteLink.
*/
readonly sitelinkEnabled: pulumi.Output<boolean | undefined>;
/**
* A map of tags to assign to the resource. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* The VLAN ID.
*/
readonly vlan: pulumi.Output<number>;
/**
* Create a TransitVirtualInterface resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: TransitVirtualInterfaceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering TransitVirtualInterface resources.
*/
export interface TransitVirtualInterfaceState {
/**
* The address family for the BGP peer. `ipv4 ` or `ipv6`.
*/
addressFamily?: pulumi.Input<string>;
/**
* The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
*/
amazonAddress?: pulumi.Input<string>;
amazonSideAsn?: pulumi.Input<string>;
/**
* The ARN of the virtual interface.
*/
arn?: pulumi.Input<string>;
/**
* The Direct Connect endpoint on which the virtual interface terminates.
*/
awsDevice?: pulumi.Input<string>;
/**
* The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
*/
bgpAsn?: pulumi.Input<number>;
/**
* The authentication key for BGP configuration.
*/
bgpAuthKey?: pulumi.Input<string>;
/**
* The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
*/
connectionId?: pulumi.Input<string>;
/**
* The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
*/
customerAddress?: pulumi.Input<string>;
/**
* The ID of the Direct Connect gateway to which to connect the virtual interface.
*/
dxGatewayId?: pulumi.Input<string>;
/**
* Indicates whether jumbo frames (8500 MTU) are supported.
*/
jumboFrameCapable?: pulumi.Input<boolean>;
/**
* 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`.
*/
mtu?: pulumi.Input<number>;
/**
* The name for the virtual interface.
*/
name?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Indicates whether to enable or disable SiteLink.
*/
sitelinkEnabled?: pulumi.Input<boolean>;
/**
* A map of tags to assign to the resource. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The VLAN ID.
*/
vlan?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a TransitVirtualInterface resource.
*/
export interface TransitVirtualInterfaceArgs {
/**
* The address family for the BGP peer. `ipv4 ` or `ipv6`.
*/
addressFamily: pulumi.Input<string>;
/**
* The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
*/
amazonAddress?: pulumi.Input<string>;
/**
* The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
*/
bgpAsn: pulumi.Input<number>;
/**
* The authentication key for BGP configuration.
*/
bgpAuthKey?: pulumi.Input<string>;
/**
* The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
*/
connectionId: pulumi.Input<string>;
/**
* The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
*/
customerAddress?: pulumi.Input<string>;
/**
* The ID of the Direct Connect gateway to which to connect the virtual interface.
*/
dxGatewayId: pulumi.Input<string>;
/**
* 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`.
*/
mtu?: pulumi.Input<number>;
/**
* The name for the virtual interface.
*/
name?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Indicates whether to enable or disable SiteLink.
*/
sitelinkEnabled?: pulumi.Input<boolean>;
/**
* A map of tags to assign to the resource. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The VLAN ID.
*/
vlan: pulumi.Input<number>;
}