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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass CreateClientVpnRouteRequest data as a hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

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

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


4416
4417
4418
4419
4420
4421
4422
4423
4424
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4416

class CreateClientVpnRouteRequest < Struct.new(
  :client_vpn_endpoint_id,
  :destination_cidr_block,
  :target_vpc_subnet_id,
  :description,
  :client_token,
  :dry_run)
  include Aws::Structure
end

#client_vpn_endpoint_idString

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

Returns:

  • (String)


4416
4417
4418
4419
4420
4421
4422
4423
4424
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4416

class CreateClientVpnRouteRequest < Struct.new(
  :client_vpn_endpoint_id,
  :destination_cidr_block,
  :target_vpc_subnet_id,
  :description,
  :client_token,
  :dry_run)
  include Aws::Structure
end

#descriptionString

A brief description of the route.

Returns:

  • (String)


4416
4417
4418
4419
4420
4421
4422
4423
4424
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4416

class CreateClientVpnRouteRequest < Struct.new(
  :client_vpn_endpoint_id,
  :destination_cidr_block,
  :target_vpc_subnet_id,
  :description,
  :client_token,
  :dry_run)
  include Aws::Structure
end

#destination_cidr_blockString

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

Route address ranges cannot overlap with the CIDR range specified for client allocation.

Returns:

  • (String)


4416
4417
4418
4419
4420
4421
4422
4423
4424
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4416

class CreateClientVpnRouteRequest < Struct.new(
  :client_vpn_endpoint_id,
  :destination_cidr_block,
  :target_vpc_subnet_id,
  :description,
  :client_token,
  :dry_run)
  include Aws::Structure
end

#dry_runBoolean

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)


4416
4417
4418
4419
4420
4421
4422
4423
4424
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4416

class CreateClientVpnRouteRequest < Struct.new(
  :client_vpn_endpoint_id,
  :destination_cidr_block,
  :target_vpc_subnet_id,
  :description,
  :client_token,
  :dry_run)
  include Aws::Structure
end

#target_vpc_subnet_idString

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.

Returns:

  • (String)


4416
4417
4418
4419
4420
4421
4422
4423
4424
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4416

class CreateClientVpnRouteRequest < Struct.new(
  :client_vpn_endpoint_id,
  :destination_cidr_block,
  :target_vpc_subnet_id,
  :description,
  :client_token,
  :dry_run)
  include Aws::Structure
end