Esta es la guía para AWS CDK desarrolladores de la versión 2. La CDK versión anterior entró en mantenimiento el 1 de junio de 2022 y finalizó el soporte el 1 de junio de 2023.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Inicie su entorno para usarlo con AWS CDK

Inicie su AWS entorno para prepararlo para AWS Cloud Development Kit (AWS CDK) las implementaciones de pilas.

Cómo arrancar su entorno

Puede utilizar la interfaz de línea de AWS CDK comandos (AWS CDK CLI) o su herramienta de AWS CloudFormation implementación preferida para arrancar su entorno.

Utilice la CDK CLI

Puedes usar el CDK CLI cdk bootstrapcomando para arrancar su entorno. Este es el método que recomendamos si no necesita realizar modificaciones importantes en el arranque.

Para obtener más información sobre el cdk bootstrap comando y las opciones compatibles, consultecdk bootstrap.

Utilice cualquier AWS CloudFormation herramienta

Puede copiar la plantilla de arranque del aws-cdk GitHub reposicione u obtenga la plantilla con el comando. cdk bootstrap --show-template A continuación, utilice cualquier AWS CloudFormation herramienta para implementar la plantilla en su entorno.

Con este método, puede usar AWS CloudFormation StackSets o AWS Control Tower. También puede utilizar la AWS CloudFormation consola o el AWS Command Line Interface (AWS CLI). Puede realizar modificaciones en la plantilla antes de implementarla. Este método puede ser más flexible y adecuado para despliegues a gran escala.

A continuación, se muestra un ejemplo del uso de la --show-template opción para recuperar y guardar la plantilla de arranque en su máquina local:

macOS/Linux

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

Windows

En Windows, PowerShell debe usarse para conservar la codificación de la plantilla.

powershell "cdk bootstrap --show-template | Out-File -encoding utf8 bootstrap-template.yaml"

Para implementar esta plantilla mediante el CDK CLI, puede ejecutar lo siguiente:

$ cdk bootstrap --template bootstrap-template.yaml

A continuación, se muestra un ejemplo del uso de AWS CLI para implementar la plantilla:

macOS/Linux

aws cloudformation create-stack \
  --stack-name CDKToolkit \
  --template-body file://path/to/bootstrap-template.yaml \
  --capabilities CAPABILITY_NAMED_IAM \
  --region us-west-1

Windows

aws cloudformation create-stack ^
  --stack-name CDKToolkit ^
  --template-body file://path/to/bootstrap-template.yaml ^
  --capabilities CAPABILITY_NAMED_IAM ^
  --region us-west-1

Para obtener información sobre cómo iniciar varios entornos, consulte Cómo iniciar varios entornos Cuentas de AWS para su AWS CDK uso CloudFormation StackSets en el blog sobre operaciones y migraciones en la AWS nube. CloudFormation StackSets

¿Cuándo iniciar su entorno

Debe arrancar cada AWS entorno antes de implementarlo en el entorno. Le recomendamos que arranque de forma proactiva todos los entornos que vaya a utilizar. Puede hacerlo antes de planificar la implementación efectiva de CDK las aplicaciones en el entorno. Al arrancar sus entornos de forma proactiva, evita posibles problemas futuros, como conflictos con los nombres de los buckets de Amazon S3 o la implementación de CDK aplicaciones en entornos que no se han iniciado.

Está bien iniciar un entorno más de una vez. Si un entorno ya se ha iniciado, la pila de arranque se actualizará si es necesario. De lo contrario, no pasará nada.

Si intentas implementar una CDK pila en un entorno que no se ha iniciado, verás un error como el siguiente:

$ cdk deploy

✨  Synthesis time: 2.02s

 ❌ Deployment failed: Error: BootstrapExampleStack: SSM parameter /cdk-bootstrap/hnb659fds/version not found. Has the environment been bootstrapped? Please run 'cdk bootstrap' (see https://docs.aws.amazon.com/cdk/latest/guide/bootstrapping.html)

Actualiza tu pila de bootstrap

Periódicamente, el CDK equipo actualizará la plantilla de bootstrap a una nueva versión. Cuando esto suceda, te recomendamos que actualices tu pila de bootstrap. Si no ha personalizado el proceso de arranque, puede actualizar su pila de arranque siguiendo los mismos pasos que siguió para arrancar su entorno originalmente. Para obtener más información, consulte Historial de versiones de la plantilla Bootstrap.

Recursos predeterminados creados durante el arranque

IAMroles creados durante el arranque

De forma predeterminada, el arranque proporciona las siguientes AWS Identity and Access Management () IAM funciones en su entorno:

Recurso IDs creado durante el arranque

Al implementar la plantilla de arranque predeterminada, los recursos físicos IDs para el arranque se crean utilizando la siguiente estructura:. cdk-qualifier-description-account-ID-Region

El siguiente es un ejemplo de ID físico del bucket de almacenamiento provisional de Amazon S3 creado durante el arranque:. cdk-hnb659fds-assets-012345678910-us-west-1

Permisos que se deben usar al arrancar su entorno

Al iniciar un AWS entorno, la IAM identidad que realiza el arranque debe tener al menos los siguientes permisos:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "cloudformation:*",
                "ecr:*",
                "ssm:*",
                "s3:*",
                "iam:*"
            ],
            "Resource": "*"
        }
    ]
}

Con el tiempo, la pila de arranque, incluidos los recursos que se crean y los permisos que requieren, puede cambiar. Con futuros cambios, es posible que tenga que modificar los permisos necesarios para arrancar un entorno.

Personalice el arranque

Si la plantilla de arranque predeterminada no se ajusta a sus necesidades, puede personalizar la transferencia de recursos a su entorno de las siguientes maneras:

Para obtener más información sobre la personalización del arranque, consulte. Personaliza el AWS CDK bootstrapping

CDKPuesta en marcha con canalizaciones

Si utilizas CDK Pipelines para realizar la implementación en el entorno de otra cuenta y recibes un mensaje como el siguiente:

Policy contains a statement with one or more invalid principals

Este mensaje de error significa que las IAM funciones adecuadas no existen en el otro entorno. La causa más probable es que el entorno no se haya iniciado. Inicie el entorno e inténtelo de nuevo.

Proteja su pila de bootstrap para que no se elimine

Si se elimina una pila de bootstrap, también se eliminarán los AWS recursos que se aprovisionaron originalmente en el entorno para respaldar CDK las implementaciones. Esto hará que la canalización deje de funcionar. Si esto sucede, no existe una solución general para la recuperación.

Una vez iniciado el entorno, no elimine ni vuelva a crear la pila de arranque del entorno. En su lugar, intente actualizar la pila de arranque a una nueva versión ejecutando el comando de nuevo. cdk bootstrap

Para evitar que se elimine accidentalmente la pila de bootstrap, le recomendamos que proporcione la --termination-protection opción junto con el cdk bootstrap comando para habilitar la protección de terminación. Puede activar la protección de terminación en pilas de bootstrap nuevas o existentes. Para obtener instrucciones sobre cómo habilitar la protección de terminación, consulte Habilitar la protección de terminación para la pila de arranque.

Historial de versiones de la plantilla Bootstrap

La plantilla bootstrap está versionada y evoluciona con el tiempo consigo misma. AWS CDK Si proporciona su propia plantilla de bootstrap, manténgala actualizada con la plantilla canónica predeterminada. Quieres asegurarte de que tu plantilla siga funcionando con todas las funciones. CDK

Esta sección contiene una lista de los cambios realizados en cada versión.

Actualice una plantilla de bootstrap antigua a una moderna

La AWS CDK versión 1 admitía dos plantillas de arranque, la antigua y la moderna. CDKLa versión 2 solo admite la plantilla moderna. Como referencia, estas son las diferencias de alto nivel entre estas dos plantillas.

* Agregaremos recursos adicionales a la plantilla de bootstrap según sea necesario.

Un entorno que se inició con la plantilla anterior debe actualizarse para utilizar la plantilla moderna de la versión CDK 2 mediante el reinicio. Vuelva a implementar todas las AWS CDK aplicaciones en el entorno al menos una vez antes de eliminar el bucket heredado.

Abordar las conclusiones de Security Hub

Si lo está utilizando AWS Security Hub, es posible que vea los resultados de algunos de los recursos creados por el proceso de AWS CDK arranque. Los resultados de Security Hub le ayudan a encontrar configuraciones de recursos que debe comprobar para garantizar su precisión y seguridad. Hemos revisado estas configuraciones de recursos específicas con AWS Security y estamos seguros de que no constituyen un problema de seguridad.

[KMS.2] IAM los directores no deberían tener políticas IAM integradas que permitan realizar acciones de descifrado en todas las claves KMS

La función de despliegue (DeploymentActionRole) otorga permiso para leer datos cifrados, lo cual es necesario para las implementaciones entre cuentas con Pipelines. CDK Las políticas de este rol no otorgan permisos a todos los datos. Solo concede permiso para leer datos cifrados de Amazon S3 y AWS KMS solo cuando esos recursos lo permiten a través de su política de bucket o clave.

A continuación, se incluye un fragmento de estas dos afirmaciones sobre la función de despliegue de la plantilla de arranque:

DeploymentActionRole:
    Type: AWS::IAM::Role
    Properties:
      ...
      Policies:
        - PolicyDocument:
            Statement:
              ...
              - Sid: PipelineCrossAccountArtifactsBucket
                Effect: Allow
                Action:
                  - s3:GetObject*
                  - s3:GetBucket*
                  - s3:List*
                  - s3:Abort*
                  - s3:DeleteObject*
                  - s3:PutObject*
                Resource: "*"
                Condition:
                  StringNotEquals:
                    s3:ResourceAccount:
                      Ref: AWS::AccountId
              - Sid: PipelineCrossAccountArtifactsKey
                Effect: Allow
                Action:
                  - kms:Decrypt
                  - kms:DescribeKey
                  - kms:Encrypt
                  - kms:ReEncrypt*
                  - kms:GenerateDataKey*
                Resource: "*"
                Condition:
                  StringEquals:
                    kms:ViaService:
                      Fn::Sub: s3.${AWS::Region}.amazonaws.com
              ...

¿Por qué Security Hub marca esto?

Las políticas contienen una cláusula Resource: * combinada con una Condition cláusula. Security Hub marca el * comodín. Este comodín se utiliza porque, en el momento en que se inicia la cuenta, la AWS KMS clave creada por CDK Pipelines para el depósito de CodePipeline artefactos aún no existe y, por lo tanto, no se puede hacer referencia a ella en la plantilla de arranque. ARN Además, Security Hub no tiene en cuenta la Condition cláusula al levantar esta bandera. Esto Condition se limita Resource: * a las solicitudes realizadas desde Cuenta de AWS la misma AWS KMS clave. Estas solicitudes deben provenir de Amazon S3 junto con Región de AWS la AWS KMS clave.

¿Debo corregir este hallazgo?

Mientras no hayas modificado la AWS KMS clave de tu plantilla de bootstrap para que sea demasiado permisiva, la función de despliegue no permitirá más acceso del que necesita. Por lo tanto, no es necesario corregir este hallazgo.

¿Qué sucede si quiero corregir este hallazgo?

La forma de solucionar este problema dependerá de si vas a utilizar CDK Pipelines o no para despliegues entre cuentas.

Consideraciones

Dado que el arranque aprovisiona los recursos de su entorno, puede incurrir en AWS cargos si esos recursos se utilizan con el. AWS CDK