Show / Hide Table of Contents

Class CfnRouteProps

Properties for defining a CfnRoute.

Inheritance
object
CfnRouteProps
Implements
ICfnRouteProps
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.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnRouteProps : ICfnRouteProps
Syntax (vb)
Public Class CfnRouteProps Implements ICfnRouteProps
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.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.EC2;

             var cfnRouteProps = new CfnRouteProps {
                 RouteTableId = "routeTableId",

                 // the properties below are optional
                 CarrierGatewayId = "carrierGatewayId",
                 CoreNetworkArn = "coreNetworkArn",
                 DestinationCidrBlock = "destinationCidrBlock",
                 DestinationIpv6CidrBlock = "destinationIpv6CidrBlock",
                 DestinationPrefixListId = "destinationPrefixListId",
                 EgressOnlyInternetGatewayId = "egressOnlyInternetGatewayId",
                 GatewayId = "gatewayId",
                 InstanceId = "instanceId",
                 LocalGatewayId = "localGatewayId",
                 NatGatewayId = "natGatewayId",
                 NetworkInterfaceId = "networkInterfaceId",
                 TransitGatewayId = "transitGatewayId",
                 VpcEndpointId = "vpcEndpointId",
                 VpcPeeringConnectionId = "vpcPeeringConnectionId"
             };

Synopsis

Constructors

CfnRouteProps()

Properties for defining a CfnRoute.

Properties

CarrierGatewayId

The ID of the carrier gateway.

CoreNetworkArn

The Amazon Resource Name (ARN) of the core network.

DestinationCidrBlock

The IPv4 CIDR address block used for the destination match.

DestinationIpv6CidrBlock

The IPv6 CIDR block used for the destination match.

DestinationPrefixListId

The ID of a prefix list used for the destination match.

EgressOnlyInternetGatewayId

[IPv6 traffic only] The ID of an egress-only internet gateway.

GatewayId

The ID of an internet gateway or virtual private gateway attached to your VPC.

InstanceId

The ID of a NAT instance in your VPC.

LocalGatewayId

The ID of the local gateway.

NatGatewayId

[IPv4 traffic only] The ID of a NAT gateway.

NetworkInterfaceId

The ID of a network interface.

RouteTableId

The ID of the route table for the route.

TransitGatewayId

The ID of a transit gateway.

VpcEndpointId

The ID of a VPC endpoint.

VpcPeeringConnectionId

The ID of a VPC peering connection.

Constructors

CfnRouteProps()

Properties for defining a CfnRoute.

public CfnRouteProps()
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.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.EC2;

             var cfnRouteProps = new CfnRouteProps {
                 RouteTableId = "routeTableId",

                 // the properties below are optional
                 CarrierGatewayId = "carrierGatewayId",
                 CoreNetworkArn = "coreNetworkArn",
                 DestinationCidrBlock = "destinationCidrBlock",
                 DestinationIpv6CidrBlock = "destinationIpv6CidrBlock",
                 DestinationPrefixListId = "destinationPrefixListId",
                 EgressOnlyInternetGatewayId = "egressOnlyInternetGatewayId",
                 GatewayId = "gatewayId",
                 InstanceId = "instanceId",
                 LocalGatewayId = "localGatewayId",
                 NatGatewayId = "natGatewayId",
                 NetworkInterfaceId = "networkInterfaceId",
                 TransitGatewayId = "transitGatewayId",
                 VpcEndpointId = "vpcEndpointId",
                 VpcPeeringConnectionId = "vpcPeeringConnectionId"
             };

Properties

CarrierGatewayId

The ID of the carrier gateway.

public string? CarrierGatewayId { get; set; }
Property Value

string

Remarks

You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-carriergatewayid

CoreNetworkArn

The Amazon Resource Name (ARN) of the core network.

public string? CoreNetworkArn { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-corenetworkarn

DestinationCidrBlock

The IPv4 CIDR address block used for the destination match.

public string? DestinationCidrBlock { get; set; }
Property Value

string

Remarks

Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18 , we modify it to 100.68.0.0/18 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-destinationcidrblock

DestinationIpv6CidrBlock

The IPv6 CIDR block used for the destination match.

public string? DestinationIpv6CidrBlock { get; set; }
Property Value

string

Remarks

Routing decisions are based on the most specific match.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-destinationipv6cidrblock

DestinationPrefixListId

The ID of a prefix list used for the destination match.

public string? DestinationPrefixListId { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-destinationprefixlistid

EgressOnlyInternetGatewayId

[IPv6 traffic only] The ID of an egress-only internet gateway.

public string? EgressOnlyInternetGatewayId { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-egressonlyinternetgatewayid

GatewayId

The ID of an internet gateway or virtual private gateway attached to your VPC.

public string? GatewayId { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-gatewayid

InstanceId

The ID of a NAT instance in your VPC.

public string? InstanceId { get; set; }
Property Value

string

Remarks

The operation fails if you specify an instance ID unless exactly one network interface is attached.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-instanceid

LocalGatewayId

The ID of the local gateway.

public string? LocalGatewayId { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-localgatewayid

NatGatewayId

[IPv4 traffic only] The ID of a NAT gateway.

public string? NatGatewayId { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-natgatewayid

NetworkInterfaceId

The ID of a network interface.

public string? NetworkInterfaceId { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-networkinterfaceid

RouteTableId

The ID of the route table for the route.

public string RouteTableId { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-routetableid

TransitGatewayId

The ID of a transit gateway.

public string? TransitGatewayId { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-transitgatewayid

VpcEndpointId

The ID of a VPC endpoint.

public string? VpcEndpointId { get; set; }
Property Value

string

Remarks

Supported for Gateway Load Balancer endpoints only.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-vpcendpointid

VpcPeeringConnectionId

The ID of a VPC peering connection.

public string? VpcPeeringConnectionId { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-vpcpeeringconnectionid

Implements

ICfnRouteProps
Back to top Generated by DocFX