Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

action « AWS CDK  déployer » YAML

Voici la YAML définition de l'action de AWS CDK déploiement. Pour savoir comment utiliser cette action, consultezDéploiement d'une AWS CDK application avec 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.

# 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.   
  CDKDeploy_nn: 
    Identifier: aws/cdk-deploy@v2
    DependsOn:
      - CDKBootstrap
    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_artifact
          Files: 
            - "cdk.out/**/*"
    Environment:
      Name: environment-name
      Connections:
        - Name: account-connection-name
          Role: iam-role-name
    Configuration:
      StackName: my-cdk-stack
      Region: us-west-2
      Tags: '{"key1": "value1", "key2": "value2"}'
      Context: '{"key1": "value1", "key2": "value2"}'
      CdkCliVersion: version
      CdkRootPath: directory-containing-cdk.json-file
      CfnOutputVariables: '["CnfOutputKey1","CfnOutputKey2","CfnOutputKey3"]'
      CloudAssemblyRootPath: path-to-cdk.out

CDKDeploy

(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: CDKDeploy_nn.

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

Identifier

(CDKDeploy/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.

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

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

DependsOn

(CDKDeploy/DependsOn)

(Facultatif)

Spécifiez une action ou un groupe d'actions qui doit s'exécuter correctement pour que l'action de AWS CDK déploiement soit exécutée. Nous recommandons de spécifier l'action AWS CDK bootstrap dans la DependsOn propriété, comme suit :

CDKDeploy:
  Identifier: aws/cdk-deploy@v2
  DependsOn:
    - CDKBootstrap

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

(CDKDeploy/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

(CDKDeploy/Compute/Type)

(Obligatoire s'Computeil est inclus)

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

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

(CDKDeploy/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

(CDKDeploy/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

(CDKDeploy/Inputs)

(Facultatif)

La Inputs section définit les données dont ils ont CDKDeploy besoin lors de l'exécution d'un flux de travail.

Interface utilisateur correspondante : onglet Entrées

Sources

(CDKDeploy/Inputs/Sources)

(Obligatoire si l' AWS CDK application que vous souhaitez déployer 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 de AWS CDK déploiement synthétise l'application dans ce référentiel avant de démarrer le processus de déploiement. Actuellement, la seule étiquette 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

(CDKDeploy/Inputs/Artifacts)

(Obligatoire si l' AWS CDK application que vous souhaitez déployer 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 de AWS CDK déploiement synthétise l'application dans l'artefact spécifié dans un CloudFormation modèle avant de démarrer le processus de déploiement. 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

(CDKDeploy/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

(CDKDeploy/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

(CDKDeploy/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 de AWS CDK déploiement lors de l'exécution. La valeur par défaut est cdk_artifact. 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

(CDKDeploy/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.

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

Environment

(CDKDeploy/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.

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

(CDKDeploy/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

(CDKDeploy/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 :

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 options suivantes, selon la version de l'action :

Name

(CDKDeploy/Environment/Connections/Name)

(Obligatoire s'Connectionsil est inclus)

Spécifiez le nom de la connexion au compte.

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

Role

(CDKDeploy/Environment/Connections/Role)

(Obligatoire s'Connectionsil est inclus)

Spécifiez le nom de la connexion au compte.

Spécifiez le nom du IAM rôle que l'action de AWS CDK déploiement utilise pour accéder à la pile d' AWS CDK applications AWS et la déployer. 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.

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

Configuration

(CDKDeploy/Configuration)

(Obligatoire)

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

Interface utilisateur correspondante : onglet Configuration

StackName

(CDKDeploy/Configuration/StackName)

(Obligatoire)

Le nom de votre pile d' AWS CDK applications, tel qu'il apparaît dans le fichier de point d'entrée du répertoire de bin votre AWS CDK application. L'exemple suivant montre le contenu d'un fichier de TypeScript point d'entrée, avec le nom de la pile surligné dans red italics. Si votre fichier de point d'entrée est rédigé dans une autre langue, il aura un aspect similaire.

import * as cdk from 'aws-cdk-lib';
import { CdkWorksopTypescriptStack } from '../lib/cdk_workshop_typescript-stack';

const app = new cdk.App();
new CdkWorkshopTypescriptStack(app, 'CdkWorkshopTypescriptStack');

Vous ne pouvez spécifier qu'une seule pile.

Interface utilisateur correspondante : onglet Configuration/nom de la pile

Region

(CDKDeploy/Configuration/Region)

(Facultatif)

Spécifiez le Région AWS lieu dans lequel la pile AWS CDK d'applications sera déployée. Pour obtenir la liste des codes de région, consultez la section Points de terminaison régionaux.

Si vous ne spécifiez aucune région, l'action de AWS CDK déploiement est déployée dans la région spécifiée dans votre AWS CDK code. Pour plus d'informations, consultez la section Environnements du guide du AWS Cloud Development Kit (AWS CDK) développeur.

Interface utilisateur correspondante : onglet Configuration/région

Tags

(CDKDeploy/Configuration/Tags)

(Facultatif)

Spécifiez les balises que vous souhaitez appliquer aux AWS ressources de la pile AWS CDK d'applications. Les balises sont appliquées à la pile elle-même ainsi qu'aux ressources individuelles de la pile. Pour plus d'informations sur le balisage, consultez la section Balisage dans le guide du AWS Cloud Development Kit (AWS CDK) développeur.

Interface utilisateur correspondante : onglet Configuration/Avancé - facultatif/Tags

Context

(CDKDeploy/Configuration/Context)

(Facultatif)

Spécifiez les contextes, sous forme de paires clé-valeur, à associer à la pile d' AWS CDK applications. Pour plus d'informations sur les contextes, consultez la section Contextes d'exécution dans le Guide du AWS Cloud Development Kit (AWS CDK) développeur.

Interface utilisateur correspondante : onglet Configuration/Avancé - facultatif/Contexte

CdkCliVersion

(CDKDeploy/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 :

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

CdkRootPath

(CDKDeploy/Configuration/CdkRootPath)

(Facultatif)

Le chemin d'accès au répertoire qui contient le cdk.json fichier de votre AWS CDK projet. L'action de AWS CDK déploiement s'exécute à partir de ce dossier, et toutes les sorties créées par l'action seront ajoutées à ce répertoire. Si elle n'est pas spécifiée, l'action de AWS CDK déploiement suppose que le cdk.json fichier se trouve à la racine de votre AWS CDK projet.

Interface utilisateur correspondante : onglet de configuration/répertoire où réside le fichier cdk.json

CfnOutputVariables

(CDKDeploy/Configuration/CfnOutputVariables)

(Facultatif)

Spécifiez CfnOutput les constructions du code de votre AWS CDK application que vous souhaitez exposer en tant que variables de sortie du flux de travail. Vous pouvez ensuite référencer les variables de sortie du flux de travail dans les actions suivantes de votre flux de travail. Pour plus d'informations sur les variables dans CodeCatalyst, voirUtilisation de variables dans les flux de travail.

Par exemple, si le code de votre AWS CDK application ressemble à ceci :

import { Duration, Stack, StackProps, CfnOutput, RemovalPolicy} from 'aws-cdk-lib';
import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
import * as s3 from 'aws-cdk-lib/aws-s3';
import { Construct } from 'constructs';
import * as cdk from 'aws-cdk-lib';
export class HelloCdkStack extends Stack {
  constructor(scope: Construct, id: string, props?: StackProps) {
    super(scope, id, props);
    const bucket = new s3.Bucket(this, 'amzn-s3-demo-bucket', {
      removalPolicy: RemovalPolicy.DESTROY,
    });
    new CfnOutput(this, 'bucketName', {
      value: bucket.bucketName,
      description: 'The name of the s3 bucket',
      exportName: 'amzn-s3-demo-bucket',
    });
    const table = new dynamodb.Table(this, 'todos-table', {
      partitionKey: {name: 'todoId', type: dynamodb.AttributeType.NUMBER},
      billingMode: dynamodb.BillingMode.PAY_PER_REQUEST,
      removalPolicy: RemovalPolicy.DESTROY,
    })
    new CfnOutput(this, 'tableName', {
      value: table.tableName,
      description: 'The name of the dynamodb table',
      exportName: 'myDynamoDbTable',
    });
    ...
  }
}

... et votre CfnOutputVariables propriété ressemble à ceci :

Configuration:
  ...
  CfnOutputVariables: '["bucketName","tableName"]'

... puis l'action génère les variables de sortie du flux de travail suivantes :

Vous pouvez ensuite référencer les tableName variables bucketName et dans les actions suivantes. Pour savoir comment référencer les variables de sortie du flux de travail dans les actions suivantes, voirRéférencement d'une variable prédéfinie.

Si vous ne spécifiez aucune CfnOutput construction dans la CfnOutputVariables propriété, l'action expose les quatre premières variables de sortie (ou moins) qu'elle trouve en tant que variables de CloudFormation sortie du flux de travail. Pour de plus amples informations, veuillez consulter variables « AWS CDK  déployer ».

Pour plus d'informations sur les variables de AWS CloudFormation sortie, consultez la documentation de la CfnOutput construction, disponible sous la rubrique class CfnOutput (construct) dans la AWS Cloud Development Kit (AWS CDK) APIréférence.

Interface utilisateur correspondante : onglet Configuration/variables AWS CloudFormation de sortie

CloudAssemblyRootPath

(CDKDeploy/Configuration/CloudAssemblyRootPath)

(Facultatif)

Si vous avez déjà synthétisé la pile de votre AWS CDK application dans un assemblage cloud (à l'aide de l'cdk synthopération), spécifiez le chemin racine du répertoire d'assemblage cloud (cdk.out). Le AWS CloudFormation modèle situé dans le répertoire d'assemblage cloud spécifié sera déployé par l'action de AWS CDK déploiement dans votre ordinateur à Compte AWS l'aide de la cdk deploy --app commande. Lorsque l'--appoption est présente, l'cdk synthopération ne se produit pas.

Si vous ne spécifiez aucun répertoire d'assemblage cloud, l'action de AWS CDK déploiement exécutera la cdk deploy commande sans l'--appoption. Sans --app cette option, l'cdk deployopération synthétisera (cdk synth) et déploiera votre AWS CDK application dans votre Compte AWS.

Pourquoi spécifier un assemblage cloud synthétisé existant alors que l'action « AWS CDK  déployer » peut effectuer la synthèse au moment de l'exécution ?

Vous souhaiterez peut-être spécifier un assemblage cloud synthétisé existant pour :

Pour plus d'informations sur la configuration du cdk.json fichier afin d'inclure les commandes d'installation et d'exécution de votre AWS CDK application, consultez la section Spécification de la commande de l'application.

Pour plus d'informations sur les cdk synth commandes cdk deploy et, ainsi que sur l'--appoption, voir Déployer des piles, synthétiser des piles et ignorer la synthèse dans le guide du développeur.AWS Cloud Development Kit (AWS CDK)

Pour plus d'informations sur les assemblages cloud, voir Cloud Assembly dans la AWS Cloud Development Kit (AWS CDK) APIréférence.

Interface utilisateur correspondante : onglet Configuration/Chemin d'accès au répertoire d'assemblage du cloud