Spécification de ressources existantes à l’exécution avec les types de paramètres fournis par CloudFormation

Lors de la création de votre modèle, vous pouvez définir des paramètres qui obligent les utilisateurs à saisir des identifiants de ressources AWS existantes ou de paramètres Systems Manager grâce à des types spécialisés fournis par CloudFormation.

Présentation

Dans CloudFormation, les paramètres permettent de personnaliser vos piles en fournissant des valeurs d’entrée lors de la création ou de la mise à jour d’une pile. Cette caractéristique rend vos modèles réutilisables et flexibles dans divers scénarios.

Les paramètres sont définis dans la section Parameters d’un modèle CloudFormation. Chaque paramètre possède un nom et un type, et peut comporter des paramètres supplémentaires tels qu’une valeur par défaut et des valeurs autorisées. Pour de plus amples informations, consultez Syntaxe Parameters du modèle CloudFormation.

Le type de paramètre détermine le type de valeur que le paramètre peut accepter. Par exemple, Number accepte uniquement des valeurs numériques, tandis que String accepte des valeurs textuelles.

CloudFormation propose plusieurs types de paramètres supplémentaires à utiliser dans vos modèles pour référencer des ressources AWS existantes ou des paramètres Systems Manager.

Ces types de paramètres appartiennent à deux catégories :

Une fois les paramètres définis dans la section Parameters, vous pouvez référencer leurs valeurs dans tout votre modèle CloudFormation à l’aide de la fonction Ref.

Exemple

L’exemple suivant montre un modèle utilisant les types de paramètres suivants.

Pour créer une pile à partir de ce modèle, vous devez spécifier un ID VPC, un ID de sous-réseau et un nom de paire de clés existants dans votre compte. Vous pouvez également spécifier une clé de magasin de paramètres existante qui fait référence à l’ID d’AMI souhaité ou conserver la valeur par défaut de /aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2. Ce paramètre public est un alias de l’ID AMI régional le plus récent pour l’AMI Amazon Linux 2. Pour plus d’informations sur les paramètres publics, consultez Découverte des paramètres publics dans le magasin de paramètres dans le Guide de l’utilisateur AWS Systems Manager.

{
    "Parameters": {
        "VpcId": {
            "Description": ID of an existing Virtual Private Cloud (VPC).,
            "Type": AWS::EC2::VPC::Id
        },
        "PublicSubnetId": {
            "Description": ID of an existing public subnet within the specified VPC.,
            "Type": AWS::EC2::Subnet::Id
        },
        "KeyName": {
            "Description": Name of an existing EC2 key pair to enable SSH access to the instance.,
            "Type": AWS::EC2::KeyPair::KeyName
        },
        "AMIId": {
            "Description": Name of a Parameter Store parameter that stores the ID of the Amazon Machine Image (AMI).,
            "Type": AWS::SSM::Parameter::Value<AWS::EC2::Image::Id>,
            "Default": /aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2
        }
    },
    "Resources": {
        "InstanceSecurityGroup": {
            "Type": "AWS::EC2::SecurityGroup",
            "Properties": {
                "GroupDescription": "Enable SSH access via port 22",
                "VpcId": { "Ref": "VpcId" },
                "SecurityGroupIngress": [
                    {
                        "IpProtocol": "tcp",
                        "FromPort": 22,
                        "ToPort": 22,
                        "CidrIp": "0.0.0.0/0"
                    }
                ]
            }
        },
        "Ec2Instance": {
            "Type": "AWS::EC2::Instance",
            "Properties": {
                "KeyName": { "Ref": "KeyName" },
                "ImageId": { "Ref": "AMIId" },
                "NetworkInterfaces": [
                    {
                        "AssociatePublicIpAddress": "true",
                        "DeviceIndex": "0",
                        "SubnetId": { "Ref": "PublicSubnetId" },
                        "GroupSet": [{ "Ref": "InstanceSecurityGroup" }]
                    }
                ]
            }
        }
    },
    "Outputs": {
        "InstanceId": {
            "Value": { "Ref": "Ec2Instance" }
        }
    }
}

Parameters:
  VpcId:
    Description: ID of an existing Virtual Private Cloud (VPC).
    Type: AWS::EC2::VPC::Id
  PublicSubnetId:
    Description: ID of an existing public subnet within the specified VPC.
    Type: AWS::EC2::Subnet::Id
  KeyName:
    Description: Name of an existing EC2 KeyPair to enable SSH access to the instance.
    Type: AWS::EC2::KeyPair::KeyName
  AMIId:
    Description: Name of a Parameter Store parameter that stores the ID of the Amazon Machine Image (AMI).
    Type: AWS::SSM::Parameter::Value<AWS::EC2::Image::Id>
    Default: /aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2
Resources:
  InstanceSecurityGroup:
    Type: AWS::EC2::SecurityGroup
    Properties:
      GroupDescription: Enable SSH access via port 22
      VpcId: !Ref VpcId
      SecurityGroupIngress:
        - IpProtocol: tcp
          FromPort: 22
          ToPort: 22
          CidrIp: 0.0.0.0/0
  Ec2Instance:
    Type: AWS::EC2::Instance
    Properties:
      KeyName: !Ref KeyName
      ImageId: !Ref AMIId
      NetworkInterfaces:
        - AssociatePublicIpAddress: "true"
          DeviceIndex: "0"
          SubnetId: !Ref PublicSubnetId
          GroupSet:
            - !Ref InstanceSecurityGroup
Outputs:
  InstanceId:
    Value: !Ref Ec2Instance

Commande AWS CLI pour créer la pile

La commande create-stack suivante crée une pile basée sur l’exemple de modèle.

aws cloudformation create-stack --stack-name MyStack \
  --template-body file://sampletemplate.json \
  --parameters \
ParameterKey="VpcId",ParameterValue="vpc-a123baa3" \
ParameterKey="PublicSubnetId",ParameterValue="subnet-123a351e" \
ParameterKey="KeyName",ParameterValue="MyKeyName" \
ParameterKey="AMIId",ParameterValue="MyParameterKey"

Pour utiliser un type de paramètre qui accepte une liste de chaînes, par exemple List<AWS::EC2::Subnet::Id>, vous devez échapper les virgules dans la ParameterValue à l’aide d’une double barre oblique inversée, comme illustré dans l’exemple suivant.

--parameters ParameterKey="SubnetIDs",ParameterValue="subnet-5ea0c127\\,subnet-6194ea3b\\,subnet-c87f2be0"

Considérations

Il est fortement recommandé d’utiliser des références dynamiques afin de restreindre l’accès aux définitions de configuration sensibles, comme les informations d’identification tierces. Pour de plus amples informations, consultez Obtenir les valeurs stockées dans d’autres services à l’aide de références dynamiques.

Si vous souhaitez permettre aux utilisateurs du modèle de spécifier des valeurs provenant de différents Comptes AWS, n’utilisez pas les types de paramètres propres à AWS. Définissez plutôt des paramètres de type String ou CommaDelimitedList.

Voici quelques éléments à garder à l’esprit sur les types de paramètres Systems Manager :

Prise en charge de types de paramètres spécifiques à AWS

CloudFormation prend en charge les types propres à AWS suivants :

Types de paramètres Systems Manager pris en charge

CloudFormation prend en charge les types de paramètres Systems Manager suivants :

Types de paramètres Systems Manager non pris en charge

CloudFormation ne prend pas en charge les types de paramètres Systems Manager suivants :

En outre, CloudFormation ne prend pas en charge la définition des paramètres de modèle en tant que types de paramètres Systems Manager SecureString. Cependant, vous pouvez spécifier des chaînes sécurisées comme valeurs de paramètres pour certaines ressources. Pour de plus amples informations, consultez Obtenir les valeurs stockées dans d’autres services à l’aide de références dynamiques.