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")
.managedQueryResultsConfiguration(ManagedQueryResultsConfigurationProperty.builder()
.enabled(false)
.encryptionConfiguration(ManagedStorageEncryptionConfigurationProperty.builder()
.kmsKey("kmsKey")
.build())
.build())
.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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnWorkGroup.WorkGroupConfigurationPropertystatic final classAn implementation forCfnWorkGroup.WorkGroupConfigurationProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default StringSpecifies a user defined JSON string that is passed to the session engine.default NumberThe upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.default ObjectSpecifies the KMS key that is used to encrypt the user's data stores in Athena.default ObjectIf set to "true", the settings for the workgroup override client-side settings.default ObjectThe engine version that all queries running on the workgroup use.default StringRole used to access user resources in an Athena for Apache Spark session.default ObjectThe configuration for storing results in Athena owned storage, which includes whether this feature is enabled;default ObjectIndicates that the Amazon CloudWatch metrics are enabled for the workgroup.default ObjectIf set totrue, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries.default ObjectSpecifies 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.- See Also:
-
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.
- See Also:
-
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.
Returns union: either
IResolvableorCfnWorkGroup.CustomerContentEncryptionConfigurationProperty- See Also:
-
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 Override client-side settings .
Returns union: either
BooleanorIResolvable- See Also:
-
getEngineVersion
The engine version that all queries running on the workgroup use.Returns union: either
IResolvableorCfnWorkGroup.EngineVersionProperty- See Also:
-
getExecutionRole
Role used to access user resources in an Athena for Apache Spark session.This property applies only to Spark-enabled workgroups in Athena.
- See Also:
-
getManagedQueryResultsConfiguration
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.
Returns union: either
IResolvableorCfnWorkGroup.ManagedQueryResultsConfigurationProperty- See Also:
-
getPublishCloudWatchMetricsEnabled
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.Returns union: either
BooleanorIResolvable- See Also:
-
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 .Returns union: either
BooleanorIResolvable- See Also:
-
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 Work with query results and recent queries .
Returns union: either
IResolvableorCfnWorkGroup.ResultConfigurationProperty- See Also:
-
builder
-