/** * 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 namespace Aws { namespace SimSpaceWeaver { namespace Model { /** */ class StartSimulationRequest : public SimSpaceWeaverRequest { public: AWS_SIMSPACEWEAVER_API StartSimulationRequest(); // 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 "StartSimulation"; } AWS_SIMSPACEWEAVER_API Aws::String SerializePayload() const override; /** *

A value that you provide to ensure that repeated calls to this API operation * using the same parameters complete only once. A ClientToken is also * known as an idempotency token. A ClientToken expires after * 24 hours.

*/ inline const Aws::String& GetClientToken() const{ return m_clientToken; } /** *

A value that you provide to ensure that repeated calls to this API operation * using the same parameters complete only once. A ClientToken is also * known as an idempotency token. A ClientToken expires after * 24 hours.

*/ inline bool ClientTokenHasBeenSet() const { return m_clientTokenHasBeenSet; } /** *

A value that you provide to ensure that repeated calls to this API operation * using the same parameters complete only once. A ClientToken is also * known as an idempotency token. A ClientToken expires after * 24 hours.

*/ inline void SetClientToken(const Aws::String& value) { m_clientTokenHasBeenSet = true; m_clientToken = value; } /** *

A value that you provide to ensure that repeated calls to this API operation * using the same parameters complete only once. A ClientToken is also * known as an idempotency token. A ClientToken expires after * 24 hours.

*/ inline void SetClientToken(Aws::String&& value) { m_clientTokenHasBeenSet = true; m_clientToken = std::move(value); } /** *

A value that you provide to ensure that repeated calls to this API operation * using the same parameters complete only once. A ClientToken is also * known as an idempotency token. A ClientToken expires after * 24 hours.

*/ inline void SetClientToken(const char* value) { m_clientTokenHasBeenSet = true; m_clientToken.assign(value); } /** *

A value that you provide to ensure that repeated calls to this API operation * using the same parameters complete only once. A ClientToken is also * known as an idempotency token. A ClientToken expires after * 24 hours.

*/ inline StartSimulationRequest& WithClientToken(const Aws::String& value) { SetClientToken(value); return *this;} /** *

A value that you provide to ensure that repeated calls to this API operation * using the same parameters complete only once. A ClientToken is also * known as an idempotency token. A ClientToken expires after * 24 hours.

*/ inline StartSimulationRequest& WithClientToken(Aws::String&& value) { SetClientToken(std::move(value)); return *this;} /** *

A value that you provide to ensure that repeated calls to this API operation * using the same parameters complete only once. A ClientToken is also * known as an idempotency token. A ClientToken expires after * 24 hours.

*/ inline StartSimulationRequest& WithClientToken(const char* value) { SetClientToken(value); return *this;} /** *

The description of the simulation.

*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *

The description of the simulation.

*/ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *

The description of the simulation.

*/ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *

The description of the simulation.

*/ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *

The description of the simulation.

*/ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *

The description of the simulation.

*/ inline StartSimulationRequest& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

The description of the simulation.

*/ inline StartSimulationRequest& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

The description of the simulation.

*/ inline StartSimulationRequest& WithDescription(const char* value) { SetDescription(value); return *this;} /** *

The maximum running time of the simulation, specified as a number of minutes * (m or M), hours (h or H), or days (d or D). The simulation stops when it reaches * this limit. The maximum value is 14D, or its equivalent in the * other units. The default value is 14D. A value equivalent to * 0 makes the simulation immediately transition to * Stopping as soon as it reaches Started.

*/ inline const Aws::String& GetMaximumDuration() const{ return m_maximumDuration; } /** *

The maximum running time of the simulation, specified as a number of minutes * (m or M), hours (h or H), or days (d or D). The simulation stops when it reaches * this limit. The maximum value is 14D, or its equivalent in the * other units. The default value is 14D. A value equivalent to * 0 makes the simulation immediately transition to * Stopping as soon as it reaches Started.

*/ inline bool MaximumDurationHasBeenSet() const { return m_maximumDurationHasBeenSet; } /** *

The maximum running time of the simulation, specified as a number of minutes * (m or M), hours (h or H), or days (d or D). The simulation stops when it reaches * this limit. The maximum value is 14D, or its equivalent in the * other units. The default value is 14D. A value equivalent to * 0 makes the simulation immediately transition to * Stopping as soon as it reaches Started.

*/ inline void SetMaximumDuration(const Aws::String& value) { m_maximumDurationHasBeenSet = true; m_maximumDuration = value; } /** *

The maximum running time of the simulation, specified as a number of minutes * (m or M), hours (h or H), or days (d or D). The simulation stops when it reaches * this limit. The maximum value is 14D, or its equivalent in the * other units. The default value is 14D. A value equivalent to * 0 makes the simulation immediately transition to * Stopping as soon as it reaches Started.

*/ inline void SetMaximumDuration(Aws::String&& value) { m_maximumDurationHasBeenSet = true; m_maximumDuration = std::move(value); } /** *

The maximum running time of the simulation, specified as a number of minutes * (m or M), hours (h or H), or days (d or D). The simulation stops when it reaches * this limit. The maximum value is 14D, or its equivalent in the * other units. The default value is 14D. A value equivalent to * 0 makes the simulation immediately transition to * Stopping as soon as it reaches Started.

*/ inline void SetMaximumDuration(const char* value) { m_maximumDurationHasBeenSet = true; m_maximumDuration.assign(value); } /** *

The maximum running time of the simulation, specified as a number of minutes * (m or M), hours (h or H), or days (d or D). The simulation stops when it reaches * this limit. The maximum value is 14D, or its equivalent in the * other units. The default value is 14D. A value equivalent to * 0 makes the simulation immediately transition to * Stopping as soon as it reaches Started.

*/ inline StartSimulationRequest& WithMaximumDuration(const Aws::String& value) { SetMaximumDuration(value); return *this;} /** *

The maximum running time of the simulation, specified as a number of minutes * (m or M), hours (h or H), or days (d or D). The simulation stops when it reaches * this limit. The maximum value is 14D, or its equivalent in the * other units. The default value is 14D. A value equivalent to * 0 makes the simulation immediately transition to * Stopping as soon as it reaches Started.

*/ inline StartSimulationRequest& WithMaximumDuration(Aws::String&& value) { SetMaximumDuration(std::move(value)); return *this;} /** *

The maximum running time of the simulation, specified as a number of minutes * (m or M), hours (h or H), or days (d or D). The simulation stops when it reaches * this limit. The maximum value is 14D, or its equivalent in the * other units. The default value is 14D. A value equivalent to * 0 makes the simulation immediately transition to * Stopping as soon as it reaches Started.

*/ inline StartSimulationRequest& WithMaximumDuration(const char* value) { SetMaximumDuration(value); return *this;} /** *

The name of the simulation.

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

The name of the simulation.

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

The name of the simulation.

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

The name of the simulation.

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

The name of the simulation.

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

The name of the simulation.

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

The name of the simulation.

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

The name of the simulation.

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

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) * role that the simulation assumes to perform actions. For more information about * ARNs, see Amazon * Resource Names (ARNs) in the Amazon Web Services General Reference. * For more information about IAM roles, see IAM * roles in the Identity and Access Management User Guide.

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

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) * role that the simulation assumes to perform actions. For more information about * ARNs, see Amazon * Resource Names (ARNs) in the Amazon Web Services General Reference. * For more information about IAM roles, see IAM * roles in the Identity and Access Management User Guide.

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

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) * role that the simulation assumes to perform actions. For more information about * ARNs, see Amazon * Resource Names (ARNs) in the Amazon Web Services General Reference. * For more information about IAM roles, see IAM * roles in the Identity and Access Management User Guide.

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

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) * role that the simulation assumes to perform actions. For more information about * ARNs, see Amazon * Resource Names (ARNs) in the Amazon Web Services General Reference. * For more information about IAM roles, see IAM * roles in the Identity and Access Management User Guide.

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

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) * role that the simulation assumes to perform actions. For more information about * ARNs, see Amazon * Resource Names (ARNs) in the Amazon Web Services General Reference. * For more information about IAM roles, see IAM * roles in the Identity and Access Management User Guide.

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

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) * role that the simulation assumes to perform actions. For more information about * ARNs, see Amazon * Resource Names (ARNs) in the Amazon Web Services General Reference. * For more information about IAM roles, see IAM * roles in the Identity and Access Management User Guide.

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

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) * role that the simulation assumes to perform actions. For more information about * ARNs, see Amazon * Resource Names (ARNs) in the Amazon Web Services General Reference. * For more information about IAM roles, see IAM * roles in the Identity and Access Management User Guide.

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

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) * role that the simulation assumes to perform actions. For more information about * ARNs, see Amazon * Resource Names (ARNs) in the Amazon Web Services General Reference. * For more information about IAM roles, see IAM * roles in the Identity and Access Management User Guide.

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

The location of the simulation schema in Amazon Simple Storage Service * (Amazon S3). For more information about Amazon S3, see the * Amazon Simple Storage Service User Guide .

Provide a * SchemaS3Location to start your simulation from a schema.

If * you provide a SchemaS3Location then you can't provide a * SnapshotS3Location.

*/ inline const S3Location& GetSchemaS3Location() const{ return m_schemaS3Location; } /** *

The location of the simulation schema in Amazon Simple Storage Service * (Amazon S3). For more information about Amazon S3, see the * Amazon Simple Storage Service User Guide .

Provide a * SchemaS3Location to start your simulation from a schema.

If * you provide a SchemaS3Location then you can't provide a * SnapshotS3Location.

*/ inline bool SchemaS3LocationHasBeenSet() const { return m_schemaS3LocationHasBeenSet; } /** *

The location of the simulation schema in Amazon Simple Storage Service * (Amazon S3). For more information about Amazon S3, see the * Amazon Simple Storage Service User Guide .

Provide a * SchemaS3Location to start your simulation from a schema.

If * you provide a SchemaS3Location then you can't provide a * SnapshotS3Location.

*/ inline void SetSchemaS3Location(const S3Location& value) { m_schemaS3LocationHasBeenSet = true; m_schemaS3Location = value; } /** *

The location of the simulation schema in Amazon Simple Storage Service * (Amazon S3). For more information about Amazon S3, see the * Amazon Simple Storage Service User Guide .

Provide a * SchemaS3Location to start your simulation from a schema.

If * you provide a SchemaS3Location then you can't provide a * SnapshotS3Location.

*/ inline void SetSchemaS3Location(S3Location&& value) { m_schemaS3LocationHasBeenSet = true; m_schemaS3Location = std::move(value); } /** *

The location of the simulation schema in Amazon Simple Storage Service * (Amazon S3). For more information about Amazon S3, see the * Amazon Simple Storage Service User Guide .

Provide a * SchemaS3Location to start your simulation from a schema.

If * you provide a SchemaS3Location then you can't provide a * SnapshotS3Location.

*/ inline StartSimulationRequest& WithSchemaS3Location(const S3Location& value) { SetSchemaS3Location(value); return *this;} /** *

The location of the simulation schema in Amazon Simple Storage Service * (Amazon S3). For more information about Amazon S3, see the * Amazon Simple Storage Service User Guide .

Provide a * SchemaS3Location to start your simulation from a schema.

If * you provide a SchemaS3Location then you can't provide a * SnapshotS3Location.

*/ inline StartSimulationRequest& WithSchemaS3Location(S3Location&& value) { SetSchemaS3Location(std::move(value)); return *this;} /** *

The location of the snapshot .zip file in Amazon Simple Storage Service * (Amazon S3). For more information about Amazon S3, see the * Amazon Simple Storage Service User Guide .

Provide a * SnapshotS3Location to start your simulation from a snapshot.

*

The Amazon S3 bucket must be in the same Amazon Web Services Region as the * simulation.

If you provide a SnapshotS3Location then you * can't provide a SchemaS3Location.

*/ inline const S3Location& GetSnapshotS3Location() const{ return m_snapshotS3Location; } /** *

The location of the snapshot .zip file in Amazon Simple Storage Service * (Amazon S3). For more information about Amazon S3, see the * Amazon Simple Storage Service User Guide .

Provide a * SnapshotS3Location to start your simulation from a snapshot.

*

The Amazon S3 bucket must be in the same Amazon Web Services Region as the * simulation.

If you provide a SnapshotS3Location then you * can't provide a SchemaS3Location.

*/ inline bool SnapshotS3LocationHasBeenSet() const { return m_snapshotS3LocationHasBeenSet; } /** *

The location of the snapshot .zip file in Amazon Simple Storage Service * (Amazon S3). For more information about Amazon S3, see the * Amazon Simple Storage Service User Guide .

Provide a * SnapshotS3Location to start your simulation from a snapshot.

*

The Amazon S3 bucket must be in the same Amazon Web Services Region as the * simulation.

If you provide a SnapshotS3Location then you * can't provide a SchemaS3Location.

*/ inline void SetSnapshotS3Location(const S3Location& value) { m_snapshotS3LocationHasBeenSet = true; m_snapshotS3Location = value; } /** *

The location of the snapshot .zip file in Amazon Simple Storage Service * (Amazon S3). For more information about Amazon S3, see the * Amazon Simple Storage Service User Guide .

Provide a * SnapshotS3Location to start your simulation from a snapshot.

*

The Amazon S3 bucket must be in the same Amazon Web Services Region as the * simulation.

If you provide a SnapshotS3Location then you * can't provide a SchemaS3Location.

*/ inline void SetSnapshotS3Location(S3Location&& value) { m_snapshotS3LocationHasBeenSet = true; m_snapshotS3Location = std::move(value); } /** *

The location of the snapshot .zip file in Amazon Simple Storage Service * (Amazon S3). For more information about Amazon S3, see the * Amazon Simple Storage Service User Guide .

Provide a * SnapshotS3Location to start your simulation from a snapshot.

*

The Amazon S3 bucket must be in the same Amazon Web Services Region as the * simulation.

If you provide a SnapshotS3Location then you * can't provide a SchemaS3Location.

*/ inline StartSimulationRequest& WithSnapshotS3Location(const S3Location& value) { SetSnapshotS3Location(value); return *this;} /** *

The location of the snapshot .zip file in Amazon Simple Storage Service * (Amazon S3). For more information about Amazon S3, see the * Amazon Simple Storage Service User Guide .

Provide a * SnapshotS3Location to start your simulation from a snapshot.

*

The Amazon S3 bucket must be in the same Amazon Web Services Region as the * simulation.

If you provide a SnapshotS3Location then you * can't provide a SchemaS3Location.

*/ inline StartSimulationRequest& WithSnapshotS3Location(S3Location&& value) { SetSnapshotS3Location(std::move(value)); return *this;} /** *

A list of tags for the simulation. For more information about tags, see Tagging * Amazon Web Services resources in the Amazon Web Services General * Reference.

*/ inline const Aws::Map& GetTags() const{ return m_tags; } /** *

A list of tags for the simulation. For more information about tags, see Tagging * Amazon Web Services resources in the Amazon Web Services General * Reference.

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

A list of tags for the simulation. For more information about tags, see Tagging * Amazon Web Services resources in the Amazon Web Services General * Reference.

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

A list of tags for the simulation. For more information about tags, see Tagging * Amazon Web Services resources in the Amazon Web Services General * Reference.

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

A list of tags for the simulation. For more information about tags, see Tagging * Amazon Web Services resources in the Amazon Web Services General * Reference.

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

A list of tags for the simulation. For more information about tags, see Tagging * Amazon Web Services resources in the Amazon Web Services General * Reference.

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

A list of tags for the simulation. For more information about tags, see Tagging * Amazon Web Services resources in the Amazon Web Services General * Reference.

*/ inline StartSimulationRequest& AddTags(const Aws::String& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } /** *

A list of tags for the simulation. For more information about tags, see Tagging * Amazon Web Services resources in the Amazon Web Services General * Reference.

*/ inline StartSimulationRequest& AddTags(Aws::String&& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } /** *

A list of tags for the simulation. For more information about tags, see Tagging * Amazon Web Services resources in the Amazon Web Services General * Reference.

*/ inline StartSimulationRequest& AddTags(const Aws::String& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } /** *

A list of tags for the simulation. For more information about tags, see Tagging * Amazon Web Services resources in the Amazon Web Services General * Reference.

*/ inline StartSimulationRequest& AddTags(Aws::String&& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), std::move(value)); return *this; } /** *

A list of tags for the simulation. For more information about tags, see Tagging * Amazon Web Services resources in the Amazon Web Services General * Reference.

*/ inline StartSimulationRequest& AddTags(const char* key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; } /** *

A list of tags for the simulation. For more information about tags, see Tagging * Amazon Web Services resources in the Amazon Web Services General * Reference.

*/ inline StartSimulationRequest& AddTags(Aws::String&& key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; } /** *

A list of tags for the simulation. For more information about tags, see Tagging * Amazon Web Services resources in the Amazon Web Services General * Reference.

*/ inline StartSimulationRequest& AddTags(const char* key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; } private: Aws::String m_clientToken; bool m_clientTokenHasBeenSet = false; Aws::String m_description; bool m_descriptionHasBeenSet = false; Aws::String m_maximumDuration; bool m_maximumDurationHasBeenSet = false; Aws::String m_name; bool m_nameHasBeenSet = false; Aws::String m_roleArn; bool m_roleArnHasBeenSet = false; S3Location m_schemaS3Location; bool m_schemaS3LocationHasBeenSet = false; S3Location m_snapshotS3Location; bool m_snapshotS3LocationHasBeenSet = false; Aws::Map m_tags; bool m_tagsHasBeenSet = false; }; } // namespace Model } // namespace SimSpaceWeaver } // namespace Aws