Référencez les ressources existantes et les paramètres de Systems Manager avec les CloudFormation types de paramètres fournis

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

Présentation

Dans CloudFormation, vous pouvez utiliser des paramètres pour personnaliser vos piles en fournissant des valeurs d'entrée lors de la création ou de la mise à jour des piles. Cette fonctionnalité rend vos modèles réutilisables et flexibles dans différents scénarios.

Les paramètres sont définis dans la Parameters section d'un CloudFormation modèle. 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, veuillez consulter Parameters référence de syntaxe de section pour les CloudFormation modèles.

Le type de paramètre détermine le type de valeur d'entrée que le paramètre peut accepter. Par exemple, accepte Number uniquement les valeurs numériques, tandis que la saisie de texte est String acceptée.

CloudFormation fournit plusieurs types de paramètres supplémentaires que vous pouvez utiliser dans vos modèles pour référencer les AWS ressources existantes et les paramètres de Systems Manager.

Ces types de paramètres se répartissent en deux catégories :

Une fois que vos paramètres sont définis dans la Parameters section, vous pouvez référencer les valeurs des paramètres dans l'ensemble de votre CloudFormation modèle à l'aide de la Ref fonction.

Exemple

L'exemple suivant montre un modèle qui utilise les types de paramètres suivants.

Pour créer une pile à partir de ce modèle, vous devez spécifier un VPC ID, un ID de sous-réseau et un nom de paire de clés existants depuis votre compte. Vous pouvez également spécifier une clé de magasin de paramètres existante qui fait référence à l'AMIID 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 pour l'AMIID régional de la dernière version d'Amazon Linux 2AMI. Pour plus d'informations sur les paramètres publics, consultez la section Découverte des paramètres publics dans Parameter Store dans le guide de AWS Systems Manager l'utilisateur.

{
    "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

AWS CLI commande pour créer la pile

Ce qui suit create-stackcette commande crée une pile basée sur le modèle d'exemple.

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 exempleList<AWS::EC2::Subnet::Id>, vous devez éviter les virgules à l'intérieur du ParameterValue par une double barre oblique inverse, comme indiqué dans l'exemple suivant.

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

Considérations

Il est vivement recommandé d'utiliser des références dynamiques pour restreindre l'accès aux définitions de configuration sensibles, telles que les informations d'identification tierces. Pour de plus amples informations, veuillez consulter Obtenez des valeurs stockées dans d'autres services à l'aide de références dynamiques.

Si vous souhaitez autoriser les utilisateurs du modèle à spécifier des valeurs différentes Comptes AWS, n'utilisez pas de types de paramètres AWS spécifiques. Définissez plutôt des paramètres de type String ouCommaDelimitedList.

Voici quelques points à prendre en compte en ce qui concerne les types de paramètres de Systems Manager :

Types de paramètres AWS spécifiques pris en charge

CloudFormation prend en charge les types AWS spécifiques suivants :

Types de paramètres de 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 le type de paramètre Systems Manager suivant :

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