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

Confira a seguir a definição de YAML da ação Implantação do AWS CDK. Para saber como usar essa ação, consulte Implantar 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.   
  CDKDeploy_nn: 
    Identifier: aws/cdk-deploy@v2
    DependsOn:
      - CDKBootstrap
    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_artifact
          Files: 
            - "cdk.out/**/*"
    Environment:
      Name: environment-name
      Connections:
        - Name: account-connection-name
          Role: iam-role-name
    Configuration:
      StackName: my-cdk-stack
      Region: us-west-2
      Tags: '{"key1": "value1", "key2": "value2"}'
      Context: '{"key1": "value1", "key2": "value2"}'
      CdkCliVersion: version
      CdkRootPath: directory-containing-cdk.json-file
      CfnOutputVariables: '["CnfOutputKey1","CfnOutputKey2","CfnOutputKey3"]'
      CloudAssemblyRootPath: path-to-cdk.out

CDKDeploy

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

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

Identifier

(CDKDeploy/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-deploy@v2.

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

DependsOn

(CDKDeploy/DependsOn)

(Opcional)

Especifique uma ação ou um grupo de ação que deve ser executado para que a ação Implantação do AWS CDK seja executada. Recomendamos especificar a ação Inicialização do AWS CDK na propriedade DependsOn, da seguinte forma:

CDKDeploy:
  Identifier: aws/cdk-deploy@v2
  DependsOn:
    - CDKBootstrap

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

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

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

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

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

(CDKDeploy/Inputs)

(Opcional)

A seção Inputs define os dados que CDKDeploy precisa durante a execução de um fluxo de trabalho.

Interface de usuário correspondente: guia Entradas

Sources

(CDKDeploy/Inputs/Sources)

(Obrigatório se a aplicação AWS CDK que você quer implantar estiver armazenado 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 Implantação do AWS CDK sintetiza a aplicação nesse repositório antes de iniciar o processo de implantação. Atualmente, o único rótulo 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

(CDKDeploy/Inputs/Artifacts)

(Obrigatório se a aplicação AWS CDK que você quer implantar estiver armazenado 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 Implantação do AWS CDK sintetiza a aplicação no artefato especificado em um modelo do CloudFormation antes de iniciar o processo de implantaçã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

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

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

(CDKDeploy/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 Implantação do AWS CDK em runtime. O valor padrão é cdk_artifact. 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

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

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

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

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

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

(CDKDeploy/Environment/Connections/Role)

(Obrigatório se Connections for incluído)

Especifique o nome da conexão da conta.

Especifique o nome do perfil do IAM que a ação Implantação do AWS CDK usa para acessar a AWS e implantar a pilha de aplicações AWS CDK. 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

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

StackName

(CDKDeploy/Configuration/StackName)

(Obrigatório)

O nome da pilha de aplicações AWS CDK, conforme aparece no arquivo do ponto de entrada no diretório bin da aplicação AWS CDK. O exemplo a seguir mostra o conteúdo de um arquivo de ponto de entrada do TypeScript, com o nome da pilha destacado em itálico vermelho. Se o arquivo do ponto de entrada estiver em outra linguagem, ele terá uma aparência semelhante.

import * as cdk from 'aws-cdk-lib';
import { CdkWorksopTypescriptStack } from '../lib/cdk_workshop_typescript-stack';

const app = new cdk.App();
new CdkWorkshopTypescriptStack(app, 'CdkWorkshopTypescriptStack');

Você pode especificar apenas uma pilha.

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

Region

(CDKDeploy/Configuration/Region)

(Opcional)

Especifique a Região da AWS na qual a aplicação AWS CDK será implantada. Para obter uma lista dos códigos das regiões, consulte Endpoints regionais.

Se você não especificar uma região, a ação Implantação do AWS CDK será implantada na região especificada no código do AWS CDK. Para ter mais informações, consulte Ambientes no Guia do desenvolvedor do AWS Cloud Development Kit (AWS CDK).

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

Tags

(CDKDeploy/Configuration/Tags)

(Opcional)

Especifique as tags que deseja aplicar aos recursos da AWS na pilha de aplicações AWS CDK. As tags são aplicadas à pilha em si, bem como aos recursos individuais na pilha. Para ter mais informações sobre marcação, consulte Marcação, no Guia do desenvolvedor do AWS Cloud Development Kit (AWS CDK).

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

Context

(CDKDeploy/Configuration/Context)

(Opcional)

Especifique contextos, na forma de pares de valor-chave, a serem associados à pilha de aplicações AWS CDK. Para ter mais informações sobre contextos, consulte Contextos de runtime no Guia do desenvolvedor do AWS Cloud Development Kit (AWS CDK).

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

CdkCliVersion

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

CdkRootPath

(CDKDeploy/Configuration/CdkRootPath)

(Opcional)

O caminho para o diretório que contém o arquivo cdk.json do projeto do AWS CDK. A ação Implantação do AWS CDK é executada nessa pasta e todas as saídas criadas pela ação serão adicionadas a esse diretório. Se não for especificada, a ação Implantação do AWS CDK vai supor que o arquivo cdk.json está na raiz do projeto AWS CDK.

Interface de usuário correspondente: guia Configuração/Diretório em que o cdk.json reside

CfnOutputVariables

(CDKDeploy/Configuration/CfnOutputVariables)

(Opcional)

Especifique quais constructos de CfnOutput no código da aplicação do AWS CDK você deseja expor como variáveis de saída do fluxo de trabalho. Depois, você pode referenciar as variáveis de saída do fluxo de trabalho em ações subsequentes no fluxo de trabalho. Para ter mais informações sobre variáveis no CodeCatalyst, consulte Uso de variáveis em fluxos de trabalho.

Por exemplo, se o código da aplicação AWS CDK for semelhante a:

import { Duration, Stack, StackProps, CfnOutput, RemovalPolicy} from 'aws-cdk-lib';
import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
import * as s3 from 'aws-cdk-lib/aws-s3';
import { Construct } from 'constructs';
import * as cdk from 'aws-cdk-lib';
export class HelloCdkStack extends Stack {
  constructor(scope: Construct, id: string, props?: StackProps) {
    super(scope, id, props);
    const bucket = new s3.Bucket(this, 'amzn-s3-demo-bucket', {
      removalPolicy: RemovalPolicy.DESTROY,
    });
    new CfnOutput(this, 'bucketName', {
      value: bucket.bucketName,
      description: 'The name of the s3 bucket',
      exportName: 'amzn-s3-demo-bucket',
    });
    const table = new dynamodb.Table(this, 'todos-table', {
      partitionKey: {name: 'todoId', type: dynamodb.AttributeType.NUMBER},
      billingMode: dynamodb.BillingMode.PAY_PER_REQUEST,
      removalPolicy: RemovalPolicy.DESTROY,
    })
    new CfnOutput(this, 'tableName', {
      value: table.tableName,
      description: 'The name of the dynamodb table',
      exportName: 'myDynamoDbTable',
    });
    ...
  }
}

... e a propriedade CfnOutputVariables for semelhante a:

Configuration:
  ...
  CfnOutputVariables: '["bucketName","tableName"]'

... a ação gera as seguintes variáveis de saída do fluxo de trabalho:

Depois, você pode referenciar as variáveis bucketName e tableName em ações subsequentes. Para saber como referenciar variáveis de saída do fluxo de trabalho em ações subsequentes, consulte Referência a uma variável predefinida.

Se você não especificar nenhum constructo CfnOutput na propriedade CfnOutputVariables, a ação vai expor as primeiras quatro (ou menos) variáveis de saída do CloudFormation encontradas como variáveis de saída do fluxo de trabalho. Para ter mais informações, consulte Variáveis de “Implantação do AWS CDK”.

Para ter mais informações sobre variáveis de saída do AWS CloudFormation, consulte a documentação do constructo CfnOutput, disponível na classe CfnOutput (constructo) na Referência da API do AWS Cloud Development Kit (AWS CDK).

Interface do usuário correspondente: guia Configuração/Variáveis de saída do AWS CloudFormation

CloudAssemblyRootPath

(CDKDeploy/Configuration/CloudAssemblyRootPath)

(Opcional)

Se você já sintetizou a pilha da aplicação AWS CDK em um assembly de nuvem (usando a operação cdk synth), especifique o caminho raiz do diretório de assembly de nuvem (cdk.out). O modelo do AWS CloudFormation localizado no diretório de assembly de nuvem especificado será implantado pela ação Implantação do AWS CDK na Conta da AWS usando o comando cdk deploy --app. Quando a opção --app está presente, a operação cdk synth não ocorre.

Se você não especificar um diretório de assembly de nuvem, a ação Implantação do AWS CDK executará o comando cdk deploy sem a opção --app. Sem a opção --app, a operação cdk deploy sintetizará (cdk synth) e implantará a aplicação AWS CDK na sua Conta da AWS.

Por que eu especificaria um assembly de nuvem existente e sintetizado quando a ação “Implantação do AWS CDK” pode fazer a síntese em runtime?

Talvez você queira especificar um assembly de nuvem sintetizado existente para:

Para ter informações sobre como configurar o arquivo cdk.json para incluir comandos para instalar e executar a aplicação AWS CDK, consulte Especificação do comando da aplicação.

Para ter informações sobre os comandos cdk deploy e cdk synth, bem como sobre a opção --app, consulte Implantação de pilhas, Sintetização de pilhas e Como ignorar a síntese no Guia do desenvolvedor do AWS Cloud Development Kit (AWS CDK).

Para ter informações sobre assemblies de nuvem, consulte Assembly de nuvem na AWS Cloud Development Kit (AWS CDK) API Reference.

Interface de usuário correspondente: guia Configuração/Caminho para o diretório de assembly de nuvem