View a markdown version of this page

AWSSupport-EmptyS3Bucket - AWS Systems Manager Référence du dossier d’exploitation Automation

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

AWSSupport-EmptyS3Bucket

Description

Le runbook AWSSupport-EmptyS3Bucket d'automatisation vide un compartiment Amazon Simple Storage Service (Amazon S3) existant à l'aide d'une règle de configuration d'expiration du cycle de vie.

Important

  • Les compartiments Amazon S3 avec Multi-factor l'authentification (MFA) activée ne sont pas pris en charge.

  • Les règles de cycle de vie modifiées par ce runbook suppriment définitivement tous les objets et leurs versions dans le compartiment Amazon S3 spécifié. Vous ne pouvez pas récupérer des objets supprimés définitivement. Pour plus d'informations, consultez Expiring Objects.

Fonctionnement

Le runbook AWSSupport-EmptyS3Bucket exécute les étapes de haut niveau suivantes :

  • Suspend la gestion des versions des compartiments, si elle est activée.

  • Met à jour la politique du bucket pour refuser tout appel d's3:PutObjectAPI (afin d'empêcher de nouveaux téléchargements pendant qu'il est vidé).

  • Met à jour les règles de cycle de vie pour supprimer tous les objets en fonction des jours d'expiration spécifiés dans les paramètres d'entrée.

Note

  • Les versions d'objets protégées par Amazon S3 Object Lock ne sont ni supprimées ni remplacées par les configurations de cycle de vie.

  • Le processus de suppression est asynchrone et peut prendre du temps une fois l'exécution du runbook terminée.

Exécutez cette automatisation (console)

Type de document

 Automatisation

Propriétaire

Amazon

Plateformes

/

Autorisations IAM requises

Le AutomationAssumeRole paramètre nécessite les actions suivantes pour utiliser correctement le runbook.

Le AutomationAssumeRole paramètre nécessite les actions suivantes pour utiliser correctement le runbook :

  • sms : DescribeAutomationExecutions

  • sms : GetAutomationExecution

  • s3 : GetBucketVersioning

  • s3 : PutBucketVersioning

  • s3 : GetBucketPolicy

  • s3 : GetBucketLifecycleConfiguration

  • s3 : GetLifecycleConfiguration

  • s3 : PutBucketPolicy

  • s3 : PutBucketLifecycleConfiguration

  • s3 : PutLifecycleConfiguration

  • s3 : DeleteBucketPolicy

  • s3 : DeleteBucketLifecycle

Instructions

Pour configurer l'automatisation, procédez comme suit :

  1. Accédez à AWSSupport-EmptyS3Bucket la section Documents dans Systems Manager.

  2. Sélectionnez Execute automation (Exécuter l'automatisation).

  3. Pour les paramètres d'entrée, entrez les informations suivantes :

    • AutomationAssumeRole (Facultatif) :

      Le nom de ressource Amazon (ARN) du rôle AWS Gestion des identités et des accès AWS (IAM) qui permet à Systems Manager Automation d'effectuer les actions en votre nom. Si aucun rôle n'est spécifié, Systems Manager Automation utilise les autorisations de l'utilisateur qui démarre ce runbook.

    • S3BucketName:

      Le nom du compartiment Amazon S3 que vous souhaitez vider.

    • SNSTopicArn:

      Fournissez l'ARN de la rubrique Amazon SNS pour la notification d'approbation. Cette rubrique Amazon SNS est utilisée pour envoyer des notifications d'approbation lorsque cela est nécessaire lors de l'exécution de l'automatisation.

    • Approbateur IAM :

      Fournissez une liste des mandants AWS authentifiés capables d'approuver ou de rejeter l'action. Le nombre maximum d'approbateurs est 10 de. Vous pouvez spécifier des principaux en utilisant l'un de ces formats, un nom d'utilisateur Gestion des identités et des accès AWS (IAM), un ARN utilisateur IAM, un ARN de rôle IAM ou un ARN utilisateur de rôle d'assume le rôle IAM.

    • MinimumRequiredApprovals(Facultatif) :

      Le nombre minimum d'approbations requises pour que l'automatisation reprenne. Si vous ne spécifiez aucune valeur, le système utilise par défaut. 1 La valeur de ce paramètre doit être un nombre positif. La valeur de ce paramètre ne peut pas dépasser le nombre d'approbateurs défini par le paramètre ApproverIam.

    • NoncurrentVersionExpirationDays(Facultatif) :

      Spécifiez le nombre de jours pendant lesquels les versions d'objets non actuelles expirent. Lorsqu'elles expirent, Amazon S3 supprime définitivement les versions d'objet anciennes.

      • Valeur par défaut : 1

      • Valeur maximale : 365

    • ExpirationDays (Facultatif) :

      Spécifiez l'expiration du cycle de vie de l'objet sous forme de jours.

      • Valeur par défaut : 1

      • Valeur maximale : 365

    • AbortIncompleteMultipartUpload(Facultatif) :

      Spécifiez les jours écoulés depuis le lancement d'un chargement partitionné incomplet pendant lesquels Amazon S3 attendra avant de supprimer définitivement toutes les parties du téléchargement.

      • Valeur par défaut : 1

      • Valeur maximale : 365

    • Remerciement :

      Veuillez lire les détails complets des actions effectuées par ce manuel d'automatisation et donner votre consentement Yes, I understand and acknowledge si vous acceptez les étapes.

    Image contenant des exemples de paramètres d'entrée pour AWSSupport-EmptyS3Bucket le document.

  4. Sélectionnez Exécuter.

  5. L'automatisation démarre.

  6. Le document exécute les étapes suivantes :

    • checkConcurrency:

      Garantit qu'il n'y a qu'une seule exécution de ce runbook ciblant le compartiment Amazon S3 spécifié. Si le runbook détecte une autre exécution en cours ciblant le même nom de compartiment, il renvoie une erreur et se termine.

    • getBucketVersioningConfiguration:

      Récupère l'état de gestion des versions du compartiment Amazon S3 spécifié.

    • branchOnStoppingIfMFADeleteEnabled(conditionnel) :

      Arrête l'automatisation si Multi-factor l'authentification (MFA) est activée sur le compartiment Amazon S3 spécifié.

    • approvalToMakeChangesToTheProvidedS3Bucket:

      Attend l'approbation des responsables désignés pour désactiver la gestion des versions des compartiments et mettre à jour la configuration de la politique des compartiments et des règles de cycle de vie pour le compartiment Amazon S3 spécifié.

    • branchOnBucketVersioningStatus(conditionnel) :

      Si le contrôle de version est activé sur le compartiment Amazon S3 spécifié, désactivez-le, sinon continuez à mettre à jour la politique du compartiment et la configuration du cycle de vie.

    • suspendBucketVersioning:

      Suspend l'état de gestion des versions du compartiment Amazon S3 spécifié.

    • updateBucketPolicyAndLifeCycleConfiguration:

      Ajoute ou met à jour la politique de compartiment pour refuser toutes les s3:PutObject demandes et met à jour la configuration du cycle de vie pour faire expirer les objets en fonction des paramètres d'entrée fournis par l'utilisateur.

    • branchOnFailingIfBucketPropertiesNotUpdated(conditionnel) :

      Vérifie l'état de l'updateBucketPolicyAndLifeCycleConfigurationétape et essaie de rétablir l'état de version d'origine du bucket s'il est modifié automatiquement.

    • branchOnFailureOriginalVersioningStatus(conditionnel) :

      En cas d'échec, les branches déterminent l'état de version d'origine. S'il a été activé et suspendu par cette automatisation, essaie de l'activer à nouveau.

    • onFailureRestoreBucketVersioning

      Restaure l'état de gestion des versions activé du compartiment Amazon S3 spécifié.

  7. Une fois terminé, consultez la section Sorties pour obtenir les résultats détaillés de l'exécution :

    Image contenant le résultat de l'exécution du AWSSupport-EmptyS3Bucket document montrant l'exécution réussie et la politique de cycle de vie configurée.

    • Exécution réussie

      Ce flux de travail met à jour la règle de cycle de vie du bucket. Les objets seront supprimés conformément à la politique de Delete-All-AWSSupport-EmptyS3-Bucket cycle de vie.

      Image contenant la politique de Delete-All-AWSSupport-EmptyS3-Bucket cycle de vie configurée.

    • Exécution d'un échec

      La suppression partielle ne sera pas effectuée. Si l'exécution échoue, le cycle de vie et les autres paramètres du bucket sont annulés.

Références

Systems Manager Automation

Pour plus d'informations sur la gestion des compartiments et des objets Amazon S3, consultez la section Vidange d'un compartiment.