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

#include <WorkGroupConfiguration.h>

Public Member Functions

 WorkGroupConfiguration ()
 
 WorkGroupConfiguration (Aws::Utils::Json::JsonView jsonValue)
 
WorkGroupConfigurationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const ResultConfigurationGetResultConfiguration () const
 
bool ResultConfigurationHasBeenSet () const
 
void SetResultConfiguration (const ResultConfiguration &value)
 
void SetResultConfiguration (ResultConfiguration &&value)
 
WorkGroupConfigurationWithResultConfiguration (const ResultConfiguration &value)
 
WorkGroupConfigurationWithResultConfiguration (ResultConfiguration &&value)
 
bool GetEnforceWorkGroupConfiguration () const
 
bool EnforceWorkGroupConfigurationHasBeenSet () const
 
void SetEnforceWorkGroupConfiguration (bool value)
 
WorkGroupConfigurationWithEnforceWorkGroupConfiguration (bool value)
 
bool GetPublishCloudWatchMetricsEnabled () const
 
bool PublishCloudWatchMetricsEnabledHasBeenSet () const
 
void SetPublishCloudWatchMetricsEnabled (bool value)
 
WorkGroupConfigurationWithPublishCloudWatchMetricsEnabled (bool value)
 
long long GetBytesScannedCutoffPerQuery () const
 
bool BytesScannedCutoffPerQueryHasBeenSet () const
 
void SetBytesScannedCutoffPerQuery (long long value)
 
WorkGroupConfigurationWithBytesScannedCutoffPerQuery (long long value)
 
bool GetRequesterPaysEnabled () const
 
bool RequesterPaysEnabledHasBeenSet () const
 
void SetRequesterPaysEnabled (bool value)
 
WorkGroupConfigurationWithRequesterPaysEnabled (bool value)
 
const EngineVersionGetEngineVersion () const
 
bool EngineVersionHasBeenSet () const
 
void SetEngineVersion (const EngineVersion &value)
 
void SetEngineVersion (EngineVersion &&value)
 
WorkGroupConfigurationWithEngineVersion (const EngineVersion &value)
 
WorkGroupConfigurationWithEngineVersion (EngineVersion &&value)
 

Detailed Description

The configuration of the 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 and whether workgroup settings override query 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.

See Also:

AWS API Reference

Definition at line 40 of file WorkGroupConfiguration.h.

Constructor & Destructor Documentation

◆ WorkGroupConfiguration() [1/2]

Aws::Athena::Model::WorkGroupConfiguration::WorkGroupConfiguration ( )

◆ WorkGroupConfiguration() [2/2]

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

Member Function Documentation

◆ BytesScannedCutoffPerQueryHasBeenSet()

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

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

Definition at line 200 of file WorkGroupConfiguration.h.

◆ EnforceWorkGroupConfigurationHasBeenSet()

bool Aws::Athena::Model::WorkGroupConfiguration::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 144 of file WorkGroupConfiguration.h.

◆ EngineVersionHasBeenSet()

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

The engine version that all queries running on the workgroup use. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

Definition at line 280 of file WorkGroupConfiguration.h.

◆ GetBytesScannedCutoffPerQuery()

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

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

Definition at line 194 of file WorkGroupConfiguration.h.

◆ GetEnforceWorkGroupConfiguration()

bool Aws::Athena::Model::WorkGroupConfiguration::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 135 of file WorkGroupConfiguration.h.

◆ GetEngineVersion()

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

The engine version that all queries running on the workgroup use. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

Definition at line 273 of file WorkGroupConfiguration.h.

◆ GetPublishCloudWatchMetricsEnabled()

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

Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.

Definition at line 169 of file WorkGroupConfiguration.h.

◆ GetRequesterPaysEnabled()

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

If set to true, allows members assigned to a workgroup to reference 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 226 of file WorkGroupConfiguration.h.

◆ GetResultConfiguration()

const ResultConfiguration& Aws::Athena::Model::WorkGroupConfiguration::GetResultConfiguration ( ) const
inline

The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided. For more information, see Query Results.

Definition at line 60 of file WorkGroupConfiguration.h.

◆ Jsonize()

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

◆ operator=()

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

◆ PublishCloudWatchMetricsEnabledHasBeenSet()

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

Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.

Definition at line 175 of file WorkGroupConfiguration.h.

◆ RequesterPaysEnabledHasBeenSet()

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

If set to true, allows members assigned to a workgroup to reference 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 239 of file WorkGroupConfiguration.h.

◆ ResultConfigurationHasBeenSet()

bool Aws::Athena::Model::WorkGroupConfiguration::ResultConfigurationHasBeenSet ( ) const
inline

The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided. For more information, see Query Results.

Definition at line 73 of file WorkGroupConfiguration.h.

◆ SetBytesScannedCutoffPerQuery()

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

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

Definition at line 206 of file WorkGroupConfiguration.h.

◆ SetEnforceWorkGroupConfiguration()

void Aws::Athena::Model::WorkGroupConfiguration::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 153 of file WorkGroupConfiguration.h.

◆ SetEngineVersion() [1/2]

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

The engine version that all queries running on the workgroup use. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

Definition at line 287 of file WorkGroupConfiguration.h.

◆ SetEngineVersion() [2/2]

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

The engine version that all queries running on the workgroup use. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

Definition at line 294 of file WorkGroupConfiguration.h.

◆ SetPublishCloudWatchMetricsEnabled()

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

Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.

Definition at line 181 of file WorkGroupConfiguration.h.

◆ SetRequesterPaysEnabled()

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

If set to true, allows members assigned to a workgroup to reference 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 252 of file WorkGroupConfiguration.h.

◆ SetResultConfiguration() [1/2]

void Aws::Athena::Model::WorkGroupConfiguration::SetResultConfiguration ( const ResultConfiguration value)
inline

The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided. For more information, see Query Results.

Definition at line 86 of file WorkGroupConfiguration.h.

◆ SetResultConfiguration() [2/2]

void Aws::Athena::Model::WorkGroupConfiguration::SetResultConfiguration ( ResultConfiguration &&  value)
inline

The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided. For more information, see Query Results.

Definition at line 99 of file WorkGroupConfiguration.h.

◆ WithBytesScannedCutoffPerQuery()

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

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

Definition at line 212 of file WorkGroupConfiguration.h.

◆ WithEnforceWorkGroupConfiguration()

WorkGroupConfiguration& Aws::Athena::Model::WorkGroupConfiguration::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 162 of file WorkGroupConfiguration.h.

◆ WithEngineVersion() [1/2]

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

The engine version that all queries running on the workgroup use. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

Definition at line 301 of file WorkGroupConfiguration.h.

◆ WithEngineVersion() [2/2]

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

The engine version that all queries running on the workgroup use. Queries on the AmazonAthenaPreviewFunctionality workgroup run on the preview engine regardless of this setting.

Definition at line 308 of file WorkGroupConfiguration.h.

◆ WithPublishCloudWatchMetricsEnabled()

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

Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.

Definition at line 187 of file WorkGroupConfiguration.h.

◆ WithRequesterPaysEnabled()

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

If set to true, allows members assigned to a workgroup to reference 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 265 of file WorkGroupConfiguration.h.

◆ WithResultConfiguration() [1/2]

WorkGroupConfiguration& Aws::Athena::Model::WorkGroupConfiguration::WithResultConfiguration ( const ResultConfiguration value)
inline

The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided. For more information, see Query Results.

Definition at line 112 of file WorkGroupConfiguration.h.

◆ WithResultConfiguration() [2/2]

WorkGroupConfiguration& Aws::Athena::Model::WorkGroupConfiguration::WithResultConfiguration ( ResultConfiguration &&  value)
inline

The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided. For more information, see Query Results.

Definition at line 125 of file WorkGroupConfiguration.h.


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