Package software.amazon.awscdk.services.apigatewayv2

Class CfnDeployment

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.apigatewayv2.CfnDeployment
All Implemented Interfaces:
IEnvironmentAware, IInspectable, IDeploymentRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:39:57.504Z") @Stability(Stable) public class CfnDeployment extends CfnResource implements IInspectable, IDeploymentRef
The AWS::ApiGatewayV2::Deployment resource creates a deployment for an API.

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.apigatewayv2.*;
 CfnDeployment cfnDeployment = CfnDeployment.Builder.create(this, "MyCfnDeployment")
         .apiId("apiId")
         // the properties below are optional
         .description("description")
         .stageName("stageName")
         .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

    • CfnDeployment

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

    • CfnDeployment

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

    • CfnDeployment

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

    • 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.

    • getAttrDeploymentId

      @Stability(Stable) @NotNull public String getAttrDeploymentId()
      The deployment ID.

    • getCfnProperties

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

    • getDeploymentRef

      @Stability(Stable) @NotNull public DeploymentReference getDeploymentRef()
      A reference to a Deployment resource.
      Specified by:
      getDeploymentRef in interface IDeploymentRef

    • getApiId

      @Stability(Stable) @NotNull public String getApiId()
      The API identifier.

    • setApiId

      @Stability(Stable) public void setApiId(@NotNull String value)
      The API identifier.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description for the deployment resource.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description for the deployment resource.

    • getStageName

      @Stability(Stable) @Nullable public String getStageName()
      The name of an existing stage to associate with the deployment.

    • setStageName

      @Stability(Stable) public void setStageName(@Nullable String value)
      The name of an existing stage to associate with the deployment.