Package software.amazon.awssdk.services.athena.model

Interface WorkGroupConfigurationUpdates.Builder

All Superinterfaces:

Buildable, CopyableBuilder<WorkGroupConfigurationUpdates.Builder,WorkGroupConfigurationUpdates>, SdkBuilder<WorkGroupConfigurationUpdates.Builder,WorkGroupConfigurationUpdates>, SdkPojo

Enclosing class:

WorkGroupConfigurationUpdates

@Mutable
@NotThreadSafe
public static interface WorkGroupConfigurationUpdates.Builder
extends SdkPojo, CopyableBuilder<WorkGroupConfigurationUpdates.Builder,WorkGroupConfigurationUpdates>

Method Summary

Modifier and Type	Method	Description
WorkGroupConfigurationUpdates.Builder	additionalConfiguration(String additionalConfiguration)	Contains a user defined string in JSON format for a Spark-enabled workgroup.
WorkGroupConfigurationUpdates.Builder	bytesScannedCutoffPerQuery(Long bytesScannedCutoffPerQuery)	The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
default WorkGroupConfigurationUpdates.Builder	customerContentEncryptionConfiguration(Consumer<CustomerContentEncryptionConfiguration.Builder> customerContentEncryptionConfiguration)	Sets the value of the CustomerContentEncryptionConfiguration property for this object.
WorkGroupConfigurationUpdates.Builder	customerContentEncryptionConfiguration(CustomerContentEncryptionConfiguration customerContentEncryptionConfiguration)	Sets the value of the CustomerContentEncryptionConfiguration property for this object.
WorkGroupConfigurationUpdates.Builder	enableMinimumEncryptionConfiguration(Boolean enableMinimumEncryptionConfiguration)	Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3.
WorkGroupConfigurationUpdates.Builder	enforceWorkGroupConfiguration(Boolean enforceWorkGroupConfiguration)	If set to "true", the settings for the workgroup override client-side settings.
default WorkGroupConfigurationUpdates.Builder	engineConfiguration(Consumer<EngineConfiguration.Builder> engineConfiguration)	Sets the value of the EngineConfiguration property for this object.
WorkGroupConfigurationUpdates.Builder	engineConfiguration(EngineConfiguration engineConfiguration)	Sets the value of the EngineConfiguration property for this object.
default WorkGroupConfigurationUpdates.Builder	engineVersion(Consumer<EngineVersion.Builder> engineVersion)	The engine version requested when a workgroup is updated.
WorkGroupConfigurationUpdates.Builder	engineVersion(EngineVersion engineVersion)	The engine version requested when a workgroup is updated.
WorkGroupConfigurationUpdates.Builder	executionRole(String executionRole)	The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups.
default WorkGroupConfigurationUpdates.Builder	managedQueryResultsConfigurationUpdates(Consumer<ManagedQueryResultsConfigurationUpdates.Builder> managedQueryResultsConfigurationUpdates)	Updates configuration information for managed query results in the workgroup.
WorkGroupConfigurationUpdates.Builder	managedQueryResultsConfigurationUpdates(ManagedQueryResultsConfigurationUpdates managedQueryResultsConfigurationUpdates)	Updates configuration information for managed query results in the workgroup.
default WorkGroupConfigurationUpdates.Builder	monitoringConfiguration(Consumer<MonitoringConfiguration.Builder> monitoringConfiguration)	Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.
WorkGroupConfigurationUpdates.Builder	monitoringConfiguration(MonitoringConfiguration monitoringConfiguration)	Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.
WorkGroupConfigurationUpdates.Builder	publishCloudWatchMetricsEnabled(Boolean publishCloudWatchMetricsEnabled)	Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
default WorkGroupConfigurationUpdates.Builder	queryResultsS3AccessGrantsConfiguration(Consumer<QueryResultsS3AccessGrantsConfiguration.Builder> queryResultsS3AccessGrantsConfiguration)	Specifies whether Amazon S3 access grants are enabled for query results.
WorkGroupConfigurationUpdates.Builder	queryResultsS3AccessGrantsConfiguration(QueryResultsS3AccessGrantsConfiguration queryResultsS3AccessGrantsConfiguration)	Specifies whether Amazon S3 access grants are enabled for query results.
WorkGroupConfigurationUpdates.Builder	removeBytesScannedCutoffPerQuery(Boolean removeBytesScannedCutoffPerQuery)	Indicates that the data usage control limit per query is removed.
WorkGroupConfigurationUpdates.Builder	removeCustomerContentEncryptionConfiguration(Boolean removeCustomerContentEncryptionConfiguration)	Removes content encryption configuration from an Apache Spark-enabled Athena workgroup.
WorkGroupConfigurationUpdates.Builder	requesterPaysEnabled(Boolean requesterPaysEnabled)	If set to true, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries.
default WorkGroupConfigurationUpdates.Builder	resultConfigurationUpdates(Consumer<ResultConfigurationUpdates.Builder> resultConfigurationUpdates)	The result configuration information about the queries in this workgroup that will be updated.
WorkGroupConfigurationUpdates.Builder	resultConfigurationUpdates(ResultConfigurationUpdates resultConfigurationUpdates)	The result configuration information about the queries in this workgroup that will be updated.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

enforceWorkGroupConfiguration

WorkGroupConfigurationUpdates.Builder enforceWorkGroupConfiguration(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

resultConfigurationUpdates

WorkGroupConfigurationUpdates.Builder resultConfigurationUpdates(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

resultConfigurationUpdates

default WorkGroupConfigurationUpdates.Builder resultConfigurationUpdates(Consumer<ResultConfigurationUpdates.Builder> 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.

This is a convenience method that creates an instance of the ResultConfigurationUpdates.Builder avoiding the need to create one manually via ResultConfigurationUpdates.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resultConfigurationUpdates(ResultConfigurationUpdates).

Parameters:

resultConfigurationUpdates - a consumer that will call methods on ResultConfigurationUpdates.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• resultConfigurationUpdates(ResultConfigurationUpdates)

managedQueryResultsConfigurationUpdates

WorkGroupConfigurationUpdates.Builder managedQueryResultsConfigurationUpdates(ManagedQueryResultsConfigurationUpdates managedQueryResultsConfigurationUpdates)

Updates configuration information for managed query results in the workgroup.

Parameters:

managedQueryResultsConfigurationUpdates - Updates configuration information for managed query results in the workgroup.

Returns:

Returns a reference to this object so that method calls can be chained together.

managedQueryResultsConfigurationUpdates

default WorkGroupConfigurationUpdates.Builder managedQueryResultsConfigurationUpdates(Consumer<ManagedQueryResultsConfigurationUpdates.Builder> managedQueryResultsConfigurationUpdates)

Updates configuration information for managed query results in the workgroup.

This is a convenience method that creates an instance of the ManagedQueryResultsConfigurationUpdates.Builder avoiding the need to create one manually via ManagedQueryResultsConfigurationUpdates.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to managedQueryResultsConfigurationUpdates(ManagedQueryResultsConfigurationUpdates).

Parameters:

managedQueryResultsConfigurationUpdates - a consumer that will call methods on ManagedQueryResultsConfigurationUpdates.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• managedQueryResultsConfigurationUpdates(ManagedQueryResultsConfigurationUpdates)

publishCloudWatchMetricsEnabled

WorkGroupConfigurationUpdates.Builder publishCloudWatchMetricsEnabled(Boolean publishCloudWatchMetricsEnabled)

Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.

Parameters:

publishCloudWatchMetricsEnabled - Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.

Returns:

Returns a reference to this object so that method calls can be chained together.

bytesScannedCutoffPerQuery

WorkGroupConfigurationUpdates.Builder bytesScannedCutoffPerQuery(Long bytesScannedCutoffPerQuery)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

removeBytesScannedCutoffPerQuery

WorkGroupConfigurationUpdates.Builder removeBytesScannedCutoffPerQuery(Boolean removeBytesScannedCutoffPerQuery)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

requesterPaysEnabled

WorkGroupConfigurationUpdates.Builder requesterPaysEnabled(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

engineVersion

WorkGroupConfigurationUpdates.Builder engineVersion(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

engineVersion

default WorkGroupConfigurationUpdates.Builder engineVersion(Consumer<EngineVersion.Builder> 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.

This is a convenience method that creates an instance of the EngineVersion.Builder avoiding the need to create one manually via EngineVersion.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to engineVersion(EngineVersion).

Parameters:

engineVersion - a consumer that will call methods on EngineVersion.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• engineVersion(EngineVersion)

removeCustomerContentEncryptionConfiguration

WorkGroupConfigurationUpdates.Builder removeCustomerContentEncryptionConfiguration(Boolean removeCustomerContentEncryptionConfiguration)

Removes content encryption configuration from an Apache Spark-enabled Athena workgroup.

Parameters:

removeCustomerContentEncryptionConfiguration - Removes content encryption configuration from an Apache Spark-enabled Athena workgroup.

Returns:

Returns a reference to this object so that method calls can be chained together.

additionalConfiguration

WorkGroupConfigurationUpdates.Builder additionalConfiguration(String additionalConfiguration)

Contains a user defined string in JSON format for a Spark-enabled workgroup.

Parameters:

additionalConfiguration - Contains a user defined string in JSON format for a Spark-enabled workgroup.

Returns:

Returns a reference to this object so that method calls can be chained together.

executionRole

WorkGroupConfigurationUpdates.Builder executionRole(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

customerContentEncryptionConfiguration

WorkGroupConfigurationUpdates.Builder customerContentEncryptionConfiguration(CustomerContentEncryptionConfiguration customerContentEncryptionConfiguration)

Sets the value of the CustomerContentEncryptionConfiguration property for this object.

Parameters:

customerContentEncryptionConfiguration - The new value for the CustomerContentEncryptionConfiguration property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

customerContentEncryptionConfiguration

default WorkGroupConfigurationUpdates.Builder customerContentEncryptionConfiguration(Consumer<CustomerContentEncryptionConfiguration.Builder> customerContentEncryptionConfiguration)

Sets the value of the CustomerContentEncryptionConfiguration property for this object. This is a convenience method that creates an instance of the CustomerContentEncryptionConfiguration.Builder avoiding the need to create one manually via CustomerContentEncryptionConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customerContentEncryptionConfiguration(CustomerContentEncryptionConfiguration).

Parameters:

customerContentEncryptionConfiguration - a consumer that will call methods on CustomerContentEncryptionConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• customerContentEncryptionConfiguration(CustomerContentEncryptionConfiguration)

enableMinimumEncryptionConfiguration

WorkGroupConfigurationUpdates.Builder enableMinimumEncryptionConfiguration(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

queryResultsS3AccessGrantsConfiguration

WorkGroupConfigurationUpdates.Builder queryResultsS3AccessGrantsConfiguration(QueryResultsS3AccessGrantsConfiguration queryResultsS3AccessGrantsConfiguration)

Specifies whether Amazon S3 access grants are enabled for query results.

Parameters:

queryResultsS3AccessGrantsConfiguration - Specifies whether Amazon S3 access grants are enabled for query results.

Returns:

Returns a reference to this object so that method calls can be chained together.

queryResultsS3AccessGrantsConfiguration

default WorkGroupConfigurationUpdates.Builder queryResultsS3AccessGrantsConfiguration(Consumer<QueryResultsS3AccessGrantsConfiguration.Builder> queryResultsS3AccessGrantsConfiguration)

Specifies whether Amazon S3 access grants are enabled for query results.

This is a convenience method that creates an instance of the QueryResultsS3AccessGrantsConfiguration.Builder avoiding the need to create one manually via QueryResultsS3AccessGrantsConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to queryResultsS3AccessGrantsConfiguration(QueryResultsS3AccessGrantsConfiguration).

Parameters:

queryResultsS3AccessGrantsConfiguration - a consumer that will call methods on QueryResultsS3AccessGrantsConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• queryResultsS3AccessGrantsConfiguration(QueryResultsS3AccessGrantsConfiguration)

monitoringConfiguration

WorkGroupConfigurationUpdates.Builder monitoringConfiguration(MonitoringConfiguration monitoringConfiguration)

Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.

Parameters:

monitoringConfiguration - Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.

Returns:

Returns a reference to this object so that method calls can be chained together.

monitoringConfiguration

default WorkGroupConfigurationUpdates.Builder monitoringConfiguration(Consumer<MonitoringConfiguration.Builder> monitoringConfiguration)

Contains the configuration settings for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc.

This is a convenience method that creates an instance of the MonitoringConfiguration.Builder avoiding the need to create one manually via MonitoringConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to monitoringConfiguration(MonitoringConfiguration).

Parameters:

monitoringConfiguration - a consumer that will call methods on MonitoringConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• monitoringConfiguration(MonitoringConfiguration)

engineConfiguration

WorkGroupConfigurationUpdates.Builder engineConfiguration(EngineConfiguration engineConfiguration)

Sets the value of the EngineConfiguration property for this object.

Parameters:

engineConfiguration - The new value for the EngineConfiguration property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

engineConfiguration

default WorkGroupConfigurationUpdates.Builder engineConfiguration(Consumer<EngineConfiguration.Builder> engineConfiguration)

Sets the value of the EngineConfiguration property for this object. This is a convenience method that creates an instance of the EngineConfiguration.Builder avoiding the need to create one manually via EngineConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to engineConfiguration(EngineConfiguration).

Parameters:

engineConfiguration - a consumer that will call methods on EngineConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• engineConfiguration(EngineConfiguration)