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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.298Z")
 @Stability(value=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")
         .tags(List.of(TagsProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDeployment.Builder A fluent builder for CfnDeployment.
static interface	CfnDeployment.TagsProperty Metadata to assign to the deployment strategy.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDeployment(software.constructs.Construct scope, String id, CfnDeploymentProps props) Create a new `AWS::AppConfig::Deployment`.
protected	CfnDeployment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDeployment(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getApplicationId() The application ID.
protected Map<String,Object>	getCfnProperties()
String	getConfigurationProfileId() The configuration profile ID.
String	getConfigurationVersion() The configuration version to deploy.
String	getDeploymentStrategyId() The deployment strategy ID.
String	getDescription() A description of the deployment.
String	getEnvironmentId() The environment ID.
List<CfnDeployment.TagsProperty>	getTags() Metadata to assign to the deployment.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApplicationId(String value) The application ID.
void	setConfigurationProfileId(String value) The configuration profile ID.
void	setConfigurationVersion(String value) The configuration version to deploy.
void	setDeploymentStrategyId(String value) The deployment strategy ID.
void	setDescription(String value) A description of the deployment.
void	setEnvironmentId(String value) The environment ID.
void	setTags(List<CfnDeployment.TagsProperty> value) Metadata to assign to the deployment.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDeployment

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

CfnDeployment

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

CfnDeployment

@Stability(value=Stable)
public CfnDeployment(@NotNull
                                              software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getApplicationId

@Stability(value=Stable)
 @NotNull
public String getApplicationId()

The application ID.

setApplicationId

@Stability(value=Stable)
public void setApplicationId(@NotNull
                                                      String value)

The application ID.

getConfigurationProfileId

@Stability(value=Stable)
 @NotNull
public String getConfigurationProfileId()

The configuration profile ID.

setConfigurationProfileId

@Stability(value=Stable)
public void setConfigurationProfileId(@NotNull
                                                               String value)

The configuration profile ID.

getConfigurationVersion

@Stability(value=Stable)
 @NotNull
public String getConfigurationVersion()

The configuration version to deploy.

setConfigurationVersion

@Stability(value=Stable)
public void setConfigurationVersion(@NotNull
                                                             String value)

The configuration version to deploy.

getDeploymentStrategyId

@Stability(value=Stable)
 @NotNull
public String getDeploymentStrategyId()

The deployment strategy ID.

setDeploymentStrategyId

@Stability(value=Stable)
public void setDeploymentStrategyId(@NotNull
                                                             String value)

The deployment strategy ID.

getEnvironmentId

@Stability(value=Stable)
 @NotNull
public String getEnvironmentId()

The environment ID.

setEnvironmentId

@Stability(value=Stable)
public void setEnvironmentId(@NotNull
                                                      String value)

The environment ID.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A description of the deployment.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description of the deployment.

getTags

@Stability(value=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(value=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.