This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html). # 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 CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::EC2::LocalGatewayRoute", "Properties" : { "[DestinationCidrBlock](#cfn-ec2-localgatewayroute-destinationcidrblock)" : {{String}}, "[LocalGatewayRouteTableId](#cfn-ec2-localgatewayroute-localgatewayroutetableid)" : {{String}}, "[LocalGatewayVirtualInterfaceGroupId](#cfn-ec2-localgatewayroute-localgatewayvirtualinterfacegroupid)" : {{String}}, "[NetworkInterfaceId](#cfn-ec2-localgatewayroute-networkinterfaceid)" : {{String}} } } ``` ### YAML ``` Type: AWS::EC2::LocalGatewayRoute Properties: [DestinationCidrBlock](#cfn-ec2-localgatewayroute-destinationcidrblock): {{String}} [LocalGatewayRouteTableId](#cfn-ec2-localgatewayroute-localgatewayroutetableid): {{String}} [LocalGatewayVirtualInterfaceGroupId](#cfn-ec2-localgatewayroute-localgatewayvirtualinterfacegroupid): {{String}} [NetworkInterfaceId](#cfn-ec2-localgatewayroute-networkinterfaceid): {{String}} ``` ## Properties `DestinationCidrBlock` The CIDR block used for destination matches. *Required*: No *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `LocalGatewayRouteTableId` The ID of the local gateway route table. *Required*: No *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `LocalGatewayVirtualInterfaceGroupId` The ID of the virtual interface group. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NetworkInterfaceId` The ID of the network interface. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## 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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### 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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `State` The state of the local gateway route table. `Type` The type of local gateway route. ## See also + [Local gateway](https://docs.aws.amazon.com/outposts/latest/userguide/outposts-local-gateways.html) in *AWS Outposts User Guide* + [CreateLocalGatewayRouteTable](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLocalGatewayRoute.html) in the *Amazon EC2 API Reference*