Acción 'AWS CDK bootstrap' en YAML - Amazon CodeCatalyst
CDKBootstrapActionIdentifierDependsOnComputeTypeFleetTimeoutInputsSourcesArtifacts - inputOutputsArtifacts - outputNameFilesEnvironmentNameConnectionsNameRoleConfigurationRegionCdkCliVersion

Acción 'AWS CDK bootstrap' en YAML

La siguiente es la definición en YAML de la acción AWS CDK bootstrap. Para obtener información sobre cómo utilizar esta acción, consulte Arranque de una aplicación de AWS CDK con un flujo de trabajo.

Esta definición de acción existe como una sección dentro de un archivo de definición de flujo de trabajo más amplio. Para obtener más información acerca de este archivo, consulte Definición de flujo de trabajo en YAML.

nota

La mayoría de las propiedades de YAML que se muestran a continuación tienen elementos de interfaz de usuario correspondientes en el editor visual. Para buscar un elemento de la interfaz de usuario, use Ctrl+F. El elemento aparecerá en la lista con su propiedad de YAML asociada.

# The workflow definition starts here.
# See Propiedades de nivel superior for details.
        
Name: MyWorkflow
SchemaVersion: 1.0 
Actions:

# The action definition starts here.    
  CDKBootstrapAction_nn: 
    Identifier: aws/cdk-bootstrap@v2
    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

(Obligatorio)

Especifique el nombre de la acción. Todos los nombres de las acciones deben ser únicos dentro del flujo de trabajo. Los nombres de las acciones están limitados a caracteres alfanuméricos (a-z, A-Z y 0-9), guiones (-) y guiones bajos (_). No se permiten espacios. No puede utilizar comillas para permitir caracteres especiales ni espacios en los nombres de las acciones.

Predeterminado: CDKBootstrapAction_nn.

Interfaz de usuario correspondiente: pestaña Configuración/Nombre de visualización de la acción

Identifier

(CDKBootstrapAction/Identifier)

(Obligatorio)

Identifica la acción. No cambie esta propiedad a menos que desee cambiar la versión. Para obtener más información, consulte Especificación de la versión de la acción que se va a utilizar.

nota

Si se especifica aws/cdk-bootstrap@v2, la acción se ejecuta en la imagen de marzo de 2024, que incluye herramientas más recientes, como Node.js 18. Si se especifica aws/cdk-bootstrap@v1, la acción se ejecuta en la imagen de noviembre de 2022, que incluye herramientas más antiguas, como Node.js 16.

Predeterminado: aws/cdk-bootstrap@v2.

Interfaz de usuario correspondiente: Diagrama de flujo de trabajo/CDKBootstrapAction_nn/etiqueta aws/cdk-bootstrap@v2

DependsOn

(CDKBootstrapAction/DependsOn)

(Opcional)

Especifique la acción, el grupo de acciones o la puerta que debe ejecutarse correctamente para que esta acción se ejecute.

Para obtener más información sobre la funcionalidad “depende de”, consulte Secuenciación de acciones.

Interfaz de usuario correspondiente: pestaña Entradas/Depende de (opcional)

Compute

(CDKBootstrapAction/Compute)

(Opcional)

El motor de computación utilizado para ejecutar las acciones del flujo de trabajo. Puede especificar el motor de computación en el nivel del flujo de trabajo o en el nivel de acción, pero no en ambos. Cuando se especifica en el nivel de flujo de trabajo, la configuración del motor de computación se aplica a todas las acciones definidas en el flujo de trabajo. En el nivel de flujo de trabajo, también puede ejecutar varias acciones en la misma instancia. Para obtener más información, consulte Uso compartido de recursos de computación entre acciones.

Interfaz de usuario correspondiente: ninguna

Type

(CDKBootstrapAction/Compute/Type)

(Obligatorio si se incluye Compute)

El tipo de motor de computación. Puede utilizar uno de los siguientes valores.

  • EC2 (editor visual) o EC2 (editor de YAML)

    Optimizado para ofrecer flexibilidad durante las ejecuciones de acciones.

  • Lambda (editor visual) o Lambda (editor de YAML)

    Velocidades de inicio de acciones optimizadas.

Para obtener más información sobre los tipos de computación, consulte Tipos de computación.

Interfaz de usuario correspondiente: pestaña Configuración/Avanzada (opcional)/Tipo de computación

Fleet

(CDKBootstrapAction/Compute/Fleet)

(Opcional)

Especifique la máquina o la flota que ejecutará el flujo de trabajo o las acciones del flujo de trabajo. Con las flotas bajo demanda, cuando se inicia una acción, el flujo de trabajo aprovisiona los recursos que necesita y las máquinas se destruyen cuando finaliza la acción. Ejemplos de flotas bajo demanda: Linux.x86-64.Large, Linux.x86-64.XLarge. Para obtener más información sobre las flotas bajo demanda, consulte Propiedades de las flotas bajo demanda.

Con las flotas aprovisionadas, configura un conjunto de máquinas dedicadas para ejecutar las acciones del flujo de trabajo. Estas máquinas permanecen inactivas, listas para procesar acciones de forma inmediata. Para obtener más información sobre las flotas aprovisionadas, consulte Propiedades de flotas aprovisionadas.

Si Fleet se omite, el valor predeterminado es Linux.x86-64.Large.

Interfaz de usuario correspondiente: pestaña Configuración/Avanzada (opcional)/Flota de computación

Timeout

(CDKBootstrapAction/Timeout)

(Obligatorio)

Especifique la cantidad de tiempo, en minutos (editor de YAML) o en horas y minutos (editor visual) que la acción puede ejecutarse antes de que CodeCatalyst la finalice. El mínimo es 5 minutos y el máximo se describe en Cuotas para flujos de trabajo en CodeCatalyst. El tiempo de espera predeterminado es el mismo que el tiempo de espera máximo.

Interfaz de usuario correspondiente: pestaña Configuración/Tiempo de espera (opcional)

Inputs

(CDKBootstrapAction/Inputs)

(Opcional)

La sección Inputs define los datos que necesita la acción AWS CDK bootstrap durante la ejecución de un flujo de trabajo.

Interfaz de usuario correspondiente: pestaña Entradas

nota

Solo se permite una entrada (ya sea un código fuente o un artefacto) para cada acción AWS CDK bootstrap.

Sources

(CDKBootstrapAction/Inputs/Sources)

(Obligatorio si la aplicación de AWS CDK está almacenada en un repositorio de código fuente)

Si la aplicación de AWS CDK está almacenada en un repositorio de código fuente, especifique la etiqueta de dicho repositorio. La acción AWS CDK bootstrap sintetiza la aplicación en este repositorio antes de iniciar el proceso de arranque. Actualmente, la única etiqueta de repositorio admitida es WorkflowSource.

Si la aplicación de AWS CDK no está incluida en un repositorio de código fuente, debe residir en un artefacto generado por otra acción.

Para obtener más información sobre orígenes, consulte Conexión de repositorios de código fuente a flujos de trabajo.

Interfaz de usuario correspondiente: pestaña Entradas/Orígenes (opcional)

Artifacts - input

(CDKBootstrapAction/Inputs/Artifacts)

(Obligatorio si la aplicación de AWS CDK está almacenada en un artefacto de salida de una acción anterior)

Si la aplicación de AWS CDK está incluida en un artefacto generado por una acción anterior, especifique ese artefacto aquí. La acción AWS CDK bootstrap sintetiza la aplicación en el artefacto especificado en una plantilla de CloudFormation antes de iniciar el proceso de arranque. Si la aplicación de AWS CDK no está incluida en un artefacto, debe residir en el repositorio de código fuente.

Para obtener más información sobre los artefactos, incluidos ejemplos, consulte Cómo compartir artefactos y archivos entre acciones.

Interfaz de usuario correspondiente: pestaña Entradas/Artefactos (opcional)

Outputs

(CDKBootstrapAction/Outputs)

(Opcional)

Define los datos que necesita una acción durante la ejecución de un flujo de trabajo.

Interfaz de usuario correspondiente: pestaña Salidas

Artifacts - output

(CDKBootstrapAction/Outputs/Artifacts)

(Opcional)

Especifique el nombre de los artefactos generados por la acción. Puede hacer referencia a estos artefactos como entrada en otras acciones.

Para obtener más información sobre los artefactos, incluidos ejemplos, consulte Cómo compartir artefactos y archivos entre acciones.

Interfaz de usuario correspondiente: pestaña Salidas/Artefactos

Name

(CDKBootstrapAction/Outputs/Artifacts/Name)

(Obligatorio si se incluye Artifacts - output)

Especifique el nombre del artefacto que contendrá la plantilla de AWS CloudFormation sintetizada por la acción AWS CDK bootstrap en tiempo de ejecución. El valor predeterminado es cdk_bootstrap_artifacts. Si no especifica un artefacto, la acción sintetizará la plantilla, pero no la guardará en un artefacto. Considere la posibilidad de guardar la plantilla sintetizada en un artefacto para conservar un registro de la misma para probarla o solucionar problemas.

Interfaz de usuario correspondiente: pestaña Salidas/Artefactos/Agregar artefacto/Nombre de artefacto de compilación

Files

(CDKBootstrapAction/Outputs/Artifacts/Files)

(Obligatorio si se incluye Artifacts - output)

Especifique los archivos que desee incluir en el artefacto. Debe especificar "cdk.out/**/*" si desea incluir la plantilla de AWS CloudFormation sintetizada de la aplicación de AWS CDK.

nota

cdk.out es el directorio predeterminado en el que se guardan los archivos sintetizados. Si especificó un directorio de salida distinto de cdk.out en el archivo cdk.json, especifique ese directorio aquí en lugar de cdk.out.

Interfaz de usuario correspondiente: pestaña Salidas/Artefactos/Agregar artefactos/Archivos producidos por compilación

Environment

(CDKBootstrapAction/Environment)

(Obligatorio)

Especifique el entorno de CodeCatalyst que se utilizará con la acción. La acción se conecta a la Cuenta de AWS y a la VPC de Amazon especificada en el entorno elegido. La acción utiliza el rol de IAM predeterminado especificado en el entorno para conectarse a la Cuenta de AWS, y utiliza el rol de IAM especificado en la conexión a la VPC de Amazon para conectarse a la VPC de Amazon.

nota

Si el rol de IAM predeterminado no tiene los permisos necesarios para la acción, puede configurarla para que utilice un rol diferente. Para obtener más información, consulte Cambio del rol de IAM de una acción.

Para obtener más información sobre los entornos, consulte Implementación en Cuentas de AWS y VPC y Creación de un entorno.

Interfaz de usuario correspondiente: pestaña Configuración/Entorno

Name

(CDKBootstrapAction/Environment/Name)

(Obligatorio si se incluye Environment)

Especifique el nombre del entorno existente que desea asociar a la acción.

Interfaz de usuario correspondiente: pestaña Configuración/Entorno

Connections

(CDKBootstrapAction/Environment/Connections)

(Opcional en las versiones más recientes de la acción; obligatorio en las versiones más antiguas)

Especifique la conexión de cuenta que desee asociar a la acción. Puede especificar un máximo de una conexión de cuenta en Environment.

Si no especifica una conexión de cuenta:

  • La acción utiliza la conexión de la Cuenta de AWS y el rol de IAM predeterminado especificado en el entorno de la consola de CodeCatalyst. Para obtener información sobre cómo añadir una conexión de cuenta y un rol de IAM predeterminado al entorno, consulte Creación de un entorno.

  • El rol de IAM predeterminado debe incluir las políticas y los permisos que requiere la acción. Para determinar cuáles son esas políticas y permisos, consulte la descripción de la propiedad Role en la documentación de la definición de YAML de la acción.

Para obtener más información sobre las conexiones de cuenta, consulte Permisos de acceso a recursos de AWS con Cuentas de AWS conectadas. Para obtener más información sobre cómo añadir una conexión de cuenta a un entorno, consulte Creación de un entorno.

Interfaz de usuario correspondiente: una de las siguientes, según la versión de la acción:

  • (Versiones más recientes): pestaña Configuración/Entorno/¿Qué hay en mi-entorno?/menú de tres puntos/Cambiar rol

  • (Versiones más antiguas) pestaña Configuración/'Entorno/cuenta/rol'/Conexión de cuenta de AWS

Name

(CDKBootstrapAction/Environment/Connections/Name)

(Obligatorio si se incluye Connections)

Especifique el nombre de la conexión de cuenta.

Interfaz de usuario correspondiente: una de las siguientes, según la versión de la acción:

  • (Versiones más recientes): pestaña Configuración/Entorno/¿Qué hay en mi-entorno?/menú de tres puntos/Cambiar rol

  • (Versiones más antiguas) pestaña Configuración/'Entorno/cuenta/rol'/Conexión de cuenta de AWS

Role

(CDKBootstrapAction/Environment/Connections/Role)

(Obligatorio si se incluye Connections)

Especifique el nombre del rol de IAM que la acción AWS CDK bootstrap utiliza para acceder a AWS y a la pila de arranque. Asegúrese de haber añadido el rol a su espacio de CodeCatalyst y de que el rol incluya las siguientes políticas.

Si no especifica un rol de IAM, la acción utilizará el rol de IAM predeterminado que aparece en el entorno en la consola de CodeCatalyst. Si usa el rol predeterminado en el entorno, asegúrese de que tenga las siguientes políticas.

nota

Los permisos que se muestran en la siguiente política de permisos son los necesarios para que el comando cdk bootstrap realice su arranque cuando se redactó este artículo. Estos permisos pueden cambiar si el AWS CDK cambia su comando de arranque.

aviso

Utilice este rol únicamente con la acción AWS CDK bootstrap. Es muy permisivo y su uso con otras acciones puede suponer un riesgo para la seguridad.

  • La siguiente política de permisos:

    {
    "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

    La primera vez que utilice el rol, use el siguiente comodín en la instrucción de política de recursos y, a continuación, precise el ámbito de la política con el nombre del recurso cuando esté disponible.

    "Resource": "*"

  • La siguiente política de confianza personalizada:

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

Puede usar el rol CodeCatalystWorkflowDevelopmentRole-spaceName con esta acción, si así lo desea. Para obtener más información acerca de este rol, consulte Creación del rol CodeCatalystWorkflowDevelopmentRole-spaceName para su cuenta y su espacio. Tenga en cuenta que el rol CodeCatalystWorkflowDevelopmentRole-spaceName tiene permisos de acceso total, lo que puede suponer un riesgo para la seguridad. Le recomendamos que utilice este rol solo en tutoriales y situaciones en las que la seguridad no sea un problema.

Interfaz de usuario correspondiente: una de las siguientes, según la versión de la acción:

  • (Versiones más recientes) Pestaña Configuración/Entorno/¿Qué hay en mi-entorno?/menú de tres puntos/Cambiar rol

  • (Versiones más antiguas) pestaña Configuración/'Entorno/cuenta/rol'/Rol

Configuration

(CDKBootstrapAction/Configuration)

(Obligatorio)

Una sección en la que puede definir las propiedades de configuración de la acción.

Interfaz de usuario correspondiente: pestaña Configuración

Region

(CDKBootstrapAction/Configuration/Region)

(Obligatorio)

Especifique la Región de AWS en la que se implementará la pila de arranque. Esta región debe coincidir con aquella en la que se implementa la aplicación de AWS CDK. Para ver una lista de códigos de regiones, consulte Puntos de conexión regionales.

Interfaz de usuario correspondiente: pestaña Configuración/Región

CdkCliVersion

(CDKBootstrapAction/Configuration/CdkCliVersion)

(Opcional)

Esta propiedad está disponible en la versión 1.0.13 o posterior de la acción AWS CDK deploy y en la versión 1.0.8 o posterior de la acción AWS CDK bootstrap.

Especifique uno de los siguientes valores:

  • La versión completa de la interfaz de la línea de comandos (CLI) de AWS Cloud Development Kit (AWS CDK) (que también recibe el nombre de Kit de herramientas de AWS CDK) que desea que utilice esta acción. Ejemplo:2.102.1. Considere la posibilidad de especificar una versión completa para garantizar la coherencia y la estabilidad al crear e implementar la aplicación.

    Or (Disyunción)

  • latest. Considere la posibilidad de especificar latest para aprovechar las características y correcciones más recientes de la CLI de CDK.

La acción descargará la versión especificada (o la última versión) de la CLI de AWS CDK en la imagen de compilación de CodeCatalyst y, a continuación, utilizará esta versión para ejecutar los comandos necesarios para implementar la aplicación de CDK o arrancar el entorno de AWS.

Para obtener una lista de las versiones de CLI de CDK compatibles que puede utilizar, consulte Versiones de AWS CDK.

Si omite esta propiedad, la acción utilizará una versión de la CLI de AWS CDK predeterminada, que se describe en uno de los temas siguientes:

Interfaz de usuario correspondiente: pestaña Configuración/Versión de la CLI de AWS CDK