ec2_create_route {aws.ecx}

Create Route

Description

Create Route

Usage

ec2_create_route(
  RouteTableId,
  DestinationCidrBlock = NULL,
  DestinationIpv6CidrBlock = NULL,
  DestinationPrefixListId = NULL,
  DryRun = NULL,
  VpcEndpointId = NULL,
  EgressOnlyInternetGatewayId = NULL,
  GatewayId = NULL,
  InstanceId = NULL,
  NatGatewayId = NULL,
  TransitGatewayId = NULL,
  LocalGatewayId = NULL,
  CarrierGatewayId = NULL,
  NetworkInterfaceId = NULL,
  VpcPeeringConnectionId = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

RouteTableId

Character. The ID of the route table for the route.

DestinationCidrBlock

Character. The IPv4 CIDR address block used for the destination match.[optional]

DestinationIpv6CidrBlock

Character. The IPv6 CIDR block used for the destination match.[optional]

DestinationPrefixListId

Character. The ID of a prefix list used for the destination match.[optional]

DryRun

Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]

VpcEndpointId

Character. The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.[optional]

EgressOnlyInternetGatewayId

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

GatewayId

Character. The ID of an internet gateway or virtual private gateway attached to your VPC.[optional]

InstanceId

Character. The ID of a NAT instance in your VPC.[optional]

NatGatewayId

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

TransitGatewayId

Character. The ID of a transit gateway.[optional]

LocalGatewayId

Character. The ID of the local gateway.[optional]

CarrierGatewayId

Character. The ID of the carrier gateway.[optional]

NetworkInterfaceId

Character. The ID of a network interface.[optional]

VpcPeeringConnectionId

Character. The ID of a VPC peering connection.[optional]

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

RouteTableId

The ID of the route table for the route.

DestinationCidrBlock

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⁠.

DestinationIpv6CidrBlock

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

DestinationPrefixListId

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

DryRun

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.

VpcEndpointId

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

EgressOnlyInternetGatewayId

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

GatewayId

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

InstanceId

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.

NatGatewayId

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

TransitGatewayId

The ID of a transit gateway.

LocalGatewayId

The ID of the local gateway.

CarrierGatewayId

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.

NetworkInterfaceId

The ID of a network interface.

VpcPeeringConnectionId

The ID of a VPC peering connection.