Package software.amazon.awscdk.services.ec2

Class CfnCustomerGateway

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.CfnCustomerGateway
All Implemented Interfaces:
IInspectable, ITaggable, ICustomerGatewayRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:35.425Z") @Stability(Stable) public class CfnCustomerGateway extends CfnResource implements IInspectable, ICustomerGatewayRef, ITaggable
Specifies a customer gateway.

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.*;
 CfnCustomerGateway cfnCustomerGateway = CfnCustomerGateway.Builder.create(this, "MyCfnCustomerGateway")
         .ipAddress("ipAddress")
         .type("type")
         // the properties below are optional
         .bgpAsn(123)
         .bgpAsnExtended(123)
         .certificateArn("certificateArn")
         .deviceName("deviceName")
         .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

    • CfnCustomerGateway

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

    • CfnCustomerGateway

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

    • CfnCustomerGateway

      @Stability(Stable) public CfnCustomerGateway(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCustomerGatewayProps props)
      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

    • fromCustomerGatewayId

      @Stability(Stable) @NotNull public static ICustomerGatewayRef fromCustomerGatewayId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String customerGatewayId)
      Creates a new ICustomerGatewayRef from a customerGatewayId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      customerGatewayId - 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.

    • getAttrCustomerGatewayId

      @Stability(Stable) @NotNull public String getAttrCustomerGatewayId()
      The ID of the customer gateway.

    • getCfnProperties

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

    • getCustomerGatewayRef

      @Stability(Stable) @NotNull public CustomerGatewayReference getCustomerGatewayRef()
      A reference to a CustomerGateway resource.
      Specified by:
      getCustomerGatewayRef in interface ICustomerGatewayRef

    • getTags

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

    • getIpAddress

      @Stability(Stable) @NotNull public String getIpAddress()
      The IP address for the customer gateway device's outside interface.

    • setIpAddress

      @Stability(Stable) public void setIpAddress(@NotNull String value)
      The IP address for the customer gateway device's outside interface.

    • getType

      @Stability(Stable) @NotNull public String getType()
      The type of VPN connection that this customer gateway supports ( ipsec.1 ).

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      The type of VPN connection that this customer gateway supports ( ipsec.1 ).

    • getBgpAsn

      @Stability(Stable) @Nullable public Number getBgpAsn()
      For customer gateway devices that support BGP, specify the device's ASN.

    • setBgpAsn

      @Stability(Stable) public void setBgpAsn(@Nullable Number value)
      For customer gateway devices that support BGP, specify the device's ASN.

    • getBgpAsnExtended

      @Stability(Stable) @Nullable public Number getBgpAsnExtended()
      For customer gateway devices that support BGP, specify the device's ASN.

    • setBgpAsnExtended

      @Stability(Stable) public void setBgpAsnExtended(@Nullable Number value)
      For customer gateway devices that support BGP, specify the device's ASN.

    • getCertificateArn

      @Stability(Stable) @Nullable public String getCertificateArn()
      The Amazon Resource Name (ARN) for the customer gateway certificate.

    • setCertificateArn

      @Stability(Stable) public void setCertificateArn(@Nullable String value)
      The Amazon Resource Name (ARN) for the customer gateway certificate.

    • getDeviceName

      @Stability(Stable) @Nullable public String getDeviceName()
      The name of customer gateway device.

    • setDeviceName

      @Stability(Stable) public void setDeviceName(@Nullable String value)
      The name of customer gateway device.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      One or more tags for the customer gateway.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      One or more tags for the customer gateway.