@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)", date="2022-06-22T23:27:49.600Z") public class CfnDeployment extends CfnResource implements IInspectable
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:
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnDeployment(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnDeployment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnDeployment(Construct scope, java.lang.String id, CfnDeploymentProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getApplicationId()
public void setApplicationId(java.lang.String value)
public java.lang.String getConfigurationProfileId()
public void setConfigurationProfileId(java.lang.String value)
public java.lang.String getConfigurationVersion()
public void setConfigurationVersion(java.lang.String value)
public java.lang.String getDeploymentStrategyId()
public void setDeploymentStrategyId(java.lang.String value)
public java.lang.String getEnvironmentId()
public void setEnvironmentId(java.lang.String value)
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.util.List<CfnDeployment.TagsProperty> getTags()
Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
public void setTags(java.util.List<CfnDeployment.TagsProperty> value)
Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.