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::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](#cfn-ec2-localgatewayvirtualinterface-localaddress)" : {{String}}, "[LocalGatewayVirtualInterfaceGroupId](#cfn-ec2-localgatewayvirtualinterface-localgatewayvirtualinterfacegroupid)" : {{String}}, "[OutpostLagId](#cfn-ec2-localgatewayvirtualinterface-outpostlagid)" : {{String}}, "[PeerAddress](#cfn-ec2-localgatewayvirtualinterface-peeraddress)" : {{String}}, "[PeerBgpAsn](#cfn-ec2-localgatewayvirtualinterface-peerbgpasn)" : {{Integer}}, "[PeerBgpAsnExtended](#cfn-ec2-localgatewayvirtualinterface-peerbgpasnextended)" : {{Integer}}, "[Tags](#cfn-ec2-localgatewayvirtualinterface-tags)" : {{[ Tag, ... ]}}, "[Vlan](#cfn-ec2-localgatewayvirtualinterface-vlan)" : {{Integer}} } } ``` ### YAML ``` Type: AWS::EC2::LocalGatewayVirtualInterface Properties: [LocalAddress](#cfn-ec2-localgatewayvirtualinterface-localaddress): {{String}} [LocalGatewayVirtualInterfaceGroupId](#cfn-ec2-localgatewayvirtualinterface-localgatewayvirtualinterfacegroupid): {{String}} [OutpostLagId](#cfn-ec2-localgatewayvirtualinterface-outpostlagid): {{String}} [PeerAddress](#cfn-ec2-localgatewayvirtualinterface-peeraddress): {{String}} [PeerBgpAsn](#cfn-ec2-localgatewayvirtualinterface-peerbgpasn): {{Integer}} [PeerBgpAsnExtended](#cfn-ec2-localgatewayvirtualinterface-peerbgpasnextended): {{Integer}} [Tags](#cfn-ec2-localgatewayvirtualinterface-tags): {{ - Tag}} [Vlan](#cfn-ec2-localgatewayvirtualinterface-vlan): {{Integer}} ``` ## Properties `LocalAddress` The local address. *Required*: Yes *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 local gateway virtual interface group. *Required*: Yes *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `OutpostLagId` The Outpost LAG ID. *Required*: Yes *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `PeerAddress` The peer address. *Required*: Yes *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `PeerBgpAsn` The peer BGP ASN. *Required*: No *Type*: Integer *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `PeerBgpAsnExtended` The extended 32-bit ASN of the BGP peer for use with larger ASN values. *Required*: No *Type*: Integer *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Tags` The tags assigned to the virtual interface. *Required*: No *Type*: Array of [Tag](aws-properties-ec2-localgatewayvirtualinterface-tag.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Vlan` The ID of the VLAN. *Required*: Yes *Type*: Integer *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-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 [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). #### `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.

AltStyle によって変換されたページ (->オリジナル) /