software.amazon.awscdk.services.appconfig

Class CfnDeployment

java.lang.Object

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

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-18T02:14:03.450Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

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

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnDeployment(Construct scope,
                     java.lang.String id,
                     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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getApplicationId

public java.lang.String getApplicationId()

The application ID.

setApplicationId

public void setApplicationId(java.lang.String value)

The application ID.

getConfigurationProfileId

public java.lang.String getConfigurationProfileId()

The configuration profile ID.

setConfigurationProfileId

public void setConfigurationProfileId(java.lang.String value)

The configuration profile ID.

getConfigurationVersion

public java.lang.String getConfigurationVersion()

The configuration version to deploy.

setConfigurationVersion

public void setConfigurationVersion(java.lang.String value)

The configuration version to deploy.

getDeploymentStrategyId

public java.lang.String getDeploymentStrategyId()

The deployment strategy ID.

setDeploymentStrategyId

public void setDeploymentStrategyId(java.lang.String value)

The deployment strategy ID.

getEnvironmentId

public java.lang.String getEnvironmentId()

The environment ID.

setEnvironmentId

public void setEnvironmentId(java.lang.String value)

The environment ID.

getDescription

public java.lang.String getDescription()

A description of the deployment.

setDescription

public void setDescription(java.lang.String value)

A description of the deployment.

getTags

public java.util.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

public void setTags(java.util.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.