CloudFormation ConditionsVorlagensyntax - AWS CloudFormation

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.

CloudFormation ConditionsVorlagensyntax

Der optionale Abschnitt Conditions enthält Anweisungen, die die Bedingungen definieren, unter denen Entitäten erstellt oder konfiguriert werden. Sie können beispielsweise eine Bedingung erstellen und sie einer Ressource oder Ausgabe zuordnen, sodass die Ressource oder Ausgabe nur CloudFormation erstellt wird, wenn die Bedingung erfüllt ist. Ebenso können Sie einer Eigenschaft eine Bedingung zuordnen, sodass die CloudFormation Eigenschaft nur dann auf einen bestimmten Wert gesetzt wird, wenn die Bedingung erfüllt ist. Wenn die Bedingung falsch ist, wird die CloudFormation Eigenschaft auf einen alternativen Wert gesetzt, den Sie angeben.

Sie können Bedingungen verwenden, wenn Sie eine Vorlage wiederverwenden möchten, um Ressourcen in unterschiedlichen Kontexten zu erstellen, z. B. in Test- und Produktionsumgebungen. Sie können Ihrer Vorlage beispielsweise einen EnvironmentType Eingabeparameter hinzufügen, der entweder prod oder test als Eingaben akzeptiert. Für die prod Umgebung könnten Sie EC2 Instanzen mit bestimmten Funktionen einbeziehen, während Sie für die test Umgebung möglicherweise reduzierte Funktionen verwenden, um Geld zu sparen. Mit dieser Bedingungsdefinition können Sie für jeden Umgebungstyp definieren, welche Ressourcen erstellt und wie sie konfiguriert werden.

Syntax

Der Abschnitt Conditions besteht aus dem Schlüsselnamen Conditions. Jede Bedingungsdeklaration umfasst eine logische ID und eine oder mehrere systeminterne Funktionen.

JSON

"Conditions": { "LogicalConditionName1": { "Intrinsic function": ...[ }, "LogicalConditionName2": { "Intrinsic function": ... } }

YAML

Conditions: LogicalConditionName1: Intrinsic function: ... LogicalConditionName2: Intrinsic function: ...

Wie funktionieren Bedingungen

Gehen Sie wie folgt vor, um Bedingungen zu verwenden:

  1. Fügen Sie eine Parameterdefinition hinzu — Definieren Sie im Parameters Abschnitt Ihrer Vorlage die Eingaben, die Ihre Bedingungen auswerten werden. Die Bedingungen werden auf der Grundlage dieser Eingabeparameterwerte als wahr oder falsch bewertet. Beachten Sie, dass Pseudo-Parameter automatisch verfügbar sind und keine ausdrückliche Definition in Parameters diesem Abschnitt erfordern. Weitere Informationen zu Pseudoparametern finden Sie unter AWS Werte mithilfe von Pseudo-Parametern abrufen.

  2. Fügen Sie eine Bedingungsdefinition hinzu — Definieren Sie Bedingungen im Conditions Abschnitt mithilfe systemeigener Funktionen wieFn::If, undFn::Equals. Fn::Not Diese Bedingungen bestimmen, wann die zugehörigen CloudFormation Ressourcen erstellt werden. Die Bedingungen können auf folgenden Faktoren basieren:

    • Eingabe- oder Pseudo-Parameterwerte

    • Andere Bedingungen

    • Werte zuordnen

  3. Zuordnen von Bedingungen zu Ressourcen oder Ausgaben — Referenzieren Sie Bedingungen in Ressourcen oder Ausgaben mithilfe des Condition Schlüssels und der logischen ID einer Bedingung. Verwenden Sie Fn::If optional auch andere Teile der Vorlage (z. B. Eigenschaftswerte), um Werte auf der Grundlage einer Bedingung festzulegen.

CloudFormation wertet Bedingungen aus, wenn ein Stapel erstellt oder aktualisiert wird. CloudFormation erstellt Entitäten, die mit einer wahren Bedingung verknüpft sind, und ignoriert Entitäten, die einer falschen Bedingung zugeordnet sind. CloudFormation bewertet diese Bedingungen außerdem bei jedem Stack-Update neu, bevor Ressourcen geändert werden. Entitäten, die weiterhin mit einer wahren Bedingung verknüpft sind, werden aktualisiert, während Entitäten, denen eine falsche Bedingung zugewiesen wird, gelöscht werden.

Wichtig

Bedingungen können während einer Stack-Aktualisierung nicht allein aktualisiert werden. Sie können Bedingungen nur aktualisieren, wenn Sie Änderungen einschließen, die Ressourcen hinzufügen, ändern oder löschen.

Intrinsische Bedingungsfunktionen

Sie können die folgenden intrinsischen Funktionen verwenden, um Bedingungen zu definieren:

Anmerkung

Fn::If wird nur im Metadatenattribut, Aktualisierungsrichtlinienattribut und Eigenschaftswerte im Bereich Resources und den Bereichen Outputs einer Vorlage unterstützt.

Beispiele

Umgebungsbasierte Erstellung von Ressourcen

In den folgenden Beispielen wird eine EC2 Instanz bereitgestellt und ein neues EBS-Volume nur dann unter bestimmten Bedingungen erstellt und angehängt, wenn der Umgebungstyp prod Wenn es sich um eine Umgebung handelttest, wird die EC2 Instanz einfach ohne das zusätzliche Volume erstellt.

JSON

{ "AWSTemplateFormatVersion": "2010-09-09", "Parameters": { "EnvType": { "Description": "Environment type", "Default": "test", "Type": "String", "AllowedValues": [ "prod", "test" ], "ConstraintDescription": "must specify prod or test" } }, "Conditions": { "CreateProdResources": { "Fn::Equals": [ { "Ref": "EnvType" }, "prod" ] } }, "Resources": { "EC2Instance": { "Type": "AWS::EC2::Instance", "Properties": { "ImageId": "ami-1234567890abcdef0" } }, "MountPoint": { "Type": "AWS::EC2::VolumeAttachment", "Condition": "CreateProdResources", "Properties": { "InstanceId": { "Ref": "EC2Instance" }, "VolumeId": { "Ref": "NewVolume" }, "Device": "/dev/sdh" } }, "NewVolume": { "Type": "AWS::EC2::Volume", "Condition": "CreateProdResources", "Properties": { "Size": 100, "AvailabilityZone": { "Fn::GetAtt": [ "EC2Instance", "AvailabilityZone" ] } } } } }

YAML

AWSTemplateFormatVersion: 2010-09-09 Parameters: EnvType: Description: Environment type Default: test Type: String AllowedValues: - prod - test ConstraintDescription: must specify prod or test Conditions: CreateProdResources: !Equals - !Ref EnvType - prod Resources: EC2Instance: Type: AWS::EC2::Instance Properties: ImageId: ami-1234567890abcdef0 MountPoint: Type: AWS::EC2::VolumeAttachment Condition: CreateProdResources Properties: InstanceId: !Ref EC2Instance VolumeId: !Ref NewVolume Device: /dev/sdh NewVolume: Type: AWS::EC2::Volume Condition: CreateProdResources Properties: Size: 100 AvailabilityZone: !GetAtt - EC2Instance - AvailabilityZone

Bereitstellung von Ressourcen unter mehreren Bedingungen

In den folgenden Beispielen wird unter bestimmten Bedingungen ein S3-Bucket erstellt, wenn ein Bucket-Name angegeben wird, und eine Bucket-Richtlinie wird nur angehängt, wenn die Umgebung auf eingestellt ist. prod Wenn kein Bucket-Name angegeben wird oder die Umgebung bereits angegeben isttest, werden keine Ressourcen erstellt.

JSON

{ "AWSTemplateFormatVersion": "2010-09-09", "Parameters": { "EnvType": { "Type": "String", "AllowedValues": [ "prod", "test" ] }, "BucketName": { "Default": "", "Type": "String" } }, "Conditions": { "IsProduction": { "Fn::Equals": [ { "Ref": "EnvType" }, "prod" ] }, "CreateBucket": { "Fn::Not": [ { "Fn::Equals": [ { "Ref": "BucketName" }, "" ] } ] }, "CreateBucketPolicy": { "Fn::And": [ { "Condition": "IsProduction" }, { "Condition": "CreateBucket" } ] } }, "Resources": { "Bucket": { "Type": "AWS::S3::Bucket", "Condition": "CreateBucket", "Properties": { "BucketName": { "Ref": "BucketName" } } }, "Policy": { "Type": "AWS::S3::BucketPolicy", "Condition": "CreateBucketPolicy", "Properties": { "Bucket": { "Ref": "Bucket" }, "PolicyDocument": { ... } } } } }

YAML

AWSTemplateFormatVersion: 2010-09-09 Parameters: EnvType: Type: String AllowedValues: - prod - test BucketName: Default: '' Type: String Conditions: IsProduction: !Equals - !Ref EnvType - prod CreateBucket: !Not - !Equals - !Ref BucketName - '' CreateBucketPolicy: !And - !Condition IsProduction - !Condition CreateBucket Resources: Bucket: Type: AWS::S3::Bucket Condition: CreateBucket Properties: BucketName: !Ref BucketName Policy: Type: AWS::S3::BucketPolicy Condition: CreateBucketPolicy Properties: Bucket: !Ref Bucket PolicyDocument: ...