This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::AppConfig::Deployment
<a name="aws-resource-appconfig-deployment"></a>

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:

1. Create an application

1. Create an environment

1. Create a configuration profile

1. Choose a pre-defined deployment strategy or create your own

1. Deploy the configuration

For more information, see [AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) in the *AWS AppConfig User Guide*.

## Syntax
<a name="aws-resource-appconfig-deployment-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-appconfig-deployment-syntax.json"></a>

```
{
  "Type" : "AWS::AppConfig::Deployment",
  "Properties" : {
      "[ApplicationId](#cfn-appconfig-deployment-applicationid)" : String,
      "[ConfigurationProfileId](#cfn-appconfig-deployment-configurationprofileid)" : String,
      "[ConfigurationVersion](#cfn-appconfig-deployment-configurationversion)" : String,
      "[DeploymentStrategyId](#cfn-appconfig-deployment-deploymentstrategyid)" : String,
      "[Description](#cfn-appconfig-deployment-description)" : String,
      "[DynamicExtensionParameters](#cfn-appconfig-deployment-dynamicextensionparameters)" : [ DynamicExtensionParameters, ... ],
      "[EnvironmentId](#cfn-appconfig-deployment-environmentid)" : String,
      "[KmsKeyIdentifier](#cfn-appconfig-deployment-kmskeyidentifier)" : String,
      "[Tags](#cfn-appconfig-deployment-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-appconfig-deployment-syntax.yaml"></a>

```
Type: AWS::AppConfig::Deployment
Properties:
  [ApplicationId](#cfn-appconfig-deployment-applicationid): String
  [ConfigurationProfileId](#cfn-appconfig-deployment-configurationprofileid): String
  [ConfigurationVersion](#cfn-appconfig-deployment-configurationversion): String
  [DeploymentStrategyId](#cfn-appconfig-deployment-deploymentstrategyid): String
  [Description](#cfn-appconfig-deployment-description): String
  [DynamicExtensionParameters](#cfn-appconfig-deployment-dynamicextensionparameters): 
    - DynamicExtensionParameters
  [EnvironmentId](#cfn-appconfig-deployment-environmentid): String
  [KmsKeyIdentifier](#cfn-appconfig-deployment-kmskeyidentifier): String
  [Tags](#cfn-appconfig-deployment-tags): 
    - Tag
```

## Properties
<a name="aws-resource-appconfig-deployment-properties"></a>

`ApplicationId`  <a name="cfn-appconfig-deployment-applicationid"></a>
The application ID.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[a-z0-9]{4,7}`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ConfigurationProfileId`  <a name="cfn-appconfig-deployment-configurationprofileid"></a>
The configuration profile ID.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[a-z0-9]{4,7}`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ConfigurationVersion`  <a name="cfn-appconfig-deployment-configurationversion"></a>
The configuration version to deploy. If deploying an AWS AppConfig hosted configuration version, you can specify either the version number or version label. For all other configurations, you must specify the version number.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DeploymentStrategyId`  <a name="cfn-appconfig-deployment-deploymentstrategyid"></a>
The deployment strategy ID.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[a-z0-9]{4,7}`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Description`  <a name="cfn-appconfig-deployment-description"></a>
A description of the deployment.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `1024`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DynamicExtensionParameters`  <a name="cfn-appconfig-deployment-dynamicextensionparameters"></a>
A map of dynamic extension parameter names to values to pass to associated extensions with `PRE_START_DEPLOYMENT` actions.  
*Required*: No  
*Type*: [Array](aws-properties-appconfig-deployment-dynamicextensionparameters.md) of [DynamicExtensionParameters](aws-properties-appconfig-deployment-dynamicextensionparameters.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`EnvironmentId`  <a name="cfn-appconfig-deployment-environmentid"></a>
The environment ID.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[a-z0-9]{4,7}`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`KmsKeyIdentifier`  <a name="cfn-appconfig-deployment-kmskeyidentifier"></a>
The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-appconfig-deployment-tags"></a>
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.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-appconfig-deployment-tag.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-appconfig-deployment-return-values"></a>

### Ref
<a name="aws-resource-appconfig-deployment-return-values-ref"></a>

### Fn::GetAtt
<a name="aws-resource-appconfig-deployment-return-values-fn--getatt"></a>

#### 
<a name="aws-resource-appconfig-deployment-return-values-fn--getatt-fn--getatt"></a>

`DeploymentNumber`  <a name="DeploymentNumber-fn::getatt"></a>
The sequence number of the deployment.

`State`  <a name="State-fn::getatt"></a>
The state of the deployment.

## Examples
<a name="aws-resource-appconfig-deployment--examples"></a>



### AWS AppConfig deployment example
<a name="aws-resource-appconfig-deployment--examples--deployment_example"></a>

The following example creates an AWS AppConfig 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. 

#### JSON
<a name="aws-resource-appconfig-deployment--examples--deployment_example--json"></a>

```
Resources": {
    "BasicDeployment": {
      "Type": "AWS::AppConfig::Deployment",
      "DependsOn": [
        "MyTestApplication",
        "MyTestConfigurationProfile",
        "MyTestEnvironment",
        "MyTestDeploymentStrategy"
      ],
      "Properties": {
        "ApplicationId": MyTestApplication,
        "EnvironmentId": MyTestEnvironment,
        "DeploymentStrategyId": MyTestDeploymentStrategy,
        "ConfigurationProfileId": MyTestConfigurationProfile,
        "ConfigurationVersion": "1",
        "Description": "My test deployment",
        "Tags": [
          {
            "Key": "Env",
            "Value": "test"
          }
        ]
      }
    }
  }
}
```

#### YAML
<a name="aws-resource-appconfig-deployment--examples--deployment_example--yaml"></a>

```
Resources:
  BasicDeployment:
    Type: AWS::AppConfig::Deployment
    Properties:
      ApplicationId: !Ref MyTestApplication
      EnvironmentId: !Ref MyTestEnvironment
      DeploymentStrategyId: !Ref MyTestDeploymentStrategy
      ConfigurationProfileId: !Ref MyTestConfigurationProfile
      ConfigurationVersion: '1'
      Description: 'My test deployment'
      Tags:
        - Key: Env
          Value: test
```

## See also
<a name="aws-resource-appconfig-deployment--seealso"></a>
+  [AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) 
+  [Deploying a configuration](https://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig-deploying.html) 

# AWS::AppConfig::Deployment DynamicExtensionParameters
<a name="aws-properties-appconfig-deployment-dynamicextensionparameters"></a>

A map of dynamic extension parameter names to values to pass to associated extensions with `PRE_START_DEPLOYMENT` actions.

## Syntax
<a name="aws-properties-appconfig-deployment-dynamicextensionparameters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-appconfig-deployment-dynamicextensionparameters-syntax.json"></a>

```
{
  "[ExtensionReference](#cfn-appconfig-deployment-dynamicextensionparameters-extensionreference)" : String,
  "[ParameterName](#cfn-appconfig-deployment-dynamicextensionparameters-parametername)" : String,
  "[ParameterValue](#cfn-appconfig-deployment-dynamicextensionparameters-parametervalue)" : String
}
```

### YAML
<a name="aws-properties-appconfig-deployment-dynamicextensionparameters-syntax.yaml"></a>

```
  [ExtensionReference](#cfn-appconfig-deployment-dynamicextensionparameters-extensionreference): String
  [ParameterName](#cfn-appconfig-deployment-dynamicextensionparameters-parametername): String
  [ParameterValue](#cfn-appconfig-deployment-dynamicextensionparameters-parametervalue): String
```

## Properties
<a name="aws-properties-appconfig-deployment-dynamicextensionparameters-properties"></a>

`ExtensionReference`  <a name="cfn-appconfig-deployment-dynamicextensionparameters-extensionreference"></a>
The ARN or ID of the extension for which you are inserting a dynamic parameter.  
*Required*: No  
*Type*: String  
*Pattern*: `arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+`  
*Minimum*: `20`  
*Maximum*: `2048`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ParameterName`  <a name="cfn-appconfig-deployment-dynamicextensionparameters-parametername"></a>
The parameter name.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ParameterValue`  <a name="cfn-appconfig-deployment-dynamicextensionparameters-parametervalue"></a>
The parameter value.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::AppConfig::Deployment Tag
<a name="aws-properties-appconfig-deployment-tag"></a>

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.

## Syntax
<a name="aws-properties-appconfig-deployment-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-appconfig-deployment-tag-syntax.json"></a>

```
{
  "[Key](#cfn-appconfig-deployment-tag-key)" : String,
  "[Value](#cfn-appconfig-deployment-tag-value)" : String
}
```

### YAML
<a name="aws-properties-appconfig-deployment-tag-syntax.yaml"></a>

```
  [Key](#cfn-appconfig-deployment-tag-key): String
  [Value](#cfn-appconfig-deployment-tag-value): String
```

## Properties
<a name="aws-properties-appconfig-deployment-tag-properties"></a>

`Key`  <a name="cfn-appconfig-deployment-tag-key"></a>
The tag key.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Value`  <a name="cfn-appconfig-deployment-tag-value"></a>
An optional tag value.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)