Package software.amazon.awscdk.services.appconfig

Class CfnDeployment

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.appconfig.CfnDeployment
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:55.456Z") @Stability(Stable) public class CfnDeployment extends CfnResource implements IInspectable
A CloudFormation AWS::AppConfig::Deployment.

The AWS::AppConfig::Deployment resource starts a deployment. Starting a deployment in AWS AppConfig calls the StartDeployment API action. This call includes the IDs of the AWS AppConfig application, the environment, the configuration profile, and (optionally) the configuration data version to deploy. The call also includes the ID of the deployment strategy to use, which determines how the configuration data is deployed.

AWS AppConfig monitors the distribution to all hosts and reports status. If a distribution fails, then AWS AppConfig rolls back the configuration.

AWS AppConfig requires that you create resources and deploy a configuration in the following order:

  • Create an application
  • Create an environment
  • Create a configuration profile
  • Create a deployment strategy
  • Deploy the configuration

For more information, see AWS AppConfig in the AWS AppConfig User 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.appconfig.*;
 CfnDeployment cfnDeployment = CfnDeployment.Builder.create(this, "MyCfnDeployment")
         .applicationId("applicationId")
         .configurationProfileId("configurationProfileId")
         .configurationVersion("configurationVersion")
         .deploymentStrategyId("deploymentStrategyId")
         .environmentId("environmentId")
         // the properties below are optional
         .description("description")
         .kmsKeyIdentifier("kmsKeyIdentifier")
         .tags(List.of(TagsProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • 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 Construct scope, @NotNull String id, @NotNull CfnDeploymentProps props)
      Create a new AWS::AppConfig::Deployment.

      Parameters:
      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
      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.

    • getCfnProperties

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

    • getApplicationId

      @Stability(Stable) @NotNull public String getApplicationId()
      The application ID.

    • setApplicationId

      @Stability(Stable) public void setApplicationId(@NotNull String value)
      The application ID.

    • getConfigurationProfileId

      @Stability(Stable) @NotNull public String getConfigurationProfileId()
      The configuration profile ID.

    • setConfigurationProfileId

      @Stability(Stable) public void setConfigurationProfileId(@NotNull String value)
      The configuration profile ID.

    • getConfigurationVersion

      @Stability(Stable) @NotNull public String getConfigurationVersion()
      The configuration version to deploy.

      If deploying an AWS AppConfig hosted configuration version, you can specify either the version number or version label. For all other configurations, you must specify the version number.

    • setConfigurationVersion

      @Stability(Stable) public void setConfigurationVersion(@NotNull String value)
      The configuration version to deploy.

      If deploying an AWS AppConfig hosted configuration version, you can specify either the version number or version label. For all other configurations, you must specify the version number.

    • getDeploymentStrategyId

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

    • setDeploymentStrategyId

      @Stability(Stable) public void setDeploymentStrategyId(@NotNull String value)
      The deployment strategy ID.

    • getEnvironmentId

      @Stability(Stable) @NotNull public String getEnvironmentId()
      The environment ID.

    • setEnvironmentId

      @Stability(Stable) public void setEnvironmentId(@NotNull String value)
      The environment ID.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the deployment.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the deployment.

    • getKmsKeyIdentifier

      @Stability(Stable) @Nullable public String getKmsKeyIdentifier()
      The AWS KMS key identifier (key ID, key alias, or key ARN).

      AWS AppConfig uses this ID to encrypt the configuration data using a customer managed key.

    • setKmsKeyIdentifier

      @Stability(Stable) public void setKmsKeyIdentifier(@Nullable String value)
      The AWS KMS key identifier (key ID, key alias, or key ARN).

      AWS AppConfig uses this ID to encrypt the configuration data using a customer managed key.

    • getTags

      @Stability(Stable) @Nullable public List<CfnDeployment.TagsProperty> getTags()
      Metadata to assign to the deployment.

      Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnDeployment.TagsProperty> value)
      Metadata to assign to the deployment.

      Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.