Package software.amazon.awscdk.services.ec2

Class CfnLocalGatewayVirtualInterface

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ec2.CfnLocalGatewayVirtualInterface
All Implemented Interfaces:
IInspectable, ILocalGatewayVirtualInterfaceRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:34.901Z") @Stability(Stable) public class CfnLocalGatewayVirtualInterface extends CfnResource implements IInspectable, ILocalGatewayVirtualInterfaceRef, ITaggableV2
Describes a local gateway virtual interface.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 CfnLocalGatewayVirtualInterface cfnLocalGatewayVirtualInterface = CfnLocalGatewayVirtualInterface.Builder.create(this, "MyCfnLocalGatewayVirtualInterface")
         .localAddress("localAddress")
         .localGatewayVirtualInterfaceGroupId("localGatewayVirtualInterfaceGroupId")
         .outpostLagId("outpostLagId")
         .peerAddress("peerAddress")
         .vlan(123)
         // the properties below are optional
         .peerBgpAsn(123)
         .peerBgpAsnExtended(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnLocalGatewayVirtualInterface

      protected CfnLocalGatewayVirtualInterface(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnLocalGatewayVirtualInterface

      protected CfnLocalGatewayVirtualInterface(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnLocalGatewayVirtualInterface

      @Stability(Stable) public CfnLocalGatewayVirtualInterface(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnLocalGatewayVirtualInterfaceProps props)
      Create a new AWS::EC2::LocalGatewayVirtualInterface.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForLocalGatewayVirtualInterface

      @Stability(Stable) @NotNull public static String arnForLocalGatewayVirtualInterface(@NotNull ILocalGatewayVirtualInterfaceRef resource)
      Parameters:
      resource - This parameter is required.

    • fromLocalGatewayVirtualInterfaceId

      @Stability(Stable) @NotNull public static ILocalGatewayVirtualInterfaceRef fromLocalGatewayVirtualInterfaceId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String localGatewayVirtualInterfaceId)
      Creates a new ILocalGatewayVirtualInterfaceRef from a localGatewayVirtualInterfaceId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      localGatewayVirtualInterfaceId - This parameter is required.

    • isCfnLocalGatewayVirtualInterface

      @Stability(Stable) @NotNull public static Boolean isCfnLocalGatewayVirtualInterface(@NotNull Object x)
      Checks whether the given object is a CfnLocalGatewayVirtualInterface.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrConfigurationState

      @Stability(Stable) @NotNull public String getAttrConfigurationState()
      The current state of the local gateway virtual interface.

    • getAttrLocalBgpAsn

      @Stability(Stable) @NotNull public Number getAttrLocalBgpAsn()
      The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.

    • getAttrLocalGatewayId

      @Stability(Stable) @NotNull public String getAttrLocalGatewayId()
      The ID of the local gateway.

    • getAttrLocalGatewayVirtualInterfaceId

      @Stability(Stable) @NotNull public String getAttrLocalGatewayVirtualInterfaceId()
      The ID of the virtual interface.

    • getAttrOwnerId

      @Stability(Stable) @NotNull public String getAttrOwnerId()
      The ID of the AWS account that owns the local gateway virtual interface.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getLocalGatewayVirtualInterfaceRef

      @Stability(Stable) @NotNull public LocalGatewayVirtualInterfaceReference getLocalGatewayVirtualInterfaceRef()
      A reference to a LocalGatewayVirtualInterface resource.
      Specified by:
      getLocalGatewayVirtualInterfaceRef in interface ILocalGatewayVirtualInterfaceRef

    • getLocalAddress

      @Stability(Stable) @NotNull public String getLocalAddress()
      The local address.

    • setLocalAddress

      @Stability(Stable) public void setLocalAddress(@NotNull String value)
      The local address.

    • getLocalGatewayVirtualInterfaceGroupId

      @Stability(Stable) @NotNull public String getLocalGatewayVirtualInterfaceGroupId()
      The ID of the local gateway virtual interface group.

    • setLocalGatewayVirtualInterfaceGroupId

      @Stability(Stable) public void setLocalGatewayVirtualInterfaceGroupId(@NotNull String value)
      The ID of the local gateway virtual interface group.

    • getOutpostLagId

      @Stability(Stable) @NotNull public String getOutpostLagId()
      The Outpost LAG ID.

    • setOutpostLagId

      @Stability(Stable) public void setOutpostLagId(@NotNull String value)
      The Outpost LAG ID.

    • getPeerAddress

      @Stability(Stable) @NotNull public String getPeerAddress()
      The peer address.

    • setPeerAddress

      @Stability(Stable) public void setPeerAddress(@NotNull String value)
      The peer address.

    • getVlan

      @Stability(Stable) @NotNull public Number getVlan()
      The ID of the VLAN.

    • setVlan

      @Stability(Stable) public void setVlan(@NotNull Number value)
      The ID of the VLAN.

    • getPeerBgpAsn

      @Stability(Stable) @Nullable public Number getPeerBgpAsn()
      The peer BGP ASN.

    • setPeerBgpAsn

      @Stability(Stable) public void setPeerBgpAsn(@Nullable Number value)
      The peer BGP ASN.

    • getPeerBgpAsnExtended

      @Stability(Stable) @Nullable public Number getPeerBgpAsnExtended()
      The extended 32-bit ASN of the BGP peer for use with larger ASN values.

    • setPeerBgpAsnExtended

      @Stability(Stable) public void setPeerBgpAsnExtended(@Nullable Number value)
      The extended 32-bit ASN of the BGP peer for use with larger ASN values.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags assigned to the virtual interface.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags assigned to the virtual interface.