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.

CloudFormation StackSets référence des actions de déploiement

CodePipeline offre la possibilité d'effectuer des CloudFormation StackSets opérations dans le cadre de votre CI/CD processus. Vous utilisez un ensemble de piles pour créer des piles dans les AWS comptes des différentes AWS régions à l'aide d'un CloudFormation modèle unique. Toutes les ressources incluses dans chaque pile sont définies par le CloudFormation modèle de l'ensemble de piles. Lorsque vous créez le jeu de piles, vous spécifiez le modèle à utiliser, ainsi que tous les paramètres et fonctionnalités requis par le modèle.

Pour plus d'informations sur les concepts de CloudFormation StackSets, consultez StackSets les concepts du Guide de AWS CloudFormation l'utilisateur.

Vous intégrez votre pipeline CloudFormation StackSets grâce à deux types d'actions distincts que vous utilisez ensemble :

Vous pouvez utiliser ces actions pour déployer sur des AWS comptes cibles ou des identifiants d'unité organisationnelle des AWS organisations cibles.

Comment ? CloudFormation StackSets les actions fonctionnent

Une CloudFormationStackSet action crée ou met à jour des ressources selon qu'elle est exécutée pour la première fois ou non.

L'CloudFormationStackSetaction crée ou met à jour l'ensemble de piles et déploie ces modifications sur les instances spécifiées.

L'CloudFormationStackInstancesaction crée de nouvelles instances de pile ou met à jour des instances de pile obsolètes. Une instance devient obsolète lorsqu'un ensemble de piles est mis à jour, mais toutes les instances qu'il contient ne sont pas mises à jour.

Dans le cadre d'une mise à jour, les CloudFormationStackInstances actions CloudFormationStackSet et peuvent spécifier de nouvelles cibles de déploiement, ce qui crée de nouvelles instances de pile.

Dans le cadre d'une mise à jour, les CloudFormationStackInstances actions CloudFormationStackSet et ne suppriment pas les ensembles de piles, les instances ou les ressources. Lorsque l'action met à jour une pile mais ne spécifie pas toutes les instances à mettre à jour, les instances qui n'ont pas été spécifiées pour la mise à jour sont supprimées de la mise à jour et leur statut est défini surOUTDATED.

Au cours d'un déploiement, les instances de pile peuvent également indiquer OUTDATED si le déploiement vers les instances a échoué.

Comment structurer StackSets les actions dans un pipeline

Il est recommandé de construire votre pipeline de manière à ce que l'ensemble de piles soit créé et initialement déployé sur un sous-ensemble ou une seule instance. Après avoir testé votre déploiement et visualisé l'ensemble de piles généré, ajoutez l'CloudFormationStackInstancesaction pour que les instances restantes soient créées et mises à jour.

Utilisez la console ou l'interface de ligne de commande pour créer la structure de pipeline recommandée comme suit :

Lorsque vous lancez une mise à jour de pile au cours de laquelle vous avez supprimé des cibles de déploiement de la configuration d'action, les instances de pile qui n'étaient pas destinées à être mises à jour sont supprimées du déploiement et passent à l'état OBSOLÈTE. Par exemple, pour la mise à jour d'une instance de pile pour un compte Account-A dont la us-east-2 région est supprimée de la configuration de l'action, les instances de pile restantes sont créées et l'instance supprimée est définie sur OBSOLETED comme suit :

Pour plus d'informations sur les meilleures pratiques en matière de déploiement de stack sets, consultez la section Meilleures pratiques du Guide de AWS CloudFormation l'utilisateur. StackSets

L'action CloudFormationStackSet

Cette action crée ou met à jour un ensemble de piles à partir du modèle stocké dans l'emplacement source du pipeline.

Après avoir défini un ensemble de piles, vous pouvez créer, mettre à jour ou supprimer des piles dans les comptes cibles et les régions spécifiés dans les paramètres de configuration. Lors de la création, de la mise à jour et de la suppression de piles, vous pouvez spécifier d'autres préférences, telles que l'ordre des régions pour les opérations à effectuer, le pourcentage de tolérance aux pannes au-delà duquel les opérations de pile s'arrêtent et le nombre de comptes dans lesquels les opérations sont effectuées simultanément sur les piles.

Un ensemble de piles est une ressource régionale. Si vous créez un ensemble de piles dans une AWS région, vous ne pouvez pas y accéder depuis d'autres régions.

Lorsque cette action est utilisée comme action de mise à jour de l'ensemble de piles, les mises à jour de la pile ne sont pas autorisées sans un déploiement sur au moins une instance de pile.

Type d'action

Paramètres de configuration

Artefacts d'entrée

Vous devez inclure au moins un artefact d'entrée contenant le modèle de l'ensemble de piles dans une CloudFormationStackSet action. Vous pouvez inclure d'autres artefacts d'entrée pour les listes de cibles de déploiement, de comptes et de paramètres.

Artefacts de sortie

Variables de sortie

Si vous configurez cette action, elle produit des variables qui peuvent être référencées par la configuration de l'action d'une action en aval dans le pipeline. Vous configurez une action avec un espace de noms pour rendre ces variables disponibles pour la configuration des actions en aval.

Pour de plus amples informations, veuillez consulter Référence des variables.

Exemple CloudFormationStackSet configuration des actions

Les exemples suivants montrent la configuration de l'CloudFormationStackSetaction.

Exemple de modèle d'autorisations autogérées

L'exemple suivant montre une CloudFormationStackSet action dans laquelle la cible de déploiement saisie est un ID de AWS compte.

YAML

Name: CreateStackSet
ActionTypeId:
  Category: Deploy
  Owner: AWS
  Provider: CloudFormationStackSet
  Version: '1'
RunOrder: 1
Configuration:
  DeploymentTargets: '111111222222'
  FailureTolerancePercentage: '20'
  MaxConcurrentPercentage: '25'
  PermissionModel: SELF_MANAGED
  Regions: us-east-1
  StackSetName: my-stackset
  TemplatePath: 'SourceArtifact::template.json'
OutputArtifacts: []
InputArtifacts:
  - Name: SourceArtifact
Region: us-west-2
Namespace: DeployVariables

JSON

{
    "Name": "CreateStackSet",
    "ActionTypeId": {
        "Category": "Deploy",
        "Owner": "AWS",
        "Provider": "CloudFormationStackSet",
        "Version": "1"
    },
    "RunOrder": 1,
    "Configuration": {
        "DeploymentTargets": "111111222222",
        "FailureTolerancePercentage": "20",
        "MaxConcurrentPercentage": "25",
        "PermissionModel": "SELF_MANAGED",
        "Regions": "us-east-1",
        "StackSetName": "my-stackset",
        "TemplatePath": "SourceArtifact::template.json"
    },
    "OutputArtifacts": [],
    "InputArtifacts": [
        {
            "Name": "SourceArtifact"
        }
    ],
    "Region": "us-west-2",
    "Namespace": "DeployVariables"
}

Exemple de modèle d'autorisations gérées par les services

L'exemple suivant montre une CloudFormationStackSet action pour le modèle d'autorisations gérées par les services dans laquelle l'option de déploiement automatique auprès des AWS organisations est activée avec la rétention de la pile.

YAML

Name: Deploy
ActionTypeId:
  Category: Deploy
  Owner: AWS
  Provider: CloudFormationStackSet
  Version: '1'
RunOrder: 1
Configuration:
  Capabilities: 'CAPABILITY_IAM,CAPABILITY_NAMED_IAM'
  OrganizationsAutoDeployment: EnabledWithStackRetention
  PermissionModel: SERVICE_MANAGED
  StackSetName: stacks-orgs
  TemplatePath: 'SourceArtifact::template.json'
OutputArtifacts: []
InputArtifacts:
  - Name: SourceArtifact
Region: eu-central-1
Namespace: DeployVariables

JSON

{
    "Name": "Deploy",
    "ActionTypeId": {
        "Category": "Deploy",
        "Owner": "AWS",
        "Provider": "CloudFormationStackSet",
        "Version": "1"
    },
    "RunOrder": 1,
    "Configuration": {
        "Capabilities": "CAPABILITY_IAM,CAPABILITY_NAMED_IAM",
        "OrganizationsAutoDeployment": "EnabledWithStackRetention",
        "PermissionModel": "SERVICE_MANAGED",
        "StackSetName": "stacks-orgs",
        "TemplatePath": "SourceArtifact::template.json"
    },
    "OutputArtifacts": [],
    "InputArtifacts": [
        {
            "Name": "SourceArtifact"
        }
    ],
    "Region": "eu-central-1",
    "Namespace": "DeployVariables"
}

L' CloudFormationStackInstances action

Cette action crée de nouvelles instances et déploie des ensembles de piles sur des instances spécifiées. Une instance de pile est une référence à une pile d’un compte de destination dans une région. Une instance de pile peut exister sans pile ; par exemple, si la création de pile échoue, l'instance de pile indique la raison de l'échec de la création de la pile. L'instance de pile est associée à un seul ensemble de piles.

Après la création initiale d'un ensemble de piles, vous pouvez ajouter de nouvelles instances de pile à l'aide deCloudFormationStackInstances. Les valeurs des paramètres du modèle peuvent être remplacées au niveau de l'instance de pile lors des opérations de création ou de mise à jour d'instances d'ensemble de piles.

Chaque ensemble de piles possède un modèle et un ensemble de paramètres de modèle. Lorsque vous mettez à jour le modèle ou les paramètres du modèle, vous les mettez à jour pour l'ensemble complet. Tous les statuts de l'instance sont ensuite définis sur OUTDATED jusqu'à ce que les modifications soient déployées sur cette instance.

Pour remplacer les valeurs de paramètres sur des instances spécifiques, par exemple, si le modèle contient un paramètre pour stage ayant une valeur deprod, vous pouvez remplacer la valeur de ce paramètre par ou. beta gamma

Type d'action

Paramètres de configuration

Artefacts d'entrée

CloudFormationStackInstancespeut contenir des artefacts répertoriant les cibles et les paramètres de déploiement.

Artefacts de sortie

Variables de sortie

Lorsque cette action est configurée, elle produit des variables qui peuvent être référencées par la configuration d'action d'une action en aval dans le pipeline. Vous configurez une action avec un espace de noms pour rendre ces variables disponibles pour la configuration des actions en aval.

Pour de plus amples informations, veuillez consulter Référence des variables.

Exemple de configuration d'action

Les exemples suivants montrent la configuration de l'CloudFormationStackInstancesaction.

Exemple de modèle d'autorisations autogérées

L'exemple suivant montre une CloudFormationStackInstances action dans laquelle la cible de déploiement saisie est un Compte AWS ID111111222222.

YAML

Name: my-instances
ActionTypeId:
  Category: Deploy
  Owner: AWS
  Provider: CloudFormationStackInstances
  Version: '1'
RunOrder: 2
Configuration:
  DeploymentTargets: '111111222222'
  Regions: 'us-east-1,us-east-2,us-west-1,us-west-2'
  StackSetName: my-stackset
OutputArtifacts: []
InputArtifacts:
  - Name: SourceArtifact
Region: us-west-2

JSON

{
    "Name": "my-instances",
    "ActionTypeId": {
        "Category": "Deploy",
        "Owner": "AWS",
        "Provider": "CloudFormationStackInstances",
        "Version": "1"
    },
    "RunOrder": 2,
    "Configuration": {
        "DeploymentTargets": "111111222222",
        "Regions": "us-east-1,us-east-2,us-west-1,us-west-2",
        "StackSetName": "my-stackset"
    },
    "OutputArtifacts": [],
    "InputArtifacts": [
        {
            "Name": "SourceArtifact"
        }
    ],
    "Region": "us-west-2"
}

Exemple de modèle d'autorisations gérées par les services

L'exemple suivant montre une CloudFormationStackInstances action pour le modèle d'autorisations gérées par les services où la cible de déploiement est l'ID d'une unité organisationnelle de l' AWS organisation. ou-1111-1example

YAML

Name: Instances
ActionTypeId:
  Category: Deploy
  Owner: AWS
  Provider: CloudFormationStackInstances
  Version: '1'
RunOrder: 2
Configuration:
  DeploymentTargets: ou-1111-1example
  Regions: us-east-1
  StackSetName: my-stackset
OutputArtifacts: []
InputArtifacts:
  - Name: SourceArtifact
Region: eu-central-1

JSON

{
    "Name": "Instances",
    "ActionTypeId": {
        "Category": "Deploy",
        "Owner": "AWS",
        "Provider": "CloudFormationStackInstances",
        "Version": "1"
    },
    "RunOrder": 2,
    "Configuration": {
        "DeploymentTargets": "ou-1111-1example",
        "Regions": "us-east-1",
        "StackSetName": "my-stackset"
    },
    "OutputArtifacts": [],
    "InputArtifacts": [
        {
            "Name": "SourceArtifact"
        }
    ],
    "Region": "eu-central-1"
}

Autorisations relatives aux rôles de service : CloudFormationStackSet action

Pour CloudFormation StackSets les actions, les autorisations minimales suivantes sont requises.

Pour l'CloudFormationStackSetaction, ajoutez ce qui suit à votre déclaration de politique :

{
    "Effect": "Allow",
    "Action": [
        "cloudformation:CreateStackSet",
        "cloudformation:UpdateStackSet",
        "cloudformation:CreateStackInstances",
        "cloudformation:DescribeStackSetOperation",
        "cloudformation:DescribeStackSet",
        "cloudformation:ListStackInstances"
    ],
    "Resource": "resource_ARN"
},

Autorisations relatives aux rôles de service : CloudFormationStackInstances action

Pour l'CloudFormationStackInstancesaction, ajoutez ce qui suit à votre déclaration de politique :

{
    "Effect": "Allow",
    "Action": [
        "cloudformation:CreateStackInstances",
        "cloudformation:DescribeStackSetOperation"
    ],
    "Resource": "resource_ARN"
},

Modèles d'autorisations pour les opérations relatives aux ensembles de piles

Comme il CloudFormation StackSets effectue des opérations sur plusieurs comptes, vous devez définir les autorisations nécessaires sur ces comptes avant de pouvoir créer le stack set. Vous pouvez définir des autorisations par le biais d'autorisations autogérées ou d'autorisations gérées par service.

Avec les autorisations autogérées, vous créez les deux rôles IAM requis par StackSets  : un rôle d'administrateur, par exemple, AWSCloudFormationStackSetAdministrationRole dans le compte où vous définissez le stack set, et un rôle d'exécution, tel que AWSCloudFormationStackSetExecutionRole dans chacun des comptes où vous déployez des instances de stack set. À l'aide de ce modèle d'autorisations, StackSets vous pouvez effectuer un déploiement AWS sur n'importe quel compte dans lequel l'utilisateur est autorisé à créer un rôle IAM. Pour plus d'informations, voir Accorder des autorisations autogérées dans le Guide de l'AWS CloudFormation utilisateur.

Grâce aux autorisations gérées par les services, vous pouvez déployer des instances de stack sur des comptes gérés par AWS des organisations. À l'aide de ce modèle d'autorisations, vous n'avez pas à créer les rôles IAM nécessaires, car les rôles IAM sont StackSets créés en votre nom. Avec ce modèle, vous pouvez également activer les déploiements automatiques sur les comptes qui seront ajoutés ultérieurement à l'organisation. Consultez la section Activer l'accès sécurisé auprès AWS des organisations dans le Guide de AWS CloudFormation l'utilisateur.

Types de données des paramètres du modèle

Les paramètres de modèle utilisés dans les opérations d'ensembles de piles incluent les types de données suivants. Pour de plus amples informations, veuillez consulter DescribeStackSet.

Chaque ensemble de piles possède un modèle et un ensemble de paramètres de modèle. Lorsque vous mettez à jour le modèle ou les paramètres du modèle, vous les mettez à jour pour l'ensemble complet. Ensuite, tous les statuts d'instance sont définis sur OBSOLÈTE jusqu'à ce que les modifications soient déployées sur cette instance.

Pour remplacer les valeurs de paramètres sur des instances spécifiques, par exemple, si le modèle contient un paramètre pour stage ayant une valeur deprod, vous pouvez remplacer la valeur de ce paramètre par ou. beta gamma

Consultez aussi

Les ressources connexes suivantes peuvent s'avérer utiles dans le cadre de l'utilisation de cette action.