/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include namespace Aws { namespace SFN { namespace Model { /** */ class CreateStateMachineRequest : public SFNRequest { public: AWS_SFN_API CreateStateMachineRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "CreateStateMachine"; } AWS_SFN_API Aws::String SerializePayload() const override; AWS_SFN_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

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

*/ inline const Aws::String& GetName() const{ return m_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 _.

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

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

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

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

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

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

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

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

*/ inline CreateStateMachineRequest& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

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

*/ inline CreateStateMachineRequest& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

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

*/ inline CreateStateMachineRequest& WithName(const char* value) { SetName(value); return *this;} /** *

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

*/ inline const Aws::String& GetDefinition() const{ return m_definition; } /** *

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

*/ inline bool DefinitionHasBeenSet() const { return m_definitionHasBeenSet; } /** *

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

*/ inline void SetDefinition(const Aws::String& value) { m_definitionHasBeenSet = true; m_definition = value; } /** *

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

*/ inline void SetDefinition(Aws::String&& value) { m_definitionHasBeenSet = true; m_definition = std::move(value); } /** *

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

*/ inline void SetDefinition(const char* value) { m_definitionHasBeenSet = true; m_definition.assign(value); } /** *

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

*/ inline CreateStateMachineRequest& WithDefinition(const Aws::String& value) { SetDefinition(value); return *this;} /** *

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

*/ inline CreateStateMachineRequest& WithDefinition(Aws::String&& value) { SetDefinition(std::move(value)); return *this;} /** *

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

*/ inline CreateStateMachineRequest& WithDefinition(const char* value) { SetDefinition(value); return *this;} /** *

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

*/ inline const Aws::String& GetRoleArn() const{ return m_roleArn; } /** *

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

*/ inline bool RoleArnHasBeenSet() const { return m_roleArnHasBeenSet; } /** *

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

*/ inline void SetRoleArn(const Aws::String& value) { m_roleArnHasBeenSet = true; m_roleArn = value; } /** *

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

*/ inline void SetRoleArn(Aws::String&& value) { m_roleArnHasBeenSet = true; m_roleArn = std::move(value); } /** *

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

*/ inline void SetRoleArn(const char* value) { m_roleArnHasBeenSet = true; m_roleArn.assign(value); } /** *

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

*/ inline CreateStateMachineRequest& WithRoleArn(const Aws::String& value) { SetRoleArn(value); return *this;} /** *

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

*/ inline CreateStateMachineRequest& WithRoleArn(Aws::String&& value) { SetRoleArn(std::move(value)); return *this;} /** *

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

*/ inline CreateStateMachineRequest& WithRoleArn(const char* value) { SetRoleArn(value); return *this;} /** *

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.

*/ inline const StateMachineType& GetType() const{ return m_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.

*/ inline bool TypeHasBeenSet() const { return m_typeHasBeenSet; } /** *

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.

*/ inline void SetType(const StateMachineType& value) { m_typeHasBeenSet = true; m_type = value; } /** *

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.

*/ inline void SetType(StateMachineType&& value) { m_typeHasBeenSet = true; m_type = std::move(value); } /** *

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.

*/ inline CreateStateMachineRequest& WithType(const StateMachineType& value) { SetType(value); return *this;} /** *

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.

*/ inline CreateStateMachineRequest& WithType(StateMachineType&& value) { SetType(std::move(value)); return *this;} /** *

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.

*/ inline const LoggingConfiguration& GetLoggingConfiguration() const{ return m_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.

*/ inline bool LoggingConfigurationHasBeenSet() const { return m_loggingConfigurationHasBeenSet; } /** *

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.

*/ inline void SetLoggingConfiguration(const LoggingConfiguration& value) { m_loggingConfigurationHasBeenSet = true; m_loggingConfiguration = value; } /** *

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.

*/ inline void SetLoggingConfiguration(LoggingConfiguration&& value) { m_loggingConfigurationHasBeenSet = true; m_loggingConfiguration = std::move(value); } /** *

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.

*/ inline CreateStateMachineRequest& WithLoggingConfiguration(const LoggingConfiguration& value) { SetLoggingConfiguration(value); return *this;} /** *

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.

*/ inline CreateStateMachineRequest& WithLoggingConfiguration(LoggingConfiguration&& value) { SetLoggingConfiguration(std::move(value)); return *this;} /** *

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

*/ inline const Aws::Vector& GetTags() const{ return m_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: _ . : / = + - @.

*/ inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; } /** *

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

*/ inline void SetTags(const Aws::Vector& value) { m_tagsHasBeenSet = true; m_tags = value; } /** *

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

*/ inline void SetTags(Aws::Vector&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); } /** *

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

*/ inline CreateStateMachineRequest& WithTags(const Aws::Vector& value) { SetTags(value); return *this;} /** *

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

*/ inline CreateStateMachineRequest& WithTags(Aws::Vector&& value) { SetTags(std::move(value)); return *this;} /** *

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

*/ inline CreateStateMachineRequest& AddTags(const Tag& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; } /** *

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

*/ inline CreateStateMachineRequest& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; } /** *

Selects whether X-Ray tracing is enabled.

*/ inline const TracingConfiguration& GetTracingConfiguration() const{ return m_tracingConfiguration; } /** *

Selects whether X-Ray tracing is enabled.

*/ inline bool TracingConfigurationHasBeenSet() const { return m_tracingConfigurationHasBeenSet; } /** *

Selects whether X-Ray tracing is enabled.

*/ inline void SetTracingConfiguration(const TracingConfiguration& value) { m_tracingConfigurationHasBeenSet = true; m_tracingConfiguration = value; } /** *

Selects whether X-Ray tracing is enabled.

*/ inline void SetTracingConfiguration(TracingConfiguration&& value) { m_tracingConfigurationHasBeenSet = true; m_tracingConfiguration = std::move(value); } /** *

Selects whether X-Ray tracing is enabled.

*/ inline CreateStateMachineRequest& WithTracingConfiguration(const TracingConfiguration& value) { SetTracingConfiguration(value); return *this;} /** *

Selects whether X-Ray tracing is enabled.

*/ inline CreateStateMachineRequest& WithTracingConfiguration(TracingConfiguration&& value) { SetTracingConfiguration(std::move(value)); return *this;} /** *

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

*/ inline bool GetPublish() const{ return m_publish; } /** *

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

*/ inline bool PublishHasBeenSet() const { return m_publishHasBeenSet; } /** *

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

*/ inline void SetPublish(bool value) { m_publishHasBeenSet = true; m_publish = value; } /** *

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

*/ inline CreateStateMachineRequest& WithPublish(bool value) { SetPublish(value); return *this;} /** *

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.

*/ inline const Aws::String& GetVersionDescription() const{ return m_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.

*/ inline bool VersionDescriptionHasBeenSet() const { return m_versionDescriptionHasBeenSet; } /** *

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.

*/ inline void SetVersionDescription(const Aws::String& value) { m_versionDescriptionHasBeenSet = true; m_versionDescription = value; } /** *

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.

*/ inline void SetVersionDescription(Aws::String&& value) { m_versionDescriptionHasBeenSet = true; m_versionDescription = std::move(value); } /** *

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.

*/ inline void SetVersionDescription(const char* value) { m_versionDescriptionHasBeenSet = true; m_versionDescription.assign(value); } /** *

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.

*/ inline CreateStateMachineRequest& WithVersionDescription(const Aws::String& value) { SetVersionDescription(value); return *this;} /** *

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.

*/ inline CreateStateMachineRequest& WithVersionDescription(Aws::String&& value) { SetVersionDescription(std::move(value)); return *this;} /** *

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.

*/ inline CreateStateMachineRequest& WithVersionDescription(const char* value) { SetVersionDescription(value); return *this;} private: Aws::String m_name; bool m_nameHasBeenSet = false; Aws::String m_definition; bool m_definitionHasBeenSet = false; Aws::String m_roleArn; bool m_roleArnHasBeenSet = false; StateMachineType m_type; bool m_typeHasBeenSet = false; LoggingConfiguration m_loggingConfiguration; bool m_loggingConfigurationHasBeenSet = false; Aws::Vector m_tags; bool m_tagsHasBeenSet = false; TracingConfiguration m_tracingConfiguration; bool m_tracingConfigurationHasBeenSet = false; bool m_publish; bool m_publishHasBeenSet = false; Aws::String m_versionDescription; bool m_versionDescriptionHasBeenSet = false; }; } // namespace Model } // namespace SFN } // namespace Aws