@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
124 lines (123 loc) • 5.07 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource Type definition for AWS::DirectConnect::PrivateVirtualInterface
*/
export declare class PrivateVirtualInterface extends pulumi.CustomResource {
/**
* Get an existing PrivateVirtualInterface 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 opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): 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.
*/
static isInstance(obj: any): obj is PrivateVirtualInterface;
/**
* The Amazon Resource Name (ARN) of the role to allocate the private virtual interface. Needs directconnect:AllocatePrivateVirtualInterface permissions and tag permissions if applicable.
*/
readonly allocatePrivateVirtualInterfaceRoleArn: pulumi.Output<string | undefined>;
/**
* The BGP peers configured on this virtual interface.
*/
readonly bgpPeers: pulumi.Output<outputs.directconnect.PrivateVirtualInterfaceBgpPeer[]>;
/**
* The ID or ARN of the connection or LAG.
*/
readonly connectionId: pulumi.Output<string>;
/**
* The ID or ARN of the Direct Connect gateway.
*/
readonly directConnectGatewayId: pulumi.Output<string | undefined>;
/**
* Indicates whether to enable or disable SiteLink.
*/
readonly enableSiteLink: pulumi.Output<boolean | undefined>;
/**
* The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
*/
readonly mtu: pulumi.Output<number | undefined>;
/**
* The tags associated with the private virtual interface.
*/
readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* The ID or ARN of the virtual private gateway.
*/
readonly virtualGatewayId: pulumi.Output<string | undefined>;
/**
* The ID of the virtual interface.
*/
readonly virtualInterfaceArn: pulumi.Output<string>;
/**
* The ID of the virtual interface.
*/
readonly virtualInterfaceId: pulumi.Output<string>;
/**
* The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
*/
readonly virtualInterfaceName: pulumi.Output<string>;
/**
* The ID of the VLAN.
*/
readonly vlan: pulumi.Output<number>;
/**
* Create a PrivateVirtualInterface 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: PrivateVirtualInterfaceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a PrivateVirtualInterface resource.
*/
export interface PrivateVirtualInterfaceArgs {
/**
* The Amazon Resource Name (ARN) of the role to allocate the private virtual interface. Needs directconnect:AllocatePrivateVirtualInterface permissions and tag permissions if applicable.
*/
allocatePrivateVirtualInterfaceRoleArn?: pulumi.Input<string>;
/**
* The BGP peers configured on this virtual interface.
*/
bgpPeers: pulumi.Input<pulumi.Input<inputs.directconnect.PrivateVirtualInterfaceBgpPeerArgs>[]>;
/**
* The ID or ARN of the connection or LAG.
*/
connectionId: pulumi.Input<string>;
/**
* The ID or ARN of the Direct Connect gateway.
*/
directConnectGatewayId?: pulumi.Input<string>;
/**
* Indicates whether to enable or disable SiteLink.
*/
enableSiteLink?: pulumi.Input<boolean>;
/**
* The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
*/
mtu?: pulumi.Input<number>;
/**
* The tags associated with the private virtual interface.
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
/**
* The ID or ARN of the virtual private gateway.
*/
virtualGatewayId?: pulumi.Input<string>;
/**
* The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
*/
virtualInterfaceName?: pulumi.Input<string>;
/**
* The ID of the VLAN.
*/
vlan: pulumi.Input<number>;
}