Show / Hide Table of Contents

Class CfnClientVpnRoute

Specifies a network route to add to a Client VPN endpoint.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnClientVpnRoute
Implements
IInspectable
Inherited Members
CfnResource.IsCfnResource(object)
CfnResource.AddDeletionOverride(string)
CfnResource.AddDependency(CfnResource)
CfnResource.AddDependsOn(CfnResource)
CfnResource.AddMetadata(string, object)
CfnResource.AddOverride(string, object)
CfnResource.AddPropertyDeletionOverride(string)
CfnResource.AddPropertyOverride(string, object)
CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)
CfnResource.GetAtt(string, ResolutionTypeHint?)
CfnResource.GetMetadata(string)
CfnResource.ObtainDependencies()
CfnResource.ObtainResourceDependencies()
CfnResource.RemoveDependency(CfnResource)
CfnResource.ReplaceDependency(CfnResource, CfnResource)
CfnResource.ShouldSynthesize()
CfnResource.ToString()
CfnResource.ValidateProperties(object)
CfnResource.CfnOptions
CfnResource.CfnResourceType
CfnResource.UpdatedProperites
CfnResource.UpdatedProperties
CfnRefElement.Ref
CfnElement.IsCfnElement(object)
CfnElement.OverrideLogicalId(string)
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnClientVpnRoute : CfnResource, IInspectable
Syntax (vb)
Public Class CfnClientVpnRoute Inherits CfnResource Implements IInspectable
Remarks

Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.

A target network association must be created before you can specify a route. If you're setting up all the components of a Client VPN endpoint at the same time, you must use the DependsOn Attribute to declare a dependency on the AWS::EC2::ClientVpnTargetNetworkAssociation resource.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html

CloudformationResource: AWS::EC2::ClientVpnRoute

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 cfnClientVpnRoute = new CfnClientVpnRoute(this, "MyCfnClientVpnRoute", new CfnClientVpnRouteProps {
                 ClientVpnEndpointId = "clientVpnEndpointId",
                 DestinationCidrBlock = "destinationCidrBlock",
                 TargetVpcSubnetId = "targetVpcSubnetId",

                 // the properties below are optional
                 Description = "description"
             });

Synopsis

Constructors

CfnClientVpnRoute(Construct, string, ICfnClientVpnRouteProps)

Specifies a network route to add to a Client VPN endpoint.

Properties

AttrId

Specifies a network route to add to a Client VPN endpoint.

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

CfnProperties

Specifies a network route to add to a Client VPN endpoint.

ClientVpnEndpointId

The ID of the Client VPN endpoint to which to add the route.

Description

A brief description of the route.

DestinationCidrBlock

The IPv4 address range, in CIDR notation, of the route destination.

TargetVpcSubnetId

The ID of the subnet through which you want to route traffic.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

RenderProperties(IDictionary<string, object>)

Specifies a network route to add to a Client VPN endpoint.

Constructors

CfnClientVpnRoute(Construct, string, ICfnClientVpnRouteProps)

Specifies a network route to add to a Client VPN endpoint.

public CfnClientVpnRoute(Construct scope, string id, ICfnClientVpnRouteProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnClientVpnRouteProps

Resource properties.

Remarks

Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.

A target network association must be created before you can specify a route. If you're setting up all the components of a Client VPN endpoint at the same time, you must use the DependsOn Attribute to declare a dependency on the AWS::EC2::ClientVpnTargetNetworkAssociation resource.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html

CloudformationResource: AWS::EC2::ClientVpnRoute

ExampleMetadata: fixture=_generated

Properties

AttrId

Specifies a network route to add to a Client VPN endpoint.

public virtual string AttrId { get; }
Property Value

string

Remarks

CloudformationAttribute: Id

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.

A target network association must be created before you can specify a route. If you're setting up all the components of a Client VPN endpoint at the same time, you must use the DependsOn Attribute to declare a dependency on the AWS::EC2::ClientVpnTargetNetworkAssociation resource.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html

CloudformationResource: AWS::EC2::ClientVpnRoute

ExampleMetadata: fixture=_generated

CfnProperties

Specifies a network route to add to a Client VPN endpoint.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
CfnResource.CfnProperties
Remarks

Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.

A target network association must be created before you can specify a route. If you're setting up all the components of a Client VPN endpoint at the same time, you must use the DependsOn Attribute to declare a dependency on the AWS::EC2::ClientVpnTargetNetworkAssociation resource.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html

CloudformationResource: AWS::EC2::ClientVpnRoute

ExampleMetadata: fixture=_generated

ClientVpnEndpointId

The ID of the Client VPN endpoint to which to add the route.

public virtual string ClientVpnEndpointId { get; set; }
Property Value

string

Remarks

Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.

A target network association must be created before you can specify a route. If you're setting up all the components of a Client VPN endpoint at the same time, you must use the DependsOn Attribute to declare a dependency on the AWS::EC2::ClientVpnTargetNetworkAssociation resource.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html

CloudformationResource: AWS::EC2::ClientVpnRoute

ExampleMetadata: fixture=_generated

Description

A brief description of the route.

public virtual string? Description { get; set; }
Property Value

string

Remarks

Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.

A target network association must be created before you can specify a route. If you're setting up all the components of a Client VPN endpoint at the same time, you must use the DependsOn Attribute to declare a dependency on the AWS::EC2::ClientVpnTargetNetworkAssociation resource.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html

CloudformationResource: AWS::EC2::ClientVpnRoute

ExampleMetadata: fixture=_generated

DestinationCidrBlock

The IPv4 address range, in CIDR notation, of the route destination.

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

string

Remarks

For example:.

TargetVpcSubnetId

The ID of the subnet through which you want to route traffic.

public virtual string TargetVpcSubnetId { get; set; }
Property Value

string

Remarks

Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.

A target network association must be created before you can specify a route. If you're setting up all the components of a Client VPN endpoint at the same time, you must use the DependsOn Attribute to declare a dependency on the AWS::EC2::ClientVpnTargetNetworkAssociation resource.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html

CloudformationResource: AWS::EC2::ClientVpnRoute

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.

A target network association must be created before you can specify a route. If you're setting up all the components of a Client VPN endpoint at the same time, you must use the DependsOn Attribute to declare a dependency on the AWS::EC2::ClientVpnTargetNetworkAssociation resource.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html

CloudformationResource: AWS::EC2::ClientVpnRoute

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Specifies a network route to add to a Client VPN endpoint.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
CfnResource.RenderProperties(IDictionary<string, object>)
Remarks

Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.

A target network association must be created before you can specify a route. If you're setting up all the components of a Client VPN endpoint at the same time, you must use the DependsOn Attribute to declare a dependency on the AWS::EC2::ClientVpnTargetNetworkAssociation resource.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html

CloudformationResource: AWS::EC2::ClientVpnRoute

ExampleMetadata: fixture=_generated

Implements

IInspectable
Back to top Generated by DocFX