Action « Rendre la définition de ECS la tâche Amazon » YAML

Voici la YAML définition de l'action de définition de ECStâche Render Amazon. Pour savoir comment utiliser cette action, consultezModifier une définition de ECS tâche Amazon.

Cette définition d'action existe sous la forme d'une 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 YAMLDéfinition du flux de travail.

Note

La plupart des YAML propriétés 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 YAML propriété 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.   
  ECSRenderTaskDefinition_nn: 
    Identifier: aws/ecs-render-task-definition@v1
    DependsOn:
      - build-action
    Compute:  
      Type: EC2 | Lambda
      Fleet: fleet-name
    Timeout: timeout-minutes
    Inputs:
      # Specify a source or an artifact, but not both.
      Sources:
        - source-name-1
      Artifacts:
        - task-definition-artifact
      Variables:
        - Name: variable-name-1
          Value: variable-value-1
        - Name: variable-name-2
          Value: variable-value-2
    Configuration 
      task-definition: task-definition-path
      container-definition-name: container-definition-name
      image: docker-image-name
      environment-variables:
        - variable-name-1=variable-value-1
        - variable-name-2=variable-value-2
    Outputs:
      Artifacts:
        - Name: TaskDefArtifact
          Files: "task-definition*"
      Variables:
        - task-definition
        

ECSRenderTaskDefinition

(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: ECSRenderTaskDefinition_nn.

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

Identifier

(ECSRenderTaskDefinition/Identifier)

(Obligatoire)

Identifie l'action. Ne modifiez pas cette propriété, sauf si vous souhaitez modifier la version. Pour plus d’informations, consultez Spécification de la version de l'action à utiliser.

Par défaut: aws/ecs-render-task-definition@v1.

Interface utilisateur correspondante : diagramme de flux de travail/ ECSRenderTaskDefinition _nn/ aws/ @v1 label ecs-render-task-definition

DependsOn

(ECSRenderTaskDefinition/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. Actions de séquençage

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

Compute

(ECSRenderTaskDefinition/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

(ECSRenderTaskDefinition/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 (YAMLéditeur)

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

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

  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

(ECSRenderTaskDefinition/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

(ECSRenderTaskDefinition/Timeout)

(Facultatif)

Spécifiez la durée en minutes (YAMLéditeur) 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 flux de travail dans CodeCatalyst. 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

(ECSRenderTaskDefinition/Inputs)

(Facultatif)

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

Note

Une seule entrée (source ou artefact) est autorisée par action de définition de ECS tâche Render Amazon. Les variables ne sont pas prises en compte dans ce total.

Interface utilisateur correspondante : onglet Entrées

Sources

(ECSRenderTaskDefinition/Inputs/Sources)

(Obligatoire si votre fichier de définition de tâche est stocké dans un référentiel source)

Si votre fichier de définition de tâche est stocké 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 votre fichier de définition de tâche n'est pas contenu dans un référentiel source, il doit résider dans un artefact généré par une autre action.

Pour plus d'informations sur les sources, consultez Connecter les référentiels sources aux flux de travail.

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

Artifacts - input

(ECSRenderTaskDefinition/Inputs/Artifacts)

(Obligatoire si votre fichier de définition de tâche est stocké dans un artefact de sortie d'une action précédente)

Si le fichier de définition de tâche que vous souhaitez déployer est contenu dans un artefact généré par une action précédente, spécifiez cet artefact ici. Si votre fichier de définition de tâche n'est pas contenu dans un artefact, il doit résider dans votre référentiel source.

Pour plus d'informations sur les artefacts, y compris des exemples, consultezPartage d'artefacts et de fichiers entre les actions.

Interface utilisateur correspondante : onglet Configuration/Artefacts - facultatif

Variables - input

(ECSRenderTaskDefinition/Inputs/Variables)

(Obligatoire)

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, consultezUtilisation de variables dans les flux de travail.

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

Configuration

(ECSRenderTaskDefinition/Configuration)

(Obligatoire)

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

Interface utilisateur correspondante : onglet Configuration

task-definition

(ECSRenderTaskDefinition/Configuration/task-definition)

(Obligatoire)

Spécifiez le chemin d'accès à un fichier de définition de tâche existant. Si le fichier se trouve dans votre dépôt source, le chemin est relatif au dossier racine du dépôt source. Si votre fichier réside dans un artefact issu d'une action de flux de travail précédente, le chemin est relatif au dossier racine de l'artefact. Pour plus d'informations sur les fichiers de définition de tâches, consultez la section Définitions de tâches dans le manuel Amazon Elastic Container Service Developer Guide.

Interface utilisateur correspondante : onglet Configuration/Définition des tâches

container-definition-name

(ECSRenderTaskDefinition/Configuration/container-definition-name)

(Obligatoire)

Spécifiez le nom du conteneur dans lequel votre image Docker sera exécutée. Vous pouvez trouver ce nom dans le name champcontainerDefinitions, de votre fichier de définition de tâche. Pour plus d'informations, consultez la section Nom dans le manuel Amazon Elastic Container Service Developer Guide.

Interface utilisateur correspondante : onglet Configuration/nom du conteneur

image

(ECSRenderTaskDefinition/Configuration/image)

(Obligatoire)

Spécifiez le nom de l'image Docker que l'action de définition de ECS tâche Render Amazon doit ajouter à votre fichier de définition de tâche. L'action ajoute ce nom au image champcontainerDefinitions, de votre fichier de définition de tâche. Si une valeur existe déjà dans le image champ, l'action la remplace. Vous pouvez inclure des variables dans le nom de l'image.

Exemples :

Si vous le spécifiezMyDockerImage:${WorkflowSource.CommitId}, l'action est ajoutée MyDockerImage:commit-id au fichier de définition de tâche, où commit-id est un identifiant de validation généré lors de l'exécution par le flux de travail.

Si vous le spécifiezmy-ecr-repo/image-repo:$(date +%m-%d-%y-%H-%m-%s), l'action ajoute my-ecr-repo/image-repo :date +%m-%d-%y-%H-%m-%s dans le fichier de définition de tâche, où my-ecr-repo est celui URI d'un Amazon Elastic Container Registry (ECR) et date +%m-%d-%y-%H-%m-%s est un horodatage au format month-day-year-hour-minute-second généré lors de l'exécution par le flux de travail.

Pour plus d'informations sur ce image champ, consultez l'image dans le manuel Amazon Elastic Container Service Developer Guide. Pour plus d'informations sur les variables, consultezUtilisation de variables dans les flux de travail.

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

environment-variables

(ECSRenderTaskDefinition/Configuration/environment-variables)

(Obligatoire)

Spécifiez les variables d'environnement que vous souhaitez que l'action Render Amazon de définition de ECS tâche ajoute à votre fichier de définition de tâche. L'action ajoute les variables au environment champcontainerDefinitions, de votre fichier de définition de tâche. Si des variables existent déjà dans le fichier, l'action remplace les valeurs des variables existantes et ajoute de nouvelles variables. Pour plus d'informations sur les variables d'ECSenvironnement Amazon, consultez la section Spécification des variables d'environnement dans le manuel Amazon Elastic Container Service Developer Guide.

Interface utilisateur correspondante : onglet Configuration/variables d'environnement - facultatif

Outputs

(ECSRenderTaskDefinition/Outputs)

(Obligatoire)

Définit les données produites par l'action lors de l'exécution d'un flux de travail.

Interface utilisateur correspondante : onglet Sorties

Artifacts

(ECSRenderTaskDefinition/Outputs/Artifacts)

(Obligatoire)

Spécifiez les artefacts générés par l'action. Vous pouvez faire référence à ces artefacts en tant qu'entrée dans d'autres actions.

Pour plus d'informations sur les artefacts, y compris des exemples, consultezPartage d'artefacts et de fichiers entre les actions.

Interface utilisateur correspondante : onglet Sorties/Artefacts

Name

(ECSRenderTaskDefinition/Outputs/Artifacts/Name)

(Obligatoire)

Spécifiez le nom de l'artefact qui contiendra le fichier de définition de tâche mis à jour. La valeur par défaut est MyTaskDefinitionArtifact. Vous devez ensuite spécifier cet artefact comme entrée dans l'ECSaction Deploy to Amazon. Pour comprendre comment ajouter cet artefact en tant qu'entrée à l'ECSaction Deploy to Amazon, consultezExemple : modifier une définition de ECS tâches Amazon.

Interface utilisateur correspondante : onglet Sorties/Artefacts/Nom

Files

(ECSRenderTaskDefinition/Outputs/Artifacts/Files)

(Obligatoire)

Spécifiez les fichiers à inclure dans l'artefact. Vous devez spécifier task-definition-* que le fichier de définition de tâche mis à jour, qui commence partask-definition-, sera inclus.

Interface utilisateur correspondante : onglet Sorties/Artefacts/Fichiers

Variables

(ECSRenderTaskDefinition/Outputs/Variables)

(Obligatoire)

Spécifiez le nom d'une variable à définir par l'action de rendu. L'action de rendu définira la valeur de cette variable sur le nom du fichier de définition de tâche mis à jour (par exemple,task-definition-random-string.json). Vous devez ensuite spécifier cette variable dans la propriété de définition de tâche (éditeur visuel) ou task-definition (éditeur yaml) de l'ECSaction Deploy to Amazon. Pour comprendre comment ajouter cette variable à l'ECSaction Deploy to Amazon, consultezExemple : modifier une définition de ECS tâches Amazon.

Par défaut : task-definition

Interface utilisateur correspondante : onglet Sorties/Variables/Champ de nom