Class CfnPrivateVirtualInterfaceProps

Properties for defining a CfnPrivateVirtualInterface.

Inheritance

object

CfnPrivateVirtualInterfaceProps

Implements

ICfnPrivateVirtualInterfaceProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.DirectConnect

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnPrivateVirtualInterfaceProps : ICfnPrivateVirtualInterfaceProps

Syntax (vb)

Public Class CfnPrivateVirtualInterfaceProps Implements ICfnPrivateVirtualInterfaceProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-privatevirtualinterface.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.DirectConnect;

             var cfnPrivateVirtualInterfaceProps = new CfnPrivateVirtualInterfaceProps {
                 BgpPeers = new [] { new BgpPeerProperty {
                     AddressFamily = "addressFamily",
                     Asn = "asn",

                     // the properties below are optional
                     AmazonAddress = "amazonAddress",
                     AuthKey = "authKey",
                     BgpPeerId = "bgpPeerId",
                     CustomerAddress = "customerAddress"
                 } },
                 ConnectionId = "connectionId",
                 VirtualInterfaceName = "virtualInterfaceName",
                 Vlan = 123,

                 // the properties below are optional
                 AllocatePrivateVirtualInterfaceRoleArn = "allocatePrivateVirtualInterfaceRoleArn",
                 DirectConnectGatewayId = "directConnectGatewayId",
                 EnableSiteLink = false,
                 Mtu = 123,
                 RateLimit = "rateLimit",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 VirtualGatewayId = "virtualGatewayId"
             };

Synopsis

Constructors

CfnPrivateVirtualInterfaceProps()

Properties for defining a CfnPrivateVirtualInterface.

Properties

AllocatePrivateVirtualInterfaceRoleArn	The Amazon Resource Name (ARN) of the role to allocate the private virtual interface.
BgpPeers	The BGP peers configured on this virtual interface.
ConnectionId	Properties for defining a `CfnPrivateVirtualInterface`.
DirectConnectGatewayId	Properties for defining a `CfnPrivateVirtualInterface`.
EnableSiteLink	Indicates whether to enable or disable SiteLink.
Mtu	The maximum transmission unit (MTU), in bytes.
RateLimit	The rate limit (bandwidth allocation) for the virtual interface.
Tags	The tags associated with the private virtual interface.
VirtualGatewayId	The ID or ARN of the virtual private gateway.
VirtualInterfaceName	The name of the virtual interface assigned by the customer network.
Vlan	The ID of the VLAN.

Constructors

CfnPrivateVirtualInterfaceProps()

Properties for defining a CfnPrivateVirtualInterface.

public CfnPrivateVirtualInterfaceProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-privatevirtualinterface.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.DirectConnect;

             var cfnPrivateVirtualInterfaceProps = new CfnPrivateVirtualInterfaceProps {
                 BgpPeers = new [] { new BgpPeerProperty {
                     AddressFamily = "addressFamily",
                     Asn = "asn",

                     // the properties below are optional
                     AmazonAddress = "amazonAddress",
                     AuthKey = "authKey",
                     BgpPeerId = "bgpPeerId",
                     CustomerAddress = "customerAddress"
                 } },
                 ConnectionId = "connectionId",
                 VirtualInterfaceName = "virtualInterfaceName",
                 Vlan = 123,

                 // the properties below are optional
                 AllocatePrivateVirtualInterfaceRoleArn = "allocatePrivateVirtualInterfaceRoleArn",
                 DirectConnectGatewayId = "directConnectGatewayId",
                 EnableSiteLink = false,
                 Mtu = 123,
                 RateLimit = "rateLimit",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 VirtualGatewayId = "virtualGatewayId"
             };

Properties

AllocatePrivateVirtualInterfaceRoleArn

The Amazon Resource Name (ARN) of the role to allocate the private virtual interface.

public string? AllocatePrivateVirtualInterfaceRoleArn { get; set; }

Property Value

string

Remarks

Needs directconnect:AllocatePrivateVirtualInterface permissions and tag permissions if applicable.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-privatevirtualinterface.html#cfn-directconnect-privatevirtualinterface-allocateprivatevirtualinterfacerolearn

BgpPeers

The BGP peers configured on this virtual interface.

public object BgpPeers { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-privatevirtualinterface.html#cfn-directconnect-privatevirtualinterface-bgppeers

Type union: either IResolvable or (either IResolvable or CfnPrivateVirtualInterface.IBgpPeerProperty)[]

ConnectionId

Properties for defining a CfnPrivateVirtualInterface.

public object ConnectionId { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-privatevirtualinterface.html#cfn-directconnect-privatevirtualinterface-connectionid

Type union: either string or IConnectionRef or ILagRef

DirectConnectGatewayId

Properties for defining a CfnPrivateVirtualInterface.

public object? DirectConnectGatewayId { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-privatevirtualinterface.html#cfn-directconnect-privatevirtualinterface-directconnectgatewayid

Type union: either string or IDirectConnectGatewayRef

EnableSiteLink

Indicates whether to enable or disable SiteLink.

public object? EnableSiteLink { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-privatevirtualinterface.html#cfn-directconnect-privatevirtualinterface-enablesitelink

Type union: either bool or IResolvable

Mtu

The maximum transmission unit (MTU), in bytes.

public double? Mtu { get; set; }

Property Value

double?

Remarks

The supported values are 1500 and 9001. The default value is 1500.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-privatevirtualinterface.html#cfn-directconnect-privatevirtualinterface-mtu

RateLimit

The rate limit (bandwidth allocation) for the virtual interface.

public string? RateLimit { get; set; }

Property Value

string

Remarks

The value must be one of the supported bandwidth values (e.g., 50Mbps, 1Gbps, 10Gbps) and cannot exceed the bandwidth of the parent connection or LAG.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-privatevirtualinterface.html#cfn-directconnect-privatevirtualinterface-ratelimit

VirtualGatewayId

The ID or ARN of the virtual private gateway.

public string? VirtualGatewayId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-privatevirtualinterface.html#cfn-directconnect-privatevirtualinterface-virtualgatewayid

VirtualInterfaceName

The name of the virtual interface assigned by the customer network.

public string VirtualInterfaceName { get; set; }

Property Value

string

Remarks

The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directconnect-privatevirtualinterface.html#cfn-directconnect-privatevirtualinterface-virtualinterfacename

Vlan

The ID of the VLAN.

public double Vlan { get; set; }