You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EC2::Types::CreateClientVpnRouteRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateClientVpnRouteRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  client_vpn_endpoint_id: "ClientVpnEndpointId", # required
  destination_cidr_block: "String", # required
  target_vpc_subnet_id: "SubnetId", # required
  description: "String",
  client_token: "String",
  dry_run: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Returns:

  • (String) —

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

#client_vpn_endpoint_id ⇒ String

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

Returns:

  • (String) —

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

#description ⇒ String

A brief description of the route.

Returns:

  • (String) —

    A brief description of the route.

#destination_cidr_block ⇒ String

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) —

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

#dry_run ⇒ Boolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

  • (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

#target_vpc_subnet_id ⇒ String

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) —

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