Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
AWS::Serverless::StateMachine
Crea un AWS Step Functions máquina de estado, que puede usar para orquestar AWS Lambda Funciones de eventos y otras AWS recursos para formar flujos de trabajo complejos y sólidos.
Para obtener más información acerca de Step Functions, consulta la AWS Step Functions Guía para desarrolladores de .
Este recurso también es compatible con Connectors recurso Attribute. Para obtener más información, consulte Administrar los permisos de recursos con AWS SAM conectores.
Cuando se implementa en AWS CloudFormation, AWS SAM transforma tu AWS SAM recursos en CloudFormation recursos. Para obtener más información, consulte Generado CloudFormation recursos para AWS SAM.
Sintaxis
Para declarar esta entidad en su AWS Serverless Application Model (AWS SAM), utilice la siguiente sintaxis.
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
Propiedades
-
AutoPublishAlias -
El nombre del alias de la máquina de estado. Para obtener más información sobre el uso de los alias de máquinas de estado de Step Functions, consulta Gestión de implementasciones continuas con versiones y alias en la Guía para desarrolladores de AWS Step Functions .
DeploymentPreferenceUtilícelo para configurar las preferencias de implementación de su alias. Si no especificasDeploymentPreference, AWS SAM configurará el tráfico para que cambie a la versión más reciente de la máquina de estado de una sola vez.AWS SAM establece la versión
DeletionPolicyyUpdateReplacePolicyaRetainde forma predeterminada. Las versiones anteriores no se eliminarán automáticamente.Tipo: cadena
Obligatorio: no
CloudFormation compatibilidad: Esta propiedad se pasa directamente al
Namepropiedad de unAWS::StepFunctions::StateMachineAliasrecurso. -
UseAliasAsEventTarget -
Indique si quiere pasar o no el alias, creado mediante la propiedad
AutoPublishAlias, al destino del origen de eventos definido con Eventos.Especifique
Truesi quiere utilizar el alias como destino de los eventos.Tipo: Booleano
Obligatorio: no
Valor predeterminado:
FalseCloudFormation compatibilidad: Esta propiedad es exclusiva de AWS SAM y no tiene un CloudFormation equivalente.
-
Definition -
La definición de máquina de estados es un objeto, donde el formato del objeto coincide con el formato de su AWS SAM archivo de plantilla, por ejemplo, JSON o YAML. Las definiciones de máquina de estado cumplen con el Amazon States Language.
Para ver un ejemplo de una definición de máquina de estados en línea, consulta Ejemplos.
Debe proporcionar un
Definitiono unDefinitionUri.Tipo: mapa
Obligatorio: condicional
CloudFormation compatibilidad: Esta propiedad es exclusiva de AWS SAM y no tiene un CloudFormation equivalente.
-
DefinitionSubstitutions -
Un mapa (cadena a cadena) que especifica los mapeos para variables de marcador de posición en la definición de máquina de estado. Esto permite al cliente inyectar valores obtenidos en tiempo de ejecución, por ejemplo, a partir de funciones intrínsecas, en la definición de máquina de estado.
Tipo: mapa
Obligatorio: no
CloudFormation compatibilidad: Esta propiedad es similar a
DefinitionSubstitutionspropiedad de unAWS::StepFunctions::StateMachinerecurso. Si se especifica alguna función intrínseca en una definición de máquina de estados en línea, AWS SAM agrega entradas a esta propiedad para incluirlas en la definición de la máquina de estados. -
DefinitionUri -
La URI de Amazon Simple Storage Service (Amazon S3) o la ruta de archivo local de la definición de la máquina de estados escrita en Amazon States Language.
Si proporcionas una ruta de archivo local, la plantilla debe seguir el flujo de trabajo que incluye el comando
sam deployosam packagepara transformar la definición correctamente. Para hacerlo, debe utilizar la versión 0.52.0 o posterior de la CLI de AWS SAM .Debe proporcionar un
Definitiono unDefinitionUri.Tipo: Cadena | S3Location
Obligatorio: condicional
CloudFormation compatibilidad: Esta propiedad se pasa directamente al
DefinitionS3Locationpropiedad de unAWS::StepFunctions::StateMachinerecurso. -
DeploymentPreference -
Los ajustes que permiten y configuran las implementasciones graduales de máquinas de estado. Para obtener más información sobre las implementasciones graduales de Step Functions, consulta Gestión de implementasciones continuas con versiones y alias en la Guía para desarrolladores de AWS Step Functions .
Especifica esta propiedad
AutoPublishAliasantes de configurar. La configuraciónDeploymentPreferencese aplicará al alias especificado conAutoPublishAlias.Cuando especificas
DeploymentPreference, AWS SAM genera elStateMachineVersionArnel valor de la subpropiedad automáticamente.Tipo: DeploymentPreference
Obligatorio: no
CloudFormation compatibilidad: AWS SAM genera y adjunta el
StateMachineVersionArnvalor de la propiedad aDeploymentPreferencey pasaDeploymentPreferencea laDeploymentPreferencepropiedad de unAWS::StepFunctions::StateMachineAliasrecurso. -
Events -
Especifica los eventos que activan esta máquina de estados. Los eventos constan de un tipo y un conjunto de propiedades que dependen del tipo.
Tipo: EventSource
Obligatorio: no
CloudFormation compatibilidad: Esta propiedad es exclusiva de AWS SAM y no tiene un CloudFormation equivalente.
-
Logging -
Define qué eventos del historial de ejecución se registran y dónde se registran.
Tipo: LoggingConfiguration
Obligatorio: no
CloudFormation compatibilidad: Esta propiedad se pasa directamente al
LoggingConfigurationpropiedad de unAWS::StepFunctions::StateMachinerecurso. -
Name -
El nombre de la máquina de estado.
Tipo: cadena
Obligatorio: no
CloudFormation compatibilidad: Esta propiedad se pasa directamente al
StateMachineNamepropiedad de unAWS::StepFunctions::StateMachinerecurso. -
PermissionsBoundary -
El ARN de un límite de permisos que se utilizará para el rol de ejecución de esta máquina de estados. Esta propiedad solo funciona si el rol se genera para usted.
Tipo: cadena
Obligatorio: no
CloudFormation compatibilidad: Esta propiedad se pasa directamente al
PermissionsBoundarypropiedad de unAWS::IAM::Rolerecurso. -
Policies -
Políticas de permisos para esta máquina de estados. Las políticas se adjuntarán al valor predeterminado de la máquina de estados AWS Identity and Access Management Función de ejecución (IAM).
Esta propiedad acepta un valor único o una lista de valores. Entre los valores permitidos se incluyen:
-
La ARN de una política administrada por AWS o una política administrada por el cliente.
-
El nombre de un AWS política gestionada de la siguiente lista
. -
Una política de IAM en línea con formato en YAML como un mapa.
notaSi especifica la propiedad
Role, pasa por alto esta propiedad.Tipo: Cadena | Lista | Mapa
Obligatorio: no
CloudFormation compatibilidad: Esta propiedad es exclusiva de AWS SAM y no tiene un CloudFormation equivalente.
-
Indique si quiere pasar o no las etiquetas de la propiedad
Tagsa los recursos generados AWS::Serverless::StateMachine. EspecificaTruepara propagar las etiquetas en los recursos generados.Tipo: Booleano
Obligatorio: no
Valor predeterminado:
FalseCloudFormation compatibilidad: Esta propiedad es exclusiva de AWS SAM y no tiene un CloudFormation equivalente.
-
Role -
El ARN de un rol de IAM que se utilizará como rol de ejecución de esta máquina de estados.
Tipo: cadena
Obligatorio: condicional
CloudFormation compatibilidad: Esta propiedad se pasa directamente al
RoleArnpropiedad de unAWS::StepFunctions::StateMachinerecurso. -
RolePath -
La ruta al rol de ejecución IAM de la máquina de estados.
Utilice esta propiedad cuando se genere el rol para usted. No la utilice si el rol se especifica con la propiedad
Role.Tipo: cadena
Obligatorio: condicional
CloudFormation compatibilidad: Esta propiedad se pasa directamente al
Pathpropiedad de unAWS::IAM::Rolerecurso. -
Una asignación de cadena a cadena que especifica las etiquetas que se agregan a la máquina de estado y la función de ejecución correspondiente. Para obtener información sobre las claves y los valores válidos de las etiquetas, consulta la propiedad Etiquetas de un recurso AWS::StepFunctions::StateMachine.
Tipo: mapa
Obligatorio: no
CloudFormation compatibilidad: Esta propiedad es similar a
Tagspropiedad de unAWS::StepFunctions::StateMachinerecurso. AWS SAM añade automáticamente unstateMachine:createdBy:SAMetiqueta a este recurso y al rol predeterminado que se genera para él. -
Tracing -
Selecciona si es o no AWS X-Ray está habilitado para la máquina de estados. Para obtener más información sobre el uso X-Ray con Step Functions, consulte AWS X-Ray y Step Functions en el AWS Step Functions Guía para desarrolladores.
Tipo: TracingConfiguration
Obligatorio: no
CloudFormation compatibilidad: Esta propiedad se pasa directamente al
TracingConfigurationpropiedad de unAWS::StepFunctions::StateMachinerecurso. -
Type -
El tipo de máquina de estado.
Valores válidos:
STANDARDoEXPRESSTipo: cadena
Obligatorio: no
Valor predeterminado:
STANDARDCloudFormation compatibilidad: Esta propiedad se pasa directamente al
StateMachineTypepropiedad de unAWS::StepFunctions::StateMachinerecurso.
valores devueltos
Ref.
Al proporcionar el ID lógico de este recurso a la función intrínseca Ref, esta devuelve el nombre de recurso de Amazon (ARN) del recurso AWS::StepFunctions::StateMachine subyacente.
Para obtener más información sobre el uso de la función Ref, consulta Ref en la Guía del usuario de AWS CloudFormation .
Diversión::GetAtt
Fn::GetAtt devuelve un valor para un atributo especificado de este tipo. A continuación se indican los atributos disponibles y los valores devueltos de muestra.
Para obtener más información acerca de cómo usar Fn::GetAtt, consulta Fn::GetAtt en la Guía del usuario de AWS CloudFormation .
Name-
Devuelve el nombre de la máquina de estados, como
HelloWorld-StateMachine.
Ejemplos
Archivo de definición de máquina de estado
A continuación, se muestra un ejemplo de una definición de máquina de estados en línea que permite que una función de Lambda invoque una máquina de estados en línea. Tenga en cuenta que en este ejemplo se espera que la propiedad Role configure la política adecuada para permitir la invocación. El archivo my_state_machine.asl.json debe estar escrito en Amazon States Language.
En este ejemplo, el DefinitionSubstitution las entradas permiten a la máquina de estados incluir los recursos declarados en el AWS SAM archivo de plantilla.
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
Definición de máquina de estados en línea
A continuación, se muestra un ejemplo de una definición de máquinas de estado insertadas.
En este ejemplo, el AWS SAM el archivo de plantilla está escrito en YAML, por lo que la definición de la máquina de estados también está en YAML. Para declarar una definición de máquina de estado en línea en JSON, escribe tu AWS SAM archivo de plantilla en 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