Package software.amazon.awscdk.cfnpropertymixins.services.appconfig

Class CfnDeploymentPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.appconfig.CfnDeploymentPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:55.564Z") @Stability(Stable) public class CfnDeploymentPropsMixin extends Mixin implements software.constructs.IMixin
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.cfnpropertymixins.services.appconfig.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnDeploymentPropsMixin cfnDeploymentPropsMixin = CfnDeploymentPropsMixin.Builder.create(CfnDeploymentMixinProps.builder()
         .applicationId("applicationId")
         .configurationProfileId("configurationProfileId")
         .configurationVersion("configurationVersion")
         .deploymentStrategyId("deploymentStrategyId")
         .description("description")
         .dynamicExtensionParameters(List.of(DynamicExtensionParametersProperty.builder()
                 .extensionReference("extensionReference")
                 .parameterName("parameterName")
                 .parameterValue("parameterValue")
                 .build()))
         .environmentId("environmentId")
         .kmsKeyIdentifier("kmsKeyIdentifier")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnDeploymentPropsMixin

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

    • CfnDeploymentPropsMixin

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

    • CfnDeploymentPropsMixin

      @Stability(Stable) public CfnDeploymentPropsMixin(@NotNull CfnDeploymentMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::AppConfig::Deployment.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnDeploymentPropsMixin

      @Stability(Stable) public CfnDeploymentPropsMixin(@NotNull CfnDeploymentMixinProps props)
      Create a mixin to apply properties to AWS::AppConfig::Deployment.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnDeploymentMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()