EC2 / Client / create_local_gateway_route

create_local_gateway_route#

EC2.Client.create_local_gateway_route(**kwargs)#

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

  • LocalGatewayVirtualInterfaceGroupId

  • NetworkInterfaceId

See also: AWS API Documentation

Request Syntax

response = client.create_local_gateway_route(
    DestinationCidrBlock='string',
    LocalGatewayRouteTableId='string',
    LocalGatewayVirtualInterfaceGroupId='string',
    DryRun=True|False,
    NetworkInterfaceId='string',
    DestinationPrefixListId='string'
)
Parameters:

  • DestinationCidrBlock (string) – The CIDR range used for destination matches. Routing decisions are based on the most specific match.

  • LocalGatewayRouteTableId (string) –

    [REQUIRED]

    The ID of the local gateway route table.

  • LocalGatewayVirtualInterfaceGroupId (string) – The ID of the virtual interface group.

  • DryRun (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.

  • NetworkInterfaceId (string) – The ID of the network interface.

  • DestinationPrefixListId (string) – The ID of the prefix list. Use a prefix list in place of DestinationCidrBlock. You cannot use DestinationPrefixListId and DestinationCidrBlock in the same request.

Return type:

dict

Returns:

Response Syntax

{
    'Route': {
        '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'
    }
}

Response Structure

  • (dict) –

    • Route (dict) –

      Information about the route.

      • DestinationCidrBlock (string) –

        The CIDR block used for destination matches.

      • LocalGatewayVirtualInterfaceGroupId (string) –

        The ID of the virtual interface group.

      • Type (string) –

        The route type.

      • State (string) –

        The state of the route.

      • LocalGatewayRouteTableId (string) –

        The ID of the local gateway route table.

      • LocalGatewayRouteTableArn (string) –

        The Amazon Resource Name (ARN) of the local gateway route table.

      • OwnerId (string) –

        The ID of the Amazon Web Services account that owns the local gateway route.

      • SubnetId (string) –

        The ID of the subnet.

      • CoipPoolId (string) –

        The ID of the customer-owned address pool.

      • NetworkInterfaceId (string) –

        The ID of the network interface.

      • DestinationPrefixListId (string) –

        The ID of the prefix list.