/** * 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 Utils { namespace Xml { class XmlNode; } // namespace Xml } // namespace Utils namespace CloudFormation { namespace Model { /** *

The structures that contain summary information about the specified * operation.

*/ class StackSetOperationSummary { public: AWS_CLOUDFORMATION_API StackSetOperationSummary(); AWS_CLOUDFORMATION_API StackSetOperationSummary(const Aws::Utils::Xml::XmlNode& xmlNode); AWS_CLOUDFORMATION_API StackSetOperationSummary& operator=(const Aws::Utils::Xml::XmlNode& xmlNode); AWS_CLOUDFORMATION_API void OutputToStream(Aws::OStream& ostream, const char* location, unsigned index, const char* locationValue) const; AWS_CLOUDFORMATION_API void OutputToStream(Aws::OStream& oStream, const char* location) const; /** *

The unique ID of the stack set operation.

*/ inline const Aws::String& GetOperationId() const{ return m_operationId; } /** *

The unique ID of the stack set operation.

*/ inline bool OperationIdHasBeenSet() const { return m_operationIdHasBeenSet; } /** *

The unique ID of the stack set operation.

*/ inline void SetOperationId(const Aws::String& value) { m_operationIdHasBeenSet = true; m_operationId = value; } /** *

The unique ID of the stack set operation.

*/ inline void SetOperationId(Aws::String&& value) { m_operationIdHasBeenSet = true; m_operationId = std::move(value); } /** *

The unique ID of the stack set operation.

*/ inline void SetOperationId(const char* value) { m_operationIdHasBeenSet = true; m_operationId.assign(value); } /** *

The unique ID of the stack set operation.

*/ inline StackSetOperationSummary& WithOperationId(const Aws::String& value) { SetOperationId(value); return *this;} /** *

The unique ID of the stack set operation.

*/ inline StackSetOperationSummary& WithOperationId(Aws::String&& value) { SetOperationId(std::move(value)); return *this;} /** *

The unique ID of the stack set operation.

*/ inline StackSetOperationSummary& WithOperationId(const char* value) { SetOperationId(value); return *this;} /** *

The type of operation: CREATE, UPDATE, or * DELETE. Create and delete operations affect only the specified * stack instances that are associated with the specified stack set. Update * operations affect both the stack set itself and all associated stack set * instances.

*/ inline const StackSetOperationAction& GetAction() const{ return m_action; } /** *

*/ inline bool ActionHasBeenSet() const { return m_actionHasBeenSet; } /** *

*/ inline void SetAction(const StackSetOperationAction& value) { m_actionHasBeenSet = true; m_action = value; } /** *

*/ inline void SetAction(StackSetOperationAction&& value) { m_actionHasBeenSet = true; m_action = std::move(value); } /** *

*/ inline StackSetOperationSummary& WithAction(const StackSetOperationAction& value) { SetAction(value); return *this;} /** *

*/ inline StackSetOperationSummary& WithAction(StackSetOperationAction&& value) { SetAction(std::move(value)); return *this;} /** *

The overall status of the operation.

FAILED: * The operation exceeded the specified failure tolerance. The failure tolerance * value that you've set for an operation is applied for each Region during stack * create and update operations. If the number of failed stacks within a Region * exceeds the failure tolerance, the status of the operation in the Region is set * to FAILED. This in turn sets the status of the operation as a whole * to FAILED, and CloudFormation cancels the operation in any * remaining Regions.
QUEUED: [Service-managed * permissions] For automatic deployments that require a sequence of operations, * the operation is queued to be performed. For more information, see the stack * set operation status codes in the CloudFormation User Guide.
*
RUNNING: The operation is currently being performed.
STOPPED: The user has canceled the operation.
STOPPING: The operation is in the process of stopping, at * user request.
SUCCEEDED: The operation completed * creating or updating all the specified stacks without exceeding the failure * tolerance for the operation.

*/ inline const StackSetOperationStatus& GetStatus() const{ return m_status; } /** *

The overall status of the operation.

FAILED: * The operation exceeded the specified failure tolerance. The failure tolerance * value that you've set for an operation is applied for each Region during stack * create and update operations. If the number of failed stacks within a Region * exceeds the failure tolerance, the status of the operation in the Region is set * to FAILED. This in turn sets the status of the operation as a whole * to FAILED, and CloudFormation cancels the operation in any * remaining Regions.
QUEUED: [Service-managed * permissions] For automatic deployments that require a sequence of operations, * the operation is queued to be performed. For more information, see the stack * set operation status codes in the CloudFormation User Guide.
*
RUNNING: The operation is currently being performed.
STOPPED: The user has canceled the operation.
STOPPING: The operation is in the process of stopping, at * user request.
SUCCEEDED: The operation completed * creating or updating all the specified stacks without exceeding the failure * tolerance for the operation.

*/ inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; } /** *

The overall status of the operation.

FAILED: * The operation exceeded the specified failure tolerance. The failure tolerance * value that you've set for an operation is applied for each Region during stack * create and update operations. If the number of failed stacks within a Region * exceeds the failure tolerance, the status of the operation in the Region is set * to FAILED. This in turn sets the status of the operation as a whole * to FAILED, and CloudFormation cancels the operation in any * remaining Regions.
QUEUED: [Service-managed * permissions] For automatic deployments that require a sequence of operations, * the operation is queued to be performed. For more information, see the stack * set operation status codes in the CloudFormation User Guide.
*
RUNNING: The operation is currently being performed.
STOPPED: The user has canceled the operation.
STOPPING: The operation is in the process of stopping, at * user request.
SUCCEEDED: The operation completed * creating or updating all the specified stacks without exceeding the failure * tolerance for the operation.

*/ inline void SetStatus(const StackSetOperationStatus& value) { m_statusHasBeenSet = true; m_status = value; } /** *

The overall status of the operation.

FAILED: * The operation exceeded the specified failure tolerance. The failure tolerance * value that you've set for an operation is applied for each Region during stack * create and update operations. If the number of failed stacks within a Region * exceeds the failure tolerance, the status of the operation in the Region is set * to FAILED. This in turn sets the status of the operation as a whole * to FAILED, and CloudFormation cancels the operation in any * remaining Regions.
QUEUED: [Service-managed * permissions] For automatic deployments that require a sequence of operations, * the operation is queued to be performed. For more information, see the stack * set operation status codes in the CloudFormation User Guide.
*
RUNNING: The operation is currently being performed.
STOPPED: The user has canceled the operation.
STOPPING: The operation is in the process of stopping, at * user request.
SUCCEEDED: The operation completed * creating or updating all the specified stacks without exceeding the failure * tolerance for the operation.

*/ inline void SetStatus(StackSetOperationStatus&& value) { m_statusHasBeenSet = true; m_status = std::move(value); } /** *

The overall status of the operation.

FAILED: * The operation exceeded the specified failure tolerance. The failure tolerance * value that you've set for an operation is applied for each Region during stack * create and update operations. If the number of failed stacks within a Region * exceeds the failure tolerance, the status of the operation in the Region is set * to FAILED. This in turn sets the status of the operation as a whole * to FAILED, and CloudFormation cancels the operation in any * remaining Regions.
QUEUED: [Service-managed * permissions] For automatic deployments that require a sequence of operations, * the operation is queued to be performed. For more information, see the stack * set operation status codes in the CloudFormation User Guide.
*
RUNNING: The operation is currently being performed.
STOPPED: The user has canceled the operation.
STOPPING: The operation is in the process of stopping, at * user request.
SUCCEEDED: The operation completed * creating or updating all the specified stacks without exceeding the failure * tolerance for the operation.

*/ inline StackSetOperationSummary& WithStatus(const StackSetOperationStatus& value) { SetStatus(value); return *this;} /** *

The overall status of the operation.

FAILED: * The operation exceeded the specified failure tolerance. The failure tolerance * value that you've set for an operation is applied for each Region during stack * create and update operations. If the number of failed stacks within a Region * exceeds the failure tolerance, the status of the operation in the Region is set * to FAILED. This in turn sets the status of the operation as a whole * to FAILED, and CloudFormation cancels the operation in any * remaining Regions.
QUEUED: [Service-managed * permissions] For automatic deployments that require a sequence of operations, * the operation is queued to be performed. For more information, see the stack * set operation status codes in the CloudFormation User Guide.
*
RUNNING: The operation is currently being performed.
STOPPED: The user has canceled the operation.
STOPPING: The operation is in the process of stopping, at * user request.
SUCCEEDED: The operation completed * creating or updating all the specified stacks without exceeding the failure * tolerance for the operation.

*/ inline StackSetOperationSummary& WithStatus(StackSetOperationStatus&& value) { SetStatus(std::move(value)); return *this;} /** *

The time at which the operation was initiated. Note that the creation times * for the stack set operation might differ from the creation time of the * individual stacks themselves. This is because CloudFormation needs to perform * preparatory work for the operation, such as dispatching the work to the * requested Regions, before actually creating the first stacks.

*/ inline const Aws::Utils::DateTime& GetCreationTimestamp() const{ return m_creationTimestamp; } /** *

*/ inline bool CreationTimestampHasBeenSet() const { return m_creationTimestampHasBeenSet; } /** *

*/ inline void SetCreationTimestamp(const Aws::Utils::DateTime& value) { m_creationTimestampHasBeenSet = true; m_creationTimestamp = value; } /** *

*/ inline void SetCreationTimestamp(Aws::Utils::DateTime&& value) { m_creationTimestampHasBeenSet = true; m_creationTimestamp = std::move(value); } /** *

*/ inline StackSetOperationSummary& WithCreationTimestamp(const Aws::Utils::DateTime& value) { SetCreationTimestamp(value); return *this;} /** *

*/ inline StackSetOperationSummary& WithCreationTimestamp(Aws::Utils::DateTime&& value) { SetCreationTimestamp(std::move(value)); return *this;} /** *

The time at which the stack set operation ended, across all accounts and * Regions specified. Note that this doesn't necessarily mean that the stack set * operation was successful, or even attempted, in each account or Region.

*/ inline const Aws::Utils::DateTime& GetEndTimestamp() const{ return m_endTimestamp; } /** *

*/ inline bool EndTimestampHasBeenSet() const { return m_endTimestampHasBeenSet; } /** *

*/ inline void SetEndTimestamp(const Aws::Utils::DateTime& value) { m_endTimestampHasBeenSet = true; m_endTimestamp = value; } /** *

*/ inline void SetEndTimestamp(Aws::Utils::DateTime&& value) { m_endTimestampHasBeenSet = true; m_endTimestamp = std::move(value); } /** *

*/ inline StackSetOperationSummary& WithEndTimestamp(const Aws::Utils::DateTime& value) { SetEndTimestamp(value); return *this;} /** *

*/ inline StackSetOperationSummary& WithEndTimestamp(Aws::Utils::DateTime&& value) { SetEndTimestamp(std::move(value)); return *this;} /** *

The status of the operation in details.

*/ inline const Aws::String& GetStatusReason() const{ return m_statusReason; } /** *

The status of the operation in details.

*/ inline bool StatusReasonHasBeenSet() const { return m_statusReasonHasBeenSet; } /** *

The status of the operation in details.

*/ inline void SetStatusReason(const Aws::String& value) { m_statusReasonHasBeenSet = true; m_statusReason = value; } /** *

The status of the operation in details.

*/ inline void SetStatusReason(Aws::String&& value) { m_statusReasonHasBeenSet = true; m_statusReason = std::move(value); } /** *

The status of the operation in details.

*/ inline void SetStatusReason(const char* value) { m_statusReasonHasBeenSet = true; m_statusReason.assign(value); } /** *

The status of the operation in details.

*/ inline StackSetOperationSummary& WithStatusReason(const Aws::String& value) { SetStatusReason(value); return *this;} /** *

The status of the operation in details.

*/ inline StackSetOperationSummary& WithStatusReason(Aws::String&& value) { SetStatusReason(std::move(value)); return *this;} /** *

The status of the operation in details.

*/ inline StackSetOperationSummary& WithStatusReason(const char* value) { SetStatusReason(value); return *this;} /** *

Detailed information about the stack set operation.

*/ inline const StackSetOperationStatusDetails& GetStatusDetails() const{ return m_statusDetails; } /** *

Detailed information about the stack set operation.

*/ inline bool StatusDetailsHasBeenSet() const { return m_statusDetailsHasBeenSet; } /** *

Detailed information about the stack set operation.

*/ inline void SetStatusDetails(const StackSetOperationStatusDetails& value) { m_statusDetailsHasBeenSet = true; m_statusDetails = value; } /** *

Detailed information about the stack set operation.

*/ inline void SetStatusDetails(StackSetOperationStatusDetails&& value) { m_statusDetailsHasBeenSet = true; m_statusDetails = std::move(value); } /** *

Detailed information about the stack set operation.

*/ inline StackSetOperationSummary& WithStatusDetails(const StackSetOperationStatusDetails& value) { SetStatusDetails(value); return *this;} /** *

Detailed information about the stack set operation.

*/ inline StackSetOperationSummary& WithStatusDetails(StackSetOperationStatusDetails&& value) { SetStatusDetails(std::move(value)); return *this;} /** *

The user-specified preferences for how CloudFormation performs a stack set * operation.

For more information about maximum concurrent accounts and * failure tolerance, see Stack * set operation options.

*/ inline const StackSetOperationPreferences& GetOperationPreferences() const{ return m_operationPreferences; } /** *

The user-specified preferences for how CloudFormation performs a stack set * operation.

For more information about maximum concurrent accounts and * failure tolerance, see Stack * set operation options.

*/ inline bool OperationPreferencesHasBeenSet() const { return m_operationPreferencesHasBeenSet; } /** *

The user-specified preferences for how CloudFormation performs a stack set * operation.

For more information about maximum concurrent accounts and * failure tolerance, see Stack * set operation options.

*/ inline void SetOperationPreferences(const StackSetOperationPreferences& value) { m_operationPreferencesHasBeenSet = true; m_operationPreferences = value; } /** *

The user-specified preferences for how CloudFormation performs a stack set * operation.

For more information about maximum concurrent accounts and * failure tolerance, see Stack * set operation options.

*/ inline void SetOperationPreferences(StackSetOperationPreferences&& value) { m_operationPreferencesHasBeenSet = true; m_operationPreferences = std::move(value); } /** *

The user-specified preferences for how CloudFormation performs a stack set * operation.

For more information about maximum concurrent accounts and * failure tolerance, see Stack * set operation options.

*/ inline StackSetOperationSummary& WithOperationPreferences(const StackSetOperationPreferences& value) { SetOperationPreferences(value); return *this;} /** *

The user-specified preferences for how CloudFormation performs a stack set * operation.

For more information about maximum concurrent accounts and * failure tolerance, see Stack * set operation options.

*/ inline StackSetOperationSummary& WithOperationPreferences(StackSetOperationPreferences&& value) { SetOperationPreferences(std::move(value)); return *this;} private: Aws::String m_operationId; bool m_operationIdHasBeenSet = false; StackSetOperationAction m_action; bool m_actionHasBeenSet = false; StackSetOperationStatus m_status; bool m_statusHasBeenSet = false; Aws::Utils::DateTime m_creationTimestamp; bool m_creationTimestampHasBeenSet = false; Aws::Utils::DateTime m_endTimestamp; bool m_endTimestampHasBeenSet = false; Aws::String m_statusReason; bool m_statusReasonHasBeenSet = false; StackSetOperationStatusDetails m_statusDetails; bool m_statusDetailsHasBeenSet = false; StackSetOperationPreferences m_operationPreferences; bool m_operationPreferencesHasBeenSet = false; }; } // namespace Model } // namespace CloudFormation } // namespace Aws

See Also: