AWS AppConfig Deployment

This page shows how to write Terraform and CloudFormation for AppConfig Deployment and write them securely.

aws_appconfig_deployment (Terraform)

The Deployment in AppConfig can be configured in Terraform with the resource name aws_appconfig_deployment. The following sections describe 1 example of how to use the resource and its parameters.

Example Usage from GitHub
resource "aws_appconfig_deployment" "this" {
  application_id           =
  environment_id           = aws_appconfig_environment.this.environment_id
  configuration_profile_id = aws_appconfig_configuration_profile.this.configuration_profile_id
  configuration_version    = aws_appconfig_hosted_configuration_version.current.version_number
  deployment_strategy_id   =

Review your Terraform file for AWS best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).


The following arguments are supported:

  • application_id - (Required, Forces new resource) The application ID. Must be between 4 and 7 characters in length.
  • configuration_profile_id - (Required, Forces new resource) The configuration profile ID. Must be between 4 and 7 characters in length.
  • configuration_version - (Required, Forces new resource) The configuration version to deploy. Can be at most 1024 characters.
  • deployment_strategy_id - (Required, Forces new resource) The deployment strategy ID or name of a predefined deployment strategy. See Predefined Deployment Strategies for more details.
  • description - (Optional, Forces new resource) The description of the deployment. Can be at most 1024 characters.
  • environment_id - (Required, Forces new resource) The environment ID. Must be between 4 and 7 characters in length.
  • tags - (Optional) A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

In addition to all arguments above, the following attributes are exported:

  • id - The AppConfig application ID, environment ID, and deployment number separated by a slash (/).
  • arn - The Amazon Resource Name (ARN) of the AppConfig Deployment.
  • deployment_number - The deployment number.
  • state - The state of the deployment.
  • tags_all - A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Explanation in Terraform Registry

Provides an AppConfig Deployment resource for an aws_appconfig_application resource.

AWS::AppConfig::Deployment (CloudFormation)

The Deployment in AppConfig can be configured in CloudFormation with the resource name AWS::AppConfig::Deployment. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.


Explanation in CloudFormation Registry

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 application1. Create an environment1. Create a configuration profile1. Create a deployment strategy1. Deploy the configurationFor more information, see AWS AppConfig in the AWS AppConfig User Guide.

Frequently asked questions

What is AWS AppConfig Deployment?

AWS AppConfig Deployment is a resource for AppConfig of Amazon Web Service. Settings can be wrote in Terraform and CloudFormation.

Where can I find the example code for the AWS AppConfig Deployment?

For Terraform, the easyas314159/lobbyboy source code example is useful. See the Terraform Example section for further details.