Specifica delle risorse esistenti in fase di runtime con i tipi di parametri forniti da CloudFormation

Durante la creazione del modello puoi creare parametri che richiedono agli utenti di inserire identificatori di risorse AWS esistenti o parametri di Systems Manager utilizzando tipi di parametri specifici forniti da CloudFormation.

Panoramica

In CloudFormation, puoi utilizzare i parametri per personalizzare gli stack fornendo valori di input durante la creazione o l’aggiornamento degli stack. Questa funzionalità rende i modelli riutilizzabili e flessibili in diversi scenari.

I parametri sono definiti nella sezione Parameters di un modello CloudFormation. Ogni parametro ha un nome e un tipo e può avere impostazioni aggiuntive come un valore predefinito e valori consentiti. Per ulteriori informazioni, consulta Sintassi dei Parameters del modello CloudFormation.

Il tipo di parametro determina il tipo di valore di input che il parametro può accettare. Ad esempio, Number accetta solo valori numerici, mentre String accetta l’immissione di testo.

CloudFormation fornisce diversi tipi di parametri aggiuntivi che puoi utilizzare nei modelli per fare riferimento alle risorse AWS esistenti e ai parametri di Systems Manager.

Questi tipi di parametri si dividono in due categorie:

Una volta definiti i parametri nella sezione Parameters, puoi fare riferimento ai valori dei parametri nell’intero modello CloudFormation utilizzando la funzione Ref.

Esempio

Nel seguente esempio viene mostrato un modello che utilizza i seguenti tipi di parametro.

Per creare uno stack da questo modello devi specificare un ID del VPC, un ID di sottorete e un nome della coppia di chiavi esistenti dal tuo account. Puoi anche specificare una chiave Parameter Store esistente che faccia riferimento all’ID AMI desiderato o mantenga il valore predefinito di /aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2. Questo parametro pubblico è un alias per l’ID AMI regionale per l’AMI Amazon Linux 2 più recente. Per ulteriori informazioni sui parametri pubblici, consulta Discovering public parameters in Parameter Store nella Guida per l’utente di 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

Comando AWS CLI per creare lo stack

Il seguente comando create-stack crea uno stack in base al modello di esempio.

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"

Per utilizzare un tipo di parametro che accetta un elenco di stringhe, ad esempio List<AWS::EC2::Subnet::Id>, devi evitare le virgole all’interno del ParameterValue con una doppia barra rovesciata, come illustrato nell’esempio seguente.

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

Considerazioni

Si consiglia vivamente di utilizzare riferimenti dinamici per limitare l’accesso a definizioni di configurazione riservate, come le credenziali di terze parti. Per ulteriori informazioni, consulta Ottenimento di valori archiviati in altri servizi utilizzando riferimenti dinamici.

Se desideri consentire agli utenti del modello di specificare valori da Account AWS diversi, non utilizzare tipi di parametri specifici di AWS. Definisci, invece, parametri di tipo String o CommaDelimitedList.

Ci sono alcune cose da tenere a mente con i tipi di parametri di Systems Manager:

Tipi di parametri specifici per AWS supportati

CloudFormation supporta i seguenti tipi specifici di AWS:

Tipi di parametri supportati da Systems Manager

CloudFormation supporta i seguenti tipi di parametri Systems Manager:

Tipi di parametri Systems Manager non supportati

CloudFormation non supporta i seguenti tipi di parametri Systems Manager

Inoltre, CloudFormation non supporta la definizione dei parametri di modello come tipi di parametro Systems Manager SecureString. Tuttavia, puoi specificare stringhe sicure come valori dei parametri per alcune risorse. Per ulteriori informazioni, consulta Ottenimento di valori archiviati in altri servizi utilizzando riferimenti dinamici.