AWS::EC2::LocalGatewayRoute
Creates a static route for the specified local gateway route table. You must specify one of the following targets:
-
LocalGatewayVirtualInterfaceGroupId
-
NetworkInterfaceId
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::EC2::LocalGatewayRoute", "Properties" : { "DestinationCidrBlock" :
String
, "LocalGatewayRouteTableId" :String
, "LocalGatewayVirtualInterfaceGroupId" :String
, "NetworkInterfaceId" :String
} }
YAML
Type: AWS::EC2::LocalGatewayRoute Properties: DestinationCidrBlock:
String
LocalGatewayRouteTableId:String
LocalGatewayVirtualInterfaceGroupId:String
NetworkInterfaceId:String
Properties
DestinationCidrBlock
-
The CIDR block used for destination matches.
Required: No
Type: String
Update requires: Replacement
LocalGatewayRouteTableId
-
The ID of the local gateway route table.
Required: No
Type: String
Update requires: Replacement
LocalGatewayVirtualInterfaceGroupId
-
The ID of the virtual interface group.
Required: No
Type: String
Update requires: No interruption
NetworkInterfaceId
-
The ID of the network interface.
Required: No
Type: String
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the ID of the local gateway route table and its destination address range. For example:
{ "Ref": "lgw-rtb-12346789abcdef|10.0.0.0/24" }
For more information about using the Ref
function, see Ref
.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt
.
State
-
The state of the local gateway route table.
Type
-
The type of local gateway route.
See also
-
Local gateway in AWS Outposts User Guide
-
CreateLocalGatewayRouteTable in the Amazon EC2 API Reference