Ação “Render Amazon ECS task definition” YAML

A seguir está a YAML definição da ação de definição de ECS tarefas Render Amazon. Para saber como usar essa ação, consulteModificando uma definição de ECS tarefa da Amazon.

Essa definição de ação existe como uma seção dentro de um arquivo de definição de fluxo de trabalho mais amplo. Para obter mais informações sobre esse arquivo, consulte YAMLDefinição de fluxo de trabalho.

nota

A maioria das YAML propriedades a seguir tem elementos de interface de usuário correspondentes no editor visual. Para pesquisar um elemento de interface do usuário, use Ctrl+F. O elemento será listado com sua YAML propriedade associada.


# The workflow definition starts here.
# See Propriedades de nível superior 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

(Obrigatório)

Especifique o nome da ação. Todos os nomes das ações devem ser exclusivos no fluxo de trabalho. Os nomes das ações são limitados a caracteres alfanuméricos (a-z, A-Z, 0-9), hífens (-) e sublinhados (_). Não são permitidos espaços. Você não pode usar aspas para ativar caracteres especiais e espaços nos nomes das ações.

Padrão: ECSRenderTaskDefinition_nn.

UI correspondente: guia de configuração/nome da ação

Identifier

(ECSRenderTaskDefinition/Identifier)

(Obrigatório)

Identifica a ação. Não altere essa propriedade, a menos que você queira alterar a versão. Para ter mais informações, consulte Especificando a versão da ação a ser usada.

Padrão: aws/ecs-render-task-definition@v1.

UI correspondente: diagrama de fluxo de trabalho/ ECSRenderTaskDefinition _nn/ aws/ @v1 label ecs-render-task-definition

DependsOn

(ECSRenderTaskDefinition/DependsOn)

(Optional)

Especifique uma ação, grupo de ação ou porta que deve ser executada com êxito para que essa ação seja executada.

Para obter mais informações sobre a funcionalidade “depende de”, consulte. Ações de sequenciamento

UI correspondente: guia Entradas/Depende de - opcional

Compute

(ECSRenderTaskDefinition/Compute)

(Optional)

O mecanismo de computação usado para executar suas ações de fluxo de trabalho. Você pode especificar a computação no nível do fluxo de trabalho ou no nível da ação, mas não em ambos. Quando especificada no nível do fluxo de trabalho, a configuração computacional se aplica a todas as ações definidas no fluxo de trabalho. No nível do fluxo de trabalho, você também pode executar várias ações na mesma instância. Para ter mais informações, consulte Compartilhamento de computação entre ações.

UI correspondente: nenhuma

Type

(ECSRenderTaskDefinition/Compute/Type)

(Obrigatório se Compute estiver incluído)

O tipo de mecanismo de computação. Você pode usar um dos seguintes valores:

EC2(editor visual) ou EC2 (YAMLeditor)

Otimizado para flexibilidade durante as corridas de ação.
Lambda (editor visual) ou Lambda (YAMLeditor)

Velocidades otimizadas de inicialização da ação.

Para obter informações sobre tipos de dados, consulte Tipos de computação.

UI correspondente: guia de configuração/tipo de computação

Fleet

(ECSRenderTaskDefinition/Compute/Fleet)

(Optional)

Especifique a máquina ou frota que executará seu fluxo de trabalho ou ações de fluxo de trabalho. Com frotas sob demanda, quando uma ação é iniciada, o fluxo de trabalho provisiona os recursos necessários e as máquinas são destruídas quando a ação é concluída. Exemplos de frotas sob demanda:Linux.x86-64.Large,. Linux.x86-64.XLarge Para obter mais informações sobre frotas sob demanda, consulte. Propriedades de frota sob demanda

Com frotas provisionadas, você configura um conjunto de máquinas dedicadas para executar suas ações de fluxo de trabalho. Essas máquinas permanecem ociosas, prontas para processar ações imediatamente. Para obter mais informações sobre frotas provisionadas, consulte. Propriedades da frota provisionada

Se Fleet for omitido, o padrão será. Linux.x86-64.Large

UI correspondente: guia de configuração/frota de computação

Timeout

(ECSRenderTaskDefinition/Timeout)

(Optional)

Especifique a quantidade de tempo em minutos (YAMLeditor) ou horas e minutos (editor visual) que a ação pode ser executada antes de CodeCatalyst finalizar a ação. O mínimo é de 5 minutos e o máximo está descrito emCotas para fluxos de trabalho em CodeCatalyst. O tempo limite padrão é o mesmo que o tempo limite máximo.

UI correspondente: guia de configuração/tempo limite - opcional

Inputs

(ECSRenderTaskDefinition/Inputs)

(Optional)

A Inputs seção define os dados ECSRenderTaskDefinition necessários durante a execução de um fluxo de trabalho.

nota

Somente uma entrada (uma fonte ou um artefato) é permitida por ação de definição de ECS tarefa do Render Amazon. As variáveis não contam para esse total.

UI correspondente: guia Entradas

Sources

(ECSRenderTaskDefinition/Inputs/Sources)

(Obrigatório se o arquivo de definição de tarefas estiver armazenado em um repositório de origem)

Se seu arquivo de definição de tarefa estiver armazenado em um repositório de origem, especifique o rótulo desse repositório de origem. Atualmente, o único rótulo compatível éWorkflowSource.

Se seu arquivo de definição de tarefa não estiver contido em um repositório de origem, ele deverá residir em um artefato gerado por outra ação.

Para obter mais informações sobre fontes, consulte Conectando repositórios de origem aos fluxos de trabalho.

UI correspondente: guia Entradas/Fontes - opcional

Artifacts - input

(ECSRenderTaskDefinition/Inputs/Artifacts)

(Obrigatório se o arquivo de definição de tarefa estiver armazenado em um artefato de saída de uma ação anterior)

Se o arquivo de definição de tarefa que você deseja implantar estiver contido em um artefato gerado por uma ação anterior, especifique esse artefato aqui. Se o arquivo de definição de tarefas não estiver contido em um artefato, ele deverá residir no seu repositório de origem.

Para obter mais informações sobre artefatos, incluindo exemplos, consulteCompartilhamento de artefatos e arquivos entre ações.

UI correspondente: guia de configuração/artefatos - opcional

Variables - input

(ECSRenderTaskDefinition/Inputs/Variables)

(Obrigatório)

Especifique uma sequência de pares de nome/valor que definam as variáveis de entrada que você deseja disponibilizar para a ação. Os nomes das variáveis são limitados a caracteres alfanuméricos (a-z, A-Z, 0-9), hífens (-) e sublinhados (_). Não são permitidos espaços. Você não pode usar aspas para habilitar caracteres especiais e espaços em nomes de variáveis.

Para obter mais informações sobre variáveis, incluindo exemplos, consulteUsando variáveis em fluxos de trabalho.

UI correspondente: guia de entradas/variáveis - opcional

Configuration

(ECSRenderTaskDefinition/Configuration)

(Obrigatório)

Uma seção na qual você pode definir as propriedades de configuração da ação.

UI correspondente: guia Configuração

task-definition

(ECSRenderTaskDefinition/Configuration/task-definition)

(Obrigatório)

Especifique o caminho para um arquivo de definição de tarefa existente. Se o arquivo residir no seu repositório de origem, o caminho é relativo à pasta raiz do repositório de origem. Se o arquivo residir em um artefato de uma ação anterior do fluxo de trabalho, o caminho é relativo à pasta raiz do artefato. Para obter mais informações sobre arquivos de definição de tarefas, consulte Definições de tarefas no Amazon Elastic Container Service Developer Guide.

UI correspondente: guia de configuração/definição de tarefa

container-definition-name

(ECSRenderTaskDefinition/Configuration/container-definition-name)

(Obrigatório)

Especifique o nome do contêiner em que sua imagem do Docker será executada. Você pode encontrar esse nome no name campocontainerDefinitions, em seu arquivo de definição de tarefa. Para obter mais informações, consulte Nome no Guia do desenvolvedor do Amazon Elastic Container Service.

UI correspondente: guia de configuração/nome do contêiner

image

(ECSRenderTaskDefinition/Configuration/image)

(Obrigatório)

Especifique o nome da imagem do Docker que você deseja que a ação de definição de ECS tarefas Render Amazon adicione ao seu arquivo de definição de tarefas. A ação adiciona esse nome ao image campocontainerDefinitions, em seu arquivo de definição de tarefa. Se um valor já existir no image campo, a ação o substituirá. Você pode incluir variáveis no nome da imagem.

Exemplos:

Se você especificarMyDockerImage:${WorkflowSource.CommitId}, a ação será adicionada MyDockerImage:commit-id ao arquivo de definição da tarefa, onde commit-id é um ID de confirmação gerado em tempo de execução pelo fluxo de trabalho.

Se você especificarmy-ecr-repo/image-repo:$(date +%m-%d-%y-%H-%m-%s), a ação adiciona my-ecr-repo/repositório de imagens:date +%m-%d-%y-%H-%m-%s para o arquivo de definição da tarefa, onde my-ecr-repo é o URI de um Amazon Elastic Container Registry (ECR) e date +%m-%d-%y-%H-%m-%s é um carimbo de data/hora no formato month-day-year-hour-minute-second gerado em tempo de execução pelo fluxo de trabalho.

Para obter mais informações sobre o image campo, consulte a imagem no Amazon Elastic Container Service Developer Guide. Para obter mais informações sobre variáveis, consulteUsando variáveis em fluxos de trabalho.

UI correspondente: guia de configuração/nome da imagem

environment-variables

(ECSRenderTaskDefinition/Configuration/environment-variables)

(Obrigatório)

Especifique as variáveis de ambiente que você deseja que a ação de definição de ECS tarefas Render Amazon adicione ao seu arquivo de definição de tarefas. A ação adiciona as variáveis ao environment campocontainerDefinitions, em seu arquivo de definição de tarefa. Se as variáveis já existirem no arquivo, a ação substituirá os valores das variáveis existentes e adicionará quaisquer novas variáveis. Para obter mais informações sobre as variáveis de ECS ambiente da Amazon, consulte Especificação de variáveis de ambiente no Guia do desenvolvedor do Amazon Elastic Container Service.

UI correspondente: guia de configuração/variáveis de ambiente - opcional

Outputs

(ECSRenderTaskDefinition/Outputs)

(Obrigatório)

Define os dados que são gerados pela ação durante a execução de um fluxo de trabalho.

UI correspondente: guia Saídas

Artifacts

(ECSRenderTaskDefinition/Outputs/Artifacts)

(Obrigatório)

Especifique os artefatos gerados pela ação. Você pode referenciar esses artefatos como entrada em outras ações.

Para obter mais informações sobre artefatos, incluindo exemplos, consulteCompartilhamento de artefatos e arquivos entre ações.

UI correspondente: guia Saídas/Artefatos

Name

(ECSRenderTaskDefinition/Outputs/Artifacts/Name)

(Obrigatório)

Especifique o nome do artefato que conterá o arquivo de definição de tarefa atualizado. O valor padrão é MyTaskDefinitionArtifact. Em seguida, você deve especificar esse artefato como entrada na ECS ação Deploy to Amazon. Para entender como adicionar esse artefato como entrada para a ECS ação Deploy to Amazon, consulteExemplo: Modificar um ECS taskdef da Amazon.

UI correspondente: guia Saídas/artefatos/nome

Files

(ECSRenderTaskDefinition/Outputs/Artifacts/Files)

(Obrigatório)

Especifique os arquivos a serem incluídos no artefato. Você deve especificar task-definition-* para que o arquivo de definição de tarefa atualizado, que começa comtask-definition-, seja incluído.

UI correspondente: guia Saídas/artefatos/arquivos

Variables

(ECSRenderTaskDefinition/Outputs/Variables)

(Obrigatório)

Especifique o nome de uma variável a ser definida pela ação de renderização. A ação de renderização definirá o valor dessa variável como o nome do arquivo de definição de tarefa atualizado (por exemplo,task-definition-random-string.json). Em seguida, você deve especificar essa variável na propriedade de definição de tarefa (editor visual) ou task-definition (editor yaml) da ECS ação Deploy to Amazon. Para entender como adicionar essa variável à ECS ação Deploy to Amazon, consulteExemplo: Modificar um ECS taskdef da Amazon.

Padrão: task-definition

UI correspondente: guia de saídas/variáveis/campo de nome

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

Variáveis - 'Render a definição de ECS tarefa da Amazon'

Usando variáveis em fluxos de trabalho