使用 Amazon AppConfig deployment events to Amazon SNS 扩展 - Amazon AppConfig
使用扩展程序
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

使用 Amazon AppConfig deployment events to Amazon SNS 扩展

Amazon AppConfig deployment events to Amazon SNS 扩展程序是 Amazon 创作的扩展程序，可帮助您监视和处理 Amazon AppConfig 配置部署工作流。每当部署配置时，该扩展程序都会将消息发布到 Amazon SNS 主题。将扩展程序关联到某个 Amazon AppConfig 应用程序、环境或配置文件后，Amazon AppConfig 会在每次配置部署开始、结束和回滚后向该主题发布一条消息。

如果您希望更好地控制哪些操作点发送 Amazon SNS 通知，您可以创建自定义扩展程序，并在 URI 字段中输入 Amazon SNS 主题 Amazon 资源名称（ARN）。有关创建扩展程序的信息，请参阅 演练：创建自定义 Amazon AppConfig 扩展程序。

使用扩展程序

本节介绍如何使用 Amazon AppConfig deployment events to Amazon SNS 扩展程序。

步骤 1：配置 Amazon AppConfig 以将消息发布到主题

向 Amazon SNS 主题添加访问控制策略，授予 Amazon AppConfig(appconfig.amazonaws.com) 发布权限 (sns:Publish)。有关更多信息，请参阅 Amazon SNS 访问控制的示例案例。

步骤 2：创建扩展程序关联

通过创建扩展程序关联，将扩展附加到其中一个 Amazon AppConfig 资源。您可以使用 Amazon AppConfig 控制台或 CreateExtensionAssociation API 操作创建关联。创建关联时，您可以指定 Amazon AppConfig 应用程序、环境或配置文件的 ARN。如果将扩展程序关联到应用程序或环境，则会针对指定应用程序或环境中包含的任何配置文件发送通知。在创建关联时，您必须为 topicArn 参数输入一个值，该参数包含要使用的 Amazon SNS 主题的 ARN。

创建关联后，当部署指定 Amazon AppConfig 资源的配置时，Amazon AppConfig 会调用该扩展程序，并根据该扩展程序中指定的操作点发送通知。

注意

此扩展程序由以下操作点调用：

  • ON_DEPLOYMENT_START

  • ON_DEPLOYMENT_COMPLETE

  • ON_DEPLOYMENT_ROLLED_BACK

您无法自定义此扩展程序的操作点。若要调用不同的操作点，可以创建自己的扩展程序。有关更多信息，请参阅 演练：创建自定义 Amazon AppConfig 扩展程序。

使用以下过程通过 Amazon Systems Manager 控制台或 Amazon CLI 创建 Amazon AppConfig 扩展程序关联。

创建扩展程序关联（控制台）

  1. 访问 https://console.aws.amazon.com/systems-manager/appconfig/，打开 Amazon Systems Manager 控制台。

  2. 在导航窗格中，选择 Amazon AppConfig。

  3. 在 扩展程序 选项卡上，选择 添加到资源。

  4. 在扩展程序资源详细信息部分中，对于资源类型，选择 Amazon AppConfig 资源类型。根据您选择的资源，Amazon AppConfig 会提示您选择其他资源。

  5. 选择创建与资源的关联。

以下是调用扩展程序时发送到 Amazon SNS 主题的消息示例。

{
    "Type": "Notification",
    "MessageId": "ae9d702f-9a66-51b3-8586-2b17932a9f28",
    "TopicArn": "arn:aws:sns:us-east-1:111122223333:MySNSTopic",
    "Message": {
        "InvocationId": "7itcaxp",
        "Parameters": {
            "topicArn": "arn:aws:sns:us-east-1:111122223333:MySNSTopic"
        },
        "Application": {
            "Id": "1a2b3c4d",
            "Name": MyApp
        },
        "Environment": {
            "Id": "1a2b3c4d",
            "Name": MyEnv
        },
        "ConfigurationProfile": {
            "Id": "1a2b3c4d",
            "Name": "MyConfigProfile"
        },
        "Description": null,
        "DeploymentNumber": "3",
        "ConfigurationVersion": "1",
        "Type": "OnDeploymentComplete"
    },
    "Timestamp": "2022-06-30T20:26:52.067Z",
    "SignatureVersion": "1",
    "Signature": "<...>",
    "SigningCertURL": "<...>",
    "UnsubscribeURL": "<...>",
    "MessageAttributes": {
        "MessageType": {
            "Type": "String",
            "Value": "OnDeploymentStart"
        }
    }
}