Package software.amazon.awscdk.services.ec2

Class CfnVPNGateway

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.CfnVPNGateway
All Implemented Interfaces:
IInspectable, IVPNGatewayRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:35.188Z") @Stability(Stable) public class CfnVPNGateway extends CfnResource implements IInspectable, IVPNGatewayRef, ITaggable
Specifies a virtual private gateway.

A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide .

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.*;
 CfnVPNGateway cfnVPNGateway = CfnVPNGateway.Builder.create(this, "MyCfnVPNGateway")
         .type("type")
         // the properties below are optional
         .amazonSideAsn(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

    • CfnVPNGateway

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

    • CfnVPNGateway

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

    • CfnVPNGateway

      @Stability(Stable) public CfnVPNGateway(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnVPNGatewayProps props)
      Create a new AWS::EC2::VPNGateway.

      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

    • arnForVPNGateway

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

    • fromVpnGatewayId

      @Stability(Stable) @NotNull public static IVPNGatewayRef fromVpnGatewayId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String vpnGatewayId)
      Creates a new IVPNGatewayRef from a vpnGatewayId.

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

    • isCfnVPNGateway

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

      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.

    • getAttrVpnGatewayId

      @Stability(Stable) @NotNull public String getAttrVpnGatewayId()
      The ID of the VPN gateway.

    • getCfnProperties

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

    • getTags

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

    • getVpnGatewayRef

      @Stability(Stable) @NotNull public VPNGatewayReference getVpnGatewayRef()
      A reference to a VPNGateway resource.
      Specified by:
      getVpnGatewayRef in interface IVPNGatewayRef

    • getType

      @Stability(Stable) @NotNull public String getType()
      The type of VPN connection the virtual private gateway supports.

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      The type of VPN connection the virtual private gateway supports.

    • getAmazonSideAsn

      @Stability(Stable) @Nullable public Number getAmazonSideAsn()
      The private Autonomous System Number (ASN) for the Amazon side of a BGP session.

    • setAmazonSideAsn

      @Stability(Stable) public void setAmazonSideAsn(@Nullable Number value)
      The private Autonomous System Number (ASN) for the Amazon side of a BGP session.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Any tags assigned to the virtual private gateway.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Any tags assigned to the virtual private gateway.