/** * 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 SSM { namespace Model { /** */ class StartChangeRequestExecutionRequest : public SSMRequest { public: AWS_SSM_API StartChangeRequestExecutionRequest(); // 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 "StartChangeRequestExecution"; } AWS_SSM_API Aws::String SerializePayload() const override; AWS_SSM_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The date and time specified in the change request to run the Automation * runbooks.

The Automation runbooks specified for the runbook * workflow can't run until all required approvals for the change request have been * received.

*/ inline const Aws::Utils::DateTime& GetScheduledTime() const{ return m_scheduledTime; } /** *

The date and time specified in the change request to run the Automation * runbooks.

The Automation runbooks specified for the runbook * workflow can't run until all required approvals for the change request have been * received.

*/ inline bool ScheduledTimeHasBeenSet() const { return m_scheduledTimeHasBeenSet; } /** *

The date and time specified in the change request to run the Automation * runbooks.

The Automation runbooks specified for the runbook * workflow can't run until all required approvals for the change request have been * received.

*/ inline void SetScheduledTime(const Aws::Utils::DateTime& value) { m_scheduledTimeHasBeenSet = true; m_scheduledTime = value; } /** *

The date and time specified in the change request to run the Automation * runbooks.

The Automation runbooks specified for the runbook * workflow can't run until all required approvals for the change request have been * received.

*/ inline void SetScheduledTime(Aws::Utils::DateTime&& value) { m_scheduledTimeHasBeenSet = true; m_scheduledTime = std::move(value); } /** *

The date and time specified in the change request to run the Automation * runbooks.

The Automation runbooks specified for the runbook * workflow can't run until all required approvals for the change request have been * received.

*/ inline StartChangeRequestExecutionRequest& WithScheduledTime(const Aws::Utils::DateTime& value) { SetScheduledTime(value); return *this;} /** *

The date and time specified in the change request to run the Automation * runbooks.

The Automation runbooks specified for the runbook * workflow can't run until all required approvals for the change request have been * received.

*/ inline StartChangeRequestExecutionRequest& WithScheduledTime(Aws::Utils::DateTime&& value) { SetScheduledTime(std::move(value)); return *this;} /** *

The name of the change template document to run during the runbook * workflow.

*/ inline const Aws::String& GetDocumentName() const{ return m_documentName; } /** *

The name of the change template document to run during the runbook * workflow.

*/ inline bool DocumentNameHasBeenSet() const { return m_documentNameHasBeenSet; } /** *

The name of the change template document to run during the runbook * workflow.

*/ inline void SetDocumentName(const Aws::String& value) { m_documentNameHasBeenSet = true; m_documentName = value; } /** *

The name of the change template document to run during the runbook * workflow.

*/ inline void SetDocumentName(Aws::String&& value) { m_documentNameHasBeenSet = true; m_documentName = std::move(value); } /** *

The name of the change template document to run during the runbook * workflow.

*/ inline void SetDocumentName(const char* value) { m_documentNameHasBeenSet = true; m_documentName.assign(value); } /** *

The name of the change template document to run during the runbook * workflow.

*/ inline StartChangeRequestExecutionRequest& WithDocumentName(const Aws::String& value) { SetDocumentName(value); return *this;} /** *

The name of the change template document to run during the runbook * workflow.

*/ inline StartChangeRequestExecutionRequest& WithDocumentName(Aws::String&& value) { SetDocumentName(std::move(value)); return *this;} /** *

The name of the change template document to run during the runbook * workflow.

*/ inline StartChangeRequestExecutionRequest& WithDocumentName(const char* value) { SetDocumentName(value); return *this;} /** *

The version of the change template document to run during the runbook * workflow.

*/ inline const Aws::String& GetDocumentVersion() const{ return m_documentVersion; } /** *

The version of the change template document to run during the runbook * workflow.

*/ inline bool DocumentVersionHasBeenSet() const { return m_documentVersionHasBeenSet; } /** *

The version of the change template document to run during the runbook * workflow.

*/ inline void SetDocumentVersion(const Aws::String& value) { m_documentVersionHasBeenSet = true; m_documentVersion = value; } /** *

The version of the change template document to run during the runbook * workflow.

*/ inline void SetDocumentVersion(Aws::String&& value) { m_documentVersionHasBeenSet = true; m_documentVersion = std::move(value); } /** *

The version of the change template document to run during the runbook * workflow.

*/ inline void SetDocumentVersion(const char* value) { m_documentVersionHasBeenSet = true; m_documentVersion.assign(value); } /** *

The version of the change template document to run during the runbook * workflow.

*/ inline StartChangeRequestExecutionRequest& WithDocumentVersion(const Aws::String& value) { SetDocumentVersion(value); return *this;} /** *

The version of the change template document to run during the runbook * workflow.

*/ inline StartChangeRequestExecutionRequest& WithDocumentVersion(Aws::String&& value) { SetDocumentVersion(std::move(value)); return *this;} /** *

The version of the change template document to run during the runbook * workflow.

*/ inline StartChangeRequestExecutionRequest& WithDocumentVersion(const char* value) { SetDocumentVersion(value); return *this;} /** *

A key-value map of parameters that match the declared parameters in the * change template document.

*/ inline const Aws::Map>& GetParameters() const{ return m_parameters; } /** *

A key-value map of parameters that match the declared parameters in the * change template document.

*/ inline bool ParametersHasBeenSet() const { return m_parametersHasBeenSet; } /** *

A key-value map of parameters that match the declared parameters in the * change template document.

*/ inline void SetParameters(const Aws::Map>& value) { m_parametersHasBeenSet = true; m_parameters = value; } /** *

A key-value map of parameters that match the declared parameters in the * change template document.

*/ inline void SetParameters(Aws::Map>&& value) { m_parametersHasBeenSet = true; m_parameters = std::move(value); } /** *

A key-value map of parameters that match the declared parameters in the * change template document.

*/ inline StartChangeRequestExecutionRequest& WithParameters(const Aws::Map>& value) { SetParameters(value); return *this;} /** *

A key-value map of parameters that match the declared parameters in the * change template document.

*/ inline StartChangeRequestExecutionRequest& WithParameters(Aws::Map>&& value) { SetParameters(std::move(value)); return *this;} /** *

A key-value map of parameters that match the declared parameters in the * change template document.

*/ inline StartChangeRequestExecutionRequest& AddParameters(const Aws::String& key, const Aws::Vector& value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, value); return *this; } /** *

A key-value map of parameters that match the declared parameters in the * change template document.

*/ inline StartChangeRequestExecutionRequest& AddParameters(Aws::String&& key, const Aws::Vector& value) { m_parametersHasBeenSet = true; m_parameters.emplace(std::move(key), value); return *this; } /** *

A key-value map of parameters that match the declared parameters in the * change template document.

*/ inline StartChangeRequestExecutionRequest& AddParameters(const Aws::String& key, Aws::Vector&& value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, std::move(value)); return *this; } /** *

A key-value map of parameters that match the declared parameters in the * change template document.

*/ inline StartChangeRequestExecutionRequest& AddParameters(Aws::String&& key, Aws::Vector&& value) { m_parametersHasBeenSet = true; m_parameters.emplace(std::move(key), std::move(value)); return *this; } /** *

A key-value map of parameters that match the declared parameters in the * change template document.

*/ inline StartChangeRequestExecutionRequest& AddParameters(const char* key, Aws::Vector&& value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, std::move(value)); return *this; } /** *

A key-value map of parameters that match the declared parameters in the * change template document.

*/ inline StartChangeRequestExecutionRequest& AddParameters(const char* key, const Aws::Vector& value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, value); return *this; } /** *

The name of the change request associated with the runbook workflow to be * run.

*/ inline const Aws::String& GetChangeRequestName() const{ return m_changeRequestName; } /** *

The name of the change request associated with the runbook workflow to be * run.

*/ inline bool ChangeRequestNameHasBeenSet() const { return m_changeRequestNameHasBeenSet; } /** *

The name of the change request associated with the runbook workflow to be * run.

*/ inline void SetChangeRequestName(const Aws::String& value) { m_changeRequestNameHasBeenSet = true; m_changeRequestName = value; } /** *

The name of the change request associated with the runbook workflow to be * run.

*/ inline void SetChangeRequestName(Aws::String&& value) { m_changeRequestNameHasBeenSet = true; m_changeRequestName = std::move(value); } /** *

The name of the change request associated with the runbook workflow to be * run.

*/ inline void SetChangeRequestName(const char* value) { m_changeRequestNameHasBeenSet = true; m_changeRequestName.assign(value); } /** *

The name of the change request associated with the runbook workflow to be * run.

*/ inline StartChangeRequestExecutionRequest& WithChangeRequestName(const Aws::String& value) { SetChangeRequestName(value); return *this;} /** *

The name of the change request associated with the runbook workflow to be * run.

*/ inline StartChangeRequestExecutionRequest& WithChangeRequestName(Aws::String&& value) { SetChangeRequestName(std::move(value)); return *this;} /** *

The name of the change request associated with the runbook workflow to be * run.

*/ inline StartChangeRequestExecutionRequest& WithChangeRequestName(const char* value) { SetChangeRequestName(value); return *this;} /** *

The user-provided idempotency token. The token must be unique, is case * insensitive, enforces the UUID format, and can't be reused.

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

The user-provided idempotency token. The token must be unique, is case * insensitive, enforces the UUID format, and can't be reused.

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

The user-provided idempotency token. The token must be unique, is case * insensitive, enforces the UUID format, and can't be reused.

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

The user-provided idempotency token. The token must be unique, is case * insensitive, enforces the UUID format, and can't be reused.

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

The user-provided idempotency token. The token must be unique, is case * insensitive, enforces the UUID format, and can't be reused.

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

The user-provided idempotency token. The token must be unique, is case * insensitive, enforces the UUID format, and can't be reused.

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

The user-provided idempotency token. The token must be unique, is case * insensitive, enforces the UUID format, and can't be reused.

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

The user-provided idempotency token. The token must be unique, is case * insensitive, enforces the UUID format, and can't be reused.

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

Indicates whether the change request can be approved automatically without * the need for manual approvals.

If AutoApprovable is enabled * in a change template, then setting AutoApprove to true * in StartChangeRequestExecution creates a change request that * bypasses approver review.

Change Calendar restrictions are not * bypassed in this scenario. If the state of an associated calendar is * CLOSED, change freeze approvers must still grant permission for * this change request to run. If they don't, the change won't be processed until * the calendar state is again OPEN.

*/ inline bool GetAutoApprove() const{ return m_autoApprove; } /** *

Indicates whether the change request can be approved automatically without * the need for manual approvals.

If AutoApprovable is enabled * in a change template, then setting AutoApprove to true * in StartChangeRequestExecution creates a change request that * bypasses approver review.

Change Calendar restrictions are not * bypassed in this scenario. If the state of an associated calendar is * CLOSED, change freeze approvers must still grant permission for * this change request to run. If they don't, the change won't be processed until * the calendar state is again OPEN.

*/ inline bool AutoApproveHasBeenSet() const { return m_autoApproveHasBeenSet; } /** *

Indicates whether the change request can be approved automatically without * the need for manual approvals.

If AutoApprovable is enabled * in a change template, then setting AutoApprove to true * in StartChangeRequestExecution creates a change request that * bypasses approver review.

Change Calendar restrictions are not * bypassed in this scenario. If the state of an associated calendar is * CLOSED, change freeze approvers must still grant permission for * this change request to run. If they don't, the change won't be processed until * the calendar state is again OPEN.

*/ inline void SetAutoApprove(bool value) { m_autoApproveHasBeenSet = true; m_autoApprove = value; } /** *

Indicates whether the change request can be approved automatically without * the need for manual approvals.

If AutoApprovable is enabled * in a change template, then setting AutoApprove to true * in StartChangeRequestExecution creates a change request that * bypasses approver review.

Change Calendar restrictions are not * bypassed in this scenario. If the state of an associated calendar is * CLOSED, change freeze approvers must still grant permission for * this change request to run. If they don't, the change won't be processed until * the calendar state is again OPEN.

*/ inline StartChangeRequestExecutionRequest& WithAutoApprove(bool value) { SetAutoApprove(value); return *this;} /** *

Information about the Automation runbooks that are run during the runbook * workflow.

The Automation runbooks specified for the runbook * workflow can't run until all required approvals for the change request have been * received.

*/ inline const Aws::Vector& GetRunbooks() const{ return m_runbooks; } /** *

Information about the Automation runbooks that are run during the runbook * workflow.

The Automation runbooks specified for the runbook * workflow can't run until all required approvals for the change request have been * received.

*/ inline bool RunbooksHasBeenSet() const { return m_runbooksHasBeenSet; } /** *

Information about the Automation runbooks that are run during the runbook * workflow.

The Automation runbooks specified for the runbook * workflow can't run until all required approvals for the change request have been * received.

*/ inline void SetRunbooks(const Aws::Vector& value) { m_runbooksHasBeenSet = true; m_runbooks = value; } /** *

Information about the Automation runbooks that are run during the runbook * workflow.

The Automation runbooks specified for the runbook * workflow can't run until all required approvals for the change request have been * received.

*/ inline void SetRunbooks(Aws::Vector&& value) { m_runbooksHasBeenSet = true; m_runbooks = std::move(value); } /** *

Information about the Automation runbooks that are run during the runbook * workflow.

The Automation runbooks specified for the runbook * workflow can't run until all required approvals for the change request have been * received.

*/ inline StartChangeRequestExecutionRequest& WithRunbooks(const Aws::Vector& value) { SetRunbooks(value); return *this;} /** *

Information about the Automation runbooks that are run during the runbook * workflow.

The Automation runbooks specified for the runbook * workflow can't run until all required approvals for the change request have been * received.

*/ inline StartChangeRequestExecutionRequest& WithRunbooks(Aws::Vector&& value) { SetRunbooks(std::move(value)); return *this;} /** *

Information about the Automation runbooks that are run during the runbook * workflow.

The Automation runbooks specified for the runbook * workflow can't run until all required approvals for the change request have been * received.

*/ inline StartChangeRequestExecutionRequest& AddRunbooks(const Runbook& value) { m_runbooksHasBeenSet = true; m_runbooks.push_back(value); return *this; } /** *

Information about the Automation runbooks that are run during the runbook * workflow.

The Automation runbooks specified for the runbook * workflow can't run until all required approvals for the change request have been * received.

*/ inline StartChangeRequestExecutionRequest& AddRunbooks(Runbook&& value) { m_runbooksHasBeenSet = true; m_runbooks.push_back(std::move(value)); return *this; } /** *

Optional metadata that you assign to a resource. You can specify a maximum of * five tags for a change request. Tags enable you to categorize a resource in * different ways, such as by purpose, owner, or environment. For example, you * might want to tag a change request to identify an environment or target Amazon * Web Services Region. In this case, you could specify the following key-value * pairs:

  • Key=Environment,Value=Production

    *
  • Key=Region,Value=us-east-2

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

Optional metadata that you assign to a resource. You can specify a maximum of * five tags for a change request. Tags enable you to categorize a resource in * different ways, such as by purpose, owner, or environment. For example, you * might want to tag a change request to identify an environment or target Amazon * Web Services Region. In this case, you could specify the following key-value * pairs:

  • Key=Environment,Value=Production

    *
  • Key=Region,Value=us-east-2

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

Optional metadata that you assign to a resource. You can specify a maximum of * five tags for a change request. Tags enable you to categorize a resource in * different ways, such as by purpose, owner, or environment. For example, you * might want to tag a change request to identify an environment or target Amazon * Web Services Region. In this case, you could specify the following key-value * pairs:

  • Key=Environment,Value=Production

    *
  • Key=Region,Value=us-east-2

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

Optional metadata that you assign to a resource. You can specify a maximum of * five tags for a change request. Tags enable you to categorize a resource in * different ways, such as by purpose, owner, or environment. For example, you * might want to tag a change request to identify an environment or target Amazon * Web Services Region. In this case, you could specify the following key-value * pairs:

  • Key=Environment,Value=Production

    *
  • Key=Region,Value=us-east-2

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

Optional metadata that you assign to a resource. You can specify a maximum of * five tags for a change request. Tags enable you to categorize a resource in * different ways, such as by purpose, owner, or environment. For example, you * might want to tag a change request to identify an environment or target Amazon * Web Services Region. In this case, you could specify the following key-value * pairs:

  • Key=Environment,Value=Production

    *
  • Key=Region,Value=us-east-2

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

Optional metadata that you assign to a resource. You can specify a maximum of * five tags for a change request. Tags enable you to categorize a resource in * different ways, such as by purpose, owner, or environment. For example, you * might want to tag a change request to identify an environment or target Amazon * Web Services Region. In this case, you could specify the following key-value * pairs:

  • Key=Environment,Value=Production

    *
  • Key=Region,Value=us-east-2

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

Optional metadata that you assign to a resource. You can specify a maximum of * five tags for a change request. Tags enable you to categorize a resource in * different ways, such as by purpose, owner, or environment. For example, you * might want to tag a change request to identify an environment or target Amazon * Web Services Region. In this case, you could specify the following key-value * pairs:

  • Key=Environment,Value=Production

    *
  • Key=Region,Value=us-east-2

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

Optional metadata that you assign to a resource. You can specify a maximum of * five tags for a change request. Tags enable you to categorize a resource in * different ways, such as by purpose, owner, or environment. For example, you * might want to tag a change request to identify an environment or target Amazon * Web Services Region. In this case, you could specify the following key-value * pairs:

  • Key=Environment,Value=Production

    *
  • Key=Region,Value=us-east-2

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

The time that the requester expects the runbook workflow related to the * change request to complete. The time is an estimate only that the requester * provides for reviewers.

*/ inline const Aws::Utils::DateTime& GetScheduledEndTime() const{ return m_scheduledEndTime; } /** *

The time that the requester expects the runbook workflow related to the * change request to complete. The time is an estimate only that the requester * provides for reviewers.

*/ inline bool ScheduledEndTimeHasBeenSet() const { return m_scheduledEndTimeHasBeenSet; } /** *

The time that the requester expects the runbook workflow related to the * change request to complete. The time is an estimate only that the requester * provides for reviewers.

*/ inline void SetScheduledEndTime(const Aws::Utils::DateTime& value) { m_scheduledEndTimeHasBeenSet = true; m_scheduledEndTime = value; } /** *

The time that the requester expects the runbook workflow related to the * change request to complete. The time is an estimate only that the requester * provides for reviewers.

*/ inline void SetScheduledEndTime(Aws::Utils::DateTime&& value) { m_scheduledEndTimeHasBeenSet = true; m_scheduledEndTime = std::move(value); } /** *

The time that the requester expects the runbook workflow related to the * change request to complete. The time is an estimate only that the requester * provides for reviewers.

*/ inline StartChangeRequestExecutionRequest& WithScheduledEndTime(const Aws::Utils::DateTime& value) { SetScheduledEndTime(value); return *this;} /** *

The time that the requester expects the runbook workflow related to the * change request to complete. The time is an estimate only that the requester * provides for reviewers.

*/ inline StartChangeRequestExecutionRequest& WithScheduledEndTime(Aws::Utils::DateTime&& value) { SetScheduledEndTime(std::move(value)); return *this;} /** *

User-provided details about the change. If no details are provided, content * specified in the Template information section of the associated change * template is added.

*/ inline const Aws::String& GetChangeDetails() const{ return m_changeDetails; } /** *

User-provided details about the change. If no details are provided, content * specified in the Template information section of the associated change * template is added.

*/ inline bool ChangeDetailsHasBeenSet() const { return m_changeDetailsHasBeenSet; } /** *

User-provided details about the change. If no details are provided, content * specified in the Template information section of the associated change * template is added.

*/ inline void SetChangeDetails(const Aws::String& value) { m_changeDetailsHasBeenSet = true; m_changeDetails = value; } /** *

User-provided details about the change. If no details are provided, content * specified in the Template information section of the associated change * template is added.

*/ inline void SetChangeDetails(Aws::String&& value) { m_changeDetailsHasBeenSet = true; m_changeDetails = std::move(value); } /** *

User-provided details about the change. If no details are provided, content * specified in the Template information section of the associated change * template is added.

*/ inline void SetChangeDetails(const char* value) { m_changeDetailsHasBeenSet = true; m_changeDetails.assign(value); } /** *

User-provided details about the change. If no details are provided, content * specified in the Template information section of the associated change * template is added.

*/ inline StartChangeRequestExecutionRequest& WithChangeDetails(const Aws::String& value) { SetChangeDetails(value); return *this;} /** *

User-provided details about the change. If no details are provided, content * specified in the Template information section of the associated change * template is added.

*/ inline StartChangeRequestExecutionRequest& WithChangeDetails(Aws::String&& value) { SetChangeDetails(std::move(value)); return *this;} /** *

User-provided details about the change. If no details are provided, content * specified in the Template information section of the associated change * template is added.

*/ inline StartChangeRequestExecutionRequest& WithChangeDetails(const char* value) { SetChangeDetails(value); return *this;} private: Aws::Utils::DateTime m_scheduledTime; bool m_scheduledTimeHasBeenSet = false; Aws::String m_documentName; bool m_documentNameHasBeenSet = false; Aws::String m_documentVersion; bool m_documentVersionHasBeenSet = false; Aws::Map> m_parameters; bool m_parametersHasBeenSet = false; Aws::String m_changeRequestName; bool m_changeRequestNameHasBeenSet = false; Aws::String m_clientToken; bool m_clientTokenHasBeenSet = false; bool m_autoApprove; bool m_autoApproveHasBeenSet = false; Aws::Vector m_runbooks; bool m_runbooksHasBeenSet = false; Aws::Vector m_tags; bool m_tagsHasBeenSet = false; Aws::Utils::DateTime m_scheduledEndTime; bool m_scheduledEndTimeHasBeenSet = false; Aws::String m_changeDetails; bool m_changeDetailsHasBeenSet = false; }; } // namespace Model } // namespace SSM } // namespace Aws