java.lang.Object
- software.amazon.awssdk.services.athena.model.WorkGroupConfigurationUpdates

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<WorkGroupConfigurationUpdates.Builder,WorkGroupConfigurationUpdates>
```
@Generated("software.amazon.awssdk:codegen")
public final class WorkGroupConfigurationUpdates
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WorkGroupConfigurationUpdates.Builder,WorkGroupConfigurationUpdates>
```
The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query and calculation 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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface WorkGroupConfigurationUpdates.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`additionalConfiguration()`	Contains a user defined string in JSON format for a Spark-enabled workgroup.
`static WorkGroupConfigurationUpdates.Builder`	`builder()`
`Long`	`bytesScannedCutoffPerQuery()`	The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
`CustomerContentEncryptionConfiguration`	`customerContentEncryptionConfiguration()`	Returns the value of the CustomerContentEncryptionConfiguration property for this object.
`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 requested when a workgroup is updated.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`executionRole()`	The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Boolean`	`publishCloudWatchMetricsEnabled()`	Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
`QueryResultsS3AccessGrantsConfiguration`	`queryResultsS3AccessGrantsConfiguration()`	Specifies whether Amazon S3 access grants are enabled for query results.
`Boolean`	`removeBytesScannedCutoffPerQuery()`	Indicates that the data usage control limit per query is removed.
`Boolean`	`removeCustomerContentEncryptionConfiguration()`	Removes content encryption configuration from an Apache Spark-enabled Athena workgroup.
`Boolean`	`requesterPaysEnabled()`	If set to `true`, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries.
`ResultConfigurationUpdates`	`resultConfigurationUpdates()`	The result configuration information about the queries in this workgroup that will be updated.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends WorkGroupConfigurationUpdates.Builder>`	`serializableBuilderClass()`
`WorkGroupConfigurationUpdates.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
  - 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.
  - resultConfigurationUpdates
```
public final ResultConfigurationUpdates resultConfigurationUpdates()
```
    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.
    
    Returns:
    
    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.
  - publishCloudWatchMetricsEnabled
```
public final Boolean publishCloudWatchMetricsEnabled()
```
    Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
    
    Returns:
    
    Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
  - bytesScannedCutoffPerQuery
```
public final Long bytesScannedCutoffPerQuery()
```
    The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
    
    Returns:
    
    The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
  - removeBytesScannedCutoffPerQuery
```
public final Boolean removeBytesScannedCutoffPerQuery()
```
    Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery
    
    Returns:
    
    Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery
  - requesterPaysEnabled
```
public final Boolean requesterPaysEnabled()
```
    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.
    
    Returns:
    
    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.
  - engineVersion
```
public final EngineVersion engineVersion()
```
    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.
    
    Returns:
    
    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.
  - removeCustomerContentEncryptionConfiguration
```
public final Boolean removeCustomerContentEncryptionConfiguration()
```
    Removes content encryption configuration from an Apache Spark-enabled Athena workgroup.
    
    Returns:
    
    Removes content encryption configuration from an Apache Spark-enabled Athena workgroup.
  - additionalConfiguration
```
public final String additionalConfiguration()
```
    Contains a user defined string in JSON format for a Spark-enabled workgroup.
    
    Returns:
    
    Contains a user defined string in JSON format for a Spark-enabled workgroup.
  - executionRole
```
public final String executionRole()
```
    The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and Identity Center enabled workgroups.
    
    Returns:
    
    The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and Identity Center enabled workgroups.
  - customerContentEncryptionConfiguration
```
public final CustomerContentEncryptionConfiguration customerContentEncryptionConfiguration()
```
    Returns the value of the CustomerContentEncryptionConfiguration property for this object.
    
    Returns:
    
    The value of the CustomerContentEncryptionConfiguration property for this object.
  - 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. This setting does not apply to Spark-enabled workgroups.
    
    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. This setting does not apply to Spark-enabled workgroups.
    
    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.
  - queryResultsS3AccessGrantsConfiguration
```
public final QueryResultsS3AccessGrantsConfiguration queryResultsS3AccessGrantsConfiguration()
```
    Specifies whether Amazon S3 access grants are enabled for query results.
    
    Returns:
    
    Specifies whether Amazon S3 access grants are enabled for query results.
  - toBuilder
```
public WorkGroupConfigurationUpdates.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<WorkGroupConfigurationUpdates.Builder,WorkGroupConfigurationUpdates>
  - builder
```
public static WorkGroupConfigurationUpdates.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends WorkGroupConfigurationUpdates.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class WorkGroupConfigurationUpdates

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

enforceWorkGroupConfiguration

resultConfigurationUpdates

publishCloudWatchMetricsEnabled

bytesScannedCutoffPerQuery

removeBytesScannedCutoffPerQuery

requesterPaysEnabled

engineVersion

removeCustomerContentEncryptionConfiguration

additionalConfiguration

executionRole

customerContentEncryptionConfiguration

enableMinimumEncryptionConfiguration

queryResultsS3AccessGrantsConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField