Package software.amazon.awscdk.services.appconfig

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.appconfig.CfnDeployment
All Implemented Interfaces:
IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-24T21:00:25.164Z") @Stability(Stable) public class CfnDeployment extends CfnResource implements IInspectable, ITaggableV2
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
  • Choose a pre-defined deployment strategy or create your own
  • 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")
         .dynamicExtensionParameters(List.of(DynamicExtensionParametersProperty.builder()
                 .extensionReference("extensionReference")
                 .parameterName("parameterName")
                 .parameterValue("parameterValue")
                 .build()))
         .kmsKeyIdentifier("kmsKeyIdentifier")
         .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.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • 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

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

    • setConfigurationVersion

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

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

    • getDynamicExtensionParameters

      @Stability(Stable) @Nullable public Object getDynamicExtensionParameters()
      A map of dynamic extension parameter names to values to pass to associated extensions with PRE_START_DEPLOYMENT actions.

    • setDynamicExtensionParameters

      @Stability(Stable) public void setDynamicExtensionParameters(@Nullable IResolvable value)
      A map of dynamic extension parameter names to values to pass to associated extensions with PRE_START_DEPLOYMENT actions.

    • setDynamicExtensionParameters

      @Stability(Stable) public void setDynamicExtensionParameters(@Nullable List<Object> value)
      A map of dynamic extension parameter names to values to pass to associated extensions with PRE_START_DEPLOYMENT actions.

    • getKmsKeyIdentifier

      @Stability(Stable) @Nullable public String getKmsKeyIdentifier()
      The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.

    • setKmsKeyIdentifier

      @Stability(Stable) public void setKmsKeyIdentifier(@Nullable String value)
      The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.

    • getTags

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

    • setTags

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