Class: AWSCDK::EC2::CfnClientVpnRouteProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ec2/cfn_client_vpn_route_props.rb

Overview

Properties for defining a CfnClientVpnRoute.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client_vpn_endpoint_id:, destination_cidr_block:, description: nil, target_vpc_subnet_id: nil) ⇒ CfnClientVpnRouteProps

Returns a new instance of CfnClientVpnRouteProps.

Parameters:

  • client_vpn_endpoint_id (String) —

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

  • destination_cidr_block (String) —

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

  • description (String, nil) (defaults to: nil) —

    A brief description of the route.

  • target_vpc_subnet_id (String, nil) (defaults to: nil) —

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



13
14
15
16
17
18
19
20
21
22
 
# File 'ec2/cfn_client_vpn_route_props.rb', line 13

def initialize(client_vpn_endpoint_id:, destination_cidr_block:, description: nil, target_vpc_subnet_id: nil)
  @client_vpn_endpoint_id = client_vpn_endpoint_id
  Jsii::Type.check_type(@client_vpn_endpoint_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clientVpnEndpointId")
  @destination_cidr_block = destination_cidr_block
  Jsii::Type.check_type(@destination_cidr_block, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "destinationCidrBlock")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @target_vpc_subnet_id = target_vpc_subnet_id
  Jsii::Type.check_type(@target_vpc_subnet_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "targetVpcSubnetId") unless @target_vpc_subnet_id.nil?
end

Instance Attribute Details

#client_vpn_endpoint_id ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



28
29
30
 
# File 'ec2/cfn_client_vpn_route_props.rb', line 28

def client_vpn_endpoint_id
  @client_vpn_endpoint_id
end

#description ⇒ String? (readonly)

A brief description of the route.

Returns:

  • (String, nil)

See Also:



43
44
45
 
# File 'ec2/cfn_client_vpn_route_props.rb', line 43

def description
  @description
end

#destination_cidr_block ⇒ String (readonly)

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

  • To add a route for Internet access, enter 0.0.0.0/0
  • To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range
  • To add a route for an on-premises network, enter the AWS Site-to-Site VPN connection's IPv4 CIDR range
  • To add a route for the local network, enter the client CIDR range

Returns:

  • (String)

See Also:



38
39
40
 
# File 'ec2/cfn_client_vpn_route_props.rb', line 38

def destination_cidr_block
  @destination_cidr_block
end

#target_vpc_subnet_id ⇒ String? (readonly)

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

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 .

Returns:

  • (String, nil)

See Also:



52
53
54
 
# File 'ec2/cfn_client_vpn_route_props.rb', line 52

def target_vpc_subnet_id
  @target_vpc_subnet_id
end

Class Method Details

.jsii_properties ⇒ Object 



54
55
56
57
58
59
60
61
 
# File 'ec2/cfn_client_vpn_route_props.rb', line 54

def self.jsii_properties
  {
    :client_vpn_endpoint_id => "clientVpnEndpointId",
    :destination_cidr_block => "destinationCidrBlock",
    :description => "description",
    :target_vpc_subnet_id => "targetVpcSubnetId",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



63
64
65
66
67
68
69
70
71
72
 
# File 'ec2/cfn_client_vpn_route_props.rb', line 63

def to_jsii
  result = {}
  result.merge!({
    "clientVpnEndpointId" => @client_vpn_endpoint_id,
    "destinationCidrBlock" => @destination_cidr_block,
    "description" => @description,
    "targetVpcSubnetId" => @target_vpc_subnet_id,
  })
  result.compact
end