CDKBootstrapAction Identifier DependsOn Compute Type Fleet Timeout Inputs Sources Artifacts - input Outputs Artifacts - output Name Files Environment Name Connections Name Role Configuration Region CdkCliVersion

definição YAML da ação “AWS CDK bootstrap”

A seguir está a definição YAML da ação de AWS CDK bootstrap. Para saber como usar essa ação, consulteInicializando um AWS CDK aplicativo 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 de fluxo de trabalho YAML.

nota

A maioria das propriedades YAML 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 propriedade YAML 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.    
  CDKBootstrapAction_nn: 
    Identifier: aws/cdk-bootstrap@v1
    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 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: CDKBootstrapAction_nn.

UI correspondente: guia de 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 Especificar a versão principal, secundária ou de patch de uma ação.

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

UI correspondente: diagrama de fluxo de trabalho/ CDKBootstrapAction _nn/aws/cdk-bootstrap @v1 label

DependsOn

(CDKBootstrapAction/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. Configurando ações para depender de outras ações

UI correspondente: guia Entradas/Depende de - opcional

Compute

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

(CDKBootstrapAction/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 (editor YAML)

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

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

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

UI correspondente: guia Configuração/Avançado - opcional/Tipo de computação

Fleet

(CDKBootstrapAction/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 termina. 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 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 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. O tempo limite padrão é o mesmo que o tempo limite máximo.

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

Inputs

(CDKBootstrapAction/Inputs)

(Optional)

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

UI correspondente: guia Entradas

nota

Somente uma entrada (uma fonte ou um artefato) é permitida para cada ação de AWS CDK bootstrap.

Sources

(CDKBootstrapAction/Inputs/Sources)

(Obrigatório se seu AWS CDK aplicativo estiver armazenado em um repositório de origem)

Se seu AWS CDK aplicativo estiver armazenado em um repositório de origem, especifique o rótulo desse repositório de origem. A ação AWS CDK bootstrap sintetiza o aplicativo nesse repositório antes de iniciar o processo de inicialização. Atualmente, o único rótulo de repositório compatível éWorkflowSource.

Se seu AWS CDK aplicativo 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 um fluxo de trabalho a um repositório de origem.

UI correspondente: guia Entradas/Fontes - opcional

Artifacts - input

(CDKBootstrapAction/Inputs/Artifacts)

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

Se seu AWS CDK aplicativo estiver contido em um artefato gerado por uma ação anterior, especifique esse artefato aqui. A ação AWS CDK bootstrap sintetiza o aplicativo no artefato especificado em um CloudFormation modelo antes de iniciar o processo de inicialização. Se seu AWS CDK aplicativo 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 dados entre ações em um fluxo de trabalho usando artefatos.

UI correspondente: guia Entradas/Artefatos - opcional

Outputs

(CDKBootstrapAction/Outputs)

(Optional)

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 - output

(CDKBootstrapAction/Outputs/Artifacts)

(Optional)

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 dados entre ações em um fluxo de trabalho usando artefatos.

UI correspondente: guia Saídas/Artefatos

Name

(CDKBootstrapAction/Outputs/Artifacts/Name)

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

Especifique o nome do artefato que conterá o AWS CloudFormation modelo sintetizado pela ação de AWS CDK bootstrap em tempo de execução. 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. Considere salvar o modelo sintetizado em um artefato para preservar um registro dele para fins de teste ou solução de problemas.

UI correspondente: guia Saídas/Artefatos/Adicionar artefato/Criar nome do artefato

Files

(CDKBootstrapAction/Outputs/Artifacts/Files)

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

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

nota

cdk.outé o diretório padrão no qual os arquivos sintetizados são salvos. Se você especificou um diretório de saída diferente do cdk.out seu cdk.json arquivo, especifique esse diretório aqui em vez decdk.out.

UI correspondente: guia Saídas/Artefatos/Adicionar artefato/Arquivos produzidos pela compilação

Environment

(CDKBootstrapAction/Environment)

(Obrigatório)

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

nota

Se a função padrão do IAM não tiver as permissões exigidas pela ação, você poderá configurar a ação para usar uma função diferente. Para ter mais informações, consulte Atribuição de uma função diferente do IAM a uma ação.

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

UI correspondente: guia de configuração/ambiente

Name

(CDKBootstrapAction/Environment/Name)

(Obrigatório se Environment estiver incluído)

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

UI correspondente: guia de 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. Você pode especificar no máximo uma conexão de conta emEnvironment.

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

A ação usa a Conta da AWS conexão e a função padrão do IAM especificadas no ambiente no CodeCatalyst console. Para obter informações sobre como adicionar uma conexão de conta e uma função padrão do IAM ao ambiente, consulteCriar um ambiente.
A função padrão do IAM deve incluir as políticas e permissões exigidas pela ação. Para determinar quais são essas políticas e permissões, consulte a descrição da propriedade Role na documentação de definição de YAML da ação.

Para obter mais informações sobre conexões de conta, consultePermitindo acesso a AWS recursos com conexão Contas da AWS. Para obter informações sobre como adicionar uma conexão de conta a um ambiente, consulteCriar um ambiente.

UI correspondente: uma das seguintes, dependendo da versão da ação:

(Versões mais recentes) Guia de configuração/Ambiente/O que há no meu ambiente? /menu de três pontos/ Mudar função
(Versões mais antigas) Guia de configuração/'Ambiente/Conta/Função'/ conexão AWS de conta

Name

(CDKBootstrapAction/Environment/Connections/Name)

(Obrigatório se Connections estiver incluído)

Especifique o nome da conexão da conta.

UI correspondente: uma das seguintes, dependendo da versão da ação:

(Versões mais recentes) Guia de configuração/Ambiente/O que há no meu ambiente? /menu de três pontos/ Mudar função
(Versões mais antigas) Guia de configuração/'Ambiente/Conta/Função'/ conexão AWS de conta

Role

(CDKBootstrapAction/Environment/Connections/Role)

(Obrigatório se Connections estiver incluído)

Especifique o nome da função do IAM que a ação AWS CDK bootstrap usa para acessar AWS e adicionar a pilha de bootstrap. Certifique-se de ter adicionado a função ao seu CodeCatalyst espaço e de que a função inclua as seguintes políticas.

Se você não especificar uma função do IAM, a ação usará a função padrão do IAM listada no ambiente no CodeCatalyst console. Se você usar a função padrão no ambiente, verifique se ela tem as seguintes políticas.

nota

As permissões mostradas na política de permissões a seguir são aquelas exigidas pelo cdk bootstrap comando para realizar sua inicialização no momento da redação. Essas permissões podem mudar se o comando bootstrap for AWS CDK alterado.

Atenção

Use essa função somente com a ação AWS CDK bootstrap. É muito permissivo e usá-lo com outras ações pode representar um risco à segurança.

A seguinte política de permissões:


{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "iam:GetRole",
                "ssm:GetParameterHistory",
                "ecr:PutImageScanningConfiguration",
                "cloudformation:*",
                "iam:CreateRole",
                "iam:AttachRolePolicy",
                "ssm:GetParameters",
                "iam:PutRolePolicy",
                "ssm:GetParameter",
                "ssm:DeleteParameters",
                "ecr:DeleteRepository",
                "ssm:PutParameter",
                "ssm:DeleteParameter",
                "iam:PassRole",
                "ecr:SetRepositoryPolicy",
                "ssm:GetParametersByPath",
                "ecr:DescribeRepositories",
                "ecr:GetLifecyclePolicy"
            ],
            "Resource": [
                "arn:aws:ssm:aws-region:aws-account:parameter/cdk-bootstrap/*",
                "arn:aws:cloudformation:aws-region:aws-account:stack/CDKToolkit/*",
                "arn:aws:ecr:aws-region:aws-account:repository/cdk-*",
                "arn:aws:iam::aws-account:role/cdk-*"
            ]
        },
        {
            "Sid": "VisualEditor1",
            "Effect": "Allow",
            "Action": [
                "cloudformation:RegisterType",
                "cloudformation:CreateUploadBucket",
                "cloudformation:ListExports",
                "cloudformation:DescribeStackDriftDetectionStatus",
                "cloudformation:SetTypeDefaultVersion",
                "cloudformation:RegisterPublisher",
                "cloudformation:ActivateType",
                "cloudformation:ListTypes",
                "cloudformation:DeactivateType",
                "cloudformation:SetTypeConfiguration",
                "cloudformation:DeregisterType",
                "cloudformation:ListTypeRegistrations",
                "cloudformation:EstimateTemplateCost",
                "cloudformation:DescribeAccountLimits",
                "cloudformation:BatchDescribeTypeConfigurations",
                "cloudformation:CreateStackSet",
                "cloudformation:ListStacks",
                "cloudformation:DescribeType",
                "cloudformation:ListImports",
                "s3:*",
                "cloudformation:PublishType",
                "ecr:CreateRepository",
                "cloudformation:DescribePublisher",
                "cloudformation:DescribeTypeRegistration",
                "cloudformation:TestType",
                "cloudformation:ValidateTemplate",
                "cloudformation:ListTypeVersions"
            ],
            "Resource": "*"
        }
    ]
}

nota

Na primeira vez em que a função for usada, use o caractere curinga a seguir na declaração de política de recursos e, em seguida, defina o escopo da política com o nome do recurso depois que ele estiver disponível.


"Resource": "*"

A seguinte política de confiança personalizada:


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

nota

Você pode usar a CodeCatalystWorkflowDevelopmentRole-spaceName função com essa ação, se quiser. Para obter mais informações sobre essa função, consulte Criando a CodeCatalystWorkflowDevelopmentRole-spaceNamefunção para sua conta e espaço. Entenda que a CodeCatalystWorkflowDevelopmentRole-spaceName função tem permissões de acesso completas, o que pode representar um risco de segurança. Recomendamos que você use essa função somente em tutoriais e cenários em que a segurança seja menos preocupante.

UI correspondente: uma das seguintes, dependendo da versão da ação:

(Versões mais recentes) Guia de configuração/Ambiente/O que há no meu ambiente? /menu de três pontos/ Mudar função
(Versões mais antigas) Guia de configuração/'Ambiente/Conta/Função'/ Função

Configuration

(CDKBootstrapAction/Configuration)

(Obrigatório)

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

UI correspondente: guia Configuração

Region

(CDKBootstrapAction/Configuration/Region)

(Obrigatório)

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

UI correspondente: guia de configuração/região

CdkCliVersion

(CDKBootstrapAction/Configuration/CdkCliVersion)

(Optional)

Essa propriedade está disponível com a versão 1.0.13 ou posterior da ação de AWS CDK implantação e a versão 1.0.8 ou posterior da AWS CDK ação bootstrap.

Especifique um dos seguintes:

A versão completa da interface de linha de AWS Cloud Development Kit (AWS CDK) comando (CLI) (também chamada de AWS CDK kit de ferramentas) que você deseja que essa ação use. Exemplo: 2.102.1. Considere especificar uma versão completa para garantir consistência e estabilidade ao criar e implantar seu aplicativo.

Ou
latest. Considere especificar latest para aproveitar os recursos e correções mais recentes da CLI do CDK.

A ação baixará a versão especificada (ou a versão mais recente) da AWS CDK CLI para a imagem de CodeCatalyst compilação e, em seguida, usará essa versão para executar os comandos necessários para implantar seu aplicativo CDK ou inicializar seu ambiente. AWS

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

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

UI correspondente: guia de configuração/versão AWS CDK CLI

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 produzidas pela ação “AWS CDK bootstrap”

Publicar no Amazon S3