Package software.amazon.awscdk.services.launchwizard

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.launchwizard.CfnDeployment
All Implemented Interfaces:
IInspectable, ITaggableV2, IDeploymentRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:42.810Z") @Stability(Stable) public class CfnDeployment extends CfnResource implements IInspectable, IDeploymentRef, ITaggableV2
Creates a deployment for the given workload.

Deployments created by this operation are not available in the Launch Wizard console to use the Clone deployment action on.

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.launchwizard.*;
 CfnDeployment cfnDeployment = CfnDeployment.Builder.create(this, "MyCfnDeployment")
         .deploymentPatternName("deploymentPatternName")
         .name("name")
         .workloadName("workloadName")
         // the properties below are optional
         .specifications(Map.of(
                 "specificationsKey", "specifications"))
         .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

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

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the deployment.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The time the deployment was created.

    • getAttrDeletedAt

      @Stability(Stable) @NotNull public String getAttrDeletedAt()
      The time the deployment was deleted.

    • getAttrDeploymentId

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

    • getAttrResourceGroup

      @Stability(Stable) @NotNull public String getAttrResourceGroup()
      The resource group of the deployment.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the deployment.

    • getCdkTagManager

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

    • 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

    • getDeploymentPatternName

      @Stability(Stable) @NotNull public String getDeploymentPatternName()
      The name of the deployment pattern.

    • setDeploymentPatternName

      @Stability(Stable) public void setDeploymentPatternName(@NotNull String value)
      The name of the deployment pattern.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the deployment.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the deployment.

    • getWorkloadName

      @Stability(Stable) @NotNull public String getWorkloadName()
      The name of the workload.

    • setWorkloadName

      @Stability(Stable) public void setWorkloadName(@NotNull String value)
      The name of the workload.

    • getSpecifications

      @Stability(Stable) @Nullable public Object getSpecifications()
      The settings specified for the deployment.

      Returns union: either Mapinvalid input: '<'String, String> or IResolvable

    • setSpecifications

      @Stability(Stable) public void setSpecifications(@Nullable Map<String,String> value)
      The settings specified for the deployment.

    • setSpecifications

      @Stability(Stable) public void setSpecifications(@Nullable IResolvable value)
      The settings specified for the deployment.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Information about the tags attached to a deployment.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Information about the tags attached to a deployment.