aws:createStack - Erstellen Sie einen AWS CloudFormation-Stack - AWS Systems Manager

aws:createStack - Erstellen Sie einen AWS CloudFormation-Stack

Erstellt einen AWS CloudFormation-Stack aus einer Vorlage.

Weitere Informationen zum Erstellen von CloudFormation-Stacks finden Sie unter CreateStack in der AWS CloudFormation API Reference.

Eingabe

YAML
name: makeStack action: aws:createStack maxAttempts: 1 onFailure: Abort inputs: Capabilities: - CAPABILITY_IAM StackName: myStack TemplateURL: http://s3.amazonaws.com/amzn-s3-demo-bucket/myStackTemplate TimeoutInMinutes: 5 Parameters: - ParameterKey: LambdaRoleArn ParameterValue: "{{LambdaAssumeRole}}" - ParameterKey: createdResource ParameterValue: createdResource-{{automation:EXECUTION_ID}}
JSON
{ "name": "makeStack", "action": "aws:createStack", "maxAttempts": 1, "onFailure": "Abort", "inputs": { "Capabilities": [ "CAPABILITY_IAM" ], "StackName": "myStack", "TemplateURL": "http://s3.amazonaws.com/amzn-s3-demo-bucket/myStackTemplate", "TimeoutInMinutes": 5, "Parameters": [ { "ParameterKey": "LambdaRoleArn", "ParameterValue": "{{LambdaAssumeRole}}" }, { "ParameterKey": "createdResource", "ParameterValue": "createdResource-{{automation:EXECUTION_ID}}" } } }
Funktionen

Eine Liste der Werte, die Sie angeben, bevor CloudFormation bestimmte Stacks erstellen kann. Einige Stack-Vorlagen beinhalten Ressourcen, die sich auf die Berechtigungen in Ihrem AWS-Konto auswirken können. Für einige Stacks müssen Sie deren Fähigkeiten mithilfe dieses Parameters explizit bestätigen.

Gültige Werte sind: CAPABILITY_IAM, CAPABILITY_NAMED_IAM und CAPABILITY_AUTO_EXPAND.

CAPABILITY_IAM und CAPABILITY_NAMED_IAM

Wenn Sie &IAM;-Ressourcen besitzen, können Sie jede Fähigkeit angeben. Wenn Sie IAM-Ressourcen mit benutzerdefinierten Namen besitzen, müssen Sie CAPABILITY_NAMED_IAM angeben. Wenn Sie diesen Parameter angeben, gibt die Aktivität einen InsufficientCapabilities-Fehler zurück. Für die folgenden Ressourcen müssen Sie entweder CAPABILITY_IAM oder CAPABILITY_NAMED_IAM angeben.

Wenn Ihre Stack-Vorlage diese Ressourcen enthält, empfehlen wir, dass Sie alle ihnen zugeordneten Berechtigungen überprüfen und ihre Berechtigungen bei Bedarf bearbeiten.

Weitere Informationen finden Sie unter Bestätigen von IAM-Ressourcen in AWS CloudFormation-Vorlagen.

CAPABILITY_AUTO_EXPAND

Einige Vorlagen enthalten Makros. Makros führen eine benutzerdefinierte Verarbeitung für Vorlagen durch. Diese können einfache Aktionen wie Suchen und Ersetzen bis hin zu umfangreichen Transformationen ganzer Vorlagen umfassen. Aus diesem Grund erstellt der Benutzer normalerweise einen Änderungssatz aus der verarbeiteten Vorlage, sodass er die aus den Makros resultierenden Änderungen überprüfen kann, bevor er den Stack tatsächlich erstellt. Wenn Ihre Stack-Vorlage ein oder mehrere Makros enthält und Sie sich dafür entscheiden, einen Stack direkt aus der verarbeiteten Vorlage zu erstellen, ohne vorher die resultierenden Änderungen in einem Änderungssatz zu überprüfen, müssen Sie diese Funktion berücksichtigen.

Weitere Informationen finden Sie unter AWS CloudFormation-Makros zur Durchführung benutzerdefinierter Verarbeitung von Vorlagen verwenden im AWS CloudFormation-Benutzerhandbuch.

Typ: Zeichenfolge-Array

Zulässige Werte: CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_AUTO_EXPAND

Erforderlich: Nein

ClientRequestToken

Eine eindeutige Kennung für diese CreateStack-Anforderung. Geben Sie dieses Token an, wenn Sie maxAttempts in diesem Schritt auf einen Wert größer als 1 festlegen. Durch Angabe dieses Tokens weiß CloudFormation, dass Sie nicht versuchen, einen neuen Stack mit demselben Namen zu erstellen.

Typ: Zeichenfolge

Erforderlich: Nein

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 128 Zeichen.

Muster: [a-zA-Z0-9][-a-zA-Z0-9]*

DisableRollback

Legen Sie den Parameter auf true fest, um ein Rollback des Stacks zu deaktivieren, wenn ein Fehler bei der Erstellung des Stacks aufgetreten ist.

Bedingt: Sie können entweder den DisableRollback-Parameter oder den OnFailure-Parameter festlegen, aber nicht beide.

Standard: false

Typ: Boolesch

Erforderlich: Nein

NotificationARNs

Die Amazon Simple Notification Service (Amazon SNS)-Thema-ARNs zum Veröffentlichen von Stack-bezogenen Ereignissen. Sie finden SNS-Thema-ARNs mithilfe der Amazon SNS Konsole, https://console.aws.amazon.com/sns/v3/home.

Typ: Zeichenfolge-Array

Array-Mitglieder: Maximale Anzahl von 5 Elementen.

Erforderlich: Nein

OnFailure

Bestimmt die Aktion, die ergriffen werden muss, wenn ein Fehler am Stack auftritt. Sie müssen DO_NOTHING, ROLLBACK oder DELETE angeben.

Bedingt: Sie können entweder den OnFailure-Parameter oder den DisableRollback-Parameter festlegen, aber nicht beide.

Standard: ROLLBACK

Typ: Zeichenfolge

Zulässige Werte: DO_NOTHING | ROLLBACK | DELETE

Erforderlich: Nein

Parameter

Eine Liste der Parameter-Strukturen, die Eingabeparameter für den Stack angeben. Weitere Informationen finden Sie im Datentyp Parameter.

Typ: Array von Parameter-Objekten

Erforderlich: Nein

ResourceTypes

Die Vorlagenressourcentypen für diese Aktion zum Erstellen von Stacks, für die Sie über Berechtigungen verfügen. Beispiel: AWS::EC2::Instance, AWS::EC2::* oder Custom::MyCustomInstance. Verwenden Sie die folgende Syntax zum Beschreiben von Vorlagenressourcentypen.

  • Für alle AWS-Ressourcen:

    AWS::*
  • Für alle benutzerdefinierten Ressourcen:

    Custom::*
  • Für eine bestimmte benutzerdefinierte Ressource:

    Custom::logical_ID
  • Für alle Ressourcen eines bestimmten AWS-Service:

    AWS::service_name::*
  • Für eine bestimmte AWS-Ressource:

    AWS::service_name::resource_logical_ID

Wenn die Liste der Ressourcentypen keine Ressource enthält, die Sie erstellen, schlägt die Erstellung des Stacks fehl. Standardmäßig erteilt CloudFormation Berechtigungen für alle Ressourcentypen. IAM verwendet diesen Parameter für CloudFormation-spezifische Bedingungsschlüssel in IAM-Richtlinien. Weitere Informationen finden Sie unter Zugriffskontrolle mit AWS Identity and Access Management.

Typ: Zeichenfolge-Array

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 256 Zeichen.

Erforderlich: Nein

RoleARN

Der Amazon-Ressourcenname (ARN) für eine IAM-Rolle, die CloudFormation zum Erstellen des Stacks annimmt. CloudFormation verwendet die Anmeldeinformationen der Rolle, um Anrufe in Ihrem Auftrag zu tätigen. CloudFormation verwendet diese Rolle stets für alle künftigen Vorgänge am Stack. Wenn Benutzer die Berechtigung für Vorgänge am Stack besitzen, verwendet CloudFormation diese Rolle auch dann, wenn die Benutzer nicht über die Berechtigung zur Weitergabe verfügen. Stellen Sie sicher, dass die Rolle die geringstmögliche Menge an Berechtigungen gewährt.

Wenn Sie keinen Wert angeben, verwendet CloudFormation die Rolle, die dem Stack vorher zugeordnet war. Wenn keine Rolle verfügbar ist, verwendet CloudFormation eine temporäre Sitzung, die anhand Ihrer Benutzeranmeldeinformationen generiert wurde.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 20. Maximale Länge beträgt 2048 Zeichen.

Erforderlich: Nein

StackName

Der dem Stack zugeordnete Name. Der Name muss in der Region eindeutig sein, in der Sie den Stack erstellen.

Anmerkung

Ein Stack-Name darf nur alphanumerische Zeichen (wobei die Groß- und Kleinschreibung beachtet werden muss) und Bindestriche enthalten. Er muss mit einem alphabetischen Zeichen beginnen und darf nicht mehr als 128 Zeichen umfassen.

Typ: Zeichenfolge

Erforderlich: Ja

StackPolicyBody

Struktur, die die Stack-Richtlinie enthält. Weitere Informationen finden Sie unter Verhindern von Aktualisierungen der Stack-Ressourcen.

Bedingt: Sie können entweder den StackPolicyBody-Parameter oder den StackPolicyURL-Parameter festlegen, aber nicht beide.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 16384 Zeichen.

Erforderlich: Nein

StackPolicyURL

Speicherort einer Datei, die die Stack-Richtlinie enthält. Die URL muss auf eine Richtlinie in einem S3-Bucket in derselben Region wie der Stack verweisen. Die maximal zulässige Dateigröße für die Stack-Richtlinie ist 16 KB.

Bedingt: Sie können entweder den StackPolicyBody-Parameter oder den StackPolicyURL-Parameter festlegen, aber nicht beide.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 1350 Zeichen.

Erforderlich: Nein

Tags

Schlüssel-Wert-Paare, die diesem Stack zugeordnet werden sollen. CloudFormation verteilt diese Tags auch an die im Stack erstellten Ressourcen. Sie können höchstens 10 Tags angeben.

Typ: Array von Tag-Objekten

Erforderlich: Nein

TemplateBody

Struktur, die den Vorlagetext mit einer Mindestlänge von 1 Byte und einer Höchstlänge von 51.200 Byte enthält. Weitere Informationen finden Sie unter Aufbau einer Vorlage.

Bedingt: Sie können entweder den TemplateBody-Parameter oder den TemplateURL-Parameter festlegen, aber nicht beide.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen.

Erforderlich: Nein

TemplateURL

Speicherort einer Datei, die den Vorlagentext enthält. Die URL muss auf eine Vorlage verweisen, die sich in einem S3-Bucket befindet. Die maximal zulässige Größe für die Vorlage ist 460.800 Byte. Weitere Informationen finden Sie unter Aufbau einer Vorlage.

Bedingt: Sie können entweder den TemplateBody-Parameter oder den TemplateURL-Parameter festlegen, aber nicht beide.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 1024 Zeichen.

Erforderlich: Nein

TimeoutInMinutes

Die Zeit, die verstreichen kann, bevor der Stack-Status zu CREATE_FAILED wird. Falls DisableRollback nicht festgelegt ist oder auf false festgelegt ist, wird für den Stack ein Rollback ausgeführt.

Typ: Ganzzahl

Gültiger Bereich: Mindestwert 1.

Erforderlich: Nein

Outputs

StackId

Eindeutiger Bezeichner des Stacks.

Typ: Zeichenfolge

StackStatus

Aktueller Status des Stacks.

Typ: Zeichenfolge

Zulässige Werte: CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | ROLLBACK_IN_PROGRESS | ROLLBACK_FAILED | ROLLBACK_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE_CLEANUP_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_ROLLBACK_IN_PROGRESS | UPDATE_ROLLBACK_FAILED | UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS | UPDATE_ROLLBACK_COMPLETE | REVIEW_IN_PROGRESS

Erforderlich: Ja

StackStatusReason

Erfolgs- oder Fehlermeldung im Zusammenhang mit dem Stack-Status.

Typ: Zeichenfolge

Erforderlich: Nein

Weitere Informationen finden Sie unter CreateStack.

Sicherheitsüberlegungen

Bevor Sie die Aktion aws:createStack verwenden können, müssen Sie folgende Richtlinie der IAM-Automation-Assume-Role zuweisen. Weitere Informationen über die Übernahmerolle finden Sie unter Aufgabe 1: Erstellen einer Servicerolle für Automation.

{ "Version":"2012-10-17", "Statement":[ { "Effect":"Allow", "Action":[ "sqs:*", "cloudformation:CreateStack", "cloudformation:DescribeStacks" ], "Resource":"*" } ] }