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

Interface CreateStateMachineRequest.Builder

    • Method Detail

      • name

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

      • roleArn

        CreateStateMachineRequest.Builder roleArn​(String roleArn)

        The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

        Parameters:
        roleArn - The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • type

        CreateStateMachineRequest.Builder type​(String type)

        Determines whether a Standard or Express state machine is created. The default is STANDARD. You cannot update the type of a state machine once it has been created.

        Parameters:
        type - Determines whether a Standard or Express state machine is created. The default is STANDARD. You cannot update the type of a state machine once it has been created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        StateMachineType, StateMachineType

      • type

        CreateStateMachineRequest.Builder type​(StateMachineType type)

        Determines whether a Standard or Express state machine is created. The default is STANDARD. You cannot update the type of a state machine once it has been created.

        Parameters:
        type - Determines whether a Standard or Express state machine is created. The default is STANDARD. You cannot update the type of a state machine once it has been created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        StateMachineType, StateMachineType

      • loggingConfiguration

        CreateStateMachineRequest.Builder loggingConfiguration​(LoggingConfiguration loggingConfiguration)

        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 Step Functions User Guide.

        Parameters:
        loggingConfiguration - 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 Step Functions User Guide.

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

      • tags

        CreateStateMachineRequest.Builder tags​(Collection<Tag> tags)

        Tags to be added when creating a state machine.

        An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

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

        Parameters:
        tags - Tags to be added when creating a state machine.

        An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

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

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

      • tags

        CreateStateMachineRequest.Builder tags​(Tag... tags)

        Tags to be added when creating a state machine.

        An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

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

        Parameters:
        tags - Tags to be added when creating a state machine.

        An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

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

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

      • tracingConfiguration

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

      • publish

        CreateStateMachineRequest.Builder publish​(Boolean publish)

        Set to true to publish the first version of the state machine during creation. The default is false.

        Parameters:
        publish - Set to true to publish the first version of the state machine during creation. The default is false.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • versionDescription

        CreateStateMachineRequest.Builder versionDescription​(String versionDescription)

        Sets description about the state machine version. You can only set the description if the publish parameter is set to true. Otherwise, if you set versionDescription, but publish to false, this API action throws ValidationException.

        Parameters:
        versionDescription - Sets description about the state machine version. You can only set the description if the publish parameter is set to true. Otherwise, if you set versionDescription, but publish to false, this API action throws ValidationException.
        Returns:
        Returns a reference to this object so that method calls can be chained together.