View a markdown version of this page

Référence des actions source d'Amazon S3 - AWS CodePipeline

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.

Référence des actions source d'Amazon S3

Une action source déclenche le pipeline lorsqu'un nouvel objet est chargé dans le bucket et la clé d'objet configurés.

Cette rubrique de référence décrit l'action source Amazon S3 CodePipeline lorsque l'emplacement source est un compartiment Amazon S3 configuré pour le versionnage. Pour obtenir des informations de référence sur l'action de déploiement d'Amazon S3 dans CodePipeline, consultezRéférence des actions de déploiement d'Amazon S3.

Avant de connecter le pipeline, créez un compartiment source Amazon S3, activez la gestion des versions et chargez vos fichiers sources dans un seul fichier ZIP.

Vous pouvez créer un nouveau compartiment dans Amazon S3 ou sélectionner un compartiment Amazon S3 existant à utiliser comme emplacement source pour vos fichiers d'application. Pour plus d'informations sur l'activation de la gestion des versions, consultez la section Utilisation de la gestion des versions dans le guide de l'utilisateur Amazon S3.

Lorsqu'Amazon S3 est le fournisseur source de votre pipeline, vous pouvez compresser votre ou vos fichiers source dans un seul fichier .zip et charger le fichier .zip dans votre compartiment source. Vous pouvez également charger un seul fichier décompressé ; toutefois, les actions en aval qui prévoient un fichier .zip échoueront.

Si vous utilisez la console pour créer ou modifier votre pipeline, CodePipeline crée une EventBridge règle qui démarre votre pipeline lorsqu'un changement se produit dans le compartiment source Amazon S3.

Vous pouvez également créer un remplacement de source à l'aide d'une entrée de transformation EventBridge pour utiliser l'revisionValueentrée de votre événement de pipeline, où le revisionValue est dérivé de la variable d'événement source pour votre clé d'objet, votre commit ou votre ID d'image. Pour plus d'informations, consultez l'étape facultative pour la saisie de la transformation d'entrée incluse dans les procédures ci-dessousConnexion aux actions de source Amazon S3 avec une source activée pour les événements.

Type d'action

  • Catégorie : Source

  • Propriétaire : AWS

  • Fournisseur : S3

  • Version : 1

Paramètres de configuration

S3Bucket

Obligatoire : oui

Nom du compartiment Amazon S3 dans lequel les modifications de source doivent être détectées.

S3ObjectKey

Obligatoire : oui

Nom de la clé d'objet Amazon S3 où les modifications de source doivent être détectées.

AllowOverrideForS3ObjectKey

Obligatoire : non

AllowOverrideForS3ObjectKeycontrôle si les remplacements de source StartPipelineExecution peuvent remplacer ceux déjà configurés S3ObjectKey dans l'action source. Pour plus d'informations sur les remplacements de source à l'aide de la clé d'objet S3, consultezDémarrer un pipeline avec un remplacement de révision de la source.

Important

Si vous l'omettezAllowOverrideForS3ObjectKey, il est possible CodePipeline par défaut de remplacer le S3 ObjectKey dans l'action source en définissant ce paramètre sur. false

Valeurs valides pour ce paramètre :

  • true: Si elle est définie, la clé d'objet S3 préconfigurée peut être remplacée par des modifications de révision de la source lors de l'exécution d'un pipeline.

    Note

    Si vous souhaitez autoriser tous les CodePipeline utilisateurs à remplacer la clé d'objet S3 préconfigurée lors du démarrage d'une nouvelle exécution de pipeline, vous devez définir surAllowOverrideForS3ObjectKey. true

  • false:

    Si cette option est définie, la clé d'objet S3 ne CodePipeline pourra pas être remplacée à l'aide de modifications de révision de la source. Il s'agit également de la valeur par défaut de ce paramètre.

PollForSourceChanges

Obligatoire : non

PollForSourceChangescontrôle si le compartiment source Amazon S3 CodePipeline interroge les modifications apportées à la source. Nous vous recommandons d'utiliser CloudWatch Events et de CloudTrail détecter les modifications de source à la place. Pour plus d'informations sur la configuration CloudWatch des événements, consultez Migrer les pipelines de sondage à l'aide d'une source et d'une CloudTrail piste S3 (CLI) ouMigrez les pipelines de sondage à l'aide d'une source et d'une CloudTrail piste S3 (CloudFormation modèle).

Important

Si vous avez l'intention de configurer CloudWatch Events, vous devez définir cette PollForSourceChanges valeur pour false éviter les exécutions de pipeline en double.

Valeurs valides pour ce paramètre :

  • true: si ce paramètre est défini, CodePipeline interroge votre emplacement source pour détecter les modifications apportées à la source.

    Note

    Si vous omettezPollForSourceChanges, la CodePipeline valeur par défaut est interrogée sur votre emplacement source pour détecter les modifications apportées à la source. Ce comportement est le même que si PollForSourceChanges est inclus et défini sur true.

  • false: Si ce paramètre est défini, CodePipeline n'interroge pas votre emplacement source pour détecter les modifications apportées à la source. Utilisez ce paramètre si vous avez l'intention de configurer une règle d' CloudWatch événements pour détecter les modifications de source.

Artefacts d'entrée

  • Nombre d'artefacts : 0

  • Description : Les artefacts d'entrée ne s'appliquent pas à ce type d'action.

Artefacts de sortie

  • Nombre d'objets : 1

  • Description : Fournit les artefacts disponibles dans le compartiment source configuré pour se connecter au pipeline. Les artefacts générés à partir du compartiment sont les artefacts de sortie pour l'action Amazon S3. Les métadonnées de l'objet Amazon S3 (ETag et ID de version) sont affichées en CodePipeline tant que révision source pour l'exécution du pipeline déclenchée.

Variables de sortie

Lorsque cette action est configurée, elle produit des variables qui peuvent être référencées par la configuration d'action d'une action en aval dans le pipeline. Cette action produit des variables qui peuvent être visualisées en tant que variables de sortie, même si l'action n'a pas d'espace de noms. Vous configurez une action avec un espace de noms pour rendre ces variables disponibles pour la configuration des actions en aval.

Pour plus d'informations sur les variables dans CodePipeline, consultezRéférence des variables.

BucketName

Le nom du compartiment Amazon S3 lié à la modification de source qui a déclenché le pipeline.

ETag

Balise d'entité de l'objet lié à la modification de la source ayant déclenché le pipeline. L'ETag est un hachage MD5 de l'objet. ETag reflète uniquement les modifications apportées au contenu d'un objet, non à ses métadonnées.

ObjectKey

Le nom de la clé d'objet Amazon S3 associée au changement de source qui a déclenché le pipeline.

VersionId

ID de version de la version de l'objet lié à la modification de la source ayant déclenché le pipeline.

Autorisations relatives aux rôles de service : action source S3

Pour la prise en charge de l'action source S3, ajoutez ce qui suit à votre déclaration de politique :

JSON
{ "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "s3:GetObject", "s3:GetObjectVersion", "s3:GetBucketVersioning", "s3:GetBucketAcl", "s3:GetBucketLocation", "s3:GetObjectTagging", "s3:GetObjectVersionTagging" ], "Resource": [ "arn:aws:s3:::[[S3Bucket]]", "arn:aws:s3:::[[S3Bucket]]/*" ], "Condition": { "StringEquals": { "aws:ResourceAccount": "111122223333" } } } ] }

Déclaration d'action

YAML
Name: Source Actions: - RunOrder: 1 OutputArtifacts: - Name: SourceArtifact ActionTypeId: Provider: S3 Owner: AWS Version: '1' Category: Source Region: us-west-2 Name: Source Configuration: S3Bucket: amzn-s3-demo-source-bucket S3ObjectKey: my-application.zip PollForSourceChanges: 'false' InputArtifacts: []
JSON
{ "Name": "Source", "Actions": [ { "RunOrder": 1, "OutputArtifacts": [ { "Name": "SourceArtifact" } ], "ActionTypeId": { "Provider": "S3", "Owner": "AWS", "Version": "1", "Category": "Source" }, "Region": "us-west-2", "Name": "Source", "Configuration": { "S3Bucket": "amzn-s3-demo-source-bucket", "S3ObjectKey": "my-application.zip", "PollForSourceChanges": "false" }, "InputArtifacts": [] } ] },

Les ressources connexes suivantes peuvent s'avérer utiles dans le cadre de l'utilisation de cette action.