Définition YAML de l'action « Deploy AWS CloudFormation Stack »

Voici la définition YAML de l'action Deploy AWS CloudFormation stack. Pour savoir comment utiliser cette action, consultezDéploiement d'une AWS CloudFormation pile 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 Définition du flux de travail YAML.

Note

La plupart des propriétés YAML 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 propriété YAML 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.    
  DeployCloudFormationStack:  
    Identifier: aws/cfn-deploy@v1
    DependsOn:
      - build-action
    Compute:  
      Type: EC2 | Lambda
      Fleet: fleet-name
    Timeout: timeout-minutes
    Environment:
      Name: environment-name
      Connections:
        - Name: account-connection-name
          Role: DeployRole
    Inputs:
      Sources:
        - source-name-1
      Artifacts:
        - CloudFormation-artifact
    Configuration:
      name: stack-name
      region: us-west-2
      template: template-path
      role-arn: arn:aws:iam::123456789012:role/StackRole        
      capabilities: CAPABILITY_IAM,CAPABILITY_NAMED_IAM,CAPABILITY_AUTO_EXPAND
      parameter-overrides: KeyOne=ValueOne,KeyTwo=ValueTwo | path-to-JSON-file
      no-execute-changeset: 1|0
      fail-on-empty-changeset: 1|0
      disable-rollback: 1|0
      termination-protection: 1|0
      timeout-in-minutes: minutes
      notification-arns: arn:aws:sns:us-east-1:123456789012:MyTopic,arn:aws:sns:us-east-1:123456789012:MyOtherTopic
      monitor-alarm-arns: arn:aws:cloudwatch::123456789012:alarm/MyAlarm,arn:aws:cloudwatch::123456789012:alarm/MyOtherAlarm
      monitor-timeout-in-minutes: minutes       
      tags: '[{"Key":"MyKey1","Value":"MyValue1"},{"Key":"MyKey2","Value":"MyValue2"}]'

DeployCloudFormationStack

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

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

Identifier

(DeployCloudFormationStack/Identifier)

(Obligatoire)

Identifie l'action. Ne modifiez pas cette propriété, sauf si vous souhaitez modifier la version. Pour plus d’informations, consultez Spécifier la version majeure, mineure ou corrective d'une action.

Par défaut: aws/cfn-deploy@v1.

Interface utilisateur correspondante : diagramme de flux de travail/ DeployCloudFormationStack _nn/ aws/cfn-deploy @v1 label

DependsOn

(DeployCloudFormationStack/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. Configuration des actions pour qu'elles dépendent d'autres actions

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

Compute

(DeployCloudFormationStack/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 plus d’informations, consultez Partage du calcul entre les actions.

Interface utilisateur correspondante : aucune

Type

(DeployCloudFormationStack/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 (éditeur YAML)

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

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

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

(DeployCloudFormationStack/Timeout)

(Facultatif)

Spécifiez la durée en minutes (éditeur YAML) 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 workflows. 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 en minutes - facultatif

Environment

(DeployCloudFormationStack/Environment)

(Obligatoire)

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

Note

Si le rôle IAM par défaut ne dispose pas des autorisations requises par l'action, vous pouvez configurer l'action pour utiliser un autre rôle. Pour plus d’informations, consultez Affectation d'un rôle IAM différent à une action.

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

Interface utilisateur correspondante : onglet Configuration/Environnement

Name

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

(DeployCloudFormationStack/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 rôle IAM 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 rôle IAM par défaut dans l'environnement, consultezCréation d'un environnement.
Le rôle IAM 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 définition YAML 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 configuration/Environnement/Qu'y a-t-il dans mon environnement ? /menu à trois points/ Changer de rôle
(Anciennes versions) Onglet de configuration/'Environnement/Compte/Role'/ Connexion AWS au compte

Name

(DeployCloudFormationStack/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 configuration/Environnement/Qu'y a-t-il dans mon environnement ? /menu à trois points/ Changer de rôle
(Anciennes versions) Onglet de configuration/'Environnement/Compte/Role'/ Connexion AWS au compte

Role

(DeployCloudFormationStack/Environment/Connections/Role)

(Obligatoire s'Connectionsil est inclus)

Spécifiez le nom du rôle IAM que l'action Deploy AWS CloudFormation stack utilise pour accéder au AWS CloudFormation service AWS et à celui-ci. 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 rôle IAM, l'action utilise le rôle IAM par défaut répertorié dans l'environnement de la console. CodeCatalyst Si vous utilisez le rôle par défaut dans l'environnement, assurez-vous qu'il est conforme aux politiques suivantes.

La politique d'autorisation suivante :

Avertissement

Limitez les autorisations à celles indiquées dans la politique suivante. L'utilisation d'un rôle doté d'autorisations étendues peut présenter un risque de sécurité.


{
    "Version": "2012-10-17",
    "Statement": [{
    "Action": [
        "cloudformation:CreateStack",
        "cloudformation:DeleteStack",
        "cloudformation:Describe*",
        "cloudformation:UpdateStack",
        "cloudformation:CreateChangeSet",
        "cloudformation:DeleteChangeSet",
        "cloudformation:ExecuteChangeSet",
        "cloudformation:SetStackPolicy",
        "cloudformation:ValidateTemplate",
        "cloudformation:List*",
        "iam:PassRole"
    ],
    "Resource": "*",
    "Effect": "Allow"
}]
}

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 configuration/Environnement/Qu'y a-t-il dans mon environnement ? /menu à trois points/ Changer de rôle
(Anciennes versions) Onglet de configuration/'Environnement/Compte/Role'/ Rôle

Inputs

(DeployCloudFormationStack/Inputs)

(Facultatif)

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

Note

Un maximum de quatre entrées (une source et trois artefacts) sont autorisées par action de AWS CloudFormation stack Deploy.

Si vous devez faire référence à des fichiers résidant dans différentes entrées (par exemple, une source et un artefact), l'entrée source est l'entrée principale et l'artefact est l'entrée secondaire. Les références aux fichiers dans les entrées secondaires utilisent un préfixe spécial pour les distinguer du fichier principal. Pour plus de détails, consultez Exemple : Référencement de fichiers dans plusieurs artefacts.

Interface utilisateur correspondante : onglet Entrées

Sources

(DeployCloudFormationStack/Inputs/Sources)

(Obligatoire si votre AWS SAM modèle CloudFormation ou votre modèle est stocké dans un référentiel source)

Si votre AWS SAM modèle CloudFormation ou votre modèle est stocké dans un référentiel source, spécifiez l'étiquette de ce référentiel source. Actuellement, la seule étiquette prise en charge estWorkflowSource.

Si votre AWS SAM modèle CloudFormation ou votre modèle ne figure pas dans un référentiel source, il doit résider dans un artefact généré par une autre action ou dans un compartiment Amazon S3.

Pour plus d'informations sur les sources, consultez Connexion d'un flux de travail à un référentiel source.

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

Artifacts - input

(DeployCloudFormationStack/Inputs/Artifacts)

(Obligatoire si votre AWS SAM modèle CloudFormation ou votre modèle est stocké dans un artefact de sortie d'une action précédente)

Si le AWS SAM modèle CloudFormation ou que vous souhaitez déployer est contenu dans un artefact généré par une action précédente, spécifiez cet artefact ici. Si votre CloudFormation modèle n'est pas contenu dans un artefact, il doit résider dans votre référentiel source ou dans un compartiment Amazon S3.

Pour plus d'informations sur les artefacts, y compris des exemples, consultezPartage de données entre les actions d'un flux de travail à l'aide d'artefacts.

Interface utilisateur correspondante : onglet Configuration/Artefacts - facultatif

Configuration

(DeployCloudFormationStack/Configuration)

(Obligatoire)

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

Interface utilisateur correspondante : onglet Configuration

name

(DeployCloudFormationStack/Configuration/name)

(Obligatoire)

Spécifiez le nom de la CloudFormation pile que l'action Deploy AWS CloudFormation stack crée ou met à jour.

Interface utilisateur correspondante : onglet Configuration/nom de la pile

region

(DeployCloudFormationStack/Configuration/region)

(Obligatoire)

Spécifiez le Région AWS lieu dans lequel la pile sera 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 de pile

template

(DeployCloudFormationStack/Configuration/template)

(Obligatoire)

Spécifiez le nom et le chemin d'accès à votre fichier CloudFormation ou à votre fichier AWS SAM modèle. Le modèle peut être au format JSON ou YAML et peut résider dans un référentiel source, un artefact issu d'une action précédente ou un compartiment Amazon S3. Si le fichier modèle se trouve dans un référentiel source ou un artefact, le chemin est relatif à la source ou à la racine de l'artefact. Si le modèle se trouve dans un compartiment Amazon S3, le chemin est la valeur de l'URL de l'objet du modèle.

Exemples :

./MyFolder/MyTemplate.json

MyFolder/MyTemplate.yml

https://MyBucket.s3.us-west-2.amazonaws.com/MyTemplate.yml

Note

Vous devrez peut-être ajouter un préfixe au chemin du fichier du modèle pour indiquer dans quel artefact ou dans quelle source le trouver. Pour plus d’informations, consultez Référencement de fichiers dans un référentiel source et Référencement de fichiers dans un artefact.

Interface utilisateur correspondante : onglet/modèle de configuration

role-arn

(DeployCloudFormationStack/Configuration/role-arn)

(Obligatoire)

Spécifiez le nom de ressource Amazon (ARN) du rôle de pile. CloudFormation utilise ce rôle pour accéder aux ressources de votre stack et les modifier. Par exemple : arn:aws:iam::123456789012:role/StackRole.

Assurez-vous que le rôle de pile inclut :

Une ou plusieurs politiques d'autorisation. Les politiques dépendent des ressources dont vous disposez dans votre pile. Par exemple, si votre pile inclut une AWS Lambda fonction, vous devez ajouter des autorisations qui accordent l'accès à Lambda. Si vous avez suivi le didacticiel décrit dansTutoriel : Déployer une application sans serveur à l'aide de AWS CloudFormation, il inclut une procédure intitulée, Pour créer un rôle de pile qui répertorie les autorisations dont le rôle de pile a besoin si vous déployez une pile d'applications sans serveur typique.

Avertissement
Limitez les autorisations à celles requises par le CloudFormation service pour accéder aux ressources de votre pile. L'utilisation d'un rôle doté d'autorisations étendues peut présenter un risque de sécurité.

La politique de confiance suivante :


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

Associez éventuellement ce rôle à la connexion de votre compte. Pour en savoir plus sur l'association d'un rôle IAM à une connexion à un compte, consultezAjouter des rôles IAM aux connexions aux comptes. Si vous n'associez pas le rôle de pile à la connexion au compte, le rôle de pile n'apparaîtra pas dans la liste déroulante des rôles de pile de l'éditeur visuel ; toutefois, l'ARN du rôle peut toujours être spécifié dans le role-arn champ à l'aide de l'éditeur YAML.

Note

Interface utilisateur correspondante : onglet Configuration/rôle Stack - facultatif

capabilities

(DeployCloudFormationStack/Configuration/capabilities)

(Obligatoire)

Spécifiez une liste des fonctionnalités IAM requises pour autoriser la création AWS CloudFormation de certaines piles. Dans la plupart des cas, vous pouvez repartir capabilities avec la valeur par défaut deCAPABILITY_IAM,CAPABILITY_NAMED_IAM,CAPABILITY_AUTO_EXPAND.

Si vous voyez ##[error] requires capabilities: [capability-name] dans les journaux des actions de votre AWS CloudFormation stack Deploy, consultez Comment corriger les erreurs liées aux fonctionnalités IAM ? pour plus d'informations sur la manière de résoudre le problème.

Pour plus d'informations sur les fonctionnalités IAM, consultez la section Reconnaissance des ressources IAM dans les AWS CloudFormation modèles du Guide de l'utilisateur IAM.

Interface utilisateur correspondante : onglet Configuration/Avancé/Fonctionnalités

parameter-overrides

(DeployCloudFormationStack/Configuration/parameter-overrides)

(Facultatif)

Spécifiez dans votre AWS SAM modèle AWS CloudFormation ou dans votre modèle des paramètres qui n'ont pas de valeurs par défaut ou pour lesquels vous souhaitez spécifier des valeurs autres que celles par défaut. Pour plus d'informations sur les paramètres, consultez la section Paramètres du guide de AWS CloudFormation l'utilisateur.

L'parameter-overridesétablissement accepte :

Un fichier JSON contenant les paramètres et les valeurs.
Liste de paramètres et de valeurs séparée par des virgules.

Pour spécifier un fichier JSON

Assurez-vous que le fichier JSON utilise l'une des syntaxes suivantes :
```
{
  "Parameters": {
    "Param1": "Value1",
    "Param2": "Value2",
    ...
  }
}
```
Ou...
```
[
  {
     "ParameterKey": "Param1",
     "ParameterValue": "Value1"
  },
  ...
]
```
(Il existe d'autres syntaxes, mais elles ne sont pas prises en charge CodeCatalyst au moment de la rédaction.) Pour plus d'informations sur la spécification de CloudFormation paramètres dans un fichier JSON, consultez la section Syntaxe JSON prise en charge dans le manuel de référence des AWS CLI commandes.

Spécifiez le chemin d'accès au fichier JSON en utilisant l'un des formats suivants :

Si votre fichier JSON réside dans un artefact de sortie d'une action précédente, utilisez :

file:///artifacts/current-action-name/output-artifact-name/path-to-json-file

Voir l'exemple 1 pour plus de détails.

Si votre fichier JSON se trouve dans votre référentiel source, utilisez :

file:///sources/WorkflowSource/path-to-json-file

Voir l'exemple 2 pour plus de détails.

Exemple 1 — Le fichier JSON réside dans un artefact de sortie


##My workflow YAML
...
Actions:
  MyBuildAction:
    Identifier: aws/build@v1
    Outputs:
      Artifacts:
        - Name: ParamArtifact
          Files:
            - params.json
    Configuration:
    ...
  MyDeployCFNStackAction:
    Identifier: aws/cfn-deploy@v1
    Configuration:
      parameter-overrides: file:///artifacts/MyDeployCFNStackAction/ParamArtifact/params.json

Exemple 2 — Le fichier JSON se trouve dans votre référentiel source, dans un dossier appelé my/folder


##My workflow YAML
...
Actions:
  MyDeployCloudFormationStack:
    Identifier: aws/cfn-deploy@v1
    Inputs:
      Sources:
        - WorkflowSource
    Configuration:
      parameter-overrides: file:///sources/WorkflowSource/my/folder/params.json

Pour utiliser une liste de paramètres séparée par des virgules

Ajoutez des paires nom-valeur de paramètre dans la parameter-overrides propriété en utilisant le format suivant :

param-1=value-1,param-2=value-2

Par exemple, en supposant le AWS CloudFormation modèle suivant :
```
##My CloudFormation template

Description: My AWS CloudFormation template

Parameters:
  InstanceType:
    Description: Defines the Amazon EC2 compute for the production server.
    Type: String
    Default: t2.micro
    AllowedValues:
      - t2.micro
      - t2.small
      - t3.medium
    
Resources:
...
```
... vous pouvez définir la parameter-overrides propriété comme suit :
```
##My workflow YAML
...
Actions:
...
  DeployCloudFormationStack:
    Identifier: aws/cfn-deploy@v1
    Configuration:
      parameter-overrides: InstanceType=t3.medium,UseVPC=true   
```
Note
Vous pouvez spécifier un nom de paramètre sans valeur correspondante en l'utilisant undefined comme valeur. Par exemple :
parameter-overrides: MyParameter=undefined
L'effet est que lors d'une mise à jour de la pile, CloudFormation utilise la valeur de paramètre existante pour le nom de paramètre donné.

Interface utilisateur correspondante :

Onglet Configuration/Avancé/ Remplacements de paramètres
Onglet Configuration/Avancé/Remplacements de paramètres/Spécifier les remplacements à l'aide d'un fichier
Onglet Configuration/Avancé/Remplacements de paramètres/Spécifier les remplacements à l'aide d'un ensemble de valeurs

no-execute-changeset

(DeployCloudFormationStack/Configuration/no-execute-changeset)

(Facultatif)

Spécifiez si vous souhaitez CodeCatalyst créer l'ensemble de CloudFormation modifications, puis arrêtez-le avant de l'exécuter. Cela vous donne la possibilité de passer en revue les modifications définies dans la CloudFormation console. Si vous estimez que l'ensemble de modifications semble correct, désactivez cette option, puis réexécutez le flux de travail afin de CodeCatalyst pouvoir créer et exécuter l'ensemble de modifications sans vous arrêter. Par défaut, l'ensemble de modifications est créé et exécuté sans arrêt. Pour plus d'informations, consultez le paramètre de AWS CloudFormation déploiement dans le manuel de référence des AWS CLI commandes. Pour plus d'informations sur l'affichage d'un ensemble de modifications, consultez la section Affichage d'un ensemble de modifications dans le Guide de AWS CloudFormation l'utilisateur.

Interface utilisateur correspondante : onglet Configuration/Avancé/Aucune exécution définie

fail-on-empty-changeset

(DeployCloudFormationStack/Configuration/fail-on-empty-changeset)

(Facultatif)

Spécifiez si vous souhaitez échouer CodeCatalyst à l'action Deploy AWS CloudFormation stack si l'ensemble de CloudFormation modifications est vide. (Si un ensemble de modifications est vide, cela signifie qu'aucune modification n'a été apportée à la pile lors du dernier déploiement.) Par défaut, l'action est autorisée si l'ensemble de modifications est vide et un UPDATE_COMPLETE message est renvoyé même si la pile n'a pas été mise à jour.

Pour plus d'informations sur ce paramètre, consultez le paramètre de AWS CloudFormation déploiement dans le manuel de référence des AWS CLI commandes. Pour plus d'informations sur les ensembles de modifications, consultez la section Mise à jour des piles à l'aide d'ensembles de modifications dans le Guide de AWS CloudFormation l'utilisateur.

Interface utilisateur correspondante : onglet Configuration/Avancé/Échec si le changeset est vide

disable-rollback

(DeployCloudFormationStack/Configuration/disable-rollback)

(Facultatif)

Spécifiez si vous CodeCatalyst souhaitez annuler le déploiement de la pile en cas d'échec. Le rollback ramène la pile au dernier état stable connu. Par défaut, les annulations sont activées. Pour plus d'informations sur ce paramètre, consultez le paramètre de AWS CloudFormation déploiement dans le manuel de référence des AWS CLI commandes.

Pour plus d'informations sur la façon dont l'action Deploy AWS CloudFormation stack gère les annulations, consultezConfiguration des annulations.

Pour plus d'informations sur l'annulation d'une pile, consultez la section Options d'échec d'une pile dans le Guide de AWS CloudFormation l'utilisateur.

Interface utilisateur correspondante : onglet Configuration/Avancé/Désactiver la restauration

termination-protection

(DeployCloudFormationStack/Configuration/termination-protection)

(Facultatif)

Spécifiez si vous souhaitez que la AWS CloudFormation pile Deploy ajoute une protection de terminaison à la pile qu'elle déploie. Si un utilisateur tente de supprimer une pile pour laquelle la protection contre la résiliation est activée, la suppression échoue et la pile, et son statut, restent inchangés. Par défaut, la protection contre la résiliation est désactivée. Pour plus d'informations, consultez la section Protection d'une pile contre la suppression dans le Guide de AWS CloudFormation l'utilisateur.

Interface utilisateur correspondante : onglet Configuration/Avancé/Protection de terminaison

timeout-in-minutes

(DeployCloudFormationStack/Configuration/timeout-in-minutes)

(Facultatif)

Spécifiez le temps, en minutes, qui CloudFormation doit être alloué avant de chronométrer les opérations de création de pile et de définir le statut de la pile surCREATE_FAILED. Si vous ne CloudFormation pouvez pas créer la pile complète dans le temps imparti, la création de la pile échoue en raison du délai imparti et annule la pile.

Par défaut, il n'y a aucun délai d'expiration pour la création de la pile. Cependant, les ressources individuelles peuvent avoir leur propre délai d'expiration en fonction de la nature du service qu'elles mettent en œuvre. Par exemple, si une ressource individuelle dans votre pile arrive à expiration, la création de la pile arrive aussi à expiration, même si le délai que vous avez spécifié pour la création de la pile n'a pas encore été atteint.

Interface utilisateur correspondante : onglet Configuration/avancé/délai CloudFormation d'expiration

notification-arns

(DeployCloudFormationStack/Configuration/notification-arns)

(Facultatif)

Spécifiez l'ARN d'une rubrique Amazon SNS à laquelle vous souhaitez CodeCatalyst envoyer des messages de notification. Par exemple, arn:aws:sns:us-east-1:111222333:MyTopic. Lorsque l'action Deploy AWS CloudFormation stack s'exécute, CodeCatalyst coordonne avec CloudFormation pour envoyer une notification par AWS CloudFormation événement qui se produit pendant le processus de création ou de mise à jour de la pile. (Les événements sont visibles dans l'onglet Événements de la AWS CloudFormation console pour la pile.) Vous pouvez définir jusqu'à cinq sujets. Pour plus d’informations, consultez la section Qu’est-ce qu’Amazon SNS ?.

Interface utilisateur correspondante : onglet Configuration/Avancé/ARN de notification

monitor-alarm-arns

(DeployCloudFormationStack/Configuration/monitor-alarm-arns)

(Facultatif)

Spécifiez le nom de ressource Amazon (ARN) d'une CloudWatch alarme Amazon à utiliser comme déclencheur d'annulation. Par exemple, arn:aws:cloudwatch::123456789012:alarm/MyAlarm. Vous pouvez disposer d'un maximum de cinq déclencheurs de restauration.

Note

Si vous spécifiez un ARN CloudWatch d'alarme, vous devez également configurer des autorisations supplémentaires pour permettre à l'action d'y accéder CloudWatch. Pour plus d’informations, consultez Configuration des annulations.

Interface utilisateur correspondante : onglet Configuration/Avancé/Surveillance des ARN d'alarme

monitor-timeout-in-minutes

(DeployCloudFormationStack/Configuration/monitor-timeout-in-minutes)

(Facultatif)

Spécifiez une durée, comprise entre 0 et 180 minutes, pendant laquelle CloudFormation les alarmes spécifiées seront surveillées. La surveillance commence une fois que toutes les ressources de la pile ont été déployées. Si l'alarme se produit dans le délai de surveillance spécifié, le déploiement échoue et CloudFormation annule l'ensemble du fonctionnement de la pile.

Par défaut : 0. CloudFormation surveille uniquement les alarmes pendant le déploiement des ressources de la pile, et non après.

Interface utilisateur correspondante : onglet Configuration/Avancé/Temps de surveillance