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

#include <WorkGroup.h>

Public Member Functions

 WorkGroup ()
 
 WorkGroup (Aws::Utils::Json::JsonView jsonValue)
 
WorkGroupoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
WorkGroupWithName (const Aws::String &value)
 
WorkGroupWithName (Aws::String &&value)
 
WorkGroupWithName (const char *value)
 
const WorkGroupStateGetState () const
 
bool StateHasBeenSet () const
 
void SetState (const WorkGroupState &value)
 
void SetState (WorkGroupState &&value)
 
WorkGroupWithState (const WorkGroupState &value)
 
WorkGroupWithState (WorkGroupState &&value)
 
const WorkGroupConfigurationGetConfiguration () const
 
bool ConfigurationHasBeenSet () const
 
void SetConfiguration (const WorkGroupConfiguration &value)
 
void SetConfiguration (WorkGroupConfiguration &&value)
 
WorkGroupWithConfiguration (const WorkGroupConfiguration &value)
 
WorkGroupWithConfiguration (WorkGroupConfiguration &&value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
WorkGroupWithDescription (const Aws::String &value)
 
WorkGroupWithDescription (Aws::String &&value)
 
WorkGroupWithDescription (const char *value)
 
const Aws::Utils::DateTimeGetCreationTime () const
 
bool CreationTimeHasBeenSet () const
 
void SetCreationTime (const Aws::Utils::DateTime &value)
 
void SetCreationTime (Aws::Utils::DateTime &&value)
 
WorkGroupWithCreationTime (const Aws::Utils::DateTime &value)
 
WorkGroupWithCreationTime (Aws::Utils::DateTime &&value)
 

Detailed Description

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

Definition at line 43 of file WorkGroup.h.

Constructor & Destructor Documentation

◆ WorkGroup() [1/2]

Aws::Athena::Model::WorkGroup::WorkGroup ( )

◆ WorkGroup() [2/2]

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

Member Function Documentation

◆ ConfigurationHasBeenSet()

bool Aws::Athena::Model::WorkGroup::ConfigurationHasBeenSet ( ) const
inline

The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for query 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.

Definition at line 146 of file WorkGroup.h.

◆ CreationTimeHasBeenSet()

bool Aws::Athena::Model::WorkGroup::CreationTimeHasBeenSet ( ) const
inline

The date and time the workgroup was created.

Definition at line 246 of file WorkGroup.h.

◆ DescriptionHasBeenSet()

bool Aws::Athena::Model::WorkGroup::DescriptionHasBeenSet ( ) const
inline

The workgroup description.

Definition at line 205 of file WorkGroup.h.

◆ GetConfiguration()

const WorkGroupConfiguration& Aws::Athena::Model::WorkGroup::GetConfiguration ( ) const
inline

The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for query 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.

Definition at line 134 of file WorkGroup.h.

◆ GetCreationTime()

const Aws::Utils::DateTime& Aws::Athena::Model::WorkGroup::GetCreationTime ( ) const
inline

The date and time the workgroup was created.

Definition at line 241 of file WorkGroup.h.

◆ GetDescription()

const Aws::String& Aws::Athena::Model::WorkGroup::GetDescription ( ) const
inline

The workgroup description.

Definition at line 200 of file WorkGroup.h.

◆ GetName()

const Aws::String& Aws::Athena::Model::WorkGroup::GetName ( ) const
inline

The workgroup name.

Definition at line 55 of file WorkGroup.h.

◆ GetState()

const WorkGroupState& Aws::Athena::Model::WorkGroup::GetState ( ) const
inline

The state of the workgroup: ENABLED or DISABLED.

Definition at line 96 of file WorkGroup.h.

◆ Jsonize()

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

◆ NameHasBeenSet()

bool Aws::Athena::Model::WorkGroup::NameHasBeenSet ( ) const
inline

The workgroup name.

Definition at line 60 of file WorkGroup.h.

◆ operator=()

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

◆ SetConfiguration() [1/2]

void Aws::Athena::Model::WorkGroup::SetConfiguration ( const WorkGroupConfiguration value)
inline

The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for query 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.

Definition at line 158 of file WorkGroup.h.

◆ SetConfiguration() [2/2]

void Aws::Athena::Model::WorkGroup::SetConfiguration ( WorkGroupConfiguration &&  value)
inline

The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for query 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.

Definition at line 170 of file WorkGroup.h.

◆ SetCreationTime() [1/2]

void Aws::Athena::Model::WorkGroup::SetCreationTime ( Aws::Utils::DateTime &&  value)
inline

The date and time the workgroup was created.

Definition at line 256 of file WorkGroup.h.

◆ SetCreationTime() [2/2]

void Aws::Athena::Model::WorkGroup::SetCreationTime ( const Aws::Utils::DateTime value)
inline

The date and time the workgroup was created.

Definition at line 251 of file WorkGroup.h.

◆ SetDescription() [1/3]

void Aws::Athena::Model::WorkGroup::SetDescription ( Aws::String &&  value)
inline

The workgroup description.

Definition at line 215 of file WorkGroup.h.

◆ SetDescription() [2/3]

void Aws::Athena::Model::WorkGroup::SetDescription ( const Aws::String value)
inline

The workgroup description.

Definition at line 210 of file WorkGroup.h.

◆ SetDescription() [3/3]

void Aws::Athena::Model::WorkGroup::SetDescription ( const char *  value)
inline

The workgroup description.

Definition at line 220 of file WorkGroup.h.

◆ SetName() [1/3]

void Aws::Athena::Model::WorkGroup::SetName ( Aws::String &&  value)
inline

The workgroup name.

Definition at line 70 of file WorkGroup.h.

◆ SetName() [2/3]

void Aws::Athena::Model::WorkGroup::SetName ( const Aws::String value)
inline

The workgroup name.

Definition at line 65 of file WorkGroup.h.

◆ SetName() [3/3]

void Aws::Athena::Model::WorkGroup::SetName ( const char *  value)
inline

The workgroup name.

Definition at line 75 of file WorkGroup.h.

◆ SetState() [1/2]

void Aws::Athena::Model::WorkGroup::SetState ( const WorkGroupState value)
inline

The state of the workgroup: ENABLED or DISABLED.

Definition at line 106 of file WorkGroup.h.

◆ SetState() [2/2]

void Aws::Athena::Model::WorkGroup::SetState ( WorkGroupState &&  value)
inline

The state of the workgroup: ENABLED or DISABLED.

Definition at line 111 of file WorkGroup.h.

◆ StateHasBeenSet()

bool Aws::Athena::Model::WorkGroup::StateHasBeenSet ( ) const
inline

The state of the workgroup: ENABLED or DISABLED.

Definition at line 101 of file WorkGroup.h.

◆ WithConfiguration() [1/2]

WorkGroup& Aws::Athena::Model::WorkGroup::WithConfiguration ( const WorkGroupConfiguration value)
inline

The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for query 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.

Definition at line 182 of file WorkGroup.h.

◆ WithConfiguration() [2/2]

WorkGroup& Aws::Athena::Model::WorkGroup::WithConfiguration ( WorkGroupConfiguration &&  value)
inline

The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for query 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.

Definition at line 194 of file WorkGroup.h.

◆ WithCreationTime() [1/2]

WorkGroup& Aws::Athena::Model::WorkGroup::WithCreationTime ( Aws::Utils::DateTime &&  value)
inline

The date and time the workgroup was created.

Definition at line 266 of file WorkGroup.h.

◆ WithCreationTime() [2/2]

WorkGroup& Aws::Athena::Model::WorkGroup::WithCreationTime ( const Aws::Utils::DateTime value)
inline

The date and time the workgroup was created.

Definition at line 261 of file WorkGroup.h.

◆ WithDescription() [1/3]

WorkGroup& Aws::Athena::Model::WorkGroup::WithDescription ( Aws::String &&  value)
inline

The workgroup description.

Definition at line 230 of file WorkGroup.h.

◆ WithDescription() [2/3]

WorkGroup& Aws::Athena::Model::WorkGroup::WithDescription ( const Aws::String value)
inline

The workgroup description.

Definition at line 225 of file WorkGroup.h.

◆ WithDescription() [3/3]

WorkGroup& Aws::Athena::Model::WorkGroup::WithDescription ( const char *  value)
inline

The workgroup description.

Definition at line 235 of file WorkGroup.h.

◆ WithName() [1/3]

WorkGroup& Aws::Athena::Model::WorkGroup::WithName ( Aws::String &&  value)
inline

The workgroup name.

Definition at line 85 of file WorkGroup.h.

◆ WithName() [2/3]

WorkGroup& Aws::Athena::Model::WorkGroup::WithName ( const Aws::String value)
inline

The workgroup name.

Definition at line 80 of file WorkGroup.h.

◆ WithName() [3/3]

WorkGroup& Aws::Athena::Model::WorkGroup::WithName ( const char *  value)
inline

The workgroup name.

Definition at line 90 of file WorkGroup.h.

◆ WithState() [1/2]

WorkGroup& Aws::Athena::Model::WorkGroup::WithState ( const WorkGroupState value)
inline

The state of the workgroup: ENABLED or DISABLED.

Definition at line 116 of file WorkGroup.h.

◆ WithState() [2/2]

WorkGroup& Aws::Athena::Model::WorkGroup::WithState ( WorkGroupState &&  value)
inline

The state of the workgroup: ENABLED or DISABLED.

Definition at line 121 of file WorkGroup.h.


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