AWS SDK for C++  1.9.129
AWS SDK for C++
Public Member Functions | List of all members
Aws::Athena::Model::WorkGroupConfigurationUpdates Class Reference

#include <WorkGroupConfigurationUpdates.h>

Public Member Functions

 WorkGroupConfigurationUpdates ()
 
 WorkGroupConfigurationUpdates (Aws::Utils::Json::JsonView jsonValue)
 
WorkGroupConfigurationUpdatesoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
bool GetEnforceWorkGroupConfiguration () const
 
bool EnforceWorkGroupConfigurationHasBeenSet () const
 
void SetEnforceWorkGroupConfiguration (bool value)
 
WorkGroupConfigurationUpdatesWithEnforceWorkGroupConfiguration (bool value)
 
const ResultConfigurationUpdatesGetResultConfigurationUpdates () const
 
bool ResultConfigurationUpdatesHasBeenSet () const
 
void SetResultConfigurationUpdates (const ResultConfigurationUpdates &value)
 
void SetResultConfigurationUpdates (ResultConfigurationUpdates &&value)
 
WorkGroupConfigurationUpdatesWithResultConfigurationUpdates (const ResultConfigurationUpdates &value)
 
WorkGroupConfigurationUpdatesWithResultConfigurationUpdates (ResultConfigurationUpdates &&value)
 
bool GetPublishCloudWatchMetricsEnabled () const
 
bool PublishCloudWatchMetricsEnabledHasBeenSet () const
 
void SetPublishCloudWatchMetricsEnabled (bool value)
 
WorkGroupConfigurationUpdatesWithPublishCloudWatchMetricsEnabled (bool value)
 
long long GetBytesScannedCutoffPerQuery () const
 
bool BytesScannedCutoffPerQueryHasBeenSet () const
 
void SetBytesScannedCutoffPerQuery (long long value)
 
WorkGroupConfigurationUpdatesWithBytesScannedCutoffPerQuery (long long value)
 
bool GetRemoveBytesScannedCutoffPerQuery () const
 
bool RemoveBytesScannedCutoffPerQueryHasBeenSet () const
 
void SetRemoveBytesScannedCutoffPerQuery (bool value)
 
WorkGroupConfigurationUpdatesWithRemoveBytesScannedCutoffPerQuery (bool value)
 
bool GetRequesterPaysEnabled () const
 
bool RequesterPaysEnabledHasBeenSet () const
 
void SetRequesterPaysEnabled (bool value)
 
WorkGroupConfigurationUpdatesWithRequesterPaysEnabled (bool value)
 
const EngineVersionGetEngineVersion () const
 
bool EngineVersionHasBeenSet () const
 
void SetEngineVersion (const EngineVersion &value)
 
void SetEngineVersion (EngineVersion &&value)
 
WorkGroupConfigurationUpdatesWithEngineVersion (const EngineVersion &value)
 
WorkGroupConfigurationUpdatesWithEngineVersion (EngineVersion &&value)
 

Detailed Description

The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified.

See Also:

AWS API Reference

Definition at line 37 of file WorkGroupConfigurationUpdates.h.

Constructor & Destructor Documentation

◆ WorkGroupConfigurationUpdates() [1/2]

Aws::Athena::Model::WorkGroupConfigurationUpdates::WorkGroupConfigurationUpdates ( )

◆ WorkGroupConfigurationUpdates() [2/2]

Aws::Athena::Model::WorkGroupConfigurationUpdates::WorkGroupConfigurationUpdates ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ BytesScannedCutoffPerQueryHasBeenSet()

bool Aws::Athena::Model::WorkGroupConfigurationUpdates::BytesScannedCutoffPerQueryHasBeenSet ( ) const
inline

The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

Definition at line 161 of file WorkGroupConfigurationUpdates.h.

◆ EnforceWorkGroupConfigurationHasBeenSet()

bool Aws::Athena::Model::WorkGroupConfigurationUpdates::EnforceWorkGroupConfigurationHasBeenSet ( ) const
inline

If set to "true", the settings for the workgroup override client-side settings. If set to "false" client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.

Definition at line 62 of file WorkGroupConfigurationUpdates.h.

◆ EngineVersionHasBeenSet()

bool Aws::Athena::Model::WorkGroupConfigurationUpdates::EngineVersionHasBeenSet ( ) const
inline

The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

Definition at line 270 of file WorkGroupConfigurationUpdates.h.

◆ GetBytesScannedCutoffPerQuery()

long long Aws::Athena::Model::WorkGroupConfigurationUpdates::GetBytesScannedCutoffPerQuery ( ) const
inline

The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

Definition at line 155 of file WorkGroupConfigurationUpdates.h.

◆ GetEnforceWorkGroupConfiguration()

bool Aws::Athena::Model::WorkGroupConfigurationUpdates::GetEnforceWorkGroupConfiguration ( ) const
inline

If set to "true", the settings for the workgroup override client-side settings. If set to "false" client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.

Definition at line 53 of file WorkGroupConfigurationUpdates.h.

◆ GetEngineVersion()

const EngineVersion& Aws::Athena::Model::WorkGroupConfigurationUpdates::GetEngineVersion ( ) const
inline

The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

Definition at line 261 of file WorkGroupConfigurationUpdates.h.

◆ GetPublishCloudWatchMetricsEnabled()

bool Aws::Athena::Model::WorkGroupConfigurationUpdates::GetPublishCloudWatchMetricsEnabled ( ) const
inline

Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.

Definition at line 130 of file WorkGroupConfigurationUpdates.h.

◆ GetRemoveBytesScannedCutoffPerQuery()

bool Aws::Athena::Model::WorkGroupConfigurationUpdates::GetRemoveBytesScannedCutoffPerQuery ( ) const
inline

Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery

Definition at line 180 of file WorkGroupConfigurationUpdates.h.

◆ GetRequesterPaysEnabled()

bool Aws::Athena::Model::WorkGroupConfigurationUpdates::GetRequesterPaysEnabled ( ) const
inline

If set to true, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.

Definition at line 212 of file WorkGroupConfigurationUpdates.h.

◆ GetResultConfigurationUpdates()

const ResultConfigurationUpdates& Aws::Athena::Model::WorkGroupConfigurationUpdates::GetResultConfigurationUpdates ( ) const
inline

The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.

Definition at line 88 of file WorkGroupConfigurationUpdates.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Athena::Model::WorkGroupConfigurationUpdates::Jsonize ( ) const

◆ operator=()

WorkGroupConfigurationUpdates& Aws::Athena::Model::WorkGroupConfigurationUpdates::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PublishCloudWatchMetricsEnabledHasBeenSet()

bool Aws::Athena::Model::WorkGroupConfigurationUpdates::PublishCloudWatchMetricsEnabledHasBeenSet ( ) const
inline

Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.

Definition at line 136 of file WorkGroupConfigurationUpdates.h.

◆ RemoveBytesScannedCutoffPerQueryHasBeenSet()

bool Aws::Athena::Model::WorkGroupConfigurationUpdates::RemoveBytesScannedCutoffPerQueryHasBeenSet ( ) const
inline

Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery

Definition at line 186 of file WorkGroupConfigurationUpdates.h.

◆ RequesterPaysEnabledHasBeenSet()

bool Aws::Athena::Model::WorkGroupConfigurationUpdates::RequesterPaysEnabledHasBeenSet ( ) const
inline

If set to true, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.

Definition at line 225 of file WorkGroupConfigurationUpdates.h.

◆ ResultConfigurationUpdatesHasBeenSet()

bool Aws::Athena::Model::WorkGroupConfigurationUpdates::ResultConfigurationUpdatesHasBeenSet ( ) const
inline

The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.

Definition at line 95 of file WorkGroupConfigurationUpdates.h.

◆ SetBytesScannedCutoffPerQuery()

void Aws::Athena::Model::WorkGroupConfigurationUpdates::SetBytesScannedCutoffPerQuery ( long long  value)
inline

The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

Definition at line 167 of file WorkGroupConfigurationUpdates.h.

◆ SetEnforceWorkGroupConfiguration()

void Aws::Athena::Model::WorkGroupConfigurationUpdates::SetEnforceWorkGroupConfiguration ( bool  value)
inline

If set to "true", the settings for the workgroup override client-side settings. If set to "false" client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.

Definition at line 71 of file WorkGroupConfigurationUpdates.h.

◆ SetEngineVersion() [1/2]

void Aws::Athena::Model::WorkGroupConfigurationUpdates::SetEngineVersion ( const EngineVersion value)
inline

The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

Definition at line 279 of file WorkGroupConfigurationUpdates.h.

◆ SetEngineVersion() [2/2]

void Aws::Athena::Model::WorkGroupConfigurationUpdates::SetEngineVersion ( EngineVersion &&  value)
inline

The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

Definition at line 288 of file WorkGroupConfigurationUpdates.h.

◆ SetPublishCloudWatchMetricsEnabled()

void Aws::Athena::Model::WorkGroupConfigurationUpdates::SetPublishCloudWatchMetricsEnabled ( bool  value)
inline

Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.

Definition at line 142 of file WorkGroupConfigurationUpdates.h.

◆ SetRemoveBytesScannedCutoffPerQuery()

void Aws::Athena::Model::WorkGroupConfigurationUpdates::SetRemoveBytesScannedCutoffPerQuery ( bool  value)
inline

Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery

Definition at line 192 of file WorkGroupConfigurationUpdates.h.

◆ SetRequesterPaysEnabled()

void Aws::Athena::Model::WorkGroupConfigurationUpdates::SetRequesterPaysEnabled ( bool  value)
inline

If set to true, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.

Definition at line 238 of file WorkGroupConfigurationUpdates.h.

◆ SetResultConfigurationUpdates() [1/2]

void Aws::Athena::Model::WorkGroupConfigurationUpdates::SetResultConfigurationUpdates ( const ResultConfigurationUpdates value)
inline

The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.

Definition at line 102 of file WorkGroupConfigurationUpdates.h.

◆ SetResultConfigurationUpdates() [2/2]

void Aws::Athena::Model::WorkGroupConfigurationUpdates::SetResultConfigurationUpdates ( ResultConfigurationUpdates &&  value)
inline

The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.

Definition at line 109 of file WorkGroupConfigurationUpdates.h.

◆ WithBytesScannedCutoffPerQuery()

WorkGroupConfigurationUpdates& Aws::Athena::Model::WorkGroupConfigurationUpdates::WithBytesScannedCutoffPerQuery ( long long  value)
inline

The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

Definition at line 173 of file WorkGroupConfigurationUpdates.h.

◆ WithEnforceWorkGroupConfiguration()

WorkGroupConfigurationUpdates& Aws::Athena::Model::WorkGroupConfigurationUpdates::WithEnforceWorkGroupConfiguration ( bool  value)
inline

If set to "true", the settings for the workgroup override client-side settings. If set to "false" client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.

Definition at line 80 of file WorkGroupConfigurationUpdates.h.

◆ WithEngineVersion() [1/2]

WorkGroupConfigurationUpdates& Aws::Athena::Model::WorkGroupConfigurationUpdates::WithEngineVersion ( const EngineVersion value)
inline

The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

Definition at line 297 of file WorkGroupConfigurationUpdates.h.

◆ WithEngineVersion() [2/2]

WorkGroupConfigurationUpdates& Aws::Athena::Model::WorkGroupConfigurationUpdates::WithEngineVersion ( EngineVersion &&  value)
inline

The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

Definition at line 306 of file WorkGroupConfigurationUpdates.h.

◆ WithPublishCloudWatchMetricsEnabled()

WorkGroupConfigurationUpdates& Aws::Athena::Model::WorkGroupConfigurationUpdates::WithPublishCloudWatchMetricsEnabled ( bool  value)
inline

Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.

Definition at line 148 of file WorkGroupConfigurationUpdates.h.

◆ WithRemoveBytesScannedCutoffPerQuery()

WorkGroupConfigurationUpdates& Aws::Athena::Model::WorkGroupConfigurationUpdates::WithRemoveBytesScannedCutoffPerQuery ( bool  value)
inline

Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery

Definition at line 198 of file WorkGroupConfigurationUpdates.h.

◆ WithRequesterPaysEnabled()

WorkGroupConfigurationUpdates& Aws::Athena::Model::WorkGroupConfigurationUpdates::WithRequesterPaysEnabled ( bool  value)
inline

If set to true, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.

Definition at line 251 of file WorkGroupConfigurationUpdates.h.

◆ WithResultConfigurationUpdates() [1/2]

WorkGroupConfigurationUpdates& Aws::Athena::Model::WorkGroupConfigurationUpdates::WithResultConfigurationUpdates ( const ResultConfigurationUpdates value)
inline

The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.

Definition at line 116 of file WorkGroupConfigurationUpdates.h.

◆ WithResultConfigurationUpdates() [2/2]

WorkGroupConfigurationUpdates& Aws::Athena::Model::WorkGroupConfigurationUpdates::WithResultConfigurationUpdates ( ResultConfigurationUpdates &&  value)
inline

The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.

Definition at line 123 of file WorkGroupConfigurationUpdates.h.


The documentation for this class was generated from the following file: