Action de déploiement d'Amazon S3

Vous utilisez une action de déploiement Amazon S3 pour déployer des fichiers dans un compartiment Amazon S3 à des fins d'hébergement ou d'archivage statique de sites Web. Vous pouvez spécifier si vous souhaitez extraire les fichiers de déploiement avant de les télécharger dans votre compartiment.

Note

Cette rubrique de référence décrit l'action de déploiement d'Amazon S3 CodePipeline lorsque la plate-forme de déploiement est un compartiment Amazon S3 configuré pour l'hébergement. Pour des informations de référence sur l'action source Amazon S3 dans CodePipeline, consultezAction relative à la source Amazon S3.

Type d'action

• Catégorie : Deploy

• Propriétaire : AWS

• Fournisseur : S3

• Version : 1

Paramètres de configuration

BucketName

Obligatoire : oui

Nom du compartiment Amazon S3 dans lequel les fichiers doivent être déployés.

Extrait

Obligatoire : oui

Si vrai, indique que les fichiers doivent être extraits avant le téléchargement. Dans le cas contraire, les fichiers de l'application restent compressés pour être téléchargés, comme dans le cas d'un site Web statique hébergé. Si la valeur est fausse, ObjectKey c'est obligatoire.

ObjectKey

Conditionnelle. Obligatoire si Extract = false

Le nom de la clé d'objet Amazon S3 qui identifie de manière unique l'objet dans le compartiment S3.

EncryptionKeyARN KMS

Obligatoire : non

L'ARN de la clé de AWS KMS chiffrement pour le compartiment hôte. Le KMSEncryptionKeyARN paramètre chiffre les artefacts téléchargés à l'aide du paramètre fourni AWS KMS key. Pour une clé KMS, vous pouvez utiliser l'ID de clé, l'ARN de la clé ou l'alias ARN.

Note

Les alias ne sont reconnus que dans le compte qui a créé la clé KMS. Pour les actions entre comptes, vous pouvez uniquement utiliser l'ID de clé ou l’ARN de clé pour identifier la clé. Les actions entre comptes impliquent l'utilisation du rôle de l'autre compte (AccountB), donc en spécifiant l'ID de la clé, la clé de l'autre compte (AccountB) sera utilisée.

Important

CodePipeline ne prend en charge que les clés KMS symétriques. N'utilisez pas de clé KMS asymétrique pour chiffrer les données de votre compartiment S3.

CannedACL

Obligatoire : non

Le CannedACL paramètre applique l'ACL prédéfinie spécifiée aux objets déployés sur Amazon S3. Celle-ci remplace n'importe quelle liste ACL existante appliquée à l'objet.

CacheControl

Obligatoire : non

Le CacheControl paramètre contrôle le comportement de mise en cache des demandes/réponses relatives aux objets du compartiment. Pour obtenir la liste des valeurs valides, consultez le champ d'en-tête Cache-Control pour les opérations HTTP. Pour entrer plusieurs valeurs dans CacheControl, utilisez une virgule entre chaque valeur. Vous pouvez ajouter un espace après chaque virgule (facultatif), comme illustré dans cet exemple pour l'interface de ligne de commande :

"CacheControl": "public, max-age=0, no-transform"

Artefacts d'entrée

• Nombre d'artefacts : 1

• Description : les fichiers à déployer ou à archiver sont obtenus à partir du référentiel source, compressés et téléchargés par CodePipeline.

Artefacts de sortie

• Nombre d'objets : 0

• Description : les artefacts de sortie ne s'appliquent pas à ce type d'action.

Exemple de configuration d'action

Vous trouverez ci-dessous des exemples de configuration de l'action.

Exemple de configuration lorsque Extract le paramètre est défini sur false

L'exemple suivant montre la configuration d'action par défaut lorsque l'action est créée avec le Extract champ défini surfalse.

YAML

Name: Deploy
Actions:
  - Name: Deploy
    ActionTypeId:
      Category: Deploy
      Owner: AWS
      Provider: S3
      Version: '1'
    RunOrder: 1
    Configuration:
      BucketName: website-bucket
      Extract: 'false'
    OutputArtifacts: []
    InputArtifacts:
      - Name: SourceArtifact
    Region: us-west-2
    Namespace: DeployVariables

JSON

{
    "Name": "Deploy",
    "Actions": [
        {
            "Name": "Deploy",
            "ActionTypeId": {
                "Category": "Deploy",
                "Owner": "AWS",
                "Provider": "S3",
                "Version": "1"
            },
            "RunOrder": 1,
            "Configuration": {
                "BucketName": "website-bucket",
                "Extract": "false"
                },
            "OutputArtifacts": [],
            "InputArtifacts": [
                {
                    "Name": "SourceArtifact"
                }
            ],
            "Region": "us-west-2",
            "Namespace": "DeployVariables"
        }
    ]
},

Exemple de configuration lorsque Extract le paramètre est défini sur true

L'exemple suivant montre la configuration d'action par défaut lorsque l'action est créée avec le Extract champ défini surtrue.

YAML

Name: Deploy
Actions:
  - Name: Deploy
    ActionTypeId:
      Category: Deploy
      Owner: AWS
      Provider: S3
      Version: '1'
    RunOrder: 1
    Configuration:
      BucketName: website-bucket
      Extract: 'true'
      ObjectKey: MyWebsite
    OutputArtifacts: []
    InputArtifacts:
      - Name: SourceArtifact
    Region: us-west-2
    Namespace: DeployVariables

JSON

{
    "Name": "Deploy",
    "Actions": [
        {
            "Name": "Deploy",
            "ActionTypeId": {
                "Category": "Deploy",
                "Owner": "AWS",
                "Provider": "S3",
                "Version": "1"
            },
            "RunOrder": 1,
            "Configuration": {
                "BucketName": "website-bucket",
                "Extract": "true",
                "ObjectKey": "MyWebsite"
                },
            "OutputArtifacts": [],
            "InputArtifacts": [
                {
                    "Name": "SourceArtifact"
                }
            ],
            "Region": "us-west-2",
            "Namespace": "DeployVariables"
        }
    ]
},

Consultez aussi

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

• Tutoriel : Création d'un pipeline utilisant Amazon S3 comme fournisseur de déploiement— Ce didacticiel présente deux exemples de création d'un pipeline avec une action de déploiement S3. Vous téléchargez des exemples de fichiers, vous chargez les fichiers dans votre CodeCommit référentiel, vous créez votre compartiment S3 et vous configurez votre compartiment pour l'hébergement. Ensuite, vous utilisez la CodePipeline console pour créer votre pipeline et spécifier une configuration de déploiement Amazon S3.

• Action relative à la source Amazon S3— Cette référence d'action fournit des informations de référence et des exemples d'actions source Amazon S3 dans CodePipeline.