Ruft einen Klartext-Wert aus dem Systems Manager Parameter Store ab - AWS CloudFormation
BerechtigungenReferenzmusterBeispiel

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Ruft einen Klartext-Wert aus dem Systems Manager Parameter Store ab

Wenn Sie eine CloudFormation Vorlage erstellen, möchten Sie möglicherweise Klartextwerte verwenden, die im Parameter Store gespeichert sind. Parameter Store ist eine Funktion von. AWS Systems Manager Eine Einführung in den Parameterspeicher finden Sie unter AWS Systems Manager Parameter Store im AWS Systems Manager Benutzerhandbuch.

Um einen Klartextwert aus dem Parameter Store in Ihrer Vorlage zu verwenden, verwenden Sie eine ssm dynamische Referenz. Mit dieser Referenz können Sie auf Werte aus Parametern des Typs String oder StringList im Parameter Store zugreifen.

Um zu überprüfen, welche Version einer ssm dynamischen Referenz in einem Stack-Vorgang verwendet wird, erstellen Sie einen Änderungssatz für den Stack-Vorgang. Überprüfen Sie dann die verarbeitete Vorlage auf der Registerkarte Vorlage. Weitere Informationen erhalten Sie unter Einen Änderungssatz erstellen und Einen Änderungssatz anzeigen.

Bei der Verwendung ssm dynamischer Verweise sind einige wichtige Dinge zu beachten:

  • CloudFormation unterstützt keine Drifterkennung bei dynamischen Referenzen. Für ssm dynamische Verweise, bei denen Sie die Parameterversion nicht angegeben haben, empfehlen wir, dass Sie, wenn Sie die Parameterversion in Systems Manager aktualisieren, auch einen Stack-Aktualisierungsvorgang für alle Stacks durchführen, die die ssm dynamische Referenz enthalten, um die neueste Parameterversion abzurufen.

  • Um eine ssm dynamische Referenz im Parameters Abschnitt Ihrer CloudFormation Vorlage zu verwenden, müssen Sie eine Versionsnummer angeben. CloudFormation erlaubt es Ihnen nicht, auf einen Parameter Store-Wert ohne Versionsnummer in diesem Abschnitt zu verweisen. Alternativ können Sie Ihren Parameter in Ihrer Vorlage als Systems Manager Manager-Parametertyp definieren. Wenn Sie dies tun, können Sie einen Systems Manager Manager-Parameterschlüssel als Standardwert für Ihren Parameter angeben. CloudFormation ruft dann die neueste Version des Parameterwerts aus dem Parameter Store ab, ohne dass Sie eine Versionsnummer angeben müssen. Dadurch können Ihre Vorlagen einfacher und pflegeleichter werden. Weitere Informationen finden Sie unter Verweisen Sie mit von CloudFormation -bereitgestellten Parametertypen auf vorhandene Ressourcen und Systems Manager Manager-Parameter.

  • CloudFormation Löst bei benutzerdefinierten Ressourcen die ssm dynamischen Verweise auf, bevor die Anfrage an die benutzerdefinierte Ressource gesendet wird.

  • CloudFormation unterstützt nicht die Verwendung dynamischer Verweise zum Verweisen auf einen Parameter, der von einem anderen AWS-Konto gemeinsam genutzt wird.

  • CloudFormation unterstützt die Verwendung von Systems Manager Manager-Parameterbeschriftungen in dynamischen Verweisen nicht.

Berechtigungen

Um einen Parameter anzugeben, der im Systems Manager Parameter Store gespeichert ist, benötigen Sie die Berechtigung zum Aufrufen GetParametersfür den angegebenen Parameter. Informationen zum Erstellen von IAM Richtlinien, die den Zugriff auf bestimmte Systems Manager Manager-Parameter ermöglichen, finden Sie unter Beschränken des Zugriffs auf Systems Manager Manager-Parameter mithilfe von IAM Richtlinien im AWS Systems Manager Benutzerhandbuch.

Referenzmuster

Verwenden Sie das folgende Referenzmuster, um auf einen Klartextwert zu ssm verweisen, der in Ihrer CloudFormation Vorlage im Systems Manager Parameter Store gespeichert ist.

{{resolve:ssm:parameter-name:version}}

Ihre Referenz muss sich an das folgende reguläre Ausdrucksmuster für Parametername und Version halten:

{{resolve:ssm:[a-zA-Z0-9_.\-/]+(:\d+)?}}
parameter-name

Der Name des Parameters im Parameter Store. Der Parametername unterscheidet Groß- und Kleinschreibung.

Erforderlich

version

Eine ganze Zahl, die die Version des zu verwendenden Parameters angibt. Wenn Sie nicht die genaue Version angeben, CloudFormation verwendet immer die neueste Version des Parameters, wenn Sie den Stack erstellen oder aktualisieren. Weitere Informationen finden Sie im AWS Systems Manager Benutzerhandbuch unter Arbeiten mit Parameterversionen.

Optional.

Beispiel

Im folgenden Beispiel wird eine EC2 Startvorlage erstellt, die auf eine im Parameterspeicher gespeicherte benutzerdefinierte AMI ID verweist. Die dynamische Referenz ruft die AMI ID aus der Version ab 2 des golden-ami Parameters jedes Mal, wenn eine Instance von der Startvorlage aus gestartet wird.

JSON

{
    "Resources": {
        "MyLaunchTemplate": {
            "Type": "AWS::EC2::LaunchTemplate",
            "Properties": {
                "LaunchTemplateName": {
                    "Fn::Sub": "${AWS::StackName}-launch-template"
                },
                "LaunchTemplateData": {
                    "ImageId": "{{resolve:ssm:golden-ami:2}}",
                    "InstanceType": "t2.micro"
                }
            }
        }
    }
}

YAML

Resources:
  MyLaunchTemplate:
    Type: AWS::EC2::LaunchTemplate
    Properties: 
      LaunchTemplateName: !Sub ${AWS::StackName}-launch-template
      LaunchTemplateData:
        ImageId: '{{resolve:ssm:golden-ami:2}}'
        InstanceType: t2.micro