View a markdown version of this page

bootstrap cdk - AWS Kit de desenvolvimento em nuvem (AWS CDK) v2

Este é o Guia do desenvolvedor do AWS CDK v2. O CDK v1 antigo entrou em manutenção em 1º de junho de 2022 e encerrou o suporte em 1º de junho de 2023.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

bootstrap cdk

Prepare um AWS ambiente para implantações de CDK implantando a pilha de bootstrap de CDK, chamada, no ambiente. CDKToolkit AWS

A pilha bootstrap é uma CloudFormation pilha que provisiona um bucket Amazon S3 e um repositório Amazon ECR no ambiente. AWS O AWS CDK CLI usa esses recursos para armazenar modelos sintetizados e ativos relacionados durante a implantação.

Usage

$ cdk bootstrap <arguments> <options>

Argumentos

AWS meio ambiente

O AWS ambiente de destino para implantar a pilha de bootstrap no seguinte formato:. aws://<account-id>/<region>

Exemplo: aws://123456789012/us-east-1

Esse argumento pode ser fornecido várias vezes em um único comando para implantar a pilha de bootstrapping em vários ambientes.

Por padrão, a CLI do CDK fará o bootstrapping de todos os ambientes referenciados na aplicação do CDK ou determinará um ambiente a partir de fontes padrão. Pode ser um ambiente especificado usando a --profile opção, a partir de variáveis de ambiente ou fontes AWS CLI padrão.

Opções

Para obter uma lista das opções globais que funcionam com todos os comandos da CLI do CDK, consulte Opções globais.

--bootstrap-bucket-name, --toolkit-bucket-name, -b <STRING>

O nome do bucket do Amazon S3 que será usado pela CLI do CDK. Esse bucket será criado e não deve existir no momento.

Forneça essa opção para substituir o nome padrão do bucket do Amazon S3.

Ao usar essa opção, talvez seja necessário personalizar a síntese. Para saber mais, consulte Personalização da síntese de pilhas do CDK.

Valor padrão: Indefinido

--bootstrap-customer-key <BOOLEAN>

Crie uma chave mestra de cliente (CMK) para o bucket de apenas (será feita uma cobrança, mas será possível personalizar as permissões, somente no bootstrapping moderno).

Essa opção não é compatível com o --bootstrap-kms-key-id.

Valor padrão: Indefinido

--bootstrap-kms-key-id <STRING>

A ID da chave mestra do AWS KMS a ser usada para a SSE-KMS criptografia.

Forneça essa opção para substituir a chave AWS KMS padrão usada para criptografar o bucket do Amazon S3.

Essa opção não é compatível com o --bootstrap-customer-key.

Valor padrão: Indefinido

--express <BOOLEAN>

Bootstrap usando o modo CloudFormation expresso. O modo expresso permite implantações mais rápidas, CloudFormation relatando as operações da pilha quando concluídas assim que a configuração do recurso CloudFormation é aplicada. No entanto, CloudFormation relata o sucesso sem esperar que os recursos se estabilizem. Além disso, o modo expresso não executa a reversão automaticamente e deixará as pilhas em um estado de falha se algo der errado.

Para obter mais informações, consulte o modo expresso no Guia AWS CloudFormation do usuário.

Valor padrão: false

--cloudformation-execution-policies <ARRAY>

Os ARNs da política de IAM gerenciada que devem ser anexados à função de implantação assumida AWS CloudFormation durante a implantação de suas pilhas.

Por padrão, as pilhas são implantadas com permissões totais de administrador usando a política AdministratorAccess.

É possível fornecer essa opção várias vezes em um único comando. Você também pode fornecer vários ARNs como uma única string, com os ARNs individuais separados por vírgulas. Este é um exemplo:

$ cdk bootstrap --cloudformation-execution-policies "arn:aws:iam::aws:policy/AWSLambda_FullAccess,arn:aws:iam::aws:policy/AWSCodeDeployFullAccess"

Para evitar falhas na implantação, verifique se as políticas especificadas são suficientes para qualquer implantação que você executará no ambiente que está sendo inicializado.

Essa opção se aplica somente à inicialização moderna.

Importante

O modelo de bootstrap moderno concede efetivamente as permissões implícitas pelo --cloudformation-execution-policies para qualquer AWS conta na --trust lista. Por padrão, isso estende as permissões de leitura e gravação em qualquer recurso na conta inicializada. Certifique-se de configurar a pilha de bootstrapping com políticas e contas confiáveis com as quais você se sinta confortável.

Valor padrão: []

--custom-permissions-boundary, -cpb <STRING>

Especifique o nome de um limite de permissões a ser usado.

Essa opção não é compatível com o --example-permissions-boundary.

Valor padrão: Indefinido

--example-permissions-boundary, -epb <BOOLEAN>

Use o exemplo de limite de permissões, fornecido pelo AWS CDK.

Essa opção não é compatível com o --custom-permissions-boundary.

A política de limite de permissões fornecida pelo CDK deve ser considerada um exemplo. Edite o conteúdo e faça referência ao exemplo de política se você estiver testando o atributo. Converta-a em uma nova política para implantações reais, caso ainda não exista. A preocupação é evitar o desvio. Provavelmente, um limite de permissões é mantido e tem convenções dedicadas, incluindo de nomenclatura.

Para obter mais informações sobre a configuração de permissões, incluindo o uso de limites de permissões, consulte o Guia do desenvolvedor de segurança e proteção.

Valor padrão: Indefinido

--execute <BOOLEAN>

Configure se o conjunto de alterações deve ser executado.

Valor padrão: true

--force, -f <BOOLEAN>

Sempre inicialize, mesmo que isso faça o downgrade da versão do modelo de inicialização.

Valor padrão: false

--help, -h <BOOLEAN>

Mostrar as informações de referência do comando cdk bootstrap.

--previous-parameters <BOOLEAN>

Use valores anteriores para os parâmetros existentes.

Depois que um modelo de inicialização é implantado com um conjunto de parâmetros, você deve definir essa opção como false para alterar quaisquer parâmetros em futuras implantações. Quando false, você deve fornecer novamente todos os parâmetros fornecidos anteriormente.

Valor padrão: true

--public-access-block-configuration <BOOLEAN>

Bloqueie a configuração de acesso público no bucket do Amazon S3 que é criado e usado pela CLI do CDK.

Valor padrão: true

--qualifier <STRING>

Nine-digit valor de string exclusivo para cada pilha de bootstrap. Esse valor é adicionado ao ID físico dos recursos na pilha de bootstrapping.

Ao fornecer um qualificador, você evita conflitos de nomes de recursos ao provisionar várias pilhas de inicialização no mesmo ambiente.

Quando você altera o qualificador, sua aplicação CDK deve passar o valor alterado para o sintetizador de pilha. Para obter mais informações, consulte Personalização da síntese de pilhas do CDK.

Valor padrão: hnb659fds. Esse valor não tem significado.

--show-template <BOOLEAN>

Em vez de inicializar, imprima o modelo de inicialização atual na saída padrão (stdout). Em seguida, você pode copiar e personalizar o modelo conforme necessário.

Valor padrão: false

--tags, -t <ARRAY>

Tags a serem adicionadas à pilha de bootstrapping no formato de KEY=VALUE.

Valor padrão: []

--template <STRING>

Use o modelo do arquivo fornecido em vez do embutido.

--termination-protection <BOOLEAN>

Ative a proteção de AWS CloudFormation terminação na pilha de bootstrap.

Quando true, a proteção contra encerramento é habilitada. Isso impede que uma pilha de inicialização seja excluída acidentalmente.

Para saber mais sobre a proteção contra encerramento, consulte Como proteger uma pilha de ser excluída no Guia do AWS CloudFormation usuário.

Valor padrão: Indefinido

--toolkit-stack-name <STRING>

O nome da pilha de bootstrapping a ser criada.

Por padrão, cdk bootstrap implanta uma pilha nomeada CDKToolkit no ambiente especificado AWS . Use essa opção para fornecer um nome diferente para sua pilha de bootstrapping.

A CLI do CDK usa esse valor para verificar a versão da pilha de bootstrapping.

Valor padrão: CDKToolkit

Obrigatório: sim

--trust <ARRAY>

Os IDs de AWS conta que devem ser confiáveis para realizar implantações nesse ambiente.

A conta que executa a inicialização sempre será confiável.

Essa opção exige que você também forneça --cloudformation-execution-policies.

É possível fornecer essa opção várias vezes em um único comando.

Essa opção se aplica somente à inicialização moderna.

Para adicionar contas confiáveis a uma pilha de bootstrapping existente, é necessário especificar todas as contas confiáveis, incluindo aquelas que podem ter sido fornecidas anteriormente. Se você fornecer apenas novas contas confiáveis, as contas anteriormente confiáveis serão removidas.

Veja a seguir um exemplo que confia em duas contas:

$ cdk bootstrap aws://123456789012/us-west-2 --trust 234567890123 --trust 987654321098 --cloudformation-execution-policies arn:aws:iam::aws:policy/AdministratorAccess ⏳ Bootstrapping environment aws://123456789012/us-west-2... Trusted accounts for deployment: 234567890123, 987654321098 Trusted accounts for lookup: (none) Execution policies: arn:aws:iam::aws:policy/AdministratorAccess CDKToolkit: creating CloudFormation changeset... ✅ Environment aws://123456789012/us-west-2 bootstrapped.
Importante

O modelo de bootstrap moderno concede efetivamente as permissões implícitas pelo --cloudformation-execution-policies para qualquer AWS conta na --trust lista. Por padrão, isso estende as permissões de leitura e gravação em qualquer recurso na conta inicializada. Certifique-se de configurar a pilha de bootstrapping com políticas e contas confiáveis com as quais você se sinta confortável.

Valor padrão: []

--trust-for-lookup <ARRAY>

Os IDs de AWS conta que devem ser confiáveis para pesquisar valores nesse ambiente.

Use essa opção para dar permissão às contas para sintetizar pilhas que serão implantadas no ambiente, sem realmente dar a elas permissão para implantar essas pilhas diretamente.

É possível fornecer essa opção várias vezes em um único comando.

Essa opção se aplica somente à inicialização moderna.

Valor padrão: []

Exemplos

Inicialize o AWS ambiente especificado no perfil do produto

$ cdk bootstrap --profile prod

Implante a pilha de bootstrapping nos ambientes foo e bar

$ cdk bootstrap --app='node bin/main.js' foo bar

Exporte o modelo de inicialização para personalizá-lo

Se você tiver requisitos específicos que não são atendidos pelo modelo de inicialização, você pode personalizá-lo para atender às suas necessidades.

Você pode exportar o modelo de bootstrap, modificá-lo e implantá-lo usando AWS CloudFormation. Veja a seguir um exemplo de como exportar o modelo existente:

$ cdk bootstrap --show-template > bootstrap-template.yaml

Você também pode pedir para a CLI do CDK usar um modelo personalizado. Este é um exemplo:

$ cdk bootstrap --template my-bootstrap-template.yaml

Bootstrapping com limite de permissões. Em seguida, remova esse limite de permissões

Para fazer o bootstrapping com um limite de permissões personalizado, executamos o seguinte:

$ cdk bootstrap --custom-permissions-boundary my-permissions-boundary

Para remover o limite de permissões, executamos o seguinte:

$ cdk bootstrap --no-previous-parameters

Use um qualificador para distinguir os recursos criados para um ambiente de desenvolvimento

$ cdk bootstrap --qualifier dev2024