Interface CfnWorkGroup.WorkGroupConfigurationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnWorkGroup.WorkGroupConfigurationProperty.Jsii$Proxy
- Enclosing class:
- CfnWorkGroup
The EnforceWorkGroupConfiguration
option determines whether workgroup settings override client-side query settings.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.athena.*; WorkGroupConfigurationProperty workGroupConfigurationProperty = WorkGroupConfigurationProperty.builder() .additionalConfiguration("additionalConfiguration") .bytesScannedCutoffPerQuery(123) .customerContentEncryptionConfiguration(CustomerContentEncryptionConfigurationProperty.builder() .kmsKey("kmsKey") .build()) .enforceWorkGroupConfiguration(false) .engineVersion(EngineVersionProperty.builder() .effectiveEngineVersion("effectiveEngineVersion") .selectedEngineVersion("selectedEngineVersion") .build()) .executionRole("executionRole") .publishCloudWatchMetricsEnabled(false) .requesterPaysEnabled(false) .resultConfiguration(ResultConfigurationProperty.builder() .aclConfiguration(AclConfigurationProperty.builder() .s3AclOption("s3AclOption") .build()) .encryptionConfiguration(EncryptionConfigurationProperty.builder() .encryptionOption("encryptionOption") // the properties below are optional .kmsKey("kmsKey") .build()) .expectedBucketOwner("expectedBucketOwner") .outputLocation("outputLocation") .build()) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnWorkGroup.WorkGroupConfigurationProperty
static final class
An implementation forCfnWorkGroup.WorkGroupConfigurationProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
Specifies a user defined JSON string that is passed to the session engine.default Number
The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.default Object
Specifies the KMS key that is used to encrypt the user's data stores in Athena.default Object
If set to "true", the settings for the workgroup override client-side settings.default Object
The engine version that all queries running on the workgroup use.default String
Role used to access user resources in an Athena for Apache Spark session.default Object
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.default Object
If set totrue
, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries.default Object
Specifies the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAdditionalConfiguration
Specifies a user defined JSON string that is passed to the session engine. -
getBytesScannedCutoffPerQuery
The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.No default is defined.
This property currently supports integer types. Support for long values is planned.
-
getCustomerContentEncryptionConfiguration
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.
-
getEnforceWorkGroupConfiguration
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 .
-
getEngineVersion
The engine version that all queries running on the workgroup use. -
getExecutionRole
Role used to access user resources in an Athena for Apache Spark session.This property applies only to Spark-enabled workgroups in Athena.
-
getPublishCloudWatchMetricsEnabled
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup. -
getRequesterPaysEnabled
If set totrue
, 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 isfalse
. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide . -
getResultConfiguration
Specifies the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results.For more information, see Working with Query Results, Output Files, and Query History .
-
builder
-