Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Using the Amazon AppConfig deployment events to Amazon SQS extension

The Amazon AppConfig deployment events to Amazon SQS extension is an Amazon authored extension that helps you monitor and act on the Amazon AppConfig configuration deployment workflow. The extension enqueues messages into your Amazon Simple Queue Service (Amazon SQS) queue whenever a configuration is deployed. After you associate the extension to one of your Amazon AppConfig applications, environments, or configuration profiles, Amazon AppConfig enqueues a message into the queue after every configuration deployment start, end, and rollback.

If you want more control over which action points send Amazon SQS notifications, you can create a custom extension and enter an Amazon SQS queue Amazon Resource Name (ARN) for the URI field. For information about creating an extension, see Walkthrough: Creating custom Amazon AppConfig extensions.

Using the extension

This section describes how to use the Amazon AppConfig deployment events to Amazon SQS extension.

Step 1: Configure Amazon AppConfig to enqueue messages

Add an Amazon SQS policy to your Amazon SQS queue that gives Amazon AppConfig (appconfig.amazonaws.com) permission to send messages (sqs:SendMessage). To make sure only your own account can send these messages, add an aws:SourceAccount condition to the policy and set it to your Amazon account ID. This prevents someone in a different Amazon account from using the extension to send messages to your queue. To scope access even more tightly, you can use an aws:SourceArn condition set to the ARN of the extension association instead. For more information, see Basic examples of Amazon SQS policies.

The following example policy lets Amazon AppConfig send messages to your queue only when the request comes from your own account. Replace MySQSQueue and the example account ID with your own values.

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "AllowAppConfigSendMessage",
            "Effect": "Allow",
            "Principal": {
                "Service": "appconfig.amazonaws.com"
            },
            "Action": "SQS:SendMessage",
            "Resource": "arn:aws:sqs:us-east-1:111122223333:MySQSQueue",
            "Condition": {
                "StringEquals": {
                    "aws:SourceAccount": "111122223333"
                }
            }
        }
    ]
}

Step 2: Create an extension association

Attach the extension to one of your Amazon AppConfig resources by creating an extension association. You create the association by using the Amazon AppConfig console or the CreateExtensionAssociation API action. When you create the association, you specify the ARN of an Amazon AppConfig application, environment, or configuration profile. If you associate the extension to an application or an environment, a notification is sent for any configuration profile contained within the specified application or environment. When you create the association, you must enter a Here parameter that contains the ARN of the Amazon SQS queue you want to use.

After you create the association, when a configuration for the specified Amazon AppConfig resource is created or deployed, Amazon AppConfig invokes the extension and sends notifications according to the action points specified in the extension.

Use the following procedures to create an Amazon AppConfig extension association by using either the Amazon Systems Manager console or the Amazon CLI.

Here's an example of the message sent to the Amazon SQS queue when the extension is invoked.

{
   "InvocationId":"7itcaxp",
   "Parameters":{
      "queueArn":"arn:aws:sqs:us-east-1:111122223333:MySQSQueue"
   },
   "Application":{
      "Id":"1a2b3c4d",
      "Name":MyApp
   },
   "Environment":{
      "Id":"1a2b3c4d",
      "Name":MyEnv
   },
   "ConfigurationProfile":{
      "Id":"1a2b3c4d",
      "Name":"MyConfigProfile"
   },
   "Description":null,
   "DeploymentNumber":"3",
   "ConfigurationVersion":"1",
   "Type":"OnDeploymentComplete"
}