software.amazon.awssdk.services.athena.model

Class WorkGroupConfiguration

java.lang.Object

software.amazon.awssdk.services.athena.model.WorkGroupConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<WorkGroupConfiguration.Builder,WorkGroupConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class WorkGroupConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WorkGroupConfiguration.Builder,WorkGroupConfiguration>

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

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WorkGroupConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
String	additionalConfiguration() Specifies a user defined JSON string that is passed to the notebook engine.
static WorkGroupConfiguration.Builder	builder()
Long	bytesScannedCutoffPerQuery() The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
CustomerContentEncryptionConfiguration	customerContentEncryptionConfiguration() Specifies the KMS key that is used to encrypt the user's data stores in Athena.
Boolean	enableMinimumEncryptionConfiguration() Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3.
Boolean	enforceWorkGroupConfiguration() If set to "true", the settings for the workgroup override client-side settings.
EngineVersion	engineVersion() The engine version that all queries running on the workgroup use.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	executionRole() Role used in a session for accessing the user's resources.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	publishCloudWatchMetricsEnabled() Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
Boolean	requesterPaysEnabled() If set to true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries.
ResultConfiguration	resultConfiguration() The configuration for the workgroup, which includes the location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results.
List<SdkField<?>>	sdkFields()
static Class<? extends WorkGroupConfiguration.Builder>	serializableBuilderClass()
WorkGroupConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

resultConfiguration

public final ResultConfiguration resultConfiguration()

The configuration for the workgroup, which includes the location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation 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 Working with query results, recent queries, and output files.

Returns:

The configuration for the workgroup, which includes the location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation 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 Working with query results, recent queries, and output files.

enforceWorkGroupConfiguration

public final Boolean enforceWorkGroupConfiguration()

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.

Returns:

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.

publishCloudWatchMetricsEnabled

public final Boolean publishCloudWatchMetricsEnabled()

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

Returns:

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

bytesScannedCutoffPerQuery

public final Long bytesScannedCutoffPerQuery()

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

Returns:

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

requesterPaysEnabled

public final Boolean requesterPaysEnabled()

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.

Returns:

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.

engineVersion

public final EngineVersion engineVersion()

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.

Returns:

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.

additionalConfiguration

public final String additionalConfiguration()

Specifies a user defined JSON string that is passed to the notebook engine.

Returns:

Specifies a user defined JSON string that is passed to the notebook engine.

executionRole

public final String executionRole()

Role used in a session for accessing the user's resources.

Returns:

Role used in a session for accessing the user's resources.

customerContentEncryptionConfiguration

public final CustomerContentEncryptionConfiguration customerContentEncryptionConfiguration()

Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.

Returns:

Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.

enableMinimumEncryptionConfiguration

public final Boolean enableMinimumEncryptionConfiguration()

Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3. When enabled, workgroup users can set encryption only to the minimum level set by the administrator or higher when they submit queries.

The EnforceWorkGroupConfiguration setting takes precedence over the EnableMinimumEncryptionConfiguration flag. This means that if EnforceWorkGroupConfiguration is true, the EnableMinimumEncryptionConfiguration flag is ignored, and the workgroup configuration for encryption is used.

Returns:

Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3. When enabled, workgroup users can set encryption only to the minimum level set by the administrator or higher when they submit queries.

The EnforceWorkGroupConfiguration setting takes precedence over the EnableMinimumEncryptionConfiguration flag. This means that if EnforceWorkGroupConfiguration is true, the EnableMinimumEncryptionConfiguration flag is ignored, and the workgroup configuration for encryption is used.

toBuilder

public WorkGroupConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WorkGroupConfiguration.Builder,WorkGroupConfiguration>

builder

public static WorkGroupConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends WorkGroupConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo