AWS::EC2::LocalGatewayVirtualInterface

EC2 LocalGatewayVirtualInterface

Resource Type definition for Local Gateway Virtual Interface which describes a virtual interface for AWS Outposts local gateways.

Properties

8 configurable properties. 5 required. Click a row to see details.

Filter:

Property	Type	Flags
`LocalAddress`	`string`	RequiredCreate-only
`LocalGatewayVirtualInterfaceGroupId`	`string`	RequiredCreate-only
`OutpostLagId`	`string`	RequiredCreate-only
`PeerAddress`	`string`	RequiredCreate-only
`Vlan`	`integer`	RequiredCreate-only
`PeerBgpAsn`	`integer`	Create-only
`PeerBgpAsnExtended`	`integer`	Create-only
`Tags`	`Array<Tag>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`ConfigurationState`	`string`	The current state of the local gateway virtual interface
`LocalBgpAsn`	`integer`	The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP)
`LocalGatewayId`	`string`	The ID of the local gateway
`LocalGatewayVirtualInterfaceId`	`string`	The ID of the virtual interface
`OwnerId`	`string`	The ID of the Amazon Web Services account that owns the local gateway virtual interface group

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::EC2::LocalGatewayVirtualInterface

Resources:
  MyResource:
    Type: AWS::EC2::LocalGatewayVirtualInterface
    Properties:
      OutpostLagId: "my-outpostlagid"
      LocalGatewayVirtualInterfaceGroupId: "my-localgatewayvirtualinterfacegroupid"
      Vlan: 1
      LocalAddress: "value"
      PeerAddress: "value"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

ec2:CreateLocalGatewayVirtualInterfaceec2:DescribeLocalGatewayVirtualInterfacesec2:CreateTags

read

ec2:DescribeLocalGatewayVirtualInterfacesec2:DescribeTags

update

ec2:DescribeLocalGatewayVirtualInterfacesec2:CreateTagsec2:DeleteTagsec2:DescribeTags

delete

ec2:DeleteLocalGatewayVirtualInterfaceec2:DescribeLocalGatewayVirtualInterfacesec2:DeleteTags

list

ec2:DescribeLocalGatewayVirtualInterfaces

Get the EC2 Cheat Sheet

Everything you need to know about EC2 on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceEC2

Properties13

Required5

TaggingSupported

Primary IDLocalGatewayVirtualInterfaceId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

LocalGatewayVirtualInterfaceGroupIdOutpostLagIdVlanLocalAddressPeerAddressPeerBgpAsnPeerBgpAsnExtended

Related Resources

External Links

AWS Documentation