athena/aws.sdk.kotlin.services.athena.model/WorkGroupConfiguration/Builder

Builder

class Builder

Properties

additionalConfiguration

var additionalConfiguration: String?

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

bytesScannedCutoffPerQuery

var bytesScannedCutoffPerQuery: Long?

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

customerContentEncryptionConfiguration

var 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.

enableMinimumEncryptionConfiguration

var enableMinimumEncryptionConfiguration: Boolean?

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.

enforceWorkGroupConfiguration

var enforceWorkGroupConfiguration: Boolean?

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.

engineVersion

var 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.

executionRole

var executionRole: String?

The ARN of the execution role used to access user resources for Spark sessions and IAM Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and IAM Identity Center enabled workgroups. The property is required for IAM Identity Center enabled workgroups.

identityCenterConfiguration

var identityCenterConfiguration: IdentityCenterConfiguration?

Specifies whether the workgroup is IAM Identity Center supported.

managedQueryResultsConfiguration

var managedQueryResultsConfiguration: ManagedQueryResultsConfiguration?

The configuration for storing results in Athena owned storage, which includes whether this feature is enabled; whether encryption configuration, if any, is used for encrypting query results.

publishCloudWatchMetricsEnabled

var publishCloudWatchMetricsEnabled: Boolean?

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

queryResultsS3AccessGrantsConfiguration

var queryResultsS3AccessGrantsConfiguration: QueryResultsS3AccessGrantsConfiguration?

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

requesterPaysEnabled

var requesterPaysEnabled: Boolean?

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.

resultConfiguration

var 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.