Package software.amazon.awscdk.services.ec2

Class CfnCarrierGateway

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.CfnCarrierGateway
All Implemented Interfaces:
IInspectable, ICarrierGatewayRef, 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:34.666Z") @Stability(Stable) public class CfnCarrierGateway extends CfnResource implements IInspectable, ICarrierGatewayRef, ITaggable
Creates a carrier gateway.

For more information about carrier gateways, see Carrier gateways in the AWS Wavelength Developer 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.*;
 CfnCarrierGateway cfnCarrierGateway = CfnCarrierGateway.Builder.create(this, "MyCfnCarrierGateway")
         .vpcId("vpcId")
         // the properties below are optional
         .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

    • CfnCarrierGateway

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

    • CfnCarrierGateway

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

    • CfnCarrierGateway

      @Stability(Stable) public CfnCarrierGateway(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCarrierGatewayProps props)
      Create a new AWS::EC2::CarrierGateway.

      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

    • arnForCarrierGateway

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

    • fromCarrierGatewayId

      @Stability(Stable) @NotNull public static ICarrierGatewayRef fromCarrierGatewayId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String carrierGatewayId)
      Creates a new ICarrierGatewayRef from a carrierGatewayId.

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

    • isCfnCarrierGateway

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

      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.

    • getAttrCarrierGatewayId

      @Stability(Stable) @NotNull public String getAttrCarrierGatewayId()
      The ID of the carrier gateway.

    • getAttrOwnerId

      @Stability(Stable) @NotNull public String getAttrOwnerId()
      The AWS account ID of the owner of the carrier gateway.

    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()
      The state of the carrier gateway.

    • getCarrierGatewayRef

      @Stability(Stable) @NotNull public CarrierGatewayReference getCarrierGatewayRef()
      A reference to a CarrierGateway resource.
      Specified by:
      getCarrierGatewayRef in interface ICarrierGatewayRef

    • 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

    • getVpcId

      @Stability(Stable) @NotNull public String getVpcId()
      The ID of the VPC associated with the carrier gateway.

    • setVpcId

      @Stability(Stable) public void setVpcId(@NotNull String value)
      The ID of the VPC associated with the carrier gateway.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags assigned to the carrier gateway.

    • setTagsRaw

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