CancelUpdateStack ContinueUpdateRollback CreateStack Déploiement DeleteStack DescribeStackEvents DescribeStackResource DescribeStackResources DescribeStacks GetTemplate ListStackResources ListStacks UpdateStack ValidateTemplate

Exemples de commandes d’opération de pile CloudFormation pour l’AWS CLI et PowerShell

Les exemples de ligne de commande suivants montrent comment effectuer des actions CloudFormation individuelles avec AWS CLI et PowerShell. Ces exemples ne comprennent que les actions les plus couramment utilisées. Pour obtenir la liste complète, consultez cloudformation dans la Référence des commandes en ligne AWS CLI.

Les exemples de ce guide utilisent la convention du backslash (\) pour indiquer qu’une longue ligne de commande se poursuit à la ligne suivante.

Rubriques

Annuler la mise à jour d’une pile
Poursuite de la restauration d'une mise à jour
Création d'une pile
Créer une pile qui inclut des transformations
Supprimer une pile
Décrire les événements d’une pile
Décrire une ressource d’une pile
Décrire les ressources d’une pile
Décrire les piles
Obtenir un modèle
Répertorier les ressources d’une pile
Répertorier les piles
Mettre à jour une pile
Valider votre modèle
Charger des artefacts locaux dans un compartiment S3 à l’aide de l’AWS CLI

Annuler la mise à jour d’une pile

Utilisez la commande cancel-update-stack pour annuler la mise à jour d’une pile. Pour de plus amples informations, consultez Annuler la mise à jour d’une pile.

Poursuite de la restauration d'une mise à jour

Utilisez la commande continue-update-rollback pour poursuivre la restauration d’une mise à jour. Pour de plus amples informations, consultez Poursuite de la restauration d'une mise à jour.

CLI

AWS CLI

Pour réessayer l’annulation d’une mise à jour

L’exemple continue-update-rollback suivant reprend une opération de restauration suite à un échec antérieur de la mise à jour de la pile.


aws cloudformation continue-update-rollback \
    --stack-name my-stack

Cette commande ne produit aucun résultat.

Pour plus d’informations sur l’API, consultez ContinueUpdateRollback dans la Référence des commandes AWS CLI.

PowerShell

Outils pour PowerShell V4

Exemple 1 : poursuit l’annulation de la pile nommée, qui doit avoir l’état « UPDATE_ROLLBACK_FAILED ». Si la restauration continue réussit, la pile entrera dans l’état « UPDATE_ROLLBACK_COMPLETE ».


Resume-CFNUpdateRollback -StackName "myStack"

Pour plus de détails sur l’API, consultez ContinueUpdateRollback dans la Référence des cmdlets Outils AWS pour PowerShell (V4).

Outils pour PowerShell V5


Resume-CFNUpdateRollback -StackName "myStack"

Pour plus de détails sur l’API, consultez ContinueUpdateRollback dans la Référence des cmdlets Outils AWS pour PowerShell (V5).

Création d'une pile

Utilisez la commande create-stack pour créer une pile. Vous devez fournir le nom de la pile, l'emplacement d'un modèle valide et tous les paramètres d'entrée requis. Les noms des clés de paramètre sont sensibles à la casse. Si vous saisissez incorrectement un nom de clé de paramètre, CloudFormation ne crée pas la pile et signale que le modèle ne contient pas ce paramètre.

Les exemples suivants montrent comment créer une nouvelle pile avec le nom, le modèle et les paramètres d’entrée spécifiés.

CLI

AWS CLI

Pour créer une pile AWS CloudFormation

La commande create-stacks suivante crée une pile portant le nom myteststack à l’aide du modèle sampletemplate.json :


aws cloudformation create-stack --stack-name myteststack --template-body file://sampletemplate.json --parameters ParameterKey=KeyPairName,ParameterValue=TestKey ParameterKey=SubnetIDs,ParameterValue=SubnetID1\\,SubnetID2

Sortie :


{
    "StackId": "arn:aws:cloudformation:us-east-1:123456789012:stack/myteststack/466df9e0-0dff-08e3-8e2f-5088487c4896"
}

Pour plus d’informations, consultez Piles dans le Guide de l’utilisateur AWS CloudFormation.

Pour plus de détails sur l’API, consultez CreateStack dans la Référence des commandes de l’AWS CLI.

PowerShell

Outils pour PowerShell V4

Exemple 1 : crée une nouvelle pile avec le nom spécifié. Le modèle est analysé à partir du contenu fourni avec des paramètres de personnalisation (« PK1 » et « PK2 » représentent les noms des paramètres déclarés dans le contenu du modèle, « PV1 » et « PV2 » représentent les valeurs de ces paramètres. Les paramètres de personnalisation peuvent également être spécifiés en utilisant « Key » et « Value » au lieu de « ParameterKey » et « ParameterValue ». Si la création de la pile échoue, elle ne sera pas annulée.


New-CFNStack -StackName "myStack" `
             -TemplateBody "{TEMPLATE CONTENT HERE}" `
             -Parameter @( @{ ParameterKey="PK1"; ParameterValue="PV1" }, @{ ParameterKey="PK2"; ParameterValue="PV2" }) `
             -DisableRollback $true

Exemple 2 : crée une nouvelle pile avec le nom spécifié. Le modèle est analysé à partir du contenu fourni avec des paramètres de personnalisation (« PK1 » et « PK2 » représentent les noms des paramètres déclarés dans le contenu du modèle, « PV1 » et « PV2 » représentent les valeurs de ces paramètres. Les paramètres de personnalisation peuvent également être spécifiés en utilisant « Key » et « Value » au lieu de « ParameterKey » et « ParameterValue ». Si la création de la pile échoue, elle sera annulée.


$p1 = New-Object -Type Amazon.CloudFormation.Model.Parameter
$p1.ParameterKey = "PK1"
$p1.ParameterValue = "PV1"

$p2 = New-Object -Type Amazon.CloudFormation.Model.Parameter
$p2.ParameterKey = "PK2"
$p2.ParameterValue = "PV2"

New-CFNStack -StackName "myStack" `
             -TemplateBody "{TEMPLATE CONTENT HERE}" `
             -Parameter @( $p1, $p2 ) `
             -OnFailure "ROLLBACK"

Exemple 3 : crée une nouvelle pile avec le nom spécifié. Le modèle est obtenu à partir de l’URL Amazon S3 avec des paramètres de personnalisation (« PK1 » représente le nom d’un paramètre déclaré dans le contenu du modèle, « PV1 » représente la valeur du paramètre). Les paramètres de personnalisation peuvent également être spécifiés en utilisant « Key » et « Value » au lieu de « ParameterKey » et « ParameterValue ». Si la création de la pile échoue, elle sera annulée (comme si vous spécifiez -DisableRollback $false).


New-CFNStack -StackName "myStack" `
             -TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template `
             -Parameter @{ ParameterKey="PK1"; ParameterValue="PV1" }

Exemple 4 : crée une nouvelle pile avec le nom spécifié. Le modèle est obtenu à partir de l’URL Amazon S3 avec des paramètres de personnalisation (« PK1 » représente le nom d’un paramètre déclaré dans le contenu du modèle, « PV1 » représente la valeur du paramètre). Les paramètres de personnalisation peuvent également être spécifiés en utilisant « Key » et « Value » au lieu de « ParameterKey » et « ParameterValue ». Si la création de la pile échoue, elle sera annulée (comme si vous spécifiez -DisableRollback $false). Les AEN de notification spécifiés recevront les événements publiés liés à la pile.


New-CFNStack -StackName "myStack" `
             -TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template `
             -Parameter @{ ParameterKey="PK1"; ParameterValue="PV1" } `
             -NotificationARN @( "arn1", "arn2" )

Pour plus de détails sur l’API, consultez CreateStack dans la Référence des cmdlets d’Outils AWS pour PowerShell (V4).

Outils pour PowerShell V5


New-CFNStack -StackName "myStack" `
             -TemplateBody "{TEMPLATE CONTENT HERE}" `
             -Parameter @( @{ ParameterKey="PK1"; ParameterValue="PV1" }, @{ ParameterKey="PK2"; ParameterValue="PV2" }) `
             -DisableRollback $true


$p1 = New-Object -Type Amazon.CloudFormation.Model.Parameter
$p1.ParameterKey = "PK1"
$p1.ParameterValue = "PV1"

$p2 = New-Object -Type Amazon.CloudFormation.Model.Parameter
$p2.ParameterKey = "PK2"
$p2.ParameterValue = "PV2"

New-CFNStack -StackName "myStack" `
             -TemplateBody "{TEMPLATE CONTENT HERE}" `
             -Parameter @( $p1, $p2 ) `
             -OnFailure "ROLLBACK"


New-CFNStack -StackName "myStack" `
             -TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template `
             -Parameter @{ ParameterKey="PK1"; ParameterValue="PV1" }


New-CFNStack -StackName "myStack" `
             -TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template `
             -Parameter @{ ParameterKey="PK1"; ParameterValue="PV1" } `
             -NotificationARN @( "arn1", "arn2" )

Pour plus de détails sur l’API, consultez CreateStack dans la Référence des cmdlets d’Outils AWS pour PowerShell (V5).

Note

Vous pouvez utiliser l’option AWS CLI de l’--template-url pour spécifier l’emplacement d’un fichier de modèle dans Amazon S3 ou AWS Systems Manager.

Pour Amazon S3, l’URL doit commencer par https://. Les URL de sites Web statiques S3 ne sont pas prises en charge.


--template-url https://s3.region-code.amazonaws.com/bucket-name/template-name

Pour AWS Systems Manager, utilisez le format suivant :


--template-url "ssm-doc://arn:aws:ssm:region-code:account-id:document/document-name"

Créer une pile qui inclut des transformations

Utilisez la commande deploy pour créer une pile qui inclut des transformations. Lorsque vous créez une pile à partir d’un modèle qui inclut des transformateurs, vous devez utiliser un jeu de modifications. La commande deploy combine deux étapes (création d’un jeu de modifications et exécution de celui-ci) en une seule commande.

Supprimer une pile

Utilisez la commande delete-stack pour supprimer une pile. Pour de plus amples informations, consultez Supprimer une pile.

Si la suppression échoue et renvoie un état DELETE_FAILED, vous pouvez choisir de supprimer la pile de manière forcée à l’aide de l’option --deletion-mode. Voici les valeurs suivantes qui peuvent être utilisées avec deletion-mode :

STANDARD : supprime la pile normalement. Il s’agit du mode de suppression par défaut.
FORCE_DELETE_STACK : supprime la pile et ignore toutes les ressources qui ne peuvent pas être supprimées.

Après avoir utilisé FORCE_DELETE_STACK, vous pouvez utiliser la commande list-stack-resources pour répertorier les ressources qui ont été ignorées pendant le processus de suppression de la pile. Les ressources conservées afficheront l’état DELETE_SKIPPED. Pour de plus amples informations, consultez Répertorier les ressources d’une pile.

Décrire les événements d’une pile

Utilisez la commande describe-stack-events pour décrire les événements de la pile. Pour de plus amples informations, consultez Surveiller la progression de la pile.

CLI

AWS CLI

Pour décrire les événements d’une pile

L’exemple describe-stack-events suivant affiche les deux événements les plus récents pour la pile spécifiée.


aws cloudformation describe-stack-events \
    --stack-name my-stack \
    --max-items 2

{
    "StackEvents": [
        {
            "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204",
            "EventId": "4e1516d0-e4d6-xmpl-b94f-0a51958a168c",
            "StackName": "my-stack",
            "LogicalResourceId": "my-stack",
            "PhysicalResourceId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204",
            "ResourceType": "AWS::CloudFormation::Stack",
            "Timestamp": "2019-10-02T05:34:29.556Z",
            "ResourceStatus": "UPDATE_COMPLETE"
        },
        {
            "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204",
            "EventId": "4dd3c810-e4d6-xmpl-bade-0aaf8b31ab7a",
            "StackName": "my-stack",
            "LogicalResourceId": "my-stack",
            "PhysicalResourceId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204",
            "ResourceType": "AWS::CloudFormation::Stack",
            "Timestamp": "2019-10-02T05:34:29.127Z",
            "ResourceStatus": "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS"
        }
    ],
    "NextToken": "eyJOZXh0VG9XMPLiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ=="
}

Pour plus de détails sur l’API, consultez DescribeStackEvents dans la Référence des commandes de l’AWS CLI.

PowerShell

Outils pour PowerShell V4

Exemple 1 : renvoie tous les événements associés à une pile spécifiée.


Get-CFNStackEvent -StackName "myStack"

Pour plus de détails sur l’API, consultez DescribeStackEvents dans la Référence des cmdlets d’Outils AWS pour PowerShell (V4).

Outils pour PowerShell V5

Exemple 1 : renvoie tous les événements associés à une pile spécifiée.


Get-CFNStackEvent -StackName "myStack"

Pour plus de détails sur l’API, consultez DescribeStackEvents dans la Référence des cmdlets d’Outils AWS pour PowerShell (V5).

Décrire une ressource d’une pile

CLI

AWS CLI

Pour obtenir les informations sur une ressource de pile

L’exemple describe-stack-resource suivant affiche les détails de la ressource nommée MyFunction dans la pile spécifiée.


aws cloudformation describe-stack-resource \
    --stack-name MyStack \
    --logical-resource-id MyFunction

Sortie :


{
    "StackResourceDetail": {
        "StackName": "MyStack",
        "StackId": "arn:aws:cloudformation:us-east-2:123456789012:stack/MyStack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204",
        "LogicalResourceId": "MyFunction",
        "PhysicalResourceId": "my-function-SEZV4XMPL4S5",
        "ResourceType": "AWS::Lambda::Function",
        "LastUpdatedTimestamp": "2019-10-02T05:34:27.989Z",
        "ResourceStatus": "UPDATE_COMPLETE",
        "Metadata": "{}",
        "DriftInformation": {
            "StackResourceDriftStatus": "IN_SYNC"
        }
    }
}

Pour plus de détails sur l’API, consultez DescribeStackResource dans la Référence des commandes de l’AWS CLI.

PowerShell

Outils pour PowerShell V4

Exemple 1 : renvoie la description d’une ressource identifiée dans le modèle associé à la pile spécifiée par l’ID logique « MyDBInstance ».


Get-CFNStackResource -StackName "myStack" -LogicalResourceId "MyDBInstance"

Pour plus de détails sur l’API, consultez DescribeStackResource dans la Référence des cmdlets d’Outils AWS pour PowerShell (V4).

Outils pour PowerShell V5

Exemple 1 : renvoie la description d’une ressource identifiée dans le modèle associé à la pile spécifiée par l’ID logique « MyDBInstance ».


Get-CFNStackResource -StackName "myStack" -LogicalResourceId "MyDBInstance"

Pour plus de détails sur l’API, consultez DescribeStackResource dans la Référence des cmdlets d’Outils AWS pour PowerShell (V5).

Décrire les ressources d’une pile

CLI

AWS CLI

Pour obtenir les informations sur une ressource de pile

L’exemple describe-stack-resources suivant affiche les détails des ressources dans la pile spécifiée.


aws cloudformation describe-stack-resources \
    --stack-name my-stack

Sortie :


{
    "StackResources": [
        {
            "StackName": "my-stack",
            "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204",
            "LogicalResourceId": "bucket",
            "PhysicalResourceId": "my-stack-bucket-1vc62xmplgguf",
            "ResourceType": "AWS::S3::Bucket",
            "Timestamp": "2019-10-02T04:34:11.345Z",
            "ResourceStatus": "CREATE_COMPLETE",
            "DriftInformation": {
                "StackResourceDriftStatus": "IN_SYNC"
            }
        },
        {
            "StackName": "my-stack",
            "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204",
            "LogicalResourceId": "function",
            "PhysicalResourceId": "my-function-SEZV4XMPL4S5",
            "ResourceType": "AWS::Lambda::Function",
            "Timestamp": "2019-10-02T05:34:27.989Z",
            "ResourceStatus": "UPDATE_COMPLETE",
            "DriftInformation": {
                "StackResourceDriftStatus": "IN_SYNC"
            }
        },
        {
            "StackName": "my-stack",
            "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204",
            "LogicalResourceId": "functionRole",
            "PhysicalResourceId": "my-functionRole-HIZXMPLEOM9E",
            "ResourceType": "AWS::IAM::Role",
            "Timestamp": "2019-10-02T04:34:06.350Z",
            "ResourceStatus": "CREATE_COMPLETE",
            "DriftInformation": {
                "StackResourceDriftStatus": "IN_SYNC"
            }
        }
    ]
}

Pour plus de détails sur l’API, consultez DescribeStackResources dans la Référence des commandes de l’AWS CLI.

PowerShell

Outils pour PowerShell V4

Exemple 1 : renvoie les descriptions de ressources AWS pour un maximum de 100 ressources associées à la pile spécifiée. Pour obtenir des informations détaillées sur toutes les ressources associées à une pile, utilisez le Get-CFNStackResourceSummary, qui prend également en charge la pagination manuelle des résultats.


Get-CFNStackResourceList -StackName "myStack"

Exemple 2 : renvoie la description de l’instance Amazon EC2 identifiée dans le modèle associé à la pile spécifiée par l’ID logique « Ec2Instance ».


Get-CFNStackResourceList -StackName "myStack" -LogicalResourceId "Ec2Instance"

Exemple 3 : renvoie la description d’un maximum de 100 ressources associées à la pile contenant une instance Amazon EC2 identifiée par l’ID d’instance « i-123456 ». Pour obtenir des informations détaillées sur toutes les ressources associées à une pile, utilisez le Get-CFNStackResourceSummary, qui prend également en charge la pagination manuelle des résultats.


Get-CFNStackResourceList -PhysicalResourceId "i-123456"

Exemple 4 : renvoie la description de l’instance Amazon EC2 identifiée par l’ID logique « Ec2Instance » dans le modèle pour une pile. La pile est identifiée à l’aide de l’ID de ressource physique d’une ressource qu’elle contient, dans ce cas également une instance Amazon EC2 avec l’ID d’instance « i-123456 ». Une ressource physique différente peut également être utilisée pour identifier la pile en fonction du contenu du modèle, par exemple un compartiment Amazon S3.


Get-CFNStackResourceList -PhysicalResourceId "i-123456" -LogicalResourceId "Ec2Instance"

Pour plus de détails sur l’API, consultez DescribeStackResources dans la Référence des cmdlets d’Outils AWS pour PowerShell (V4).

Outils pour PowerShell V5


Get-CFNStackResourceList -StackName "myStack"

Exemple 2 : renvoie la description de l’instance Amazon EC2 identifiée dans le modèle associé à la pile spécifiée par l’ID logique « Ec2Instance ».


Get-CFNStackResourceList -StackName "myStack" -LogicalResourceId "Ec2Instance"


Get-CFNStackResourceList -PhysicalResourceId "i-123456"


Get-CFNStackResourceList -PhysicalResourceId "i-123456" -LogicalResourceId "Ec2Instance"

Pour plus de détails sur l’API, consultez DescribeStackResources dans la Référence des cmdlets d’Outils AWS pour PowerShell (V5).

Décrire les piles

CLI

AWS CLI

Pour décrire les piles AWS CloudFormation

La commande describe-stacks suivante affiche des informations récapitulatives sur la pile myteststack :


aws cloudformation describe-stacks --stack-name myteststack

Sortie :


{
    "Stacks":  [
        {
            "StackId": "arn:aws:cloudformation:us-east-1:123456789012:stack/myteststack/466df9e0-0dff-08e3-8e2f-5088487c4896",
            "Description": "AWS CloudFormation Sample Template S3_Bucket: Sample template showing how to create a publicly accessible S3 bucket. **WARNING** This template creates an S3 bucket. You will be billed for the AWS resources used if you create a stack from this template.",
            "Tags": [],
            "Outputs": [
                {
                    "Description": "Name of S3 bucket to hold website content",
                    "OutputKey": "BucketName",
                    "OutputValue": "myteststack-s3bucket-jssofi1zie2w"
                }
            ],
            "StackStatusReason": null,
            "CreationTime": "2013-08-23T01:02:15.422Z",
            "Capabilities": [],
            "StackName": "myteststack",
            "StackStatus": "CREATE_COMPLETE",
            "DisableRollback": false
        }
    ]
}

Pour plus d’informations, consultez Piles dans le Guide de l’utilisateur AWS CloudFormation.

Pour plus de détails sur l’API, consultez DescribeStacks dans la Référence des commandes de l’AWS CLI.

Go

Kit SDK for Go V2

Note

Il y en a plus sur GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le référentiel d’exemples de code AWS.



import (
	"context"
	"log"

	"github.com/aws/aws-sdk-go-v2/aws"
	"github.com/aws/aws-sdk-go-v2/service/cloudformation"
)

// StackOutputs defines a map of outputs from a specific stack.
type StackOutputs map[string]string

type CloudFormationActions struct {
	CfnClient *cloudformation.Client
}

// GetOutputs gets the outputs from a CloudFormation stack and puts them into a structured format.
func (actor CloudFormationActions) GetOutputs(ctx context.Context, stackName string) StackOutputs {
	output, err := actor.CfnClient.DescribeStacks(ctx, &cloudformation.DescribeStacksInput{
		StackName: aws.String(stackName),
	})
	if err != nil || len(output.Stacks) == 0 {
		log.Panicf("Couldn't find a CloudFormation stack named %v. Here's why: %v\n", stackName, err)
	}
	stackOutputs := StackOutputs{}
	for _, out := range output.Stacks[0].Outputs {
		stackOutputs[*out.OutputKey] = *out.OutputValue
	}
	return stackOutputs
}

Pour plus de détails sur l’API, consultez DescribeStacks dans la Référence des API du kit AWS SDK pour Go.

PowerShell

Outils pour PowerShell V4

Exemple 1 : renvoie une collection d’instances Stack décrivant toutes les piles de l’utilisateur.


Get-CFNStack

Exemple 2 : renvoie une instance Stack décrivant la pile spécifiée


Get-CFNStack -StackName "myStack"

Pour plus de détails sur l’API, consultez DescribeStacks dans la Référence des cmdlets d’Outils AWS pour PowerShell (V4).

Outils pour PowerShell V5

Exemple 1 : renvoie une collection d’instances Stack décrivant toutes les piles de l’utilisateur.


Get-CFNStack

Exemple 2 : renvoie une instance Stack décrivant la pile spécifiée


Get-CFNStack -StackName "myStack"

Pour plus de détails sur l’API, consultez DescribeStacks dans la Référence des cmdlets d’Outils AWS pour PowerShell (V5).

Par défaut, la commande describe-stacks renvoie les valeurs des paramètres. Pour éviter que des valeurs de paramètres sensibles, telles que des mots de passe, ne soient renvoyées, incluez une propriété NoEcho définie sur TRUE dans vos modèles CloudFormation.

Important

L'utilisation de l'attribut NoEcho ne masque aucune information stockée dans les lieux suivants :

La section de modèle Metadata CloudFormation ne transforme pas, ne modifie pas, ne rédige aucune information que vous incluez dans la section Metadata. Pour de plus amples informations, veuillez consulter Métadonnées.
La section de modèle Outputs Pour de plus amples informations, veuillez consulter Sorties
L’attribut Metadata d'une définition de ressource. Pour plus d'informations, voir la section consécrée à l'Attribut Metadata.

Nous vous recommandons vivement de ne pas utiliser ces mécanismes pour inclure des informations sensibles, telles que des mots de passe ou des secrets.

Important

Plutôt que d’intégrer des informations sensibles directement dans vos modèles CloudFormation, nous vous recommandons d’utiliser des paramètres dynamiques dans le modèle de pile pour faire référence aux informations sensibles stockées et gérées en dehors de CloudFormation, par exemple dans AWS Systems Manager Parameter Store ou AWS Secrets Manager.

Pour de plus amples informations, veuillez consulter la bonne pratique N'incorporez pas d'informations d'identification dans vos modèles.

Obtenir un modèle

CLI

AWS CLI

Pour afficher le corps du modèle d’une pile AWS CloudFormation

La commande get-template suivante affiche le modèle de la pile myteststack :


aws cloudformation get-template --stack-name myteststack

Sortie :


{
    "TemplateBody": {
        "AWSTemplateFormatVersion": "2010-09-09",
        "Outputs": {
            "BucketName": {
                "Description": "Name of S3 bucket to hold website content",
                "Value": {
                    "Ref": "S3Bucket"
                }
            }
        },
        "Description": "AWS CloudFormation Sample Template S3_Bucket: Sample template showing how to create a publicly accessible S3 bucket. **WARNING** This template creates an S3 bucket. You will be billed for the AWS resources used if you create a stack from this template.",
        "Resources": {
            "S3Bucket": {
                "Type": "AWS::S3::Bucket",
                "Properties": {
                    "AccessControl": "PublicRead"
                }
            }
        }
    }
}

Pour plus de détails sur l’API, consultez GetTemplate dans la Référence des commandes de l’AWS CLI.

PowerShell

Outils pour PowerShell V4

Exemple 1 : renvoie le modèle associé à la pile spécifiée.


Get-CFNTemplate -StackName "myStack"

Pour plus de détails sur l’API, consultez GetTemplate dans la Référence des cmdlets d’Outils AWS pour PowerShell (V4).

Outils pour PowerShell V5

Exemple 1 : renvoie le modèle associé à la pile spécifiée.


Get-CFNTemplate -StackName "myStack"

Pour plus de détails sur l’API, consultez GetTemplate dans la Référence des cmdlets d’Outils AWS pour PowerShell (V5).

Répertorier les ressources d’une pile

CLI

AWS CLI

Pour répertorier les ressources d’une pile

La commande suivante affiche la liste des ressources de la pile spécifiée.


aws cloudformation list-stack-resources \
    --stack-name my-stack

Sortie :


{
    "StackResourceSummaries": [
        {
            "LogicalResourceId": "bucket",
            "PhysicalResourceId": "my-stack-bucket-1vc62xmplgguf",
            "ResourceType": "AWS::S3::Bucket",
            "LastUpdatedTimestamp": "2019-10-02T04:34:11.345Z",
            "ResourceStatus": "CREATE_COMPLETE",
            "DriftInformation": {
                "StackResourceDriftStatus": "IN_SYNC"
            }
        },
        {
            "LogicalResourceId": "function",
            "PhysicalResourceId": "my-function-SEZV4XMPL4S5",
            "ResourceType": "AWS::Lambda::Function",
            "LastUpdatedTimestamp": "2019-10-02T05:34:27.989Z",
            "ResourceStatus": "UPDATE_COMPLETE",
            "DriftInformation": {
                "StackResourceDriftStatus": "IN_SYNC"
            }
        },
        {
            "LogicalResourceId": "functionRole",
            "PhysicalResourceId": "my-functionRole-HIZXMPLEOM9E",
            "ResourceType": "AWS::IAM::Role",
            "LastUpdatedTimestamp": "2019-10-02T04:34:06.350Z",
            "ResourceStatus": "CREATE_COMPLETE",
            "DriftInformation": {
                "StackResourceDriftStatus": "IN_SYNC"
            }
        }
    ]
}

Pour plus de détails sur l’API, consultez ListStackResources dans la Référence des commandes de l’AWS CLI.

PowerShell

Outils pour PowerShell V4

Exemple 1 : renvoie les descriptions de toutes les ressources associées à la pile spécifiée.


Get-CFNStackResourceSummary -StackName "myStack"

Pour plus de détails sur l’API, consultez ListStackResources dans la Référence des cmdlets d’Outils AWS pour PowerShell (V4).

Outils pour PowerShell V5

Exemple 1 : renvoie les descriptions de toutes les ressources associées à la pile spécifiée.


Get-CFNStackResourceSummary -StackName "myStack"

Pour plus de détails sur l’API, consultez ListStackResources dans la Référence des cmdlets d’Outils AWS pour PowerShell (V5).

Répertorier les piles

Utilisez la commande list-stacks pour répertorier les piles. Pour répertorier uniquement les piles avec les codes d’état spécifiés, incluez l’option --stack-status-filter. Vous pouvez spécifier un ou plusieurs codes d’état de pile pour l’option --stack-status-filter. Pour de plus amples informations, consultez Codes d'état de la pile.

CLI

AWS CLI

Pour répertorier les piles AWS CloudFormation

La commande list-stacks suivante affiche un résumé de toutes les piles qui ont un état CREATE_COMPLETE :


aws cloudformation list-stacks --stack-status-filter CREATE_COMPLETE

Sortie :


[
    {
        "StackId": "arn:aws:cloudformation:us-east-1:123456789012:stack/myteststack/466df9e0-0dff-08e3-8e2f-5088487c4896",
        "TemplateDescription": "AWS CloudFormation Sample Template S3_Bucket: Sample template showing how to create a publicly accessible S3 bucket. **WARNING** This template creates an S3 bucket. You will be billed for the AWS resources used if you create a stack from this template.",
        "StackStatusReason": null,
        "CreationTime": "2013-08-26T03:27:10.190Z",
        "StackName": "myteststack",
        "StackStatus": "CREATE_COMPLETE"
    }
]

Pour plus de détails sur l’API, consultez ListStacks dans la Référence des commandes de l’AWS CLI.

PowerShell

Outils pour PowerShell V4

Exemple 1 : renvoie des informations récapitulatives pour toutes les piles.


Get-CFNStackSummary

Exemple 2 : renvoie des informations récapitulatives pour toutes les piles en cours de création.


Get-CFNStackSummary -StackStatusFilter "CREATE_IN_PROGRESS"

Exemple 3 : renvoie des informations récapitulatives pour toutes les piles en cours de création ou de mise à jour.


Get-CFNStackSummary -StackStatusFilter @("CREATE_IN_PROGRESS", "UPDATE_IN_PROGRESS")

Pour plus de détails sur l’API, consultez ListStacks dans la Référence des cmdlets Outils AWS pour PowerShell (V4).

Outils pour PowerShell V5

Exemple 1 : renvoie des informations récapitulatives pour toutes les piles.


Get-CFNStackSummary

Exemple 2 : renvoie des informations récapitulatives pour toutes les piles en cours de création.


Get-CFNStackSummary -StackStatusFilter "CREATE_IN_PROGRESS"

Exemple 3 : renvoie des informations récapitulatives pour toutes les piles en cours de création ou de mise à jour.


Get-CFNStackSummary -StackStatusFilter @("CREATE_IN_PROGRESS", "UPDATE_IN_PROGRESS")

Pour plus de détails sur l’API, consultez ListStacks dans la Référence des cmdlets Outils AWS pour PowerShell (V5).

Mettre à jour une pile

Utilisez la commande update-stack pour mettre à jour directement une pile. Vous spécifiez la pile, les valeurs de paramètre et les fonctionnalités que vous souhaitez mettre à jour et, si vous voulez utiliser un modèle mis à jour, le nom de ce modèle. Pour de plus amples informations, consultez Mettre à jour directement les piles.

CLI

AWS CLI

Pour mettre à jour les piles AWS CloudFormation

La commande update-stack suivante met à jour le modèle et les paramètres d’entrée pour la pile mystack :


aws cloudformation update-stack --stack-name mystack --template-url https://s3.amazonaws.com/sample/updated.template --parameters ParameterKey=KeyPairName,ParameterValue=SampleKeyPair ParameterKey=SubnetIDs,ParameterValue=SampleSubnetID1\\,SampleSubnetID2

La commande update-stack suivante met uniquement à jour la valeur de paramètre SubnetIDs de la pile mystack. Si vous ne spécifiez aucune valeur de paramètre, la valeur par défaut spécifiée dans le modèle est utilisée :


aws cloudformation update-stack --stack-name mystack --template-url https://s3.amazonaws.com/sample/updated.template --parameters ParameterKey=KeyPairName,UsePreviousValue=true ParameterKey=SubnetIDs,ParameterValue=SampleSubnetID1\\,UpdatedSampleSubnetID2

La commande update-stack suivante ajoute deux rubriques de notification de pile à la pile mystack :


aws cloudformation update-stack --stack-name mystack --use-previous-template --notification-arns "arn:aws:sns:use-east-1:123456789012:mytopic1" "arn:aws:sns:us-east-1:123456789012:mytopic2"

Pour plus d’informations, consultez Mises à jour de pile AWS CloudFormation dans le Guide de l’utilisateur AWS CloudFormation.

Pour plus de détails sur l’API, consultez UpdateStack dans la Référence des commandes de l’AWS CLI.

PowerShell

Outils pour PowerShell V4

Exemple 1 : met à jour la pile « myStack » avec le modèle et les paramètres de personnalisation spécifiés. « PK1 » représente le nom d’un paramètre déclaré dans le modèle et « PV1 » représente sa valeur. Les paramètres de personnalisation peuvent également être spécifiés en utilisant « Key » et « Value » au lieu de « ParameterKey » et « ParameterValue ».


Update-CFNStack -StackName "myStack" `
                -TemplateBody "{Template Content Here}" `
                -Parameter @{ ParameterKey="PK1"; ParameterValue="PV1" }

Exemple 2 : met à jour la pile « myStack » avec le modèle et les paramètres de personnalisation spécifiés. « PK1 » et « PK2 » représentent les noms des paramètres déclarés dans le modèle, « PV1 » et « PV2 » représentent les valeurs demandées. Les paramètres de personnalisation peuvent également être spécifiés en utilisant « Key » et « Value » au lieu de « ParameterKey » et « ParameterValue ».


Update-CFNStack -StackName "myStack" `
                -TemplateBody "{Template Content Here}" `
                -Parameter @( @{ ParameterKey="PK1"; ParameterValue="PV1" }, @{ ParameterKey="PK2"; ParameterValue="PV2" } )

Exemple 3 : met à jour la pile « myStack » avec le modèle et les paramètres de personnalisation spécifiés. « PK1 » représente le nom d’un paramètre déclaré dans le modèle et « PV2 » représente sa valeur. Les paramètres de personnalisation peuvent également être spécifiés en utilisant « Key » et « Value » au lieu de « ParameterKey » et « ParameterValue ».


Update-CFNStack -StackName "myStack" -TemplateBody "{Template Content Here}" -Parameters @{ ParameterKey="PK1"; ParameterValue="PV1" }

Exemple 4 : met à jour la pile « myStack » avec le modèle, obtenu à partir d’Amazon S3 et les paramètres de personnalisation spécifiés. « PK1 » et « PK2 » représentent les noms des paramètres déclarés dans le modèle, « PV1 » et « PV2 » représentent les valeurs demandées. Les paramètres de personnalisation peuvent également être spécifiés en utilisant « Key » et « Value » au lieu de « ParameterKey » et « ParameterValue ».


Update-CFNStack -StackName "myStack" `
                -TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template `
                -Parameter @( @{ ParameterKey="PK1"; ParameterValue="PV1" }, @{ ParameterKey="PK2"; ParameterValue="PV2" } )

Exemple 5 : met à jour la pile « myStack », qui est supposée dans cet exemple contenir des ressources IAM, avec le modèle spécifié, obtenu auprès d’Amazon S3, et les paramètres de personnalisation. « PK1 » et « PK2 » représentent les noms des paramètres déclarés dans le modèle, « PV1 » et « PV2 » représentent les valeurs demandées. Les paramètres de personnalisation peuvent également être spécifiés en utilisant « Key » et « Value » au lieu de « ParameterKey » et « ParameterValue ». Les piles contenant des ressources IAM nécessitent que vous spécifiiez le paramètre -Capabilities « CAPABILITY_IAM », sinon la mise à jour échouera avec une erreur « InsufficientCapabilities.


Update-CFNStack -StackName "myStack" `
                -TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template `
                -Parameter @( @{ ParameterKey="PK1"; ParameterValue="PV1" }, @{ ParameterKey="PK2"; ParameterValue="PV2" } ) `
                -Capabilities "CAPABILITY_IAM"

Pour plus de détails sur l’API, consultez UpdateStack dans la Référence des cmdlets Outils AWS pour PowerShell (V4).

Outils pour PowerShell V5


Update-CFNStack -StackName "myStack" `
                -TemplateBody "{Template Content Here}" `
                -Parameter @{ ParameterKey="PK1"; ParameterValue="PV1" }


Update-CFNStack -StackName "myStack" `
                -TemplateBody "{Template Content Here}" `
                -Parameter @( @{ ParameterKey="PK1"; ParameterValue="PV1" }, @{ ParameterKey="PK2"; ParameterValue="PV2" } )


Update-CFNStack -StackName "myStack" -TemplateBody "{Template Content Here}" -Parameters @{ ParameterKey="PK1"; ParameterValue="PV1" }


Update-CFNStack -StackName "myStack" `
                -TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template `
                -Parameter @( @{ ParameterKey="PK1"; ParameterValue="PV1" }, @{ ParameterKey="PK2"; ParameterValue="PV2" } )


Update-CFNStack -StackName "myStack" `
                -TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template `
                -Parameter @( @{ ParameterKey="PK1"; ParameterValue="PV1" }, @{ ParameterKey="PK2"; ParameterValue="PV2" } ) `
                -Capabilities "CAPABILITY_IAM"

Pour plus de détails sur l’API, consultez UpdateStack dans la Référence des cmdlets Outils AWS pour PowerShell (V5).

Note

Pour supprimer toutes les notifications, spécifiez [] pour l’option --notification-arns.

Valider votre modèle

Utilisez la commande validate-template pour vérifier que votre fichier de modèle ne contient pas d’erreurs de syntaxe.

Pendant la validation, CloudFormation vérifie d'abord si le modèle est dans un format JSON valide. Si ce n'est pas le cas, CloudFormation vérifie si le modèle est dans un format YAML valide. Si les deux vérifications échouent, CloudFormation retourne une erreur de validation de modèle.

CLI

AWS CLI

Pour valider un modèle AWS CloudFormation

La commande validate-template suivante valide le modèle sampletemplate.json :


aws cloudformation validate-template --template-body file://sampletemplate.json

Sortie :


{
    "Description": "AWS CloudFormation Sample Template S3_Bucket: Sample template showing how to create a publicly accessible S3 bucket. **WARNING** This template creates an S3 bucket. You will be billed for the AWS resources used if you create a stack from this template.",
    "Parameters": [],
    "Capabilities": []
}

Pour plus d’informations, consultez la section Utilisation des modèles AWS CloudFormation dans le Guide de l’utilisateur AWS CloudFormation.

Pour plus de détails sur l’API, consultez ValidateTemplate dans la Référence des commandes de l’AWS CLI.

PowerShell

Outils pour PowerShell V4

Exemple 1 : valide le contenu du modèle spécifié. La sortie détaille les fonctionnalités, la description et les paramètres du modèle.


Test-CFNTemplate -TemplateBody "{TEMPLATE CONTENT HERE}"

Exemple 2 : valide le modèle spécifié accessible via une URL Amazon S3. La sortie détaille les fonctionnalités, la description et les paramètres du modèle.


Test-CFNTemplate -TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template

Pour plus de détails sur l’API, consultez ValidateTemplate dans la Référence des cmdlets Outils AWS pour PowerShell (V4).

Outils pour PowerShell V5

Exemple 1 : valide le contenu du modèle spécifié. La sortie détaille les fonctionnalités, la description et les paramètres du modèle.


Test-CFNTemplate -TemplateBody "{TEMPLATE CONTENT HERE}"

Exemple 2 : valide le modèle spécifié accessible via une URL Amazon S3. La sortie détaille les fonctionnalités, la description et les paramètres du modèle.


Test-CFNTemplate -TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template

Pour plus de détails sur l’API, consultez ValidateTemplate dans la Référence des cmdlets Outils AWS pour PowerShell (V5).

Voici un exemple de réponse qui génère une erreur de validation.


{
    "ResponseMetadata": {
        "RequestId": "4ae33ec0-1988-11e3-818b-e15a6df955cd"
    },
    "Errors": [
        {
            "Message": "Template format error: JSON not well-formed. (line 11, column 8)",
            "Code": "ValidationError",
            "Type": "Sender"
        }
    ],
    "Capabilities": [],
    "Parameters": []
}
A client error (ValidationError) occurred: Template format error: JSON not well-formed. (line 11, column 8)

Note

La commande validate-template est conçue pour vérifier uniquement la syntaxe de votre modèle. Elle ne garantit pas que les valeurs de propriété que vous avez spécifiées pour une ressource sont valides pour cette ressource. Elle ne détermine pas non plus le nombre de ressources qui existeront lorsque la pile sera créée.

Pour vérifier la validité opérationnelle, vous devez essayer de créer la pile. Il n'y a pas d'environnement de test (sandbox) ni de zone de test pour les piles CloudFormation. Les ressources que vous créez pendant les tests vous sont donc facturées.

Exemple de disponibilité

Vous n’avez pas trouvé ce dont vous avez besoin ? Faites une demande d’un nouvel exemple à l’aide du lien Fournir des commentaires au bas de cette page.

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

Utilisation des liens de création rapide pour créer des piles CloudFormation

Charger des artefacts locaux dans un compartiment S3