Définition YAML de l'action « Amazon S3 publish »

Voici la définition YAML de l'action de publication Amazon S3. Pour savoir comment utiliser cette action, consultezPublication de fichiers sur Amazon S3 à l'aide d'un flux de travail.

Cette définition d'action existe sous forme de section au sein d'un fichier de définition de flux de travail plus large. Pour de plus amples informations sur ce fichier, veuillez consulter Définition du flux de travail YAML.

Note

La plupart des propriétés YAML suivantes ont des éléments d'interface utilisateur correspondants dans l'éditeur visuel. Pour rechercher un élément de l'interface utilisateur, utilisez Ctrl+F. L'élément sera répertorié avec sa propriété YAML associée.

# The workflow definition starts here.
# See Propriétés de haut niveau for details.
        
Name: MyWorkflow
SchemaVersion: 1.0 
Actions:

# The action definition starts here.    
  S3Publish_nn: 
    Identifier: aws/s3-publish@v1
    DependsOn:
      - build-action
    Compute:  
      Type: EC2 | Lambda
      Fleet: fleet-name
    Timeout: timeout-minutes
    Inputs:
      Sources:
        - source-name-1
      Artifacts:
        - artifact-name
      Variables:
        - Name: variable-name-1
          Value: variable-value-1
        - Name: variable-name-2
          Value: variable-value-2
    Environment:
      Name: environment-name
      Connections:
        - Name: account-connection-name
          Role: iam-role-name
    Configuration:
      SourcePath: my/source
      DestinationBucketName: s3-bucket-name
      TargetPath: my/target

S3Publish

(Obligatoire)

Spécifiez le nom de l'action. Tous les noms d'action doivent être uniques dans le flux de travail. Les noms d'action sont limités aux caractères alphanumériques (a-z, A-Z, 0-9), aux tirets (-) et aux traits de soulignement (_). Les espaces ne sont pas autorisés. Vous ne pouvez pas utiliser de guillemets pour activer les caractères spéciaux et les espaces dans les noms d'action.

Par défaut: S3Publish_nn.

Interface utilisateur correspondante : onglet Configuration/nom de l'action

Identifier

(S3Publish/Identifier)

(Obligatoire)

Identifie l'action. Ne modifiez pas cette propriété, sauf si vous souhaitez modifier la version. Pour plus d’informations, consultez Spécifier la version majeure, mineure ou corrective d'une action.

Par défaut: aws/s3-publish@v1.

Interface utilisateur correspondante : diagramme de flux de travail/ S3Publish _nn/ aws/s3-publish @v1 label

DependsOn

(S3Publish/DependsOn)

(Facultatif)

Spécifiez une action, un groupe d'actions ou une porte qui doit s'exécuter correctement pour que cette action soit exécutée.

Pour plus d'informations sur la fonctionnalité « dépend », consultez. Configuration des actions pour qu'elles dépendent d'autres actions

Interface utilisateur correspondante : onglet Entrées/dépend de - facultatif

Compute

(S3Publish/Compute)

(Facultatif)

Le moteur informatique utilisé pour exécuter les actions de votre flux de travail. Vous pouvez spécifier le calcul au niveau du flux de travail ou au niveau de l'action, mais pas les deux. Lorsqu'elle est spécifiée au niveau du flux de travail, la configuration de calcul s'applique à toutes les actions définies dans le flux de travail. Au niveau du flux de travail, vous pouvez également exécuter plusieurs actions sur la même instance. Pour plus d’informations, consultez Partage du calcul entre les actions.

Interface utilisateur correspondante : aucune

Type

(S3Publish/Compute/Type)

(Obligatoire s'Computeil est inclus)

Type de moteur de calcul. Vous pouvez utiliser l'une des valeurs suivantes :

• EC2 (éditeur visuel) ou EC2 (éditeur YAML)

  Optimisé pour la flexibilité lors des courses d'action.

• Lambda (éditeur visuel) ou Lambda (éditeur YAML)

  Vitesses de démarrage des actions optimisées.

Pour plus d'informations sur les types de calcul, veuillez consulter Types de calcul.

Interface utilisateur correspondante : onglet Configuration/Type de calcul

Fleet

(S3Publish/Compute/Fleet)

(Facultatif)

Spécifiez la machine ou le parc qui exécutera votre flux de travail ou vos actions de flux de travail. Dans le cas des flottes à la demande, lorsqu'une action démarre, le flux de travail fournit les ressources dont il a besoin et les machines sont détruites à la fin de l'action. Exemples de flottes à la demande :Linux.x86-64.Large,Linux.x86-64.XLarge. Pour plus d'informations sur les flottes à la demande, consultezPropriétés de flotte à la demande.

Avec les flottes provisionnées, vous configurez un ensemble de machines dédiées pour exécuter les actions de votre flux de travail. Ces machines restent inactives, prêtes à exécuter des actions immédiatement. Pour plus d'informations sur les flottes provisionnées, consultez. Propriétés du parc provisionné

S'il Fleet est omis, la valeur par défaut estLinux.x86-64.Large.

Interface utilisateur correspondante : onglet Configuration/parc de calcul

Timeout

(S3Publish/Timeout)

(Obligatoire)

Spécifiez la durée en minutes (éditeur YAML) ou en heures et minutes (éditeur visuel) pendant laquelle l'action peut être exécutée avant la CodeCatalyst fin de l'action. Le minimum est de 5 minutes et le maximum est décrit dansQuotas pour les workflows. Le délai d'expiration par défaut est le même que le délai d'expiration maximal.

Interface utilisateur correspondante : onglet Configuration/Délai d'expiration - facultatif

Inputs

(S3Publish/Inputs)

(Facultatif)

La Inputs section définit les données dont ils ont S3Publish besoin lors de l'exécution d'un flux de travail.

Note

Un maximum de quatre entrées (une source et trois artefacts) sont autorisées pour chaque action de AWS CDK déploiement. Les variables ne sont pas prises en compte dans ce total.

Si vous devez faire référence à des fichiers résidant dans différentes entrées (par exemple, une source et un artefact), l'entrée source est l'entrée principale et l'artefact est l'entrée secondaire. Les références aux fichiers dans les entrées secondaires utilisent un préfixe spécial pour les distinguer du fichier principal. Pour plus de détails, consultez Exemple : Référencement de fichiers dans plusieurs artefacts.

Interface utilisateur correspondante : onglet Entrées

Sources

(S3Publish/Inputs/Sources)

(Obligatoire si les fichiers que vous souhaitez publier sur Amazon S3 sont stockés dans un référentiel source)

Si les fichiers que vous souhaitez publier sur Amazon S3 sont stockés dans un référentiel source, spécifiez l'étiquette de ce référentiel source. Actuellement, la seule étiquette prise en charge estWorkflowSource.

Si les fichiers que vous souhaitez publier sur Amazon S3 ne figurent pas dans un référentiel source, ils doivent résider dans un artefact généré par une autre action.

Pour plus d'informations sur les sources, consultez Connexion d'un flux de travail à un référentiel source.

Interface utilisateur correspondante : onglet Entrées/Sources - facultatif

Artifacts - input

(S3Publish/Inputs/Artifacts)

(Obligatoire si les fichiers que vous souhaitez publier sur Amazon S3 sont stockés dans un artefact de sortie issu d'une action précédente)

Si les fichiers que vous souhaitez publier sur Amazon S3 sont contenus dans un artefact généré par une action précédente, spécifiez cet artefact ici. Si vos fichiers ne sont pas contenus dans un artefact, ils doivent se trouver dans votre référentiel source.

Pour plus d'informations sur les artefacts, y compris des exemples, consultezPartage de données entre les actions d'un flux de travail à l'aide d'artefacts.

Interface utilisateur correspondante : onglet Configuration/Artefacts - facultatif

Variables - input

(S3Publish/Inputs/Variables)

(Facultatif)

Spécifiez une séquence de paires nom/valeur qui définissent les variables d'entrée que vous souhaitez mettre à la disposition de l'action. Les noms de variables sont limités aux caractères alphanumériques (a-z, A-Z, 0-9), aux tirets (-) et aux traits de soulignement (_). Les espaces ne sont pas autorisés. Vous ne pouvez pas utiliser de guillemets pour activer les caractères spéciaux et les espaces dans les noms de variables.

Pour plus d'informations sur les variables, y compris des exemples, consultezConfiguration et utilisation de variables dans un flux de travail.

Interface utilisateur correspondante : onglet Entrées/Variables - facultatif

Environment

(S3Publish/Environment)

(Obligatoire)

Spécifiez l' CodeCatalyst environnement à utiliser avec l'action. L'action se connecte au Compte AWS VPC Amazon facultatif spécifié dans l'environnement choisi. L'action utilise le rôle IAM par défaut spécifié dans l'environnement pour se connecter au Compte AWS, et utilise le rôle IAM spécifié dans la connexion Amazon VPC pour se connecter à Amazon VPC.

Note

Si le rôle IAM par défaut ne dispose pas des autorisations requises par l'action, vous pouvez configurer l'action pour utiliser un autre rôle. Pour plus d’informations, consultez Affectation d'un rôle IAM différent à une action.

Pour plus d'informations sur les environnements, reportez-vous Déploiement dans Comptes AWS et avec CodeCatalyst des environnements VPC aux sections etCréation d'un environnement.

Interface utilisateur correspondante : onglet Configuration/Environnement

Name

(S3Publish/Environment/Name)

(Obligatoire s'Environmentil est inclus)

Spécifiez le nom de l'environnement existant que vous souhaitez associer à l'action.

Interface utilisateur correspondante : onglet Configuration/Environnement

Connections

(S3Publish/Environment/Connections)

(Facultatif dans les nouvelles versions de l'action ; obligatoire dans les anciennes versions)

Spécifiez la connexion au compte à associer à l'action. Vous pouvez spécifier un maximum d'une connexion à un compte sousEnvironment.

Si vous ne spécifiez pas de connexion au compte :

• L'action utilise la Compte AWS connexion et le rôle IAM par défaut spécifiés dans l'environnement de la CodeCatalyst console. Pour plus d'informations sur l'ajout d'une connexion à un compte et d'un rôle IAM par défaut dans l'environnement, consultezCréation d'un environnement.

• Le rôle IAM par défaut doit inclure les politiques et les autorisations requises par l'action. Pour déterminer quelles sont ces politiques et autorisations, consultez la description de la propriété Role dans la documentation de définition YAML de l'action.

Pour plus d'informations sur les connexions aux comptes, consultezPermettre l'accès aux AWS ressources avec Connected Comptes AWS. Pour plus d'informations sur l'ajout d'une connexion de compte à un environnement, consultezCréation d'un environnement.

Interface utilisateur correspondante : l'une des options suivantes, selon la version de l'action :

• (Versions plus récentes) Onglet configuration/Environnement/Qu'y a-t-il dans mon environnement ? /menu à trois points/ Changer de rôle

• (Anciennes versions) Onglet de configuration/'Environnement/Compte/Role'/ Connexion AWS au compte

Name

(S3Publish/Environment/Connections/Name)

(Obligatoire s'Connectionsil est inclus)

Spécifiez le nom de la connexion au compte.

Interface utilisateur correspondante : l'une des options suivantes, selon la version de l'action :

• (Versions plus récentes) Onglet configuration/Environnement/Qu'y a-t-il dans mon environnement ? /menu à trois points/ Changer de rôle

• (Anciennes versions) Onglet de configuration/'Environnement/Compte/Role'/ Connexion AWS au compte

Role

(S3Publish/Environment/Connections/Role)

(Obligatoire s'Connectionsil est inclus)

Spécifiez le nom du rôle IAM que l'action de publication Amazon S3 utilise pour accéder aux fichiers AWS et les copier sur Amazon S3. Assurez-vous que vous avez ajouté le rôle à votre CodeCatalyst espace et qu'il inclut les politiques suivantes.

Si vous ne spécifiez aucun rôle IAM, l'action utilise le rôle IAM par défaut répertorié dans l'environnement de la console. CodeCatalyst Si vous utilisez le rôle par défaut dans l'environnement, assurez-vous qu'il est conforme aux politiques suivantes.

• La politique d'autorisation suivante :

  Avertissement

  Limitez les autorisations à celles indiquées dans la politique suivante. L'utilisation d'un rôle doté d'autorisations plus étendues peut présenter un risque de sécurité.

  {
      "Version": "2012-10-17",
      "Statement": [
          {
              "Sid": "VisualEditor0",
              "Effect": "Allow",
              "Action": [
                  "s3:PutObject",
                  "s3:ListBucket",
                  "s3:DeleteObject"
              ],
              "Resource": [
                  "arn:aws:s3:::bucket-name",
                  "arn:aws:s3:::bucket-name/*"
              ]
          }
      ]
  }

• La politique de confiance personnalisée suivante :

  {
      "Version": "2012-10-17",
      "Statement": [
          {
              "Sid": "",
              "Effect": "Allow",
              "Principal": {
                  "Service":  [
                     "codecatalyst-runner.amazonaws.com",
                     "codecatalyst.amazonaws.com"
                   ]
              },
              "Action": "sts:AssumeRole"
          }
      ]
  }

Note

Vous pouvez utiliser le CodeCatalystWorkflowDevelopmentRole-spaceName rôle avec cette action, si vous le souhaitez. Pour plus d’informations sur ce rôle, consultez Création du CodeCatalystWorkflowDevelopmentRole-spaceNamerôle pour votre compte et votre espace. Sachez que le CodeCatalystWorkflowDevelopmentRole-spaceName rôle dispose d'autorisations d'accès complètes, ce qui peut présenter un risque de sécurité. Nous vous recommandons de n'utiliser ce rôle que dans les didacticiels et les scénarios où la sécurité est moins préoccupante.

Interface utilisateur correspondante : l'une des suivantes, selon la version de l'action :

• (Versions plus récentes) Onglet configuration/Environnement/Qu'y a-t-il dans mon environnement ? /menu à trois points/ Changer de rôle

• (Anciennes versions) Onglet de configuration/'Environnement/Compte/Role'/ Rôle

Configuration

(S3Publish/Configuration)

(Obligatoire)

Section dans laquelle vous pouvez définir les propriétés de configuration de l'action.

Interface utilisateur correspondante : onglet Configuration

SourcePath

(S3Publish/Configuration/SourcePath)

(Obligatoire)

Spécifiez le nom et le chemin d'un répertoire ou d'un fichier que vous souhaitez publier sur Amazon S3. Le répertoire ou le fichier peut résider dans un référentiel source ou dans un artefact issu d'une action précédente, et est relatif au référentiel source ou à la racine de l'artefact.

Exemples :

La spécification ./myFolder/ copie le contenu de /myFolder vers Amazon S3 et préserve la structure de répertoire sous-jacente.

Spécifier ./myFolder/myfile.txt des copies uniquement myfile.txt pour Amazon S3. (La structure du répertoire est supprimée.)

Vous ne pouvez pas utiliser de caractères génériques.

Note

Vous devrez peut-être ajouter un préfixe au répertoire ou au chemin du fichier pour indiquer dans quel artefact ou dans quelle source le trouver. Pour plus d’informations, consultez Référencement de fichiers dans un référentiel source et Référencement de fichiers dans un artefact.

Interface utilisateur correspondante : onglet Configuration/chemin source

DestinationBucketName

(S3Publish/Configuration/DestinationBucketName)

(Obligatoire)

Spécifiez le nom du compartiment Amazon S3 dans lequel vous souhaitez publier les fichiers.

Interface utilisateur correspondante : onglet Configuration/compartiment de destination - facultatif

TargetPath

(S3Publish/Configuration/TargetPath)

(Facultatif)

Spécifiez le nom et le chemin du répertoire dans Amazon S3 dans lequel vous souhaitez publier vos fichiers. Si le répertoire n'existe pas, il sera créé. Le chemin du répertoire ne doit pas inclure le nom du bucket.

Exemples :

myS3Folder

./myS3Folder/myS3Subfolder

Interface utilisateur correspondante : onglet Configuration/répertoire de destination - facultatif