Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
AWS::Serverless::StateMachine
Crea un AWS Step Functions macchina a stati, che puoi usare per orchestrare AWS Lambda Funzioni relative agli eventi e altro AWS risorse per creare flussi di lavoro complessi e solidi.
Per ulteriori informazioni su Step Functions, consulta la AWS Step Functions Guida per sviluppatori di .
Questa risorsa supporta anche Connectors risorsa Attribute. Per ulteriori informazioni, consulta Gestione delle autorizzazioni delle risorse con AWS SAM connettori.
Quando esegui il deployment su AWS CloudFormation, AWS SAM trasforma il tuo AWS SAM risorse in CloudFormation risorse. Per ulteriori informazioni, consulta Generato CloudFormation risorse per AWS SAM.
Sintassi
Per dichiarare questa entità nel tuo AWS Serverless Application Model (AWS SAM) modello, utilizzare la seguente sintassi.
YAML
Type: AWS::Serverless::StateMachine Properties: AutoPublishAlias:StringUseAliasAsEventTarget:BooleanDefinition:MapDefinitionSubstitutions:MapDefinitionUri:String | S3LocationDeploymentPreference:DeploymentPreferenceEvents:EventSourceLogging:LoggingConfigurationName:StringPermissionsBoundary:StringPolicies:String | List | MapPropagateTags:BooleanRolePath:StringRole:StringTags:MapTracing:TracingConfigurationType:String
Properties
-
AutoPublishAlias -
Il nome dell'alias della macchina a stati. Per ulteriori informazioni sull'utilizzo degli alias delle macchine a stati Step Functions, vedete Gestisci le distribuzioni continue con versioni e alias nel AWS Step Functions Guida per gli sviluppatori.
Uso
DeploymentPreferenceper configurare le preferenze di distribuzione per il tuo alias. Se non lo specifichiDeploymentPreference, AWS SAM configurerà il traffico per passare contemporaneamente alla versione più recente della macchina a stati.AWS SAM imposta la versione
DeletionPolicyeUpdateReplacePolicyaRetainper impostazione predefinita. Le versioni precedenti non verranno eliminate automaticamente.▬Tipo: stringa
Obbligatorio: no
CloudFormation compatibilità: Questa proprietà viene passata direttamente al
Nameproprietà di unAWS::StepFunctions::StateMachineAliasrisorsa. -
UseAliasAsEventTarget -
Indicare se passare o meno l'alias, creato utilizzando
AutoPublishAliasproprietà, alla destinazione della fonte degli eventi definita con Eventi.Specificare
Trueper utilizzare l'alias come destinazione degli eventi.Tipo: Booleano
Obbligatorio: no
Default:
FalseCloudFormation compatibilità: Questa proprietà è unica per AWS SAM e non ha un CloudFormation equivalente.
-
Definition -
La definizione di macchina a stati è un oggetto, in cui il formato dell'oggetto corrisponde al formato del tuo AWS SAM file modello, ad esempio JSON o YAML. Le definizioni delle macchine a stati aderiscono ad Amazon States Language.
Per un esempio di definizione di macchina a stati in linea, vedi Esempi.
È necessario fornire un
Definitiono unDefinitionUri.Tipo: Mappa
Required: Conditional
CloudFormation compatibilità: Questa proprietà è unica per AWS SAM e non ha un CloudFormation equivalente.
-
DefinitionSubstitutions -
Una mappa da stringa a stringa che specifica le mappature per le variabili segnaposto nella definizione della macchina a stati. Ciò consente di inserire valori ottenuti in fase di esecuzione (ad esempio, da funzioni intrinseche) nella definizione della macchina a stati.
Digitare: Mappa
Obbligatorio: no
CloudFormation compatibilità: Questa proprietà è simile alla
DefinitionSubstitutionsproprietà di unAWS::StepFunctions::StateMachinerisorsa. Se una funzione intrinseca è specificata in una definizione di macchina a stati in linea, AWS SAM aggiunge voci a questa proprietà per inserirle nella definizione della macchina a stati. -
DefinitionUri -
L'URI di Amazon Simple Storage Service (Amazon S3) o il percorso del file locale della definizione della macchina a stati scritta nel Amazon States Language.
Se si fornisce un percorso di file locale, il modello deve passare attraverso il flusso di lavoro che include
sam deployosam packagecomando per trasformare correttamente la definizione. Per fare ciò, è necessario utilizzare la versione 0.52.0 o successiva di AWS SAM CLI.È necessario fornire un
Definitiono unDefinitionUri.Tipo: Stringa | Posizione S3
Required: Conditional
CloudFormation compatibilità: Questa proprietà viene passata direttamente al
DefinitionS3Locationproprietà di unAWS::StepFunctions::StateMachinerisorsa. -
DeploymentPreference -
Le impostazioni che abilitano e configurano le distribuzioni di macchine a stato graduale. Per saperne di più sulle distribuzioni graduali di Step Functions, consulta Gestisci le distribuzioni continue con versioni e alias nel AWS Step Functions Guida per gli sviluppatori.
Specificare
AutoPublishAliasprima di configurare questa proprietà. Il tuoDeploymentPreferencele impostazioni verranno applicate all'alias specificato conAutoPublishAlias.Quando si specifica
DeploymentPreference, AWS SAM genera ilStateMachineVersionArnvalore della sottoproprietà automaticamente.Tipo: DeploymentPreference
Obbligatorio: no
CloudFormation compatibilità: AWS SAM genera e collega il
StateMachineVersionArnvalore della proprietà aDeploymentPreferencee passaDeploymentPreferencealDeploymentPreferenceproprietà di unAWS::StepFunctions::StateMachineAliasrisorsa. -
Events -
Specifica gli eventi che attivano questa macchina a stati. Gli eventi sono costituiti da un tipo e da un insieme di proprietà che dipendono dal tipo.
Tipo: EventSource
Obbligatorio: no
CloudFormation compatibilità: Questa proprietà è unica per AWS SAM e non ha un CloudFormation equivalente.
-
Logging -
Definisce quali eventi della cronologia di esecuzione vengono registrati e dove vengono registrati.
Tipo: LoggingConfiguration
Obbligatorio: no
CloudFormation compatibilità: Questa proprietà viene passata direttamente al
LoggingConfigurationproprietà di unAWS::StepFunctions::StateMachinerisorsa. -
Name -
Il nome della macchina a stati.
▬Tipo: stringa
Obbligatorio: no
CloudFormation compatibilità: Questa proprietà viene passata direttamente al
StateMachineNameproprietà di unAWS::StepFunctions::StateMachinerisorsa. -
PermissionsBoundary -
L'ARN di un limite di autorizzazioni da utilizzare per il ruolo di esecuzione di questa macchina a stati. Questa proprietà funziona solo se il ruolo viene generato automaticamente.
▬Tipo: stringa
Obbligatorio: no
CloudFormation compatibilità: Questa proprietà viene passata direttamente al
PermissionsBoundaryproprietà di unAWS::IAM::Rolerisorsa. -
Policies -
Politiche di autorizzazione per questa macchina a stati. Le politiche verranno aggiunte alle impostazioni predefinite della macchina a stati AWS Identity and Access Management ruolo di esecuzione (IAM).
Questa proprietà accetta un singolo valore o un elenco di valori. I valori autorizzati includono:
-
La ARN di un AWS politica gestita o politica gestita dal cliente.
-
Il nome di un AWS politica gestita tra le seguenti lista
. -
Un politica IAM in linea formattato in YAML come mappa.
NotaSe si imposta il
Roleproprietà, questa proprietà viene ignorata.Tipo: Stringa | Elenco | Mappa
Obbligatorio: no
CloudFormation compatibilità: Questa proprietà è unica per AWS SAM e non ha un CloudFormation equivalente.
-
Indicare se passare o meno i tag dal
Tagsproprietà al tuo AWS::Serverless::StateMachine risorse generate. SpecificareTrueper propagare i tag nelle risorse generate.Tipo: Booleano
Obbligatorio: no
Default:
FalseCloudFormation compatibilità: Questa proprietà è unica per AWS SAM e non ha un CloudFormation equivalente.
-
Role -
L'ARN di un ruolo IAM da utilizzare come ruolo di esecuzione di questa macchina a stati.
Tipo: stringa
Required: Conditional
CloudFormation compatibilità: Questa proprietà viene passata direttamente al
RoleArnproprietà di unAWS::StepFunctions::StateMachinerisorsa. -
RolePath -
Il percorso del ruolo di esecuzione IAM della macchina a stati.
Usa questa proprietà quando il ruolo viene generato per te. Non utilizzare quando il ruolo è specificato con
Roleproprietà.Tipo: stringa
Required: Conditional
CloudFormation compatibilità: Questa proprietà viene passata direttamente al
Pathproprietà di unAWS::IAM::Rolerisorsa. -
Una mappa da stringa a stringa che specifica i tag aggiunti alla macchina a stati e il ruolo di esecuzione corrispondente. Per informazioni su chiavi e valori validi per i tag, consulta Tag proprietà di un AWS::StepFunctions::StateMachine risorsa.
Tipo: Mappa
Obbligatorio: no
CloudFormation compatibilità: Questa proprietà è simile alla
Tagsproprietà di unAWS::StepFunctions::StateMachinerisorsa. AWS SAM aggiunge automaticamente unstateMachine:createdBy:SAMtag a questa risorsa e al ruolo predefinito che viene generato per essa. -
Tracing -
Seleziona se o meno AWS X-Ray è abilitato per la macchina a stati. Per ulteriori informazioni sull'uso X-Ray con Step Functions, vedere AWS X-Ray e Step Functions nel AWS Step Functions Guida per gli sviluppatori.
Tipo: TracingConfiguration
Obbligatorio: no
CloudFormation compatibilità: Questa proprietà viene passata direttamente al
TracingConfigurationproprietà di unAWS::StepFunctions::StateMachinerisorsa. -
Type -
Il tipo di macchina a stati.
Valori validi:
STANDARDoEXPRESS▬Tipo: stringa
Obbligatorio: no
Default:
STANDARDCloudFormation compatibilità: Questa proprietà viene passata direttamente al
StateMachineTypeproprietà di unAWS::StepFunctions::StateMachinerisorsa.
Valori restituiti
Ref
Quando fornisci l'ID logico di questa risorsa alla funzione intrinseca Ref, Ref restituisce l'Amazon Resource Name (ARN) della risorsa sottostante AWS::StepFunctions::StateMachine risorsa.
Per ulteriori informazioni sull'uso di Ref funzione, vedere Ref nel AWS CloudFormation Guida per l'utente.
Ventola::GetAtt
Fn::GetAtt restituisce un valore per un attributo specificato di questo tipo. Di seguito sono riportati gli attributi disponibili e i valori restituiti di esempio.
Per ulteriori informazioni sull'uso Fn::GetAtt, vedi Fn::GetAtt nel AWS CloudFormation Guida per l'utente.
Name-
Restituisce il nome della macchina a stati, ad esempio
HelloWorld-StateMachine.
Esempi
File di definizione della macchina a stati
Di seguito è riportato un esempio di definizione di macchina a stati in linea che consente a una funzione lambda di richiamare una macchina a stati. Nota che questo esempio prevede il Role proprietà per configurare la politica appropriata per consentire l'invocazione. La my_state_machine.asl.json il file deve essere scritto in Amazon States Language.
In questo esempio, DefinitionSubstitution le voci consentono alla macchina a stati di includere risorse dichiarate in AWS SAM file modello.
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
Definizione di macchina a stati in linea
Di seguito è riportato un esempio di definizione di macchina a stati in linea.
In questo esempio, AWS SAM il file modello è scritto in YAML, quindi anche la definizione della macchina a stati è in YAML. Per dichiarare una definizione di macchina a stati in linea in JSON, scrivi il tuo AWS SAM file modello 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