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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

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.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

Returns:

  • (String)


7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
# File 'lib/aws-sdk-ec2/types.rb', line 7281

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

#client_vpn_endpoint_idString

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

Returns:

  • (String)


7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
# File 'lib/aws-sdk-ec2/types.rb', line 7281

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

#descriptionString

A brief description of the route.

Returns:

  • (String)


7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
# File 'lib/aws-sdk-ec2/types.rb', line 7281

class CreateClientVpnRouteRequest < Struct.new(
  :client_vpn_endpoint_id,
  :destination_cidr_block,
  :target_vpc_subnet_id,
  :description,
  :client_token,
  :dry_run)
  SENSITIVE = []
  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 Amazon Web Services Site-to-Site VPN connection’s IPv4 CIDR range

  • To add a route for the local network, enter the client CIDR range

Returns:

  • (String)


7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
# File 'lib/aws-sdk-ec2/types.rb', line 7281

class CreateClientVpnRouteRequest < Struct.new(
  :client_vpn_endpoint_id,
  :destination_cidr_block,
  :target_vpc_subnet_id,
  :description,
  :client_token,
  :dry_run)
  SENSITIVE = []
  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)


7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
# File 'lib/aws-sdk-ec2/types.rb', line 7281

class CreateClientVpnRouteRequest < Struct.new(
  :client_vpn_endpoint_id,
  :destination_cidr_block,
  :target_vpc_subnet_id,
  :description,
  :client_token,
  :dry_run)
  SENSITIVE = []
  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.

Alternatively, if you’re adding a route for the local network, specify ‘local`.

Returns:

  • (String)


7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
# File 'lib/aws-sdk-ec2/types.rb', line 7281

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