Este é o Guia do Desenvolvedor AWS CDK v2. A CDK v1 mais antiga 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á.
cdk bootstrap
Prepare um ambiente AWS para implantações de CDK implantando a pilha de inicialização de CDK, chamada CDKToolkit
, no ambiente AWS.
A pilha de inicialização é uma pilha do CloudFormation 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.
Uso
$
cdk bootstrap
<arguments>
<options>
Argumentos
- Ambiente do AWS
-
O ambiente de destino AWS implanta a pilha de inicialização 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 inicialização em vários ambientes.
Por padrão, o CDK CLI inicializará todos os ambientes referenciados no aplicativo CDK ou determinará um ambiente a partir de fontes padrão. Isso pode ser um ambiente especificado usando a opção
--profile
, de variáveis de ambiente ou fontes AWS CLI padrão.
Opções
Para uma lista das opções globais que funcionam com todos os comandos do CDK CLI, consulte Opções globais.
--bootstrap-bucket-name, --toolkit-bucket-name, -b
STRING
-
O nome do bucket do Amazon S3 que será usado pelo CDK CLI. 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 Personalizar a 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 você poderá personalizar as permissões, somente na inicialização moderna).
Essa opção não é compatível com o
--bootstrap-kms-key-id
.Valor padrão: Indefinido
--bootstrap-kms-key-id
STRING
-
ID da chave mestra AWS KMS a ser usada para a criptografia SSE-KMS.
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
--cloudformation-execution-policies
ARRAY
-
Os ARNs da política do IAM gerenciada que devem ser anexados à função de implantação assumida pelo 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
.Você pode 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. Veja um exemplo a seguir:
$
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 inicialização moderna concede efetivamente as permissões implícitas no
--cloudformation-execution-policies
para qualquer conta AWS na lista--trust
. 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 inicialização 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. Quandofalse
, 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 pelo CDK CLI.
Valor padrão:
true
--qualifier
STRING
-
Valor de string de nove dígitos que é exclusiva para cada pilha de inicialização. Esse valor é adicionado ao ID físico dos recursos na pilha de inicialização.
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, seu aplicativo CDK deve passar o valor alterado para o sintetizador de pilha. Para ter mais informações, consulte Personalizar a 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 a serem adicionadas à pilha de inicialização 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 contra encerramento AWS CloudFormation na pilha de inicialização.
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 terminação, consulte Protegendo uma pilha de ser excluída no Guia do usuário AWS CloudFormation.
Valor padrão: Indefinido
--toolkit-stack-name
STRING
-
O nome da pilha de inicialização a ser criada.
Por padrão, o
cdk bootstrap
implanta uma pilha chamadaCDKToolkit
no ambiente AWS especificado. Use essa opção para fornecer um nome diferente para sua pilha de inicialização.O CDK CLI usa esse valor para verificar a versão da pilha de inicialização.
Valor padrão:
CDKToolkit
Obrigatório: Sim
--trust
ARRAY
-
As IDs Conta da AWS 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
.Você pode 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 inicialização existente, você deve especificar todas as contas confiáveis, incluindo aquelas que você pode ter fornecido 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
⏳ 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.aws://123456789012/us-west-2
--trust234567890123
--trust987654321098
--cloudformation-execution-policiesarn:aws:iam::aws:policy/AdministratorAccess
Importante
O modelo de inicialização moderna concede efetivamente as permissões implícitas no
--cloudformation-execution-policies
para qualquer conta AWS na lista--trust
. 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 inicialização com políticas e contas confiáveis com as quais você se sinta confortável.Valor padrão:
[]
--trust-for-lookup
ARRAY
-
As IDs Conta da AWS 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.
Você pode 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 ambiente AWS especificado no perfil de produção
$
cdk bootstrap --profile prod
Implante a pilha de inicialização 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 inicialização, modificá-lo e implantá-lo usando o 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 ao CDK CLI que use um modelo personalizado. Veja um exemplo a seguir:
$
cdk bootstrap --template my-bootstrap-template.yaml
Inicialização com limite de permissões. Em seguida, remova esse limite de permissões
Para inicializar 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