Working with the Amazon AppConfig deployment events to Amazon EventBridge extension - Amazon AppConfig
Using the extension
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).

Working with the Amazon AppConfig deployment events to Amazon EventBridge extension

The Amazon AppConfig deployment events to Amazon EventBridge extension is an Amazon authored extension that helps you monitor and act on the Amazon AppConfig configuration deployment workflow. The extension sends event notifications to the EventBridge default events bus whenever a configuration is deployed. After you’ve associated the extension to one of your Amazon AppConfig applications, environments, or configuration profiles, Amazon AppConfig sends event notifications to the event bus after every configuration deployment start, end, and rollback.

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

Important

This extension supports only the EventBridge default events bus.

Using the extension

To use the Amazon AppConfig deployment events to Amazon EventBridge extension, you first 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, an event notification is sent for any configuration profile contained within the specified application or environment.

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

Note

This extension is invoked by the following action points:

  • ON_DEPLOYMENT_START

  • ON_DEPLOYMENT_COMPLETE

  • ON_DEPLOYMENT_ROLLED_BACK

You can't customize the actions points for this extension. To invoke different action points, you can create your own extension. For more information, see Walkthrough: Creating custom Amazon AppConfig extensions.

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

To create an extension association (console)

  1. Open the Amazon Systems Manager console at https://console.amazonaws.cn/systems-manager/appconfig/.

  2. In the navigation pane, choose Amazon AppConfig.

  3. On the Extensions tab, choose Add to resource.

  4. In the Extension resource details section, for Resource type, choose an Amazon AppConfig resource type. Depending on the resource you choose, Amazon AppConfig prompts you to choose other resources.

  5. Choose Create association to resource.

Here's a sample event sent to EventBridge when the extension is invoked.

{
   "version":"0",
   "id":"c53dbd72-c1a0-2302-9ed6-c076e9128277",
   "detail-type":"On Deployment Complete",
   "source":"aws.appconfig",
   "account":"111122223333",
   "time":"2022-07-09T01:44:15Z",
   "region":"us-east-1",
   "resources":[
      "arn:aws:appconfig:us-east-1:111122223333:extensionassociation/z763ff5"
   ],
   "detail":{
      "InvocationId":"5tfjcig",
       "Parameters":{
         
      },
      "Type":"OnDeploymentComplete",
      "Application":{
         "Id":"ba8toh7",
         "Name":"MyApp"
      },
      "Environment":{
         "Id":"pgil2o7",
         "Name":"MyEnv"
      },
      "ConfigurationProfile":{
         "Id":"ga3tqep",
         "Name":"MyConfigProfile"
      },
      "DeploymentNumber":1,
      "ConfigurationVersion":"1"
   }
}