/** * 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 { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace Athena { namespace Model { /** *

A workgroup, which contains a name, description, creation time, state, and * other configuration, listed under WorkGroup$Configuration. Each workgroup * enables you to isolate queries for you or your group of users from other queries * in the same account, to configure the query results location and the encryption * configuration (known as workgroup settings), to enable sending query metrics to * Amazon CloudWatch, and to establish per-query data usage control limits for all * queries in a workgroup. The workgroup settings override is specified in * EnforceWorkGroupConfiguration (true/false) in the * WorkGroupConfiguration. See * WorkGroupConfiguration$EnforceWorkGroupConfiguration.

See * Also:

AWS * API Reference

*/ class WorkGroup { public: AWS_ATHENA_API WorkGroup(); AWS_ATHENA_API WorkGroup(Aws::Utils::Json::JsonView jsonValue); AWS_ATHENA_API WorkGroup& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_ATHENA_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The workgroup name.

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

The workgroup name.

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

The workgroup name.

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

The workgroup name.

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

The workgroup name.

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

The workgroup name.

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

The workgroup name.

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

The workgroup name.

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

The state of the workgroup: ENABLED or DISABLED.

*/ inline const WorkGroupState& GetState() const{ return m_state; } /** *

The state of the workgroup: ENABLED or DISABLED.

*/ inline bool StateHasBeenSet() const { return m_stateHasBeenSet; } /** *

The state of the workgroup: ENABLED or DISABLED.

*/ inline void SetState(const WorkGroupState& value) { m_stateHasBeenSet = true; m_state = value; } /** *

The state of the workgroup: ENABLED or DISABLED.

*/ inline void SetState(WorkGroupState&& value) { m_stateHasBeenSet = true; m_state = std::move(value); } /** *

The state of the workgroup: ENABLED or DISABLED.

*/ inline WorkGroup& WithState(const WorkGroupState& value) { SetState(value); return *this;} /** *

The state of the workgroup: ENABLED or DISABLED.

*/ inline WorkGroup& WithState(WorkGroupState&& value) { SetState(std::move(value)); return *this;} /** *

The configuration of the workgroup, which includes the location in Amazon S3 * where query and calculation results are stored, the encryption configuration, if * any, used for query and calculation results; whether the Amazon CloudWatch * Metrics are enabled for the workgroup; whether workgroup settings override * client-side settings; and the data usage limits for the amount of data scanned * per query or per workgroup. The workgroup settings override is specified in * EnforceWorkGroupConfiguration (true/false) in the * WorkGroupConfiguration. See * WorkGroupConfiguration$EnforceWorkGroupConfiguration.

*/ inline const WorkGroupConfiguration& GetConfiguration() const{ return m_configuration; } /** *

The configuration of the workgroup, which includes the location in Amazon S3 * where query and calculation results are stored, the encryption configuration, if * any, used for query and calculation results; whether the Amazon CloudWatch * Metrics are enabled for the workgroup; whether workgroup settings override * client-side settings; and the data usage limits for the amount of data scanned * per query or per workgroup. The workgroup settings override is specified in * EnforceWorkGroupConfiguration (true/false) in the * WorkGroupConfiguration. See * WorkGroupConfiguration$EnforceWorkGroupConfiguration.

*/ inline bool ConfigurationHasBeenSet() const { return m_configurationHasBeenSet; } /** *

The configuration of the workgroup, which includes the location in Amazon S3 * where query and calculation results are stored, the encryption configuration, if * any, used for query and calculation results; whether the Amazon CloudWatch * Metrics are enabled for the workgroup; whether workgroup settings override * client-side settings; and the data usage limits for the amount of data scanned * per query or per workgroup. The workgroup settings override is specified in * EnforceWorkGroupConfiguration (true/false) in the * WorkGroupConfiguration. See * WorkGroupConfiguration$EnforceWorkGroupConfiguration.

*/ inline void SetConfiguration(const WorkGroupConfiguration& value) { m_configurationHasBeenSet = true; m_configuration = value; } /** *

The configuration of the workgroup, which includes the location in Amazon S3 * where query and calculation results are stored, the encryption configuration, if * any, used for query and calculation results; whether the Amazon CloudWatch * Metrics are enabled for the workgroup; whether workgroup settings override * client-side settings; and the data usage limits for the amount of data scanned * per query or per workgroup. The workgroup settings override is specified in * EnforceWorkGroupConfiguration (true/false) in the * WorkGroupConfiguration. See * WorkGroupConfiguration$EnforceWorkGroupConfiguration.

*/ inline void SetConfiguration(WorkGroupConfiguration&& value) { m_configurationHasBeenSet = true; m_configuration = std::move(value); } /** *

The configuration of the workgroup, which includes the location in Amazon S3 * where query and calculation results are stored, the encryption configuration, if * any, used for query and calculation results; whether the Amazon CloudWatch * Metrics are enabled for the workgroup; whether workgroup settings override * client-side settings; and the data usage limits for the amount of data scanned * per query or per workgroup. The workgroup settings override is specified in * EnforceWorkGroupConfiguration (true/false) in the * WorkGroupConfiguration. See * WorkGroupConfiguration$EnforceWorkGroupConfiguration.

*/ inline WorkGroup& WithConfiguration(const WorkGroupConfiguration& value) { SetConfiguration(value); return *this;} /** *

The configuration of the workgroup, which includes the location in Amazon S3 * where query and calculation results are stored, the encryption configuration, if * any, used for query and calculation results; whether the Amazon CloudWatch * Metrics are enabled for the workgroup; whether workgroup settings override * client-side settings; and the data usage limits for the amount of data scanned * per query or per workgroup. The workgroup settings override is specified in * EnforceWorkGroupConfiguration (true/false) in the * WorkGroupConfiguration. See * WorkGroupConfiguration$EnforceWorkGroupConfiguration.

*/ inline WorkGroup& WithConfiguration(WorkGroupConfiguration&& value) { SetConfiguration(std::move(value)); return *this;} /** *

The workgroup description.

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

The workgroup description.

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

The workgroup description.

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

The workgroup description.

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

The workgroup description.

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

The workgroup description.

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

The workgroup description.

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

The workgroup description.

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

The date and time the workgroup was created.

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

The date and time the workgroup was created.

*/ inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; } /** *

The date and time the workgroup was created.

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

The date and time the workgroup was created.

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

The date and time the workgroup was created.

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

The date and time the workgroup was created.

*/ inline WorkGroup& WithCreationTime(Aws::Utils::DateTime&& value) { SetCreationTime(std::move(value)); return *this;} private: Aws::String m_name; bool m_nameHasBeenSet = false; WorkGroupState m_state; bool m_stateHasBeenSet = false; WorkGroupConfiguration m_configuration; bool m_configurationHasBeenSet = false; Aws::String m_description; bool m_descriptionHasBeenSet = false; Aws::Utils::DateTime m_creationTime; bool m_creationTimeHasBeenSet = false; }; } // namespace Model } // namespace Athena } // namespace Aws