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.
AWS::EC2::LocalGatewayVirtualInterface
Describes a local gateway virtual interface.
Syntax
To declare this entity in your CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::EC2::LocalGatewayVirtualInterface", "Properties" : { "LocalAddress" :String, "LocalGatewayVirtualInterfaceGroupId" :String, "OutpostLagId" :String, "PeerAddress" :String, "PeerBgpAsn" :Integer, "PeerBgpAsnExtended" :Integer, "Tags" :[ Tag, ... ], "Vlan" :Integer} }
YAML
Type: AWS::EC2::LocalGatewayVirtualInterface Properties: LocalAddress:StringLocalGatewayVirtualInterfaceGroupId:StringOutpostLagId:StringPeerAddress:StringPeerBgpAsn:IntegerPeerBgpAsnExtended:IntegerTags:- TagVlan:Integer
Properties
LocalAddress-
The local address.
Required: Yes
Type: String
Update requires: Replacement
LocalGatewayVirtualInterfaceGroupId-
The ID of the local gateway virtual interface group.
Required: Yes
Type: String
Update requires: Replacement
OutpostLagId-
The Outpost LAG ID.
Required: Yes
Type: String
Update requires: Replacement
PeerAddress-
The peer address.
Required: Yes
Type: String
Update requires: Replacement
PeerBgpAsn-
The peer BGP ASN.
Required: No
Type: Integer
Update requires: Replacement
PeerBgpAsnExtended-
The extended 32-bit ASN of the BGP peer for use with larger ASN values.
Required: No
Type: Integer
Update requires: Replacement
-
The tags assigned to the virtual interface.
Required: No
Type: Array of Tag
Update requires: No interruption
Vlan-
The ID of the VLAN.
Required: Yes
Type: Integer
Update requires: Replacement
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 virtual interface. For example:
{ "Ref": "lgw-vif-07145b276bEXAMPLE" }
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.
ConfigurationState-
The current state of the local gateway virtual interface.
LocalBgpAsn-
The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
LocalGatewayId-
The ID of the local gateway.
LocalGatewayVirtualInterfaceId-
The ID of the virtual interface.
OwnerId-
The ID of the AWS account that owns the local gateway virtual interface.
Warning Javascript is disabled or is unavailable in your browser.
To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.