/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace CloudFormation { namespace Model { /** *

The input for the ExecuteChangeSet action.

See Also:

* AWS * API Reference

*/ class ExecuteChangeSetRequest : public CloudFormationRequest { public: AWS_CLOUDFORMATION_API ExecuteChangeSetRequest(); // 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 "ExecuteChangeSet"; } AWS_CLOUDFORMATION_API Aws::String SerializePayload() const override; protected: AWS_CLOUDFORMATION_API void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

The name or Amazon Resource Name (ARN) of the change set that you want use to * update the specified stack.

*/ inline const Aws::String& GetChangeSetName() const{ return m_changeSetName; } /** *

The name or Amazon Resource Name (ARN) of the change set that you want use to * update the specified stack.

*/ inline bool ChangeSetNameHasBeenSet() const { return m_changeSetNameHasBeenSet; } /** *

The name or Amazon Resource Name (ARN) of the change set that you want use to * update the specified stack.

*/ inline void SetChangeSetName(const Aws::String& value) { m_changeSetNameHasBeenSet = true; m_changeSetName = value; } /** *

The name or Amazon Resource Name (ARN) of the change set that you want use to * update the specified stack.

*/ inline void SetChangeSetName(Aws::String&& value) { m_changeSetNameHasBeenSet = true; m_changeSetName = std::move(value); } /** *

The name or Amazon Resource Name (ARN) of the change set that you want use to * update the specified stack.

*/ inline void SetChangeSetName(const char* value) { m_changeSetNameHasBeenSet = true; m_changeSetName.assign(value); } /** *

The name or Amazon Resource Name (ARN) of the change set that you want use to * update the specified stack.

*/ inline ExecuteChangeSetRequest& WithChangeSetName(const Aws::String& value) { SetChangeSetName(value); return *this;} /** *

The name or Amazon Resource Name (ARN) of the change set that you want use to * update the specified stack.

*/ inline ExecuteChangeSetRequest& WithChangeSetName(Aws::String&& value) { SetChangeSetName(std::move(value)); return *this;} /** *

The name or Amazon Resource Name (ARN) of the change set that you want use to * update the specified stack.

*/ inline ExecuteChangeSetRequest& WithChangeSetName(const char* value) { SetChangeSetName(value); return *this;} /** *

If you specified the name of a change set, specify the stack name or Amazon * Resource Name (ARN) that's associated with the change set you want to * execute.

*/ inline const Aws::String& GetStackName() const{ return m_stackName; } /** *

If you specified the name of a change set, specify the stack name or Amazon * Resource Name (ARN) that's associated with the change set you want to * execute.

*/ inline bool StackNameHasBeenSet() const { return m_stackNameHasBeenSet; } /** *

If you specified the name of a change set, specify the stack name or Amazon * Resource Name (ARN) that's associated with the change set you want to * execute.

*/ inline void SetStackName(const Aws::String& value) { m_stackNameHasBeenSet = true; m_stackName = value; } /** *

If you specified the name of a change set, specify the stack name or Amazon * Resource Name (ARN) that's associated with the change set you want to * execute.

*/ inline void SetStackName(Aws::String&& value) { m_stackNameHasBeenSet = true; m_stackName = std::move(value); } /** *

If you specified the name of a change set, specify the stack name or Amazon * Resource Name (ARN) that's associated with the change set you want to * execute.

*/ inline void SetStackName(const char* value) { m_stackNameHasBeenSet = true; m_stackName.assign(value); } /** *

If you specified the name of a change set, specify the stack name or Amazon * Resource Name (ARN) that's associated with the change set you want to * execute.

*/ inline ExecuteChangeSetRequest& WithStackName(const Aws::String& value) { SetStackName(value); return *this;} /** *

If you specified the name of a change set, specify the stack name or Amazon * Resource Name (ARN) that's associated with the change set you want to * execute.

*/ inline ExecuteChangeSetRequest& WithStackName(Aws::String&& value) { SetStackName(std::move(value)); return *this;} /** *

If you specified the name of a change set, specify the stack name or Amazon * Resource Name (ARN) that's associated with the change set you want to * execute.

*/ inline ExecuteChangeSetRequest& WithStackName(const char* value) { SetStackName(value); return *this;} /** *

A unique identifier for this ExecuteChangeSet request. Specify * this token if you plan to retry requests so that CloudFormation knows that * you're not attempting to execute a change set to update a stack with the same * name. You might retry ExecuteChangeSet requests to ensure that * CloudFormation successfully received them.

*/ inline const Aws::String& GetClientRequestToken() const{ return m_clientRequestToken; } /** *

A unique identifier for this ExecuteChangeSet request. Specify * this token if you plan to retry requests so that CloudFormation knows that * you're not attempting to execute a change set to update a stack with the same * name. You might retry ExecuteChangeSet requests to ensure that * CloudFormation successfully received them.

*/ inline bool ClientRequestTokenHasBeenSet() const { return m_clientRequestTokenHasBeenSet; } /** *

A unique identifier for this ExecuteChangeSet request. Specify * this token if you plan to retry requests so that CloudFormation knows that * you're not attempting to execute a change set to update a stack with the same * name. You might retry ExecuteChangeSet requests to ensure that * CloudFormation successfully received them.

*/ inline void SetClientRequestToken(const Aws::String& value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken = value; } /** *

A unique identifier for this ExecuteChangeSet request. Specify * this token if you plan to retry requests so that CloudFormation knows that * you're not attempting to execute a change set to update a stack with the same * name. You might retry ExecuteChangeSet requests to ensure that * CloudFormation successfully received them.

*/ inline void SetClientRequestToken(Aws::String&& value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken = std::move(value); } /** *

A unique identifier for this ExecuteChangeSet request. Specify * this token if you plan to retry requests so that CloudFormation knows that * you're not attempting to execute a change set to update a stack with the same * name. You might retry ExecuteChangeSet requests to ensure that * CloudFormation successfully received them.

*/ inline void SetClientRequestToken(const char* value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken.assign(value); } /** *

A unique identifier for this ExecuteChangeSet request. Specify * this token if you plan to retry requests so that CloudFormation knows that * you're not attempting to execute a change set to update a stack with the same * name. You might retry ExecuteChangeSet requests to ensure that * CloudFormation successfully received them.

*/ inline ExecuteChangeSetRequest& WithClientRequestToken(const Aws::String& value) { SetClientRequestToken(value); return *this;} /** *

A unique identifier for this ExecuteChangeSet request. Specify * this token if you plan to retry requests so that CloudFormation knows that * you're not attempting to execute a change set to update a stack with the same * name. You might retry ExecuteChangeSet requests to ensure that * CloudFormation successfully received them.

*/ inline ExecuteChangeSetRequest& WithClientRequestToken(Aws::String&& value) { SetClientRequestToken(std::move(value)); return *this;} /** *

A unique identifier for this ExecuteChangeSet request. Specify * this token if you plan to retry requests so that CloudFormation knows that * you're not attempting to execute a change set to update a stack with the same * name. You might retry ExecuteChangeSet requests to ensure that * CloudFormation successfully received them.

*/ inline ExecuteChangeSetRequest& WithClientRequestToken(const char* value) { SetClientRequestToken(value); return *this;} /** *

Preserves the state of previously provisioned resources when an operation * fails. This parameter can't be specified when the OnStackFailure * parameter to the CreateChangeSet * API operation was specified.

  • True - if the stack * creation fails, do nothing. This is equivalent to specifying * DO_NOTHING for the OnStackFailure parameter to the CreateChangeSet * API operation.

  • False - if the stack creation * fails, roll back the stack. This is equivalent to specifying * ROLLBACK for the OnStackFailure parameter to the CreateChangeSet * API operation.

Default: True

*/ inline bool GetDisableRollback() const{ return m_disableRollback; } /** *

Preserves the state of previously provisioned resources when an operation * fails. This parameter can't be specified when the OnStackFailure * parameter to the CreateChangeSet * API operation was specified.

  • True - if the stack * creation fails, do nothing. This is equivalent to specifying * DO_NOTHING for the OnStackFailure parameter to the CreateChangeSet * API operation.

  • False - if the stack creation * fails, roll back the stack. This is equivalent to specifying * ROLLBACK for the OnStackFailure parameter to the CreateChangeSet * API operation.

Default: True

*/ inline bool DisableRollbackHasBeenSet() const { return m_disableRollbackHasBeenSet; } /** *

Preserves the state of previously provisioned resources when an operation * fails. This parameter can't be specified when the OnStackFailure * parameter to the CreateChangeSet * API operation was specified.

  • True - if the stack * creation fails, do nothing. This is equivalent to specifying * DO_NOTHING for the OnStackFailure parameter to the CreateChangeSet * API operation.

  • False - if the stack creation * fails, roll back the stack. This is equivalent to specifying * ROLLBACK for the OnStackFailure parameter to the CreateChangeSet * API operation.

Default: True

*/ inline void SetDisableRollback(bool value) { m_disableRollbackHasBeenSet = true; m_disableRollback = value; } /** *

Preserves the state of previously provisioned resources when an operation * fails. This parameter can't be specified when the OnStackFailure * parameter to the CreateChangeSet * API operation was specified.

  • True - if the stack * creation fails, do nothing. This is equivalent to specifying * DO_NOTHING for the OnStackFailure parameter to the CreateChangeSet * API operation.

  • False - if the stack creation * fails, roll back the stack. This is equivalent to specifying * ROLLBACK for the OnStackFailure parameter to the CreateChangeSet * API operation.

Default: True

*/ inline ExecuteChangeSetRequest& WithDisableRollback(bool value) { SetDisableRollback(value); return *this;} /** *

This deletion policy deletes newly created resources, but retains existing * resources, when a stack operation is rolled back. This ensures new, empty, and * unused resources are deleted, while critical resources and their data are * retained. RetainExceptOnCreate can be specified for any resource * that supports the * DeletionPolicy attribute.

*/ inline bool GetRetainExceptOnCreate() const{ return m_retainExceptOnCreate; } /** *

This deletion policy deletes newly created resources, but retains existing * resources, when a stack operation is rolled back. This ensures new, empty, and * unused resources are deleted, while critical resources and their data are * retained. RetainExceptOnCreate can be specified for any resource * that supports the * DeletionPolicy attribute.

*/ inline bool RetainExceptOnCreateHasBeenSet() const { return m_retainExceptOnCreateHasBeenSet; } /** *

This deletion policy deletes newly created resources, but retains existing * resources, when a stack operation is rolled back. This ensures new, empty, and * unused resources are deleted, while critical resources and their data are * retained. RetainExceptOnCreate can be specified for any resource * that supports the * DeletionPolicy attribute.

*/ inline void SetRetainExceptOnCreate(bool value) { m_retainExceptOnCreateHasBeenSet = true; m_retainExceptOnCreate = value; } /** *

This deletion policy deletes newly created resources, but retains existing * resources, when a stack operation is rolled back. This ensures new, empty, and * unused resources are deleted, while critical resources and their data are * retained. RetainExceptOnCreate can be specified for any resource * that supports the * DeletionPolicy attribute.

*/ inline ExecuteChangeSetRequest& WithRetainExceptOnCreate(bool value) { SetRetainExceptOnCreate(value); return *this;} private: Aws::String m_changeSetName; bool m_changeSetNameHasBeenSet = false; Aws::String m_stackName; bool m_stackNameHasBeenSet = false; Aws::String m_clientRequestToken; bool m_clientRequestTokenHasBeenSet = false; bool m_disableRollback; bool m_disableRollbackHasBeenSet = false; bool m_retainExceptOnCreate; bool m_retainExceptOnCreateHasBeenSet = false; }; } // namespace Model } // namespace CloudFormation } // namespace Aws