View a markdown version of this page

AWSSupport-DeploySESSendingLogsToCloudWatchLogs - AWS Systems Manager Referência do Automation Runbook

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

AWSSupport-DeploySESSendingLogsToCloudWatchLogs

Descrição

O runbook de AWSSupport-DeploySESSendingLogsToCloudWatchLogs automação ajuda a configurar a infraestrutura necessária para a publicação de eventos do Amazon Simple Email Service (Amazon SES) no CloudWatch Amazon Logs CloudWatch (Logs). Esse runbook configura os componentes necessários para capturar eventos de envio de e-mail e armazená-los em CloudWatch registros para monitoramento e análise. Para obter mais informações sobre a publicação de eventos do Amazon SES, consulte Monitorar o envio de e-mails usando a publicação de eventos do Amazon SES.

Quando o ApproveDeployAnalyticEnvironment parâmetro é definido comoapprove, esse runbook cria novos AWS recursos em sua AWS conta. A CloudFormation pilha é excluída automaticamente após o tempo especificado no SleepTime parâmetro, a menos que seja definida como. 0

Como funciona?

Esse runbook executa as seguintes ações:

  • Lista os conjuntos de configurações existentes que têm destinos de eventos configurados para tópicos ou fluxos de entrega do Amazon Simple Notification Service (Amazon SNS).

  • Cria a infraestrutura necessária para a publicação de eventos do Amazon SES no CloudWatch Logs quando o ApproveDeployAnalyticEnvironment parâmetro é definido comoapprove.

Quando o ApproveDeployAnalyticEnvironment parâmetro é definido comoapprove, o runbook cria os seguintes recursos:

  • Uma CloudFormation pilha chamada AWSSupport-SESSendingLogsToCloudWatchLogs que inclui:

    • Tópico do Amazon SNS com criptografia AWS Key Management Service ()AWS KMS

    • Fila do Amazon Simple Queue Service (Amazon SQS)

    • AWS Lambda função para processar eventos de envio de e-mail

    • AWS Identity and Access Management Função de execução (IAM) com permissões para Amazon SQS e Logs CloudWatch

    • CloudWatch Grupo de registros

    • AWS KMS chave para criptografia

    • Configuração do Amazon SES definida com destinos de eventos

  • A infraestrutura processa eventos de envio de e-mail no seguinte fluxo: Eventos de envio de e-mail do Amazon SES → Amazon SES Configuration Set → Amazon SNS Topic → Amazon SQS Queue → Lambda Function → Logs CloudWatch

  • Associa o conjunto de configurações criado como o conjunto de configuração padrão para uma identidade específica do Amazon SES quando o SesIdentity parâmetro é fornecido.

Executar esta automação (console)

Tipo de documento

Automação

Proprietário

Amazon

Plataformas

/

Permissões obrigatórias do IAM

O parâmetro AutomationAssumeRole requer as seguintes ações para usar o runbook com êxito.

  • cloudformation:CreateStack

  • cloudformation:DeleteStack

  • cloudformation:DescribeStackEvents

  • cloudformation:DescribeStacks

  • iam:CreateRole

  • iam:AttachRolePolicy

  • iam:PassRole

  • kms:CreateKey

  • kms:CreateAlias

  • lambda:CreateFunction

  • lambda:AddPermission

  • logs:CreateLogGroup

  • logs:PutRetentionPolicy

  • ses:CreateConfigurationSet

  • ses:CreateConfigurationSetEventDestination

  • ses:ListConfigurationSets

  • ses:PutEmailIdentityConfigurationSetAttributes

  • sns:CreateTopic

  • sns:Subscribe

  • sqs:CreateQueue

  • sqs:SetQueueAttributes

  • ssm:DescribeAutomationExecutions

Exemplo de política:

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "cloudformation:CreateStack", "cloudformation:DeleteStack", "cloudformation:DescribeStackEvents", "cloudformation:DescribeStacks", "iam:CreateRole", "iam:AttachRolePolicy", "iam:PassRole", "kms:CreateKey", "kms:CreateAlias", "lambda:CreateFunction", "lambda:AddPermission", "logs:CreateLogGroup", "logs:PutRetentionPolicy", "ses:CreateConfigurationSet", "ses:CreateConfigurationSetEventDestination", "ses:ListConfigurationSets", "ses:PutEmailIdentityConfigurationSetAttributes", "sns:CreateTopic", "sns:Subscribe", "sqs:CreateQueue", "sqs:SetQueueAttributes", "ssm:DescribeAutomationExecutions" ], "Resource": "*" } ] }

Instruções

Siga estas etapas para configurar a automação:

  1. Navegue até AWSSupport-DeploySESSendingLogsToCloudWatchLogsem Systems Manager em Documentos.

  2. Selecione Execute automation (Executar automação).

  3. Para os parâmetros de entrada, insira o seguinte:

    • AutomationAssumeRole (Opcional):

      • Descrição: (Opcional) O Amazon Resource Name (ARN) da função do IAM que permite que o Systems Manager Automation execute as ações em seu nome. Se nenhum perfil for especificado, o Systems Manager Automation usa as permissões do usuário que inicia este runbook.

      • Tipo: AWS::IAM::Role::Arn

    • ApproveDeployAnalyticEnvironment (Opcional):

      • Descrição: (Opcional) Aprovação para implantar a infraestrutura de publicação de eventos do Amazon SES. Digite approve para criar a CloudFormation pilha e os recursos relacionados. Se deixado vazio, o runbook exibirá somente conjuntos de configurações existentes com ou destinos de eventos do Amazon SNS na região atual.

      • Tipo: String

      • Padrão de permissão: ^$|^approve$

      • Padrão: ""

    • SesIdentity (Opcional):

      • Descrição: (Opcional) Identidade do Amazon SES (endereço de e-mail ou domínio) a ser associada ao conjunto de configurações recém-criado como o conjunto de configuração padrão. Isso substituirá qualquer conjunto de configuração padrão existente para a identidade especificada.

      • Tipo: String

      • Padrão: ""

    • CloudWatchLogGroupName (Opcional):

      • Descrição: (Opcional) Nome do grupo de CloudWatch registros de registros a ser criado para armazenar eventos de envio de e-mail do Amazon SES.

      • Tipo: String

      • Padrão de permissão: ^[0-9a-zA-Z_.#/\\-]{1,512}$

      • Padrão: /ses/sending_event_logs

    • Máscara PIIData (opcional):

      • Descrição: (Opcional) Especifique se deseja mascarar dados de informações de identificação pessoal (PII), como endereços de e-mail de destino e assuntos de e-mail, nos Registros. CloudWatch Defina False para incluir essas informações nos registros.

      • Tipo: String

      • Valores permitidos: [True, False]

      • Padrão: True

    • SleepTime (Opcional):

      • Descrição: (Opcional) Número de minutos de espera antes de excluir automaticamente a CloudFormation pilha. O padrão é 24 horas (1.440 minutos), o máximo é 7 dias (10.080 minutos). Defina como 0 para evitar a exclusão automática.

      • Tipo: String

      • Padrão de permissão: ^(?:[0-9]|[1-9]\\d{1,3}|100[0-7][0-9])$

      • Padrão: 1440

    • RetainCloudWatchLogsOnDeletion (Opcional):

      • Descrição: (Opcional) Especifique se deseja manter o grupo de CloudWatch registros de registros quando a CloudFormation pilha for excluída. Defina como False para excluir o grupo de registros junto com a pilha.

      • Tipo: String

      • Valores permitidos: [True, False]

      • Padrão: True

    • UniqueId (Opcional):

      • Descrição: (Opcional) Um identificador exclusivo para o fluxo de trabalho.

      • Tipo: String

      • Padrão de permissão: \\{\\{ automation:EXECUTION_ID \\}\\}|[a-zA-Z0-9-]+

      • Padrão: {{ automation:EXECUTION_ID }}

      • Máximo de caracteres: 64

  4. Selecione Executar.

  5. A automação é iniciada.

  6. O bucket realiza as seguintes etapas:

    • BranchOnValueOfParameterApproveDeployAnalyticEnvironment

      Determina se a infraestrutura de publicação de eventos do Amazon SES deve ser implantada com base no valor do ApproveDeployAnalyticEnvironment parâmetro.

    • GetEligibleConfigurationSets

      Recupera conjuntos de configurações existentes do Amazon SES e identifica aqueles com destinos de eventos configurados para fluxos de entrega ou tópicos do Amazon SNS.

    • CheckConcurrency

      Verifica se não existe nenhuma pilha existente e se nenhuma outra execução simultânea desse runbook está criando a mesma pilha.

    • DeploySesEventDestinations

      Cria a CloudFormation pilha contendo a infraestrutura de publicação de eventos do Amazon SES, incluindo o tópico do Amazon SNS, a fila do Amazon SQS, a função Lambda e o grupo de registros de registros. CloudWatch

    • RelateConfigurationSetAsDefaultConfigurationSet

      Associa o conjunto de configurações recém-criado do Amazon SES como o conjunto de configuração padrão para a identidade especificada do Amazon SES (se fornecida).

    • SleepBeforeDeleteCloudFormationStack

      Aguarda a duração especificada no SleepTime parâmetro antes de prosseguir com a exclusão da CloudFormation pilha.

    • DeleteCloudFormationStack

      Exclui a CloudFormation pilha após o período especificado.

  7. Após a conclusão, revise a seção Saídas para obter os resultados detalhados da execução.

Referências

Automação do Systems Manager