Class CfnDeployment

All Implemented Interfaces:
IConstruct, IDependable, IInspectable,, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.179Z") @Stability(Stable) public class CfnDeployment extends CfnResource implements IInspectable
A CloudFormation AWS::ApiGatewayV2::Deployment.

The AWS::ApiGatewayV2::Deployment resource creates a deployment for an API.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 CfnDeployment cfnDeployment = CfnDeployment.Builder.create(this, "MyCfnDeployment")
         // the properties below are optional
  • Field Details


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

    • CfnDeployment

      protected CfnDeployment( objRef)
    • CfnDeployment

      protected CfnDeployment( initializationMode)
    • CfnDeployment

      @Stability(Stable) public CfnDeployment(@NotNull Construct scope, @NotNull String id, @NotNull CfnDeploymentProps props)
      Create a new AWS::ApiGatewayV2::Deployment.

      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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
      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)
      renderProperties in class CfnResource
      props - This parameter is required.
    • getAttrDeploymentId

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

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      getCfnProperties in class CfnResource
    • 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.