Class CfnClientVpnRoute
A CloudFormation AWS::EC2::ClientVpnRoute
.
Inherited Members
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.AWS.EC2.dll
Syntax (csharp)
public class CfnClientVpnRoute : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnClientVpnRoute
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Specifies a network route to add to a Client VPN endpoint. 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.
CloudformationResource: AWS::EC2::ClientVpnRoute
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.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 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) | Create a new |
CfnClientVpnRoute(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnClientVpnRoute(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. For example:. |
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>) |
Constructors
CfnClientVpnRoute(Construct, String, ICfnClientVpnRouteProps)
Create a new AWS::EC2::ClientVpnRoute
.
public CfnClientVpnRoute(Construct scope, string id, ICfnClientVpnRouteProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnClientVpnRouteProps
- resource properties.
CfnClientVpnRoute(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnClientVpnRoute(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnClientVpnRoute(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnClientVpnRoute(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ClientVpnEndpointId
The ID of the Client VPN endpoint to which to add the route.
public virtual string ClientVpnEndpointId { get; set; }
Property Value
System.String
Remarks
Description
A brief description of the route.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
DestinationCidrBlock
The IPv4 address range, in CIDR notation, of the route destination. For example:.
public virtual string DestinationCidrBlock { get; set; }
Property Value
System.String
Remarks
TargetVpcSubnetId
The ID of the subnet through which you want to route traffic.
public virtual string TargetVpcSubnetId { get; set; }
Property Value
System.String
Remarks
The specified subnet must be an existing target network of the Client VPN endpoint.
Alternatively, if you're adding a route for the local network, specify local
.
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>