aws_step_function

account_id

Type: STRING

creation_date

Type: TIMESTAMP
Provider name: creationDate
Description: The date the state machine is created. For a state machine version, creationDate is the date the version was created.

definition

Type: STRING
Provider name: definition
Description: The Amazon States Language definition of the state machine. See Amazon States Language. If called with includedData = METADATA_ONLY, the returned definition will be {}.

description

Type: STRING
Provider name: description
Description: The description of the state machine version.

encryption_configuration

Type: STRUCT
Provider name: encryptionConfiguration
Description: Settings to configure server-side encryption.

  • kms_data_key_reuse_period_seconds
    Type: INT32
    Provider name: kmsDataKeyReusePeriodSeconds
    Description: Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call GenerateDataKey. Only applies to customer managed keys.
  • kms_key_id
    Type: STRING
    Provider name: kmsKeyId
    Description: An alias, alias ARN, key ID, or key ARN of a symmetric encryption KMS key to encrypt data. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
  • type
    Type: STRING
    Provider name: type
    Description: Encryption type

label

Type: STRING
Provider name: label
Description: A user-defined or an auto-generated string that identifies a Map state. This parameter is present only if the stateMachineArn specified in input is a qualified state machine ARN.

logging_configuration

Type: STRUCT
Provider name: loggingConfiguration

  • destinations
    Type: UNORDERED_LIST_STRUCT
    Provider name: destinations
    Description: An array of objects that describes where your execution history events will be logged. Limited to size 1. Required, if your log level is not set to OFF.
    • cloud_watch_logs_log_group
      Type: STRUCT
      Provider name: cloudWatchLogsLogGroup
      Description: An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup in the CloudFormation User Guide.
      • log_group_arn
        Type: STRING
        Provider name: logGroupArn
        Description: The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN must end with :*
  • include_execution_data
    Type: BOOLEAN
    Provider name: includeExecutionData
    Description: Determines whether execution data is included in your log. When set to false, data is excluded.
  • level
    Type: STRING
    Provider name: level
    Description: Defines which category of execution history events are logged.

name

Type: STRING
Provider name: name
Description: The name of the state machine. A name must not contain:

  • white space
  • brackets < > { } [ ]
  • wildcard characters ? *
  • special characters " # % \ ^ | ~ ` $ & , ; : /
  • control characters (U+0000-001F, U+007F-009F)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

revision_id

Type: STRING
Provider name: revisionId
Description: The revision identifier for the state machine. Use the revisionId parameter to compare between versions of a state machine configuration used for executions without performing a diff of the properties, such as definition and roleArn.

role_arn

Type: STRING
Provider name: roleArn
Description: The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to Amazon Web Services resources.)

state_machine_arn

Type: STRING
Provider name: stateMachineArn
Description: The Amazon Resource Name (ARN) that identifies the state machine. If you specified a state machine version ARN in your request, the API returns the version ARN. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.

status

Type: STRING
Provider name: status
Description: The current status of the state machine.

tags

Type: UNORDERED_LIST_STRING

tracing_configuration

Type: STRUCT
Provider name: tracingConfiguration
Description: Selects whether X-Ray tracing is enabled.

  • enabled
    Type: BOOLEAN
    Provider name: enabled
    Description: When set to true, X-Ray tracing is enabled.

type

Type: STRING
Provider name: type
Description: The type of the state machine (STANDARD or EXPRESS).

variable_references

Type: STRING
Provider name: variableReferences
Description: A map of state name to a list of variables referenced by that state. States that do not use variable references will not be shown in the response.