AWSSupport-EmptyS3Bucket - AWS Systems Manager Referência do runbook de automação

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-EmptyS3Bucket

Descrição

O runbook de AWSSupport-EmptyS3Bucket automação esvazia um bucket existente do Amazon Simple Storage Service (Amazon S3) usando uma regra de configuração de expiração do ciclo de vida.

Importante

  • Os buckets do Amazon S3 com autenticação multifator (MFA) ativada não são suportados.

  • As regras de ciclo de vida modificadas por esse runbook excluem permanentemente todos os objetos e suas versões no bucket do Amazon S3 especificado. Você não pode recuperar objetos excluídos permanentemente. Para obter mais informações, consulte Expiring Objects.

Como funciona?

O runbook AWSSupport-EmptyS3Bucket executa as seguintes etapas de alto nível:

  • Suspende o controle de versão do bucket, se ativado.

  • Atualiza a política do bucket para negar qualquer chamada de s3:PutObject API (para evitar novos uploads enquanto ela está sendo esvaziada).

  • Atualiza as regras do ciclo de vida para excluir todos os objetos de acordo com os dias de expiração especificados nos parâmetros de entrada.

nota

  • As versões de objetos protegidas com o Amazon S3 Object Lock não são excluídas nem substituídas pelas configurações do ciclo de vida.

  • O processo de exclusão é assíncrono e pode levar algum tempo para ser concluído após o término da execução do runbook.

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.

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

  • sms: DescribeAutomationExecutions

  • sms: GetAutomationExecution

  • s3: GetBucketVersioning

  • s3: PutBucketVersioning

  • s3: GetBucketPolicy

  • s3: GetBucketLifecycleConfiguration

  • s3: GetLifecycleConfiguration

  • s3: PutBucketPolicy

  • s3: PutBucketLifecycleConfiguration

  • s3: PutLifecycleConfiguration

  • s3: DeleteBucketPolicy

  • s3: DeleteBucketLifecycle

Instruções

Siga estas etapas para configurar a automação:

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

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

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

    • AutomationAssumeRole (Opcional):

      O Amazon Resource Name (ARN) da função AWS AWS Identity and Access Management (IAM) que permite que o Systems Manager Automation execute as ações em seu nome. Se nenhuma função for especificada, o Systems Manager Automation usa as permissões do usuário que inicia esse runbook.

    • S3: BucketName

      O nome do bucket do Amazon S3 que você deseja esvaziar.

    • SNSTopicBraço:

      Forneça o ARN do tópico do Amazon SNS para notificação de aprovação. Esse tópico do Amazon SNS é usado para enviar notificações de aprovação quando necessário durante a execução da automação.

    • Aprovação:

      Forneça uma lista de diretores autenticados pela AWS que possam aprovar ou rejeitar a ação. O número máximo de aprovadores é10. Você pode especificar os principais usando qualquer um desses formatos, um nome de usuário AWS Identity and Access Management (IAM), um ARN de usuário do IAM, um ARN de função do IAM ou um ARN de usuário da função assumida pelo IAM.

    • MinimumRequiredApprovals (Opcional):

      O número mínimo de aprovações necessárias para retomar a automação. Se você não especificar um valor, o sistema usará como padrão. 1 O valor desse parâmetro deve ser um número positivo. O valor desse parâmetro não pode exceder o número de aprovadores definido pelo parâmetro ApproveRiam.

    • NoncurrentVersionExpirationDays (Opcional):

      Especifique o número de dias em que as versões não atuais do objeto expiram. Após a expiração, o Amazon S3 exclui permanentemente as versões de objetos não atuais.

      • Padrão: 1

      • Valor máximo: 365

    • ExpirationDays (Opcional):

      Especifique a expiração do ciclo de vida do objeto no formato dias.

      • Padrão: 1

      • Valor máximo: 365

    • AbortIncompleteMultipartUpload (Opcional):

      Especifique os dias, desde o início de um upload incompleto de várias partes, que o Amazon S3 aguardará antes de remover permanentemente todas as partes do upload.

      • Padrão: 1

      • Valor máximo: 365

    • Reconhecimento:

      Leia os detalhes completos das ações realizadas por este runbook de automação e forneça consentimento Yes, I understand and acknowledge se você reconhecer as etapas.

    Imagem contendo exemplos de parâmetros de entrada para o documento AWSSupport-EmptyS 3Bucket.

  4. Selecione Executar.

  5. A automação é iniciada.

  6. O bucket realiza as seguintes etapas:

    • checkConcurrency:

      Garante que haja apenas uma execução desse runbook direcionada ao bucket especificado do Amazon S3. Se o runbook encontrar outra execução em andamento com o mesmo nome de bucket, ele retornará um erro e terminará.

    • getBucketVersioningConfiguration:

      Busca o status de versionamento do bucket Amazon S3 especificado.

    • branchOnStoppingIfMFADeleteEnabled(condicional):

      Interrompe a automação se a Autenticação Multifator (MFA) estiver habilitada no bucket do Amazon S3 especificado.

    • approvalToMakeChangesToTheProvidedS3Bucket:

      Aguarda a aprovação dos diretores designados para desativar o controle de versão do bucket e atualizar a política do bucket e a configuração das regras de ciclo de vida do bucket Amazon S3 especificado.

    • branchOnBucketVersioningStatus(condicional):

      Se o controle de versão estiver ativado no bucket do Amazon S3 especificado, desative-o, caso contrário, continue atualizando a política do bucket e a configuração do ciclo de vida.

    • suspendBucketVersioning:

      Suspende o estado de versionamento do bucket Amazon S3 especificado.

    • updateBucketPolicyAndLifeCycleConfiguration:

      Adiciona ou atualiza a política do bucket para negar todas as s3:PutObject solicitações e atualiza a configuração do ciclo de vida para expirar objetos com base nos parâmetros de entrada fornecidos pelo usuário.

    • branchOnFailingIfBucketPropertiesNotUpdated(condicional):

      Verifica o status da updateBucketPolicyAndLifeCycleConfiguration etapa e tenta reverter o estado de versionamento original do bucket se alterado pela automação.

    • branchOnFailureOriginalVersioningStatus(condicional):

      Em caso de falha, ramifica para determinar o status original do controle de versão. Se foi ativado e suspenso por essa automação, tenta habilitá-la novamente.

    • onFailureRestoreBucketVersioning

      Restaura o estado de versionamento ativado do bucket Amazon S3 especificado.

  7. Depois de concluído, revise a seção Saídas para obter os resultados detalhados da execução:

    Imagem contendo a saída da execução do documento AWSSupport-EmptyS 3Bucket mostrando a execução bem-sucedida e a política de ciclo de vida configurada.

    • Execução bem-sucedida

      Esse fluxo de trabalho atualiza a regra de ciclo de vida do bucket. Os objetos serão excluídos de acordo com a política de Delete-All-AWSSupport-EmptyS3-Bucket ciclo de vida.

      Imagem contendo a política de ciclo de vida Delete-All-AWSSupport-EmptyS de 3 buckets configurada.

    • Falha na execução

      A exclusão parcial não será executada. Se a execução falhar, o ciclo de vida e outras configurações do bucket serão revertidas.

Referências

Automação do Systems Manager

Para obter mais informações sobre o gerenciamento de buckets e objetos do Amazon S3, consulte Esvaziar um bucket.