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

action « AWS CDK bootstrap » YAML

Voici la YAML définition de l'action AWS CDK bootstrap. Pour savoir comment utiliser cette action, consultezDémarrage d'une AWS CDK application à l'aide d'un flux de travail.

Cette définition d'action existe sous forme de section au sein d'un fichier de définition de flux de travail plus large. Pour de plus amples informations sur ce fichier, veuillez consulter YAMLDéfinition du flux de travail.

Note

La plupart des YAML propriétés suivantes ont des éléments d'interface utilisateur correspondants dans l'éditeur visuel. Pour rechercher un élément de l'interface utilisateur, utilisez Ctrl+F. L'élément sera répertorié avec sa YAML propriété associée.


# The workflow definition starts here.
# See Propriétés de haut niveau 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

(Obligatoire)

Spécifiez le nom de l'action. Tous les noms d'action doivent être uniques dans le flux de travail. Les noms d'action sont limités aux caractères alphanumériques (a-z, A-Z, 0-9), aux tirets (-) et aux traits de soulignement (_). Les espaces ne sont pas autorisés. Vous ne pouvez pas utiliser de guillemets pour activer les caractères spéciaux et les espaces dans les noms d'action.

Par défaut: CDKBootstrapAction_nn.

Interface utilisateur correspondante : onglet Configuration/nom d'affichage de l'action

Identifier

(CDKBootstrapAction/Identifier)

(Obligatoire)

Identifie l'action. Ne modifiez pas cette propriété, sauf si vous souhaitez modifier la version. Pour de plus amples informations, veuillez consulter Spécification de la version de l'action à utiliser.

Note

La spécification aws/cdk-bootstrap@v2 entraîne l'exécution de l'action sur l'image de mars 2024 qui inclut des outils plus récents tels que Node.js 18. La spécification aws/cdk-bootstrap@v1 entraîne l'exécution de l'action sur l'image de novembre 2022 qui inclut des outils plus anciens tels que Node.js 16.

Par défaut: aws/cdk-bootstrap@v2.

Interface utilisateur correspondante : diagramme de flux de travail/ CDKBootstrapAction _nn/ aws/cdk-bootstrap @v2 label

DependsOn

(CDKBootstrapAction/DependsOn)

(Facultatif)

Spécifiez une action, un groupe d'actions ou une porte qui doit s'exécuter correctement pour que cette action soit exécutée.

Pour plus d'informations sur la fonctionnalité « dépend », consultez. Actions de séquençage

Interface utilisateur correspondante : onglet Entrées/dépend de - facultatif

Compute

(CDKBootstrapAction/Compute)

(Facultatif)

Le moteur informatique utilisé pour exécuter les actions de votre flux de travail. Vous pouvez spécifier le calcul au niveau du flux de travail ou au niveau de l'action, mais pas les deux. Lorsqu'elle est spécifiée au niveau du flux de travail, la configuration de calcul s'applique à toutes les actions définies dans le flux de travail. Au niveau du flux de travail, vous pouvez également exécuter plusieurs actions sur la même instance. Pour de plus amples informations, veuillez consulter Partage du calcul entre les actions.

Interface utilisateur correspondante : aucune

Type

(CDKBootstrapAction/Compute/Type)

(Obligatoire s'Computeil est inclus)

Type de moteur de calcul. Vous pouvez utiliser l'une des valeurs suivantes :

EC2(éditeur visuel) ou EC2 (YAMLéditeur)

Optimisé pour la flexibilité lors des courses d'action.
Lambda (éditeur visuel) ou Lambda (YAMLéditeur)

Vitesses de démarrage des actions optimisées.

Pour plus d'informations sur les types de calcul, veuillez consulter Types de calcul.

Interface utilisateur correspondante : onglet Configuration/Avancé - facultatif/Type de calcul

Fleet

(CDKBootstrapAction/Compute/Fleet)

(Facultatif)

Spécifiez la machine ou le parc qui exécutera votre flux de travail ou vos actions de flux de travail. Dans le cas des flottes à la demande, lorsqu'une action démarre, le flux de travail fournit les ressources dont il a besoin et les machines sont détruites à la fin de l'action. Exemples de flottes à la demande :Linux.x86-64.Large,Linux.x86-64.XLarge. Pour plus d'informations sur les flottes à la demande, consultezPropriétés de flotte à la demande.

Avec les flottes provisionnées, vous configurez un ensemble de machines dédiées pour exécuter les actions de votre flux de travail. Ces machines restent inactives, prêtes à exécuter des actions immédiatement. Pour plus d'informations sur les flottes provisionnées, consultez. Propriétés du parc provisionné

S'il Fleet est omis, la valeur par défaut estLinux.x86-64.Large.

Interface utilisateur correspondante : onglet Configuration/Avancé - facultatif/Parc de calcul

Timeout

(CDKBootstrapAction/Timeout)

(Obligatoire)

Spécifiez la durée en minutes (YAMLéditeur) ou en heures et minutes (éditeur visuel) pendant laquelle l'action peut être exécutée avant la CodeCatalyst fin de l'action. Le minimum est de 5 minutes et le maximum est décrit dansQuotas pour les flux de travail dans CodeCatalyst. Le délai d'expiration par défaut est le même que le délai d'expiration maximal.

Interface utilisateur correspondante : onglet Configuration/Délai d'expiration - facultatif

Inputs

(CDKBootstrapAction/Inputs)

(Facultatif)

La Inputs section définit les données dont l'action AWS CDK bootstrap a besoin lors de l'exécution d'un flux de travail.

Interface utilisateur correspondante : onglet Entrées

Note

Une seule entrée (source ou artefact) est autorisée pour chaque action d'AWS CDK amorçage.

Sources

(CDKBootstrapAction/Inputs/Sources)

(Obligatoire si votre AWS CDK application est stockée dans un référentiel source)

Si votre AWS CDK application est stockée dans un référentiel source, spécifiez l'étiquette de ce référentiel source. L'action AWS CDK bootstrap synthétise l'application dans ce référentiel avant de démarrer le processus de démarrage. Actuellement, la seule étiquette de référentiel prise en charge estWorkflowSource.

Si votre AWS CDK application n'est pas contenue dans un référentiel source, elle doit résider dans un artefact généré par une autre action.

Pour plus d'informations sur les sources, consultez Connecter les référentiels sources aux flux de travail.

Interface utilisateur correspondante : onglet Entrées/Sources - facultatif

Artifacts - input

(CDKBootstrapAction/Inputs/Artifacts)

(Obligatoire si votre AWS CDK application est stockée dans un artefact de sortie d'une action précédente)

Si votre AWS CDK application est contenue dans un artefact généré par une action précédente, spécifiez cet artefact ici. L'action AWS CDK bootstrap synthétise l'application contenue dans l'artefact spécifié dans un CloudFormation modèle avant de démarrer le processus d'amorçage. Si votre AWS CDK application n'est pas contenue dans un artefact, elle doit résider dans votre référentiel source.

Pour plus d'informations sur les artefacts, y compris des exemples, consultezPartage d'artefacts et de fichiers entre les actions.

Interface utilisateur correspondante : onglet Entrées/Artefacts - facultatif

Outputs

(CDKBootstrapAction/Outputs)

(Facultatif)

Définit les données produites par l'action lors de l'exécution d'un flux de travail.

Interface utilisateur correspondante : onglet Sorties

Artifacts - output

(CDKBootstrapAction/Outputs/Artifacts)

(Facultatif)

Spécifiez les artefacts générés par l'action. Vous pouvez faire référence à ces artefacts en tant qu'entrée dans d'autres actions.

Pour plus d'informations sur les artefacts, y compris des exemples, consultezPartage d'artefacts et de fichiers entre les actions.

Interface utilisateur correspondante : onglet Sorties/Artefacts

Name

(CDKBootstrapAction/Outputs/Artifacts/Name)

(Obligatoire s'Artifacts - outputil est inclus)

Spécifiez le nom de l'artefact qui contiendra le AWS CloudFormation modèle synthétisé par l'action AWS CDK bootstrap lors de l'exécution. La valeur par défaut est cdk_bootstrap_artifacts. Si vous ne spécifiez aucun artefact, l'action synthétise le modèle, mais ne l'enregistre pas dans un artefact. Envisagez d'enregistrer le modèle synthétisé dans un artefact pour en conserver une trace à des fins de test ou de dépannage.

Interface utilisateur correspondante : onglet Sorties/Artifacts/Ajouter un artefact/Créer un nom d'artefact

Files

(CDKBootstrapAction/Outputs/Artifacts/Files)

(Obligatoire s'Artifacts - outputil est inclus)

Spécifiez les fichiers à inclure dans l'artefact. Vous devez spécifier "cdk.out/**/*" d'inclure le AWS CloudFormation modèle synthétisé de votre AWS CDK application.

Note

cdk.outest le répertoire par défaut dans lequel les fichiers synthétisés sont enregistrés. Si vous avez spécifié un répertoire de sortie autre que celui cdk.out de votre cdk.json fichier, spécifiez ce répertoire ici au lieu decdk.out.

Interface utilisateur correspondante : onglet Sorties/Artifacts/Ajouter un artefact/Fichiers produits par build

Environment

(CDKBootstrapAction/Environment)

(Obligatoire)

Spécifiez l' CodeCatalyst environnement à utiliser avec l'action. L'action se connecte à Compte AWS l'Amazon facultatif VPC spécifié dans l'environnement choisi. L'action utilise le IAM rôle par défaut spécifié dans l'environnement pour se connecter au Compte AWS, et utilise le IAM rôle spécifié dans la VPCconnexion Amazon pour se connecter à AmazonVPC.

Note

Si le IAM rôle par défaut ne dispose pas des autorisations requises par l'action, vous pouvez configurer l'action pour utiliser un autre rôle. Pour de plus amples informations, veuillez consulter Modifier le IAM rôle d'une action.

Pour plus d'informations sur les environnements, reportez-vous Déploiement dans Comptes AWS et VPCs aux sections etCréation d'un environnement.

Interface utilisateur correspondante : onglet Configuration/Environnement

Name

(CDKBootstrapAction/Environment/Name)

(Obligatoire s'Environmentil est inclus)

Spécifiez le nom de l'environnement existant que vous souhaitez associer à l'action.

Interface utilisateur correspondante : onglet Configuration/Environnement

Connections

(CDKBootstrapAction/Environment/Connections)

(Facultatif dans les nouvelles versions de l'action ; obligatoire dans les anciennes versions)

Spécifiez la connexion au compte à associer à l'action. Vous pouvez spécifier un maximum d'une connexion à un compte sousEnvironment.

Si vous ne spécifiez pas de connexion au compte :

L'action utilise la Compte AWS connexion et le IAM rôle par défaut spécifiés dans l'environnement de la CodeCatalyst console. Pour plus d'informations sur l'ajout d'une connexion à un compte et d'un IAM rôle par défaut dans l'environnement, consultezCréation d'un environnement.
Le IAM rôle par défaut doit inclure les politiques et les autorisations requises par l'action. Pour déterminer quelles sont ces politiques et autorisations, consultez la description de la propriété Role dans la documentation de YAML définition de l'action.

Pour plus d'informations sur les connexions aux comptes, consultezPermettre l'accès aux AWS ressources avec Connected Comptes AWS. Pour plus d'informations sur l'ajout d'une connexion de compte à un environnement, consultezCréation d'un environnement.

Interface utilisateur correspondante : l'une des suivantes selon la version de l'action :

(Versions plus récentes) Onglet de configuration/Environnement/Contenu my-environment? /menu à trois points/ Changer de rôle
(Anciennes versions) Onglet de configuration/'Environnement/Compte/Role'/ Connexion AWS au compte

Name

(CDKBootstrapAction/Environment/Connections/Name)

(Obligatoire s'Connectionsil est inclus)

Spécifiez le nom de la connexion au compte.

Interface utilisateur correspondante : l'une des suivantes selon la version de l'action :

(Versions plus récentes) Onglet de configuration/Environnement/Contenu my-environment? /menu à trois points/ Changer de rôle
(Anciennes versions) Onglet de configuration/'Environnement/Compte/Role'/ Connexion AWS au compte

Role

(CDKBootstrapAction/Environment/Connections/Role)

(Obligatoire s'Connectionsil est inclus)

Spécifiez le nom du IAM rôle que l'action AWS CDK bootstrap utilise pour accéder à la pile bootstrap AWS et l'ajouter. Assurez-vous que vous avez ajouté le rôle à votre CodeCatalyst espace et qu'il inclut les politiques suivantes.

Si vous ne spécifiez aucun IAM rôle, l'action utilise le IAM rôle par défaut répertorié dans l'environnement de la CodeCatalyst console. Si vous utilisez le rôle par défaut dans l'environnement, assurez-vous qu'il est conforme aux politiques suivantes.

Note

Les autorisations indiquées dans la politique d'autorisation suivante sont celles requises par la cdk bootstrap commande pour effectuer son amorçage au moment de la rédaction. Ces autorisations peuvent changer si la commande bootstrap est AWS CDK modifiée.

Avertissement

Utilisez ce rôle uniquement avec l'action AWS CDK bootstrap. Il est très permissif et son utilisation avec d'autres actions peut présenter un risque de sécurité.

La politique d'autorisation suivante :


{
    "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": "*"
        }
    ]
}

Note

La première fois que le rôle est utilisé, utilisez le caractère générique suivant dans la déclaration de politique de ressources, puis délimitez la politique avec le nom de la ressource une fois celle-ci disponible.


"Resource": "*"

La politique de confiance personnalisée suivante :


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

Note

Vous pouvez utiliser le CodeCatalystWorkflowDevelopmentRole-spaceName rôle avec cette action, si vous le souhaitez. Pour plus d’informations sur ce rôle, consultez Création du CodeCatalystWorkflowDevelopmentRole-spaceNamerôle pour votre compte et votre espace. Sachez que le CodeCatalystWorkflowDevelopmentRole-spaceName rôle dispose d'autorisations d'accès complètes, ce qui peut présenter un risque de sécurité. Nous vous recommandons de n'utiliser ce rôle que dans les didacticiels et les scénarios où la sécurité est moins préoccupante.

Interface utilisateur correspondante : l'une des suivantes selon la version de l'action :

(Versions plus récentes) Onglet de configuration/Environnement/Contenu my-environment? /menu à trois points/ Changer de rôle
(Anciennes versions) Onglet de configuration/'Environnement/Compte/Role'/ Rôle

Configuration

(CDKBootstrapAction/Configuration)

(Obligatoire)

Section dans laquelle vous pouvez définir les propriétés de configuration de l'action.

Interface utilisateur correspondante : onglet Configuration

Region

(CDKBootstrapAction/Configuration/Region)

(Obligatoire)

Spécifiez le Région AWS lieu dans lequel la pile bootstrap sera déployée. Cette région doit correspondre à celle dans laquelle votre AWS CDK application est déployée. Pour obtenir la liste des codes de région, consultez la section Points de terminaison régionaux.

Interface utilisateur correspondante : onglet Configuration/région

CdkCliVersion

(CDKBootstrapAction/Configuration/CdkCliVersion)

(Facultatif)

Cette propriété est disponible avec la version 1.0.13 ou ultérieure de l'action de AWS CDK déploiement, et la version 1.0.8 ou ultérieure de l'action AWS CDK bootstrap.

Spécifiez l’un des éléments suivants :

Version complète de l'interface de ligne de AWS Cloud Development Kit (AWS CDK) commande (CLI) (également appelée AWS CDK boîte à outils) que vous souhaitez utiliser pour cette action. Exemple: 2.102.1. Pensez à spécifier une version complète pour garantir la cohérence et la stabilité lors de la création et du déploiement de votre application.

Ou
latest. Pensez latest à spécifier pour tirer parti des dernières fonctionnalités et correctifs du CDKCLI.

L'action téléchargera la version spécifiée (ou la dernière version) de l'image AWS CDK CLI de CodeCatalyst construction, puis utilisera cette version pour exécuter les commandes nécessaires au déploiement de votre CDK application ou au démarrage de votre AWS environnement.

Pour obtenir la liste des CDK CLI versions prises en charge que vous pouvez utiliser, consultez la section AWS CDK Versions.

Si vous omettez cette propriété, l'action utilise une AWS CDK CLI version par défaut décrite dans l'une des rubriques suivantes :

Interface utilisateur correspondante : onglet/version AWS CDK CLI de configuration

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Variables - action « AWS CDK bootstrap »

Publication sur Amazon S3