View a markdown version of this page

AWS::Serverless::StateMachine - AWS Serverless Application Model

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.

AWS::Serverless::StateMachine

Erzeugt eine AWS Step Functions Zustandsmaschine, die Sie zur Orchestrierung verwenden können AWS Lambda Event-Funktionen und andere AWS Ressourcen zur Gestaltung komplexer und robuster Arbeitsabläufe.

Weitere Informationen zu Step Functions finden Sie im AWS Step Functions Developer Guide.

Diese Ressource unterstützt auch Connectors Ressource Attribute. Weitere Informationen finden Sie unter Verwaltung von Ressourcenberechtigungen mit AWS SAM Steckverbinder.

Anmerkung

Wenn Sie bereitstellen AWS CloudFormation, AWS SAM transformiert deine AWS SAM Ressourcen in CloudFormation Ressourcen. Weitere Informationen finden Sie unter Generiert CloudFormation Ressourcen für AWS SAM.

Syntax

Um diese Entität in Ihrem zu deklarieren AWS Serverless Application Model (AWS SAM) Vorlage, verwenden Sie die folgende Syntax.

YAML

Type: AWS::Serverless::StateMachine Properties: AutoPublishAlias: String UseAliasAsEventTarget: Boolean Definition: Map DefinitionSubstitutions: Map DefinitionUri: String | S3Location DeploymentPreference: DeploymentPreference Events: EventSource Logging: LoggingConfiguration Name: String PermissionsBoundary: String Policies: String | List | Map PropagateTags: Boolean RolePath: String Role: String Tags: Map Tracing: TracingConfiguration Type: String

Eigenschaften

AutoPublishAlias

Der Name des State-Machine-Alias. Weitere Informationen zur Verwendung von Step Functions-State-Machine-Aliasen finden Sie unter Verwalten Sie kontinuierliche Bereitstellungen mit Versionen und Aliasen in der AWS Step Functions Leitfaden für Entwickler.

Benutzen DeploymentPreference um die Bereitstellungseinstellungen für Ihren Alias zu konfigurieren. Wenn Sie nicht angeben DeploymentPreference, AWS SAM konfiguriert den Verkehr so, dass er auf einmal auf die neuere State-Machine-Version umgestellt wird.

AWS SAM legt die Version fest DeletionPolicy und UpdateReplacePolicy zu Retain standardmäßig. Frühere Versionen werden nicht automatisch gelöscht.

Typ: Zeichenfolge

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben Name Eigentum eines AWS::StepFunctions::StateMachineAlias Ressource.

UseAliasAsEventTarget

Geben Sie an, ob der Alias weitergegeben werden soll, der mit dem AutoPublishAlias Eigenschaft, für das Ziel der Ereignisquelle, definiert mit Ereignisse.

Spezifizieren True um den Alias als Ziel der Ereignisse zu verwenden.

Typ: Boolesch

Required: No

Standardwert: False

CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat keine CloudFormation gleichwertig.

Definition

Die State-Machine-Definition ist ein Objekt, wobei das Format des Objekts dem Format Ihres entspricht AWS SAM Vorlagendatei, zum Beispiel JSON oder YAML. State Machine-Definitionen halten sich an die Amazon States Language.

Ein Beispiel für eine Inline-State-Machine-Definition finden Sie unter Beispiele.

Sie müssen entweder eine angeben Definition oder ein DefinitionUri.

Typ: Landkarte

Required: Conditional

CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat keine CloudFormation gleichwertig.

DefinitionSubstitutions

Eine String-zu-String-Zuordnung, die die Zuordnungen für Platzhaltervariablen in der Zustandsmaschinen-Definition spezifiziert. Auf diese Weise können Sie Werte, die Sie zur Laufzeit erhalten haben (z. B. aus systeminternen Funktionen), in die State-Machine-Definition einfügen.

Geben Sie ein: Landkarte

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft ähnelt der DefinitionSubstitutions Eigentum eines AWS::StepFunctions::StateMachine Ressource. Wenn irgendwelche intrinsischen Funktionen in einer Inline-State-Machine-Definition spezifiziert sind, AWS SAM fügt dieser Eigenschaft Einträge hinzu, um sie in die State-Machine-Definition einzufügen.

DefinitionUri

Die Amazon Simple Storage Service (Amazon S3) -URI oder der lokale Dateipfad der Zustandsmaschinen-Definition, geschrieben in Sprache der Bundesstaaten von Amazon.

Wenn Sie einen lokalen Dateipfad angeben, muss die Vorlage den Workflow durchlaufen, der sam deploy oder sam package Befehl, um die Definition korrekt zu transformieren. Dazu müssen Sie Version 0.52.0 oder höher des verwenden AWS SAM CLI.

Sie müssen entweder eine angeben Definition oder ein DefinitionUri.

Typ: Zeichenfolge | S3 Standort

Required: Conditional

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben DefinitionS3Location Eigentum eines AWS::StepFunctions::StateMachine Ressource.

DeploymentPreference

Die Einstellungen, die schrittweise Zustandsmaschinen-Bereitstellungen ermöglichen und konfigurieren. Weitere Informationen zur schrittweisen Bereitstellung von Step Functions finden Sie unter Verwalten Sie kontinuierliche Bereitstellungen mit Versionen und Aliasen in der AWS Step Functions Leitfaden für Entwickler.

Spezifizieren AutoPublishAlias bevor Sie diese Eigenschaft konfigurieren. Ihr DeploymentPreference Die Einstellungen werden auf den mit angegebenen Alias angewendet AutoPublishAlias.

Wenn Sie angeben DeploymentPreference, AWS SAM generiert die StateMachineVersionArn Untereigenschaftswert automatisch.

Typ: DeploymentPreference

Required: No

CloudFormation Kompatibilität: AWS SAM generiert und hängt die an StateMachineVersionArn Eigenschaftswert von DeploymentPreference und Pässe DeploymentPreference zum DeploymentPreference Eigentum eines AWS::StepFunctions::StateMachineAlias Ressource.

Events

Gibt die Ereignisse an, die diese Zustandsmaschine auslösen. Ereignisse bestehen aus einem Typ und einer Reihe von Eigenschaften, die vom Typ abhängen.

Typ: EventSource

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat keine CloudFormation gleichwertig.

Logging

Definiert, welche Ereignisse im Ausführungsverlauf protokolliert werden und wo sie protokolliert werden.

Typ: LoggingConfiguration

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben LoggingConfiguration Eigentum eines AWS::StepFunctions::StateMachine Ressource.

Name

Der Name des Zustandsautomaten.

Typ: Zeichenfolge

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben StateMachineName Eigentum eines AWS::StepFunctions::StateMachine Ressource.

PermissionsBoundary

Der ARN einer Berechtigungsgrenze, die für die Ausführungsrolle dieser Zustandsmaschine verwendet werden soll. Diese Eigenschaft funktioniert nur, wenn die Rolle für Sie generiert wurde.

Typ: Zeichenfolge

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben PermissionsBoundary Eigentum eines AWS::IAM::Role Ressource.

Policies

Genehmigungsrichtlinien für diese Zustandsmaschine. Die Richtlinien werden an die Standardwerte der Zustandsmaschine angehängt AWS Identity and Access Management (IAM) -Ausführungsrolle.

Diese Eigenschaft akzeptiert einen einzelnen Wert oder eine Liste von Werten. Gültige Werte sind:

Anmerkung

Wenn du das einstellst Role Eigenschaft, diese Eigenschaft wird ignoriert.

Typ: Zeichenfolge | Liste | Karte

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat keine CloudFormation gleichwertig.

PropagateTags

Geben Sie an, ob Tags aus dem übergeben werden sollen Tags Eigentum zu Ihrem AWS::Serverless::StateMachine generierte Ressourcen. Spezifizieren True um Tags in Ihren generierten Ressourcen zu verbreiten.

Typ: Boolesch

Required: No

Standardwert: False

CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat keine CloudFormation gleichwertig.

Role

Der ARN einer IAM-Rolle, die als Ausführungsrolle dieser Zustandsmaschine verwendet werden soll.

Typ: Zeichenfolge

Required: Conditional

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben RoleArn Eigentum eines AWS::StepFunctions::StateMachine Ressource.

RolePath

Der Pfad zur IAM-Ausführungsrolle der Zustandsmaschine.

Verwenden Sie diese Eigenschaft, wenn die Rolle für Sie generiert wird. Verwenden Sie sie nicht, wenn die Rolle mit dem angegeben ist Role Eigentum.

Typ: Zeichenfolge

Required: Conditional

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben Path Eigentum eines AWS::IAM::Role Ressource.

Tags

Eine Zuordnung von Zeichenfolge zu Zeichenfolge, die die der Zustandsmaschine hinzugefügten Tags und die entsprechende Ausführungsrolle angibt. Informationen zu gültigen Schlüsseln und Werten für Tags finden Sie in der Schlagworte Eigentum eines AWS::StepFunctions::StateMachine Ressource.

Typ: Landkarte

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft ähnelt der Tags Eigentum eines AWS::StepFunctions::StateMachine Ressource. AWS SAM fügt automatisch eine hinzu stateMachine:createdBy:SAM Tag für diese Ressource und für die Standardrolle, die für sie generiert wird.

Tracing

Wählt aus, ob AWS X-Ray ist für die Zustandsmaschine aktiviert. Für weitere Informationen zur Verwendung X-Ray mit Step-Funktionen finden Sie unter AWS X-Ray und Schrittfunktionen in der AWS Step Functions Leitfaden für Entwickler.

Typ: TracingConfiguration

Required: No

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben TracingConfiguration Eigentum eines AWS::StepFunctions::StateMachine Ressource.

Type

Der Typ der Zustandsmaschine.

Zulässige Werte: STANDARD oder EXPRESS.

Typ: Zeichenfolge

Required: No

Standardwert: STANDARD

CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an den übergeben StateMachineType Eigentum eines AWS::StepFunctions::StateMachine Ressource.

Rückgabewerte

Punkt

Wenn Sie die logische ID dieser Ressource für die intrinsische Funktion Ref angeben, gibt Ref den Amazon-Ressourcennamen (ARN) der zugrunde liegenden Ressource zurück AWS::StepFunctions::StateMachine Ressource.

Für weitere Informationen zur Verwendung der Ref Funktion, siehe Ref in der AWS CloudFormation Benutzerleitfaden.

Fn::GetAtt

Fn::GetAtt gibt einen Wert für ein angegebenes Attribut dieses Typs zurück. Im Folgenden sehen Sie die verfügbaren Attribute und Beispielrückgabewerte.

Für weitere Informationen zur Verwendung Fn::GetAtt, siehe Fn::GetAtt in der AWS CloudFormation Benutzerleitfaden.

Name

Gibt den Namen der Zustandsmaschine zurück, z. B. HelloWorld-StateMachine.

Beispiele

State-Machine-Definitionsdatei

Das Folgende ist ein Beispiel für eine Inline-State-Machine-Definition, die es einer Lambda-Funktion ermöglicht, eine Zustandsmaschine aufzurufen. Beachten Sie, dass in diesem Beispiel Folgendes erwartet wird Role Eigenschaft, um die richtige Richtlinie zu konfigurieren, um den Aufruf zu ermöglichen. Die my_state_machine.asl.json Die Datei muss in das geschrieben werden Sprache der Bundesstaaten Amazon.

In diesem Beispiel ist der DefinitionSubstitution Einträge ermöglichen es der Zustandsmaschine, Ressourcen einzubeziehen, die in der AWS SAM Vorlagendatei.

YAML

MySampleStateMachine: Type: AWS::Serverless::StateMachine Properties: DefinitionUri: statemachine/my_state_machine.asl.json Role: arn:aws:iam::123456123456:role/service-role/my-sample-role Tracing: Enabled: true DefinitionSubstitutions: MyFunctionArn: !GetAtt MyFunction.Arn MyDDBTable: !Ref TransactionTable

Inline-State-Machine-Definition

Das Folgende ist ein Beispiel für eine Inline-State-Machine-Definition.

In diesem Beispiel ist der AWS SAM Die Vorlagendatei ist in YAML geschrieben, sodass die Definition der Zustandsmaschine ebenfalls in YAML enthalten ist. Um eine Inline-State-Machine-Definition in JSON zu deklarieren, schreiben Sie Ihren AWS SAM Vorlagendatei in JSON.

YAML

MySampleStateMachine: Type: AWS::Serverless::StateMachine Properties: Definition: StartAt: MyLambdaState States: MyLambdaState: Type: Task Resource: arn:aws:lambda:us-east-1:123456123456:function:my-sample-lambda-app End: true Role: arn:aws:iam::123456123456:role/service-role/my-sample-role Tracing: Enabled: true