Package software.amazon.awssdk.services.sfn.model

Interface DescribeStateMachineResponse.Builder

    • Method Detail

      • stateMachineArn

        DescribeStateMachineResponse.Builder stateMachineArn​(String stateMachineArn)

        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.

        Parameters:
        stateMachineArn - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        DescribeStateMachineResponse.Builder name​(String name)

        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 _.

        Parameters:
        name - 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 _.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • definition

        DescribeStateMachineResponse.Builder definition​(String definition)

        The Amazon States Language definition of the state machine. See Amazon States Language.

        If called with includedData = METADATA_ONLY, the returned definition will be {}.

        Parameters:
        definition - The Amazon States Language definition of the state machine. See Amazon States Language.

        If called with includedData = METADATA_ONLY, the returned definition will be {}.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • roleArn

        DescribeStateMachineResponse.Builder roleArn​(String roleArn)

        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.)

        Parameters:
        roleArn - 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.)
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • creationDate

        DescribeStateMachineResponse.Builder creationDate​(Instant creationDate)

        The date the state machine is created.

        For a state machine version, creationDate is the date the version was created.

        Parameters:
        creationDate - The date the state machine is created.

        For a state machine version, creationDate is the date the version was created.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • loggingConfiguration

        DescribeStateMachineResponse.Builder loggingConfiguration​(LoggingConfiguration loggingConfiguration)
        Sets the value of the LoggingConfiguration property for this object.
        Parameters:
        loggingConfiguration - The new value for the LoggingConfiguration property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tracingConfiguration

        DescribeStateMachineResponse.Builder tracingConfiguration​(TracingConfiguration tracingConfiguration)

        Selects whether X-Ray tracing is enabled.

        Parameters:
        tracingConfiguration - Selects whether X-Ray tracing is enabled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • label

        DescribeStateMachineResponse.Builder label​(String label)

        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.

        Parameters:
        label - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • revisionId

        DescribeStateMachineResponse.Builder revisionId​(String revisionId)

        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.

        Parameters:
        revisionId - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        DescribeStateMachineResponse.Builder description​(String description)

        The description of the state machine version.

        Parameters:
        description - The description of the state machine version.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • encryptionConfiguration

        DescribeStateMachineResponse.Builder encryptionConfiguration​(EncryptionConfiguration encryptionConfiguration)

        Settings to configure server-side encryption.

        Parameters:
        encryptionConfiguration - Settings to configure server-side encryption.
        Returns:
        Returns a reference to this object so that method calls can be chained together.