YAML da ação “Inicialização do AWS CDK”

Confira a seguir a definição de YAML da ação Inicialização do AWS CDK. Para saber como usar essa ação, consulte Inicializar uma aplicação AWS CDK com um fluxo de trabalho.

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 Definição do YAML do fluxo de trabalho.

# The workflow definition starts here.
# See Propriedades de nível superior for details.
        
Name: MyWorkflow
SchemaVersion: 1.0 
Actions:

# The action definition starts here.    
  CDKBootstrapAction_nn: 
    Identifier: aws/cdk-bootstrap@v2
    DependsOn:
      - action-name
    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:
        - artifact-name
    Outputs:
      Artifacts:
        - Name: cdk_bootstrap_artifacts
          Files: 
            - "cdk.out/**/*"
    Environment:
      Name: environment-name
      Connections:
        - Name: account-connection-name
          Role: iam-role-name
    Configuration:
      Region: us-west-2
      CdkCliVersion: version

CDKBootstrapAction

(Obrigatório)

Especifique o nome da ação. Todos os nomes de ação devem ser exclusivos no fluxo de trabalho. Os nomes de ação são limitados a caracteres alfanuméricos (a-z, A-Z, 0-9), hifens (-) e sublinhados (_). Não são permitidos espaços. Não é possível usar aspas para habilitar caracteres especiais e espaços nos nomes de ação.

Padrão: CDKBootstrapAction_nn.

Interface de usuário correspondente: guia Configuração/Nome de exibição da ação

Identifier

(CDKBootstrapAction/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 Especificação da versão da ação a ser usada.

Padrão: aws/cdk-bootstrap@v2.

Interface de usuário correspondente: Diagrama de fluxo de trabalho/CDKBootstrapAction_nn/rótulo aws/cdk-bootstrap@v2

DependsOn

(CDKBootstrapAction/DependsOn)

(Opcional)

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

Para ter mais informações sobre a funcionalidade “Depende de”, consulte Sequenciar ações.

Interface de usuário correspondente: guia Entradas/Depende de - opcional

Compute

(CDKBootstrapAction/Compute)

(Opcional)

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

Interface de usuário correspondente: nenhuma

Type

(CDKBootstrapAction/Compute/Type)

(Obrigatório se Compute for incluído)

O tipo do mecanismo de computação. É possível usar um dos seguintes valores:

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

Interface de usuário correspondente: guia Configuração/Avançado - opcional/Tipo de computação

Fleet

(CDKBootstrapAction/Compute/Fleet)

(Opcional)

Especifique a máquina ou a frota que executará o fluxo de trabalho ou as 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 termina. Exemplos de frota sob demanda: Linux.x86-64.Large, Linux.x86-64.XLarge. Para ter mais informações sobre frotas sob demanda, consulte Propriedades da frota sob demanda.

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

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

Interface de usuário correspondente: guia Configuração/Avançado - opcional/Frota de computação

Timeout

(CDKBootstrapAction/Timeout)

(Obrigatório)

Especifique a quantidade de tempo em minutos (editor YAML) ou horas e minutos (editor visual) que a ação pode ser realizada antes que o CodeCatalyst termine a ação. O mínimo é de cinco minutos e o máximo está descrito em Cotas para fluxos de trabalho no CodeCatalyst. O tempo limite padrão é igual ao tempo limite máximo.

Interface de usuário correspondente: guia Configuração/Tempo limite - opcional

Inputs

(CDKBootstrapAction/Inputs)

(Opcional)

A seção Inputs define os dados que a ação Inicialização do AWS CDK precisa durante a execução de um fluxo de trabalho.

Interface de usuário correspondente: guia Entradas

Sources

(CDKBootstrapAction/Inputs/Sources)

(Obrigatório se a aplicação AWS CDK estiver armazenada em um repositório de origem)

Se a aplicação AWS CDK estiver armazenada em um repositório de origem, especifique o rótulo do repositório de origem. A ação Inicialização do AWS CDK sintetiza a aplicação nesse repositório antes de iniciar o processo de inicialização. Atualmente, o único rótulo do repositório compatível é WorkflowSource.

Se a aplicação AWS CDK não estiver em um repositório de origem, ela deverá residir em um artefato gerado por outra ação.

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

Interface de usuário correspondente: guia Entradas/Origens - opcional

Artifacts - input

(CDKBootstrapAction/Inputs/Artifacts)

(Obrigatório se a aplicação AWS CDK estiver armazenada em um artefato de saída de uma ação anterior)

Se a aplicação AWS CDK estiver contida em um artefato gerado por uma ação anterior, especifique esse artefato aqui. A ação Inicialização do AWS CDK sintetiza a aplicação no artefato especificado em um modelo do CloudFormation antes de iniciar o processo de inicialização. Se a aplicação AWS CDK não estiver em um artefato, ela deverá residir em seu repositório de origem.

Para ter mais informações sobre artefatos, inclusive exemplos, consulte Compartilhar artefatos e arquivos entre ações.

Interface de usuário correspondente: guia Entradas/Artefatos - opcional

Outputs

(CDKBootstrapAction/Outputs)

(Opcional)

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

Interface de usuário correspondente: guia Saídas

Artifacts - output

(CDKBootstrapAction/Outputs/Artifacts)

(Opcional)

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

Para ter mais informações sobre artefatos, inclusive exemplos, consulte Compartilhar artefatos e arquivos entre ações.

Interface de usuário correspondente: guia Saídas/Artefatos

Name

(CDKBootstrapAction/Outputs/Artifacts/Name)

(Obrigatório se Artifacts - output for incluído)

Especifique o nome do artefato que conterá o modelo AWS CloudFormation sintetizado pela ação Inicialização do AWS CDK em runtime. O valor padrão é cdk_bootstrap_artifacts. Se você não especificar um artefato, a ação sintetizará o modelo, mas não o salvará em um artefato. Pense em salvar o modelo sintetizado em um artefato para preservar um registro dele para fins de teste ou solução de problemas.

Interface de usuário correspondente: guia Saídas/Artefatos/Adicionar artefato/Nome do artefato de criação

Files

(CDKBootstrapAction/Outputs/Artifacts/Files)

(Obrigatório se Artifacts - output for incluído)

Especifique os arquivos a serem incluídos no artefato. Você deve especificar "cdk.out/**/*" para incluir o modelo sintetizado AWS CloudFormation da aplicação AWS CDK.

Interface de usuário correspondente: guia Saídas/Artefatos/Adicionar artefato/Arquivos produzidos pela criação

Environment

(CDKBootstrapAction/Environment)

(Obrigatório)

Especifique o ambiente do CodeCatalyst a ser usado com a ação. A ação se conecta à Conta da AWS e à Amazon VPC opcional especificada no ambiente escolhido. A ação usa o perfil do IAM padrão especificado no ambiente para se conectar à Conta da AWS e usa o perfil do IAM especificado na conexão da Amazon VPC para se conectar à Amazon VPC.

Para ter mais informações sobre ambientes, consulte Implantação em Contas da AWS e VPCs e Criar um ambiente.

Interface de usuário correspondente: guia Configuração/Ambiente

Name

(CDKBootstrapAction/Environment/Name)

(Obrigatório se Environment for incluído)

Especifique o nome de um ambiente existente que deseja associar à ação.

Interface de usuário correspondente: guia Configuração/Ambiente

Connections

(CDKBootstrapAction/Environment/Connections)

(Opcional nas versões mais recentes da ação; obrigatório nas versões mais antigas)

Especifique a conexão da conta a ser associada à ação. É possível especificar no máximo uma conexão de conta em Environment.

Se você não especificar uma conexão de conta:

Para ter mais informações sobre conexões de conta, consulte Permissão do acesso a recursos da AWS com Contas da AWS conectadas. Para ter informações sobre como adicionar uma conexão de conta a um ambiente, consulte Criar um ambiente.

Interface de usuário correspondente: uma das seguintes, dependendo da versão da ação:

Name

(CDKBootstrapAction/Environment/Connections/Name)

(Obrigatório se Connections for incluído)

Especifique o nome da conexão da conta.

Interface de usuário correspondente: uma das seguintes, dependendo da versão da ação:

Role

(CDKBootstrapAction/Environment/Connections/Role)

(Obrigatório se Connections for incluído)

Especifique o nome do perfil do IAM que a ação Inicialização do AWS CDK usa para acessar a AWS e adicionar a pilha de inicialização. Adicione o perfil ao seu espaço do CodeCatalyst e verifique se o perfil inclui as políticas a seguir.

Se você não especificar um perfil do IAM, a ação usará o perfil padrão listado no ambiente no console do CodeCatalyst. Se você usar o perfil padrão no ambiente, verifique se ele tem as políticas a seguir.

Interface de usuário correspondente: uma das seguintes, dependendo da versão da ação:

Configuration

(CDKBootstrapAction/Configuration)

(Obrigatório)

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

Interface de usuário correspondente: guia Configuração

Region

(CDKBootstrapAction/Configuration/Region)

(Obrigatório)

Especifique a Região da AWS no qual a pilha de inicialização será implantada. Essa região deve corresponder àquela na qual a aplicação AWS CDK está implantada. Para obter uma lista dos códigos das regiões, consulte Endpoints regionais.

Interface de usuário correspondente: guia Configuração/Região

CdkCliVersion

(CDKBootstrapAction/Configuration/CdkCliVersion)

(Opcional)

Essa propriedade está disponível com a versão 1.0.13 ou posterior da ação Implantação do AWS CDK e a versão 1.0.8 ou posterior da ação Inicialização do AWS CDK.

Especifique um dos seguintes:

A ação baixará a versão especificada (ou a versão mais recente) da CLI do AWS CDK para a imagem de criação do CodeCatalyst e, depois, usará essa versão para executar os comandos necessários para implantar a aplicação do CDK ou inicializar o ambiente da AWS.

Para ter uma lista das versões compatíveis da CLI do CDK que você pode usar, consulte Versões do AWS CDK.

Se você omitir essa propriedade, a ação usará uma versão padrão da CLI do AWS CDK descrita em um dos tópicos abaixo:

Interface de usuário correspondente: guia Configuração/Versão da CLI do AWS CDK