Skip to content

Create Local Gateway Route

ec2_create_local_gateway_route R Documentation

Creates a static route for the specified local gateway route table

Description

Creates a static route for the specified local gateway route table. You must specify one of the following targets:

  • LocalGatewayVirtualInterfaceGroupId

  • NetworkInterfaceId

Usage

ec2_create_local_gateway_route(DestinationCidrBlock,
  LocalGatewayRouteTableId, LocalGatewayVirtualInterfaceGroupId, DryRun,
  NetworkInterfaceId, DestinationPrefixListId)

Arguments

DestinationCidrBlock

The CIDR range used for destination matches. Routing decisions are based on the most specific match.

LocalGatewayRouteTableId

[required] The ID of the local gateway route table.

LocalGatewayVirtualInterfaceGroupId

The ID of the virtual interface group.

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.

NetworkInterfaceId

The ID of the network interface.

DestinationPrefixListId

The ID of the prefix list. Use a prefix list in place of DestinationCidrBlock. You cannot use DestinationPrefixListId and DestinationCidrBlock in the same request.

Value

A list with the following syntax: 

list(
  Route = list(
    DestinationCidrBlock = "string",
    LocalGatewayVirtualInterfaceGroupId = "string",
    Type = "static"|"propagated",
    State = "pending"|"active"|"blackhole"|"deleting"|"deleted",
    LocalGatewayRouteTableId = "string",
    LocalGatewayRouteTableArn = "string",
    OwnerId = "string",
    SubnetId = "string",
    CoipPoolId = "string",
    NetworkInterfaceId = "string",
    DestinationPrefixListId = "string"
  )
)

Request syntax

svc$create_local_gateway_route(
  DestinationCidrBlock = "string",
  LocalGatewayRouteTableId = "string",
  LocalGatewayVirtualInterfaceGroupId = "string",
  DryRun = TRUE|FALSE,
  NetworkInterfaceId = "string",
  DestinationPrefixListId = "string"
)