Class: Aws::EC2::Types::ReplaceRouteRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::ReplaceRouteRequest

Defined in:

gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass ReplaceRouteRequest 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",
  local_target: false,
  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",
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #carrier_gateway_id ⇒ String

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

• #destination_cidr_block ⇒ String

  The IPv4 CIDR address block used for the destination match.

• #destination_ipv_6_cidr_block ⇒ String

  The IPv6 CIDR address block used for the destination match.

• #destination_prefix_list_id ⇒ String

  The ID of the prefix list for the route.

• #dry_run ⇒ Boolean

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

• #egress_only_internet_gateway_id ⇒ String

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

• #gateway_id ⇒ String

  The ID of an internet gateway or virtual private gateway.

• #instance_id ⇒ String

  The ID of a NAT instance in your VPC.

• #local_gateway_id ⇒ String

  The ID of the local gateway.

• #local_target ⇒ Boolean

  Specifies whether to reset the local route to its default target (local).

• #nat_gateway_id ⇒ String

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

• #network_interface_id ⇒ String

  The ID of a network interface.

• #route_table_id ⇒ String

  The ID of the route table.

• #transit_gateway_id ⇒ String

  The ID of a transit gateway.

• #vpc_endpoint_id ⇒ String

  The ID of a VPC endpoint.

• #vpc_peering_connection_id ⇒ String

  The ID of a VPC peering connection.

Instance Attribute Details

#carrier_gateway_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 47159

class ReplaceRouteRequest < 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,
  :local_target,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id)
  SENSITIVE = []
  include Aws::Structure
end

#destination_cidr_block ⇒ String

The IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 47159

class ReplaceRouteRequest < 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,
  :local_target,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id)
  SENSITIVE = []
  include Aws::Structure
end

#destination_ipv_6_cidr_block ⇒ String

The IPv6 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 47159

class ReplaceRouteRequest < 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,
  :local_target,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id)
  SENSITIVE = []
  include Aws::Structure
end

#destination_prefix_list_id ⇒ String

The ID of the prefix list for the route.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 47159

class ReplaceRouteRequest < 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,
  :local_target,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 47159

class ReplaceRouteRequest < 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,
  :local_target,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id)
  SENSITIVE = []
  include Aws::Structure
end

#egress_only_internet_gateway_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 47159

class ReplaceRouteRequest < 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,
  :local_target,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_id ⇒ String

The ID of an internet gateway or virtual private gateway.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 47159

class ReplaceRouteRequest < 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,
  :local_target,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id)
  SENSITIVE = []
  include Aws::Structure
end

#instance_id ⇒ String

The ID of a NAT instance in your VPC.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 47159

class ReplaceRouteRequest < 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,
  :local_target,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id)
  SENSITIVE = []
  include Aws::Structure
end

#local_gateway_id ⇒ String

The ID of the local gateway.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 47159

class ReplaceRouteRequest < 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,
  :local_target,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id)
  SENSITIVE = []
  include Aws::Structure
end

#local_target ⇒ Boolean

Specifies whether to reset the local route to its default target (local).

Returns:

• (Boolean)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 47159

class ReplaceRouteRequest < 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,
  :local_target,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id)
  SENSITIVE = []
  include Aws::Structure
end

#nat_gateway_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 47159

class ReplaceRouteRequest < 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,
  :local_target,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id)
  SENSITIVE = []
  include Aws::Structure
end

#network_interface_id ⇒ String

The ID of a network interface.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 47159

class ReplaceRouteRequest < 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,
  :local_target,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id)
  SENSITIVE = []
  include Aws::Structure
end

#route_table_id ⇒ String

The ID of the route table.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 47159

class ReplaceRouteRequest < 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,
  :local_target,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id)
  SENSITIVE = []
  include Aws::Structure
end

#transit_gateway_id ⇒ String

The ID of a transit gateway.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 47159

class ReplaceRouteRequest < 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,
  :local_target,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_endpoint_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 47159

class ReplaceRouteRequest < 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,
  :local_target,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_peering_connection_id ⇒ String

The ID of a VPC peering connection.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 47159

class ReplaceRouteRequest < 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,
  :local_target,
  :nat_gateway_id,
  :transit_gateway_id,
  :local_gateway_id,
  :carrier_gateway_id,
  :network_interface_id,
  :route_table_id,
  :vpc_peering_connection_id)
  SENSITIVE = []
  include Aws::Structure
end