Spezifizieren Sie vorhandene Ressourcen zur Laufzeit mit von CloudFormation bereitgestellten Parametertypen

Bei der Erstellung Ihrer Vorlage können Sie Parameter erstellen, die die Eingabe von Identifikatoren bestehender AWS-Ressourcen oder Systems Manager-Parameter erfordern, indem Sie spezielle, von CloudFormation bereitgestellte Parametertypen verwenden.

Übersicht

In CloudFormation können Sie Ihre Stacks mit Hilfe von Parametern anpassen, indem Sie bei der Stack-Erstellung oder Aktualisierung Eingabewerte angeben. Dieses Feature macht Ihre Vorlagen wiederverwendbar und flexibel für verschiedene Szenarien.

Die Parameter werden im Abschnitt Parameters einer CloudFormation-Vorlage definiert. Jeder Parameter hat einen Namen und einen Typ und kann zusätzliche Einstellungen wie einen Standardwert und zulässige Werte haben. Weitere Informationen finden Sie unter CloudFormation Vorlage Parameters-Syntax.

Der Parametertyp bestimmt die Art des Eingabewerts, den der Parameter akzeptieren kann. Zum Beispiel akzeptiert Number nur numerische Werte, während String auch Texteingaben akzeptiert.

CloudFormation bietet mehrere zusätzliche Parametertypen, die Sie in Ihren Vorlagen verwenden können, um auf bestehende AWS-Ressourcen und Systems Manager-Parameter zu verweisen.

Diese Parametertypen fallen in zwei Kategorien:

Sobald Ihre Parameter im Abschnitt Parameters definiert sind, können Sie mit der Funktion Ref in Ihrer gesamten CloudFormation-Vorlage auf Parameterwerte verweisen.

Beispiel

Das folgende Beispiel zeigt eine Vorlage, die die folgenden Parametertypen verwendet.

Um einen Stack aus dieser Vorlage zu erstellen, müssen Sie eine vorhandene VPC-ID, Subnetz-ID und einen Schlüsselpaar-Namen aus Ihrem Konto angeben. Sie können auch einen vorhandenen Parameterspeicherschlüssel angeben, der auf die gewünschte AMI-ID verweist, oder den Standardwert /aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2beibehalten. Dieser öffentliche Parameter ist ein Alias für die regionale AMI-ID für das neueste Amazon Linux 2 AMI. Weitere Informationen über öffentliche Parameter finden Sie unter Entdecken öffentlicher Parameter im Parameterspeicher im AWS Systems Manager Benutzerhandbuch.

{
    "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-Befehl, um den Stapel zu erstellen

Der folgende Befehl create-stack erstellt einen Stapel auf der Grundlage der Beispielvorlage.

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"

Um einen Parametertyp zu verwenden, der eine Liste von Zeichenketten akzeptiert, wie beispielsweise List<AWS::EC2::Subnet::Id>, müssen Sie die Kommas innerhalb von ParameterValue mit einem doppelten Backslash entwerten, wie im folgenden Beispiel gezeigt.

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

Überlegungen

Es wird dringend empfohlen, dynamische Verweise zu verwenden, um den Zugriff auf sensible Konfigurationsdefinitionen, wie beispielsweise Zugangsdaten von Drittanbietern, zu beschränken. Weitere Informationen finden Sie unter Abrufen von in anderen Diensten gespeicherten Werten mit Hilfe von dynamischen Referenzen.

Wenn Sie den Benutzern von Vorlagen erlauben möchten, Werte aus verschiedenen AWS-Kontenanzugeben, verwenden Sie keine-AWSspezifischen Parametertypen. Definieren Sie stattdessen Parameter vom Typ String oder CommaDelimitedList.

Bei den Parametertypen von Systems Manager gibt es einige Dinge zu beachten:

Unterstützte AWS-spezifische Parametertypen

CloudFormation unterstützt die folgenden-AWSspezifischen Typen:

Unterstützte Systems Manager Parametertypen

CloudFormation unterstützt die folgenden Systems Manager-Parametertypen:

Nicht unterstützte Systems Manager Parametertypen

CloudFormation unterstützt den folgenden Systems Manager-Parametertyp nicht:

Darüber hinaus unterstützt CloudFormation nicht die Definition von Vorlagenparametern als SecureString Systems Manager-Parametertypen. Sie können jedoch sichere Zeichenketten als Parameter Werte für bestimmte Ressourcen angeben. Weitere Informationen finden Sie unter Abrufen von in anderen Diensten gespeicherten Werten mit Hilfe von dynamischen Referenzen.