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

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",
  dry_run: false,
  egress_only_internet_gateway_id: "String",
  gateway_id: "String",
  instance_id: "String",
  nat_gateway_id: "String",
  transit_gateway_id: "String",
  network_interface_id: "String",
  route_table_id: "String", # required
  vpc_peering_connection_id: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#destination_cidr_blockString

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

Returns:

  • (String)


6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6164

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


6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6164

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


6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6164

class CreateRouteRequest < Struct.new(
  :destination_cidr_block,
  :destination_ipv_6_cidr_block,
  :dry_run,
  :egress_only_internet_gateway_id,
  :gateway_id,
  :instance_id,
  :nat_gateway_id,
  :transit_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id)
  include Aws::Structure
end

#egress_only_internet_gateway_idString

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

Returns:

  • (String)


6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6164

class CreateRouteRequest < Struct.new(
  :destination_cidr_block,
  :destination_ipv_6_cidr_block,
  :dry_run,
  :egress_only_internet_gateway_id,
  :gateway_id,
  :instance_id,
  :nat_gateway_id,
  :transit_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id)
  include Aws::Structure
end

#gateway_idString

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

Returns:

  • (String)


6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6164

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


6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6164

class CreateRouteRequest < Struct.new(
  :destination_cidr_block,
  :destination_ipv_6_cidr_block,
  :dry_run,
  :egress_only_internet_gateway_id,
  :gateway_id,
  :instance_id,
  :nat_gateway_id,
  :transit_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id)
  include Aws::Structure
end

#nat_gateway_idString

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

Returns:

  • (String)


6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6164

class CreateRouteRequest < Struct.new(
  :destination_cidr_block,
  :destination_ipv_6_cidr_block,
  :dry_run,
  :egress_only_internet_gateway_id,
  :gateway_id,
  :instance_id,
  :nat_gateway_id,
  :transit_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id)
  include Aws::Structure
end

#network_interface_idString

The ID of a network interface.

Returns:

  • (String)


6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6164

class CreateRouteRequest < Struct.new(
  :destination_cidr_block,
  :destination_ipv_6_cidr_block,
  :dry_run,
  :egress_only_internet_gateway_id,
  :gateway_id,
  :instance_id,
  :nat_gateway_id,
  :transit_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id)
  include Aws::Structure
end

#route_table_idString

The ID of the route table for the route.

Returns:

  • (String)


6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6164

class CreateRouteRequest < Struct.new(
  :destination_cidr_block,
  :destination_ipv_6_cidr_block,
  :dry_run,
  :egress_only_internet_gateway_id,
  :gateway_id,
  :instance_id,
  :nat_gateway_id,
  :transit_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id)
  include Aws::Structure
end

#transit_gateway_idString

The ID of a transit gateway.

Returns:

  • (String)


6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6164

class CreateRouteRequest < Struct.new(
  :destination_cidr_block,
  :destination_ipv_6_cidr_block,
  :dry_run,
  :egress_only_internet_gateway_id,
  :gateway_id,
  :instance_id,
  :nat_gateway_id,
  :transit_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id)
  include Aws::Structure
end

#vpc_peering_connection_idString

The ID of a VPC peering connection.

Returns:

  • (String)


6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6164

class CreateRouteRequest < Struct.new(
  :destination_cidr_block,
  :destination_ipv_6_cidr_block,
  :dry_run,
  :egress_only_internet_gateway_id,
  :gateway_id,
  :instance_id,
  :nat_gateway_id,
  :transit_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id)
  include Aws::Structure
end