Class: Aws::EC2::Types::CreateRouteRequest

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 CreateRouteRequest data as a hash:

{
  destination_cidr_block: "String",
  destination_ipv_6_cidr_block: "String",
  destination_prefix_list_id: "PrefixListResourceId",
  dry_run: false,
  vpc_endpoint_id: "VpcEndpointId",
  egress_only_internet_gateway_id: "EgressOnlyInternetGatewayId",
  gateway_id: "RouteGatewayId",
  instance_id: "InstanceId",
  nat_gateway_id: "NatGatewayId",
  transit_gateway_id: "TransitGatewayId",
  local_gateway_id: "LocalGatewayId",
  carrier_gateway_id: "CarrierGatewayId",
  network_interface_id: "NetworkInterfaceId",
  route_table_id: "RouteTableId", # required
  vpc_peering_connection_id: "VpcPeeringConnectionId",
  core_network_arn: "CoreNetworkArn",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#carrier_gateway_idString

The ID of the carrier gateway.

You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.

Returns:

  • (String)


11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11019

class CreateRouteRequest < Struct.new(
  :destination_cidr_block,
  :destination_ipv_6_cidr_block,
  :destination_prefix_list_id,
  :dry_run,
  :vpc_endpoint_id,
  :egress_only_internet_gateway_id,
  :gateway_id,
  :instance_id,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id,
  :core_network_arn)
  SENSITIVE = []
  include Aws::Structure
end

#core_network_arnString

The Amazon Resource Name (ARN) of the core network.

Returns:

  • (String)


11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11019

class CreateRouteRequest < Struct.new(
  :destination_cidr_block,
  :destination_ipv_6_cidr_block,
  :destination_prefix_list_id,
  :dry_run,
  :vpc_endpoint_id,
  :egress_only_internet_gateway_id,
  :gateway_id,
  :instance_id,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id,
  :core_network_arn)
  SENSITIVE = []
  include Aws::Structure
end

#destination_cidr_blockString

The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

Returns:

  • (String)


11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11019

class CreateRouteRequest < Struct.new(
  :destination_cidr_block,
  :destination_ipv_6_cidr_block,
  :destination_prefix_list_id,
  :dry_run,
  :vpc_endpoint_id,
  :egress_only_internet_gateway_id,
  :gateway_id,
  :instance_id,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id,
  :core_network_arn)
  SENSITIVE = []
  include Aws::Structure
end

#destination_ipv_6_cidr_blockString

The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.

Returns:

  • (String)


11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11019

class CreateRouteRequest < Struct.new(
  :destination_cidr_block,
  :destination_ipv_6_cidr_block,
  :destination_prefix_list_id,
  :dry_run,
  :vpc_endpoint_id,
  :egress_only_internet_gateway_id,
  :gateway_id,
  :instance_id,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id,
  :core_network_arn)
  SENSITIVE = []
  include Aws::Structure
end

#destination_prefix_list_idString

The ID of a prefix list used for the destination match.

Returns:

  • (String)


11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11019

class CreateRouteRequest < Struct.new(
  :destination_cidr_block,
  :destination_ipv_6_cidr_block,
  :destination_prefix_list_id,
  :dry_run,
  :vpc_endpoint_id,
  :egress_only_internet_gateway_id,
  :gateway_id,
  :instance_id,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id,
  :core_network_arn)
  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)


11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11019

class CreateRouteRequest < Struct.new(
  :destination_cidr_block,
  :destination_ipv_6_cidr_block,
  :destination_prefix_list_id,
  :dry_run,
  :vpc_endpoint_id,
  :egress_only_internet_gateway_id,
  :gateway_id,
  :instance_id,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id,
  :core_network_arn)
  SENSITIVE = []
  include Aws::Structure
end

#egress_only_internet_gateway_idString

[IPv6 traffic only] The ID of an egress-only internet gateway.

Returns:

  • (String)


11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11019

class CreateRouteRequest < Struct.new(
  :destination_cidr_block,
  :destination_ipv_6_cidr_block,
  :destination_prefix_list_id,
  :dry_run,
  :vpc_endpoint_id,
  :egress_only_internet_gateway_id,
  :gateway_id,
  :instance_id,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id,
  :core_network_arn)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_idString

The ID of an internet gateway or virtual private gateway attached to your VPC.

Returns:

  • (String)


11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11019

class CreateRouteRequest < Struct.new(
  :destination_cidr_block,
  :destination_ipv_6_cidr_block,
  :destination_prefix_list_id,
  :dry_run,
  :vpc_endpoint_id,
  :egress_only_internet_gateway_id,
  :gateway_id,
  :instance_id,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id,
  :core_network_arn)
  SENSITIVE = []
  include Aws::Structure
end

#instance_idString

The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.

Returns:

  • (String)


11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11019

class CreateRouteRequest < Struct.new(
  :destination_cidr_block,
  :destination_ipv_6_cidr_block,
  :destination_prefix_list_id,
  :dry_run,
  :vpc_endpoint_id,
  :egress_only_internet_gateway_id,
  :gateway_id,
  :instance_id,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id,
  :core_network_arn)
  SENSITIVE = []
  include Aws::Structure
end

#local_gateway_idString

The ID of the local gateway.

Returns:

  • (String)


11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11019

class CreateRouteRequest < Struct.new(
  :destination_cidr_block,
  :destination_ipv_6_cidr_block,
  :destination_prefix_list_id,
  :dry_run,
  :vpc_endpoint_id,
  :egress_only_internet_gateway_id,
  :gateway_id,
  :instance_id,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id,
  :core_network_arn)
  SENSITIVE = []
  include Aws::Structure
end

#nat_gateway_idString

[IPv4 traffic only] The ID of a NAT gateway.

Returns:

  • (String)


11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11019

class CreateRouteRequest < Struct.new(
  :destination_cidr_block,
  :destination_ipv_6_cidr_block,
  :destination_prefix_list_id,
  :dry_run,
  :vpc_endpoint_id,
  :egress_only_internet_gateway_id,
  :gateway_id,
  :instance_id,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id,
  :core_network_arn)
  SENSITIVE = []
  include Aws::Structure
end

#network_interface_idString

The ID of a network interface.

Returns:

  • (String)


11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11019

class CreateRouteRequest < Struct.new(
  :destination_cidr_block,
  :destination_ipv_6_cidr_block,
  :destination_prefix_list_id,
  :dry_run,
  :vpc_endpoint_id,
  :egress_only_internet_gateway_id,
  :gateway_id,
  :instance_id,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id,
  :core_network_arn)
  SENSITIVE = []
  include Aws::Structure
end

#route_table_idString

The ID of the route table for the route.

Returns:

  • (String)


11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11019

class CreateRouteRequest < Struct.new(
  :destination_cidr_block,
  :destination_ipv_6_cidr_block,
  :destination_prefix_list_id,
  :dry_run,
  :vpc_endpoint_id,
  :egress_only_internet_gateway_id,
  :gateway_id,
  :instance_id,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id,
  :core_network_arn)
  SENSITIVE = []
  include Aws::Structure
end

#transit_gateway_idString

The ID of a transit gateway.

Returns:

  • (String)


11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11019

class CreateRouteRequest < Struct.new(
  :destination_cidr_block,
  :destination_ipv_6_cidr_block,
  :destination_prefix_list_id,
  :dry_run,
  :vpc_endpoint_id,
  :egress_only_internet_gateway_id,
  :gateway_id,
  :instance_id,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id,
  :core_network_arn)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_endpoint_idString

The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.

Returns:

  • (String)


11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11019

class CreateRouteRequest < Struct.new(
  :destination_cidr_block,
  :destination_ipv_6_cidr_block,
  :destination_prefix_list_id,
  :dry_run,
  :vpc_endpoint_id,
  :egress_only_internet_gateway_id,
  :gateway_id,
  :instance_id,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id,
  :core_network_arn)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_peering_connection_idString

The ID of a VPC peering connection.

Returns:

  • (String)


11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11019

class CreateRouteRequest < Struct.new(
  :destination_cidr_block,
  :destination_ipv_6_cidr_block,
  :destination_prefix_list_id,
  :dry_run,
  :vpc_endpoint_id,
  :egress_only_internet_gateway_id,
  :gateway_id,
  :instance_id,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id,
  :core_network_arn)
  SENSITIVE = []
  include Aws::Structure
end