Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. stepfunctions
  5. getStateMachine

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.stepfunctions.getStateMachine

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource schema for StateMachine

    Using getStateMachine

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getStateMachine(args: GetStateMachineArgs, opts?: InvokeOptions): Promise<GetStateMachineResult>
function getStateMachineOutput(args: GetStateMachineOutputArgs, opts?: InvokeOptions): Output<GetStateMachineResult>
    def get_state_machine(arn: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetStateMachineResult
def get_state_machine_output(arn: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetStateMachineResult]
    func LookupStateMachine(ctx *Context, args *LookupStateMachineArgs, opts ...InvokeOption) (*LookupStateMachineResult, error)
func LookupStateMachineOutput(ctx *Context, args *LookupStateMachineOutputArgs, opts ...InvokeOption) LookupStateMachineResultOutput

    > Note: This function is named LookupStateMachine in the Go SDK.

    public static class GetStateMachine 
{
    public static Task<GetStateMachineResult> InvokeAsync(GetStateMachineArgs args, InvokeOptions? opts = null)
    public static Output<GetStateMachineResult> Invoke(GetStateMachineInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetStateMachineResult> getStateMachine(GetStateMachineArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:stepfunctions:getStateMachine
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string
    Returns the ARN of the resource.
    Arn string
    Returns the ARN of the resource.
    arn String
    Returns the ARN of the resource.
    arn string
    Returns the ARN of the resource.
    arn str
    Returns the ARN of the resource.
    arn String
    Returns the ARN of the resource.

    getStateMachine Result

    The following output properties are available:

    Arn string
    Returns the ARN of the resource.
    DefinitionString string
    The Amazon States Language definition of the state machine. The state machine definition must be in JSON. See Amazon States Language .
    EncryptionConfiguration Pulumi.AwsNative.StepFunctions.Outputs.StateMachineEncryptionConfiguration
    Encryption configuration for the state machine.
    LoggingConfiguration Pulumi.AwsNative.StepFunctions.Outputs.StateMachineLoggingConfiguration

    Defines what execution history events are logged and where they are logged.

    By default, the level is set to OFF . For more information see Log Levels in the AWS Step Functions User Guide.

    Name string

    Returns the name of the state machine. For example:

    { "Fn::GetAtt": ["MyStateMachine", "Name"] }

    Returns the name of your state machine:

    HelloWorld-StateMachine

    If you did not specify the name it will be similar to the following:

    MyStateMachine-1234abcdefgh

    For more information about using Fn::GetAtt , see Fn::GetAtt .

    RoleArn string
    The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
    StateMachineRevisionId string
    Identifier for a state machine revision, which is an immutable, read-only snapshot of a state machine’s definition and configuration.
    Tags List<Pulumi.AwsNative.Outputs.Tag>

    The list of tags to add to a resource.

    Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @ .

    TracingConfiguration Pulumi.AwsNative.StepFunctions.Outputs.StateMachineTracingConfiguration
    Selects whether or not the state machine's AWS X-Ray tracing is enabled.
    Arn string
    Returns the ARN of the resource.
    DefinitionString string
    The Amazon States Language definition of the state machine. The state machine definition must be in JSON. See Amazon States Language .
    EncryptionConfiguration StateMachineEncryptionConfiguration
    Encryption configuration for the state machine.
    LoggingConfiguration StateMachineLoggingConfiguration

    Defines what execution history events are logged and where they are logged.

    By default, the level is set to OFF . For more information see Log Levels in the AWS Step Functions User Guide.

    Name string

    Returns the name of the state machine. For example:

    { "Fn::GetAtt": ["MyStateMachine", "Name"] }

    Returns the name of your state machine:

    HelloWorld-StateMachine

    If you did not specify the name it will be similar to the following:

    MyStateMachine-1234abcdefgh

    For more information about using Fn::GetAtt , see Fn::GetAtt .

    RoleArn string
    The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
    StateMachineRevisionId string
    Identifier for a state machine revision, which is an immutable, read-only snapshot of a state machine’s definition and configuration.
    Tags Tag

    The list of tags to add to a resource.

    Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @ .

    TracingConfiguration StateMachineTracingConfiguration
    Selects whether or not the state machine's AWS X-Ray tracing is enabled.
    arn String
    Returns the ARN of the resource.
    definitionString String
    The Amazon States Language definition of the state machine. The state machine definition must be in JSON. See Amazon States Language .
    encryptionConfiguration StateMachineEncryptionConfiguration
    Encryption configuration for the state machine.
    loggingConfiguration StateMachineLoggingConfiguration

    Defines what execution history events are logged and where they are logged.

    By default, the level is set to OFF . For more information see Log Levels in the AWS Step Functions User Guide.

    name String

    Returns the name of the state machine. For example:

    { "Fn::GetAtt": ["MyStateMachine", "Name"] }

    Returns the name of your state machine:

    HelloWorld-StateMachine

    If you did not specify the name it will be similar to the following:

    MyStateMachine-1234abcdefgh

    For more information about using Fn::GetAtt , see Fn::GetAtt .

    roleArn String
    The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
    stateMachineRevisionId String
    Identifier for a state machine revision, which is an immutable, read-only snapshot of a state machine’s definition and configuration.
    tags List<Tag>

    The list of tags to add to a resource.

    Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @ .

    tracingConfiguration StateMachineTracingConfiguration
    Selects whether or not the state machine's AWS X-Ray tracing is enabled.
    arn string
    Returns the ARN of the resource.
    definitionString string
    The Amazon States Language definition of the state machine. The state machine definition must be in JSON. See Amazon States Language .
    encryptionConfiguration StateMachineEncryptionConfiguration
    Encryption configuration for the state machine.
    loggingConfiguration StateMachineLoggingConfiguration

    Defines what execution history events are logged and where they are logged.

    By default, the level is set to OFF . For more information see Log Levels in the AWS Step Functions User Guide.

    name string

    Returns the name of the state machine. For example:

    { "Fn::GetAtt": ["MyStateMachine", "Name"] }

    Returns the name of your state machine:

    HelloWorld-StateMachine

    If you did not specify the name it will be similar to the following:

    MyStateMachine-1234abcdefgh

    For more information about using Fn::GetAtt , see Fn::GetAtt .

    roleArn string
    The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
    stateMachineRevisionId string
    Identifier for a state machine revision, which is an immutable, read-only snapshot of a state machine’s definition and configuration.
    tags Tag[]

    The list of tags to add to a resource.

    Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @ .

    tracingConfiguration StateMachineTracingConfiguration
    Selects whether or not the state machine's AWS X-Ray tracing is enabled.
    arn str
    Returns the ARN of the resource.
    definition_string str
    The Amazon States Language definition of the state machine. The state machine definition must be in JSON. See Amazon States Language .
    encryption_configuration StateMachineEncryptionConfiguration
    Encryption configuration for the state machine.
    logging_configuration StateMachineLoggingConfiguration

    Defines what execution history events are logged and where they are logged.

    By default, the level is set to OFF . For more information see Log Levels in the AWS Step Functions User Guide.

    name str

    Returns the name of the state machine. For example:

    { "Fn::GetAtt": ["MyStateMachine", "Name"] }

    Returns the name of your state machine:

    HelloWorld-StateMachine

    If you did not specify the name it will be similar to the following:

    MyStateMachine-1234abcdefgh

    For more information about using Fn::GetAtt , see Fn::GetAtt .

    role_arn str
    The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
    state_machine_revision_id str
    Identifier for a state machine revision, which is an immutable, read-only snapshot of a state machine’s definition and configuration.
    tags Sequence[root_Tag]

    The list of tags to add to a resource.

    Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @ .

    tracing_configuration StateMachineTracingConfiguration
    Selects whether or not the state machine's AWS X-Ray tracing is enabled.
    arn String
    Returns the ARN of the resource.
    definitionString String
    The Amazon States Language definition of the state machine. The state machine definition must be in JSON. See Amazon States Language .
    encryptionConfiguration Property Map
    Encryption configuration for the state machine.
    loggingConfiguration Property Map

    Defines what execution history events are logged and where they are logged.

    By default, the level is set to OFF . For more information see Log Levels in the AWS Step Functions User Guide.

    name String

    Returns the name of the state machine. For example:

    { "Fn::GetAtt": ["MyStateMachine", "Name"] }

    Returns the name of your state machine:

    HelloWorld-StateMachine

    If you did not specify the name it will be similar to the following:

    MyStateMachine-1234abcdefgh

    For more information about using Fn::GetAtt , see Fn::GetAtt .

    roleArn String
    The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
    stateMachineRevisionId String
    Identifier for a state machine revision, which is an immutable, read-only snapshot of a state machine’s definition and configuration.
    tags List<Property Map>

    The list of tags to add to a resource.

    Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @ .

    tracingConfiguration Property Map
    Selects whether or not the state machine's AWS X-Ray tracing is enabled.

    Supporting Types

    StateMachineCloudWatchLogsLogGroup

    LogGroupArn string
    The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN must end with :*
    LogGroupArn string
    The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN must end with :*
    logGroupArn String
    The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN must end with :*
    logGroupArn string
    The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN must end with :*
    log_group_arn str
    The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN must end with :*
    logGroupArn String
    The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN must end with :*

    StateMachineEncryptionConfiguration

    Type Pulumi.AwsNative.StepFunctions.StateMachineEncryptionConfigurationType
    Encryption option for a state machine.
    KmsDataKeyReusePeriodSeconds int
    Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call GenerateDataKey . Only applies to customer managed keys.
    KmsKeyId string
    An alias, alias ARN, key ID, or key ARN of a symmetric encryption AWS KMS key to encrypt data. To specify a AWS KMS key in a different AWS account, you must use the key ARN or alias ARN.
    Type StateMachineEncryptionConfigurationType
    Encryption option for a state machine.
    KmsDataKeyReusePeriodSeconds int
    Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call GenerateDataKey . Only applies to customer managed keys.
    KmsKeyId string
    An alias, alias ARN, key ID, or key ARN of a symmetric encryption AWS KMS key to encrypt data. To specify a AWS KMS key in a different AWS account, you must use the key ARN or alias ARN.
    type StateMachineEncryptionConfigurationType
    Encryption option for a state machine.
    kmsDataKeyReusePeriodSeconds Integer
    Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call GenerateDataKey . Only applies to customer managed keys.
    kmsKeyId String
    An alias, alias ARN, key ID, or key ARN of a symmetric encryption AWS KMS key to encrypt data. To specify a AWS KMS key in a different AWS account, you must use the key ARN or alias ARN.
    type StateMachineEncryptionConfigurationType
    Encryption option for a state machine.
    kmsDataKeyReusePeriodSeconds number
    Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call GenerateDataKey . Only applies to customer managed keys.
    kmsKeyId string
    An alias, alias ARN, key ID, or key ARN of a symmetric encryption AWS KMS key to encrypt data. To specify a AWS KMS key in a different AWS account, you must use the key ARN or alias ARN.
    type StateMachineEncryptionConfigurationType
    Encryption option for a state machine.
    kms_data_key_reuse_period_seconds int
    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 str
    An alias, alias ARN, key ID, or key ARN of a symmetric encryption AWS KMS key to encrypt data. To specify a AWS KMS key in a different AWS account, you must use the key ARN or alias ARN.
    type "CUSTOMER_MANAGED_KMS_KEY" | "AWS_OWNED_KEY"
    Encryption option for a state machine.
    kmsDataKeyReusePeriodSeconds Number
    Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call GenerateDataKey . Only applies to customer managed keys.
    kmsKeyId String
    An alias, alias ARN, key ID, or key ARN of a symmetric encryption AWS KMS key to encrypt data. To specify a AWS KMS key in a different AWS account, you must use the key ARN or alias ARN.

    StateMachineEncryptionConfigurationType

    StateMachineLogDestination

    CloudWatchLogsLogGroup Pulumi.AwsNative.StepFunctions.Inputs.StateMachineCloudWatchLogsLogGroup
    An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup in the AWS CloudFormation User Guide.
    CloudWatchLogsLogGroup StateMachineCloudWatchLogsLogGroup
    An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup in the AWS CloudFormation User Guide.
    cloudWatchLogsLogGroup StateMachineCloudWatchLogsLogGroup
    An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup in the AWS CloudFormation User Guide.
    cloudWatchLogsLogGroup StateMachineCloudWatchLogsLogGroup
    An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup in the AWS CloudFormation User Guide.
    cloud_watch_logs_log_group StateMachineCloudWatchLogsLogGroup
    An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup in the AWS CloudFormation User Guide.
    cloudWatchLogsLogGroup Property Map
    An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup in the AWS CloudFormation User Guide.

    StateMachineLoggingConfiguration

    Destinations List<Pulumi.AwsNative.StepFunctions.Inputs.StateMachineLogDestination>
    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 .
    IncludeExecutionData bool
    Determines whether execution data is included in your log. When set to false , data is excluded.
    Level Pulumi.AwsNative.StepFunctions.StateMachineLoggingConfigurationLevel
    Defines which category of execution history events are logged.
    Destinations []StateMachineLogDestination
    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 .
    IncludeExecutionData bool
    Determines whether execution data is included in your log. When set to false , data is excluded.
    Level StateMachineLoggingConfigurationLevel
    Defines which category of execution history events are logged.
    destinations List<StateMachineLogDestination>
    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 .
    includeExecutionData Boolean
    Determines whether execution data is included in your log. When set to false , data is excluded.
    level StateMachineLoggingConfigurationLevel
    Defines which category of execution history events are logged.
    destinations StateMachineLogDestination[]
    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 .
    includeExecutionData boolean
    Determines whether execution data is included in your log. When set to false , data is excluded.
    level StateMachineLoggingConfigurationLevel
    Defines which category of execution history events are logged.
    destinations Sequence[StateMachineLogDestination]
    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 .
    include_execution_data bool
    Determines whether execution data is included in your log. When set to false , data is excluded.
    level StateMachineLoggingConfigurationLevel
    Defines which category of execution history events are logged.
    destinations List<Property Map>
    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 .
    includeExecutionData Boolean
    Determines whether execution data is included in your log. When set to false , data is excluded.
    level "ALL" | "ERROR" | "FATAL" | "OFF"
    Defines which category of execution history events are logged.

    StateMachineLoggingConfigurationLevel

    StateMachineTracingConfiguration

    Enabled bool
    When set to true , X-Ray tracing is enabled.
    Enabled bool
    When set to true , X-Ray tracing is enabled.
    enabled Boolean
    When set to true , X-Ray tracing is enabled.
    enabled boolean
    When set to true , X-Ray tracing is enabled.
    enabled bool
    When set to true , X-Ray tracing is enabled.
    enabled Boolean
    When set to true , X-Ray tracing is enabled.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native