/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { template class AmazonWebServiceResult; namespace Utils { namespace Json { class JsonValue; } // namespace Json } // namespace Utils namespace Backup { namespace Model { class DescribeFrameworkResult { public: AWS_BACKUP_API DescribeFrameworkResult(); AWS_BACKUP_API DescribeFrameworkResult(const Aws::AmazonWebServiceResult& result); AWS_BACKUP_API DescribeFrameworkResult& operator=(const Aws::AmazonWebServiceResult& result); /** *

The unique name of a framework.

*/ inline const Aws::String& GetFrameworkName() const{ return m_frameworkName; } /** *

The unique name of a framework.

*/ inline void SetFrameworkName(const Aws::String& value) { m_frameworkName = value; } /** *

The unique name of a framework.

*/ inline void SetFrameworkName(Aws::String&& value) { m_frameworkName = std::move(value); } /** *

The unique name of a framework.

*/ inline void SetFrameworkName(const char* value) { m_frameworkName.assign(value); } /** *

The unique name of a framework.

*/ inline DescribeFrameworkResult& WithFrameworkName(const Aws::String& value) { SetFrameworkName(value); return *this;} /** *

The unique name of a framework.

*/ inline DescribeFrameworkResult& WithFrameworkName(Aws::String&& value) { SetFrameworkName(std::move(value)); return *this;} /** *

The unique name of a framework.

*/ inline DescribeFrameworkResult& WithFrameworkName(const char* value) { SetFrameworkName(value); return *this;} /** *

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format * of the ARN depends on the resource type.

*/ inline const Aws::String& GetFrameworkArn() const{ return m_frameworkArn; } /** *

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format * of the ARN depends on the resource type.

*/ inline void SetFrameworkArn(const Aws::String& value) { m_frameworkArn = value; } /** *

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format * of the ARN depends on the resource type.

*/ inline void SetFrameworkArn(Aws::String&& value) { m_frameworkArn = std::move(value); } /** *

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format * of the ARN depends on the resource type.

*/ inline void SetFrameworkArn(const char* value) { m_frameworkArn.assign(value); } /** *

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format * of the ARN depends on the resource type.

*/ inline DescribeFrameworkResult& WithFrameworkArn(const Aws::String& value) { SetFrameworkArn(value); return *this;} /** *

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format * of the ARN depends on the resource type.

*/ inline DescribeFrameworkResult& WithFrameworkArn(Aws::String&& value) { SetFrameworkArn(std::move(value)); return *this;} /** *

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format * of the ARN depends on the resource type.

*/ inline DescribeFrameworkResult& WithFrameworkArn(const char* value) { SetFrameworkArn(value); return *this;} /** *

An optional description of the framework.

*/ inline const Aws::String& GetFrameworkDescription() const{ return m_frameworkDescription; } /** *

An optional description of the framework.

*/ inline void SetFrameworkDescription(const Aws::String& value) { m_frameworkDescription = value; } /** *

An optional description of the framework.

*/ inline void SetFrameworkDescription(Aws::String&& value) { m_frameworkDescription = std::move(value); } /** *

An optional description of the framework.

*/ inline void SetFrameworkDescription(const char* value) { m_frameworkDescription.assign(value); } /** *

An optional description of the framework.

*/ inline DescribeFrameworkResult& WithFrameworkDescription(const Aws::String& value) { SetFrameworkDescription(value); return *this;} /** *

An optional description of the framework.

*/ inline DescribeFrameworkResult& WithFrameworkDescription(Aws::String&& value) { SetFrameworkDescription(std::move(value)); return *this;} /** *

An optional description of the framework.

*/ inline DescribeFrameworkResult& WithFrameworkDescription(const char* value) { SetFrameworkDescription(value); return *this;} /** *

A list of the controls that make up the framework. Each control in the list * has a name, input parameters, and scope.

*/ inline const Aws::Vector& GetFrameworkControls() const{ return m_frameworkControls; } /** *

A list of the controls that make up the framework. Each control in the list * has a name, input parameters, and scope.

*/ inline void SetFrameworkControls(const Aws::Vector& value) { m_frameworkControls = value; } /** *

A list of the controls that make up the framework. Each control in the list * has a name, input parameters, and scope.

*/ inline void SetFrameworkControls(Aws::Vector&& value) { m_frameworkControls = std::move(value); } /** *

A list of the controls that make up the framework. Each control in the list * has a name, input parameters, and scope.

*/ inline DescribeFrameworkResult& WithFrameworkControls(const Aws::Vector& value) { SetFrameworkControls(value); return *this;} /** *

A list of the controls that make up the framework. Each control in the list * has a name, input parameters, and scope.

*/ inline DescribeFrameworkResult& WithFrameworkControls(Aws::Vector&& value) { SetFrameworkControls(std::move(value)); return *this;} /** *

A list of the controls that make up the framework. Each control in the list * has a name, input parameters, and scope.

*/ inline DescribeFrameworkResult& AddFrameworkControls(const FrameworkControl& value) { m_frameworkControls.push_back(value); return *this; } /** *

A list of the controls that make up the framework. Each control in the list * has a name, input parameters, and scope.

*/ inline DescribeFrameworkResult& AddFrameworkControls(FrameworkControl&& value) { m_frameworkControls.push_back(std::move(value)); return *this; } /** *

The date and time that a framework is created, in ISO 8601 representation. * The value of CreationTime is accurate to milliseconds. For example, * 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 * hours behind UTC.

*/ inline const Aws::Utils::DateTime& GetCreationTime() const{ return m_creationTime; } /** *

The date and time that a framework is created, in ISO 8601 representation. * The value of CreationTime is accurate to milliseconds. For example, * 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 * hours behind UTC.

*/ inline void SetCreationTime(const Aws::Utils::DateTime& value) { m_creationTime = value; } /** *

The date and time that a framework is created, in ISO 8601 representation. * The value of CreationTime is accurate to milliseconds. For example, * 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 * hours behind UTC.

*/ inline void SetCreationTime(Aws::Utils::DateTime&& value) { m_creationTime = std::move(value); } /** *

The date and time that a framework is created, in ISO 8601 representation. * The value of CreationTime is accurate to milliseconds. For example, * 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 * hours behind UTC.

*/ inline DescribeFrameworkResult& WithCreationTime(const Aws::Utils::DateTime& value) { SetCreationTime(value); return *this;} /** *

The date and time that a framework is created, in ISO 8601 representation. * The value of CreationTime is accurate to milliseconds. For example, * 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 * hours behind UTC.

*/ inline DescribeFrameworkResult& WithCreationTime(Aws::Utils::DateTime&& value) { SetCreationTime(std::move(value)); return *this;} /** *

The deployment status of a framework. The statuses are:

* CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | * FAILED

*/ inline const Aws::String& GetDeploymentStatus() const{ return m_deploymentStatus; } /** *

The deployment status of a framework. The statuses are:

* CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | * FAILED

*/ inline void SetDeploymentStatus(const Aws::String& value) { m_deploymentStatus = value; } /** *

The deployment status of a framework. The statuses are:

* CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | * FAILED

*/ inline void SetDeploymentStatus(Aws::String&& value) { m_deploymentStatus = std::move(value); } /** *

The deployment status of a framework. The statuses are:

* CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | * FAILED

*/ inline void SetDeploymentStatus(const char* value) { m_deploymentStatus.assign(value); } /** *

The deployment status of a framework. The statuses are:

* CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | * FAILED

*/ inline DescribeFrameworkResult& WithDeploymentStatus(const Aws::String& value) { SetDeploymentStatus(value); return *this;} /** *

The deployment status of a framework. The statuses are:

* CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | * FAILED

*/ inline DescribeFrameworkResult& WithDeploymentStatus(Aws::String&& value) { SetDeploymentStatus(std::move(value)); return *this;} /** *

The deployment status of a framework. The statuses are:

* CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | * FAILED

*/ inline DescribeFrameworkResult& WithDeploymentStatus(const char* value) { SetDeploymentStatus(value); return *this;} /** *

A framework consists of one or more controls. Each control governs a * resource, such as backup plans, backup selections, backup vaults, or recovery * points. You can also turn Config recording on or off for each resource. The * statuses are:

  • ACTIVE when recording is turned on * for all resources governed by the framework.

  • * PARTIALLY_ACTIVE when recording is turned off for at least one * resource governed by the framework.

  • INACTIVE * when recording is turned off for all resources governed by the framework.

    *

  • UNAVAILABLE when Backup is unable to validate * recording status at this time.

*/ inline const Aws::String& GetFrameworkStatus() const{ return m_frameworkStatus; } /** *

A framework consists of one or more controls. Each control governs a * resource, such as backup plans, backup selections, backup vaults, or recovery * points. You can also turn Config recording on or off for each resource. The * statuses are:

  • ACTIVE when recording is turned on * for all resources governed by the framework.

  • * PARTIALLY_ACTIVE when recording is turned off for at least one * resource governed by the framework.

  • INACTIVE * when recording is turned off for all resources governed by the framework.

    *

  • UNAVAILABLE when Backup is unable to validate * recording status at this time.

*/ inline void SetFrameworkStatus(const Aws::String& value) { m_frameworkStatus = value; } /** *

A framework consists of one or more controls. Each control governs a * resource, such as backup plans, backup selections, backup vaults, or recovery * points. You can also turn Config recording on or off for each resource. The * statuses are:

  • ACTIVE when recording is turned on * for all resources governed by the framework.

  • * PARTIALLY_ACTIVE when recording is turned off for at least one * resource governed by the framework.

  • INACTIVE * when recording is turned off for all resources governed by the framework.

    *

  • UNAVAILABLE when Backup is unable to validate * recording status at this time.

*/ inline void SetFrameworkStatus(Aws::String&& value) { m_frameworkStatus = std::move(value); } /** *

A framework consists of one or more controls. Each control governs a * resource, such as backup plans, backup selections, backup vaults, or recovery * points. You can also turn Config recording on or off for each resource. The * statuses are:

  • ACTIVE when recording is turned on * for all resources governed by the framework.

  • * PARTIALLY_ACTIVE when recording is turned off for at least one * resource governed by the framework.

  • INACTIVE * when recording is turned off for all resources governed by the framework.

    *

  • UNAVAILABLE when Backup is unable to validate * recording status at this time.

*/ inline void SetFrameworkStatus(const char* value) { m_frameworkStatus.assign(value); } /** *

A framework consists of one or more controls. Each control governs a * resource, such as backup plans, backup selections, backup vaults, or recovery * points. You can also turn Config recording on or off for each resource. The * statuses are:

  • ACTIVE when recording is turned on * for all resources governed by the framework.

  • * PARTIALLY_ACTIVE when recording is turned off for at least one * resource governed by the framework.

  • INACTIVE * when recording is turned off for all resources governed by the framework.

    *

  • UNAVAILABLE when Backup is unable to validate * recording status at this time.

*/ inline DescribeFrameworkResult& WithFrameworkStatus(const Aws::String& value) { SetFrameworkStatus(value); return *this;} /** *

A framework consists of one or more controls. Each control governs a * resource, such as backup plans, backup selections, backup vaults, or recovery * points. You can also turn Config recording on or off for each resource. The * statuses are:

  • ACTIVE when recording is turned on * for all resources governed by the framework.

  • * PARTIALLY_ACTIVE when recording is turned off for at least one * resource governed by the framework.

  • INACTIVE * when recording is turned off for all resources governed by the framework.

    *

  • UNAVAILABLE when Backup is unable to validate * recording status at this time.

*/ inline DescribeFrameworkResult& WithFrameworkStatus(Aws::String&& value) { SetFrameworkStatus(std::move(value)); return *this;} /** *

A framework consists of one or more controls. Each control governs a * resource, such as backup plans, backup selections, backup vaults, or recovery * points. You can also turn Config recording on or off for each resource. The * statuses are:

  • ACTIVE when recording is turned on * for all resources governed by the framework.

  • * PARTIALLY_ACTIVE when recording is turned off for at least one * resource governed by the framework.

  • INACTIVE * when recording is turned off for all resources governed by the framework.

    *

  • UNAVAILABLE when Backup is unable to validate * recording status at this time.

*/ inline DescribeFrameworkResult& WithFrameworkStatus(const char* value) { SetFrameworkStatus(value); return *this;} /** *

A customer-chosen string that you can use to distinguish between otherwise * identical calls to DescribeFrameworkOutput. Retrying a successful * request with the same idempotency token results in a success message with no * action taken.

*/ inline const Aws::String& GetIdempotencyToken() const{ return m_idempotencyToken; } /** *

A customer-chosen string that you can use to distinguish between otherwise * identical calls to DescribeFrameworkOutput. Retrying a successful * request with the same idempotency token results in a success message with no * action taken.

*/ inline void SetIdempotencyToken(const Aws::String& value) { m_idempotencyToken = value; } /** *

A customer-chosen string that you can use to distinguish between otherwise * identical calls to DescribeFrameworkOutput. Retrying a successful * request with the same idempotency token results in a success message with no * action taken.

*/ inline void SetIdempotencyToken(Aws::String&& value) { m_idempotencyToken = std::move(value); } /** *

A customer-chosen string that you can use to distinguish between otherwise * identical calls to DescribeFrameworkOutput. Retrying a successful * request with the same idempotency token results in a success message with no * action taken.

*/ inline void SetIdempotencyToken(const char* value) { m_idempotencyToken.assign(value); } /** *

A customer-chosen string that you can use to distinguish between otherwise * identical calls to DescribeFrameworkOutput. Retrying a successful * request with the same idempotency token results in a success message with no * action taken.

*/ inline DescribeFrameworkResult& WithIdempotencyToken(const Aws::String& value) { SetIdempotencyToken(value); return *this;} /** *

A customer-chosen string that you can use to distinguish between otherwise * identical calls to DescribeFrameworkOutput. Retrying a successful * request with the same idempotency token results in a success message with no * action taken.

*/ inline DescribeFrameworkResult& WithIdempotencyToken(Aws::String&& value) { SetIdempotencyToken(std::move(value)); return *this;} /** *

A customer-chosen string that you can use to distinguish between otherwise * identical calls to DescribeFrameworkOutput. Retrying a successful * request with the same idempotency token results in a success message with no * action taken.

*/ inline DescribeFrameworkResult& WithIdempotencyToken(const char* value) { SetIdempotencyToken(value); return *this;} inline const Aws::String& GetRequestId() const{ return m_requestId; } inline void SetRequestId(const Aws::String& value) { m_requestId = value; } inline void SetRequestId(Aws::String&& value) { m_requestId = std::move(value); } inline void SetRequestId(const char* value) { m_requestId.assign(value); } inline DescribeFrameworkResult& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} inline DescribeFrameworkResult& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} inline DescribeFrameworkResult& WithRequestId(const char* value) { SetRequestId(value); return *this;} private: Aws::String m_frameworkName; Aws::String m_frameworkArn; Aws::String m_frameworkDescription; Aws::Vector m_frameworkControls; Aws::Utils::DateTime m_creationTime; Aws::String m_deploymentStatus; Aws::String m_frameworkStatus; Aws::String m_idempotencyToken; Aws::String m_requestId; }; } // namespace Model } // namespace Backup } // namespace Aws