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

Class CreateStateMachineRequest

    • Method Detail

      • name

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

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

      • roleArn

        public final String roleArn()

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

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

      • type

        public final 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.

        If the service returns an enum value that is not available in the current SDK version, type will return StateMachineType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

        Returns:
        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.
        See Also:
        StateMachineType

      • typeAsString

        public final String typeAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, type will return StateMachineType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

        Returns:
        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.
        See Also:
        StateMachineType

      • loggingConfiguration

        public final 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.

        Returns:
        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.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final List<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: _ . : / = + - @.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        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: _ . : / = + - @.

      • tracingConfiguration

        public final TracingConfiguration tracingConfiguration()

        Selects whether X-Ray tracing is enabled.

        Returns:
        Selects whether X-Ray tracing is enabled.

      • publish

        public final Boolean publish()

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

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

      • versionDescription

        public final 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.

        Returns:
        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.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object