Interface CfnWorkGroup.WorkGroupConfigurationUpdatesProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnWorkGroup.WorkGroupConfigurationUpdatesProperty.Jsii$Proxy
- Enclosing class:
CfnWorkGroup
@Stability(Stable)
public static interface CfnWorkGroup.WorkGroupConfigurationUpdatesProperty
extends software.amazon.jsii.JsiiSerializable
The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query 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.
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.*; WorkGroupConfigurationUpdatesProperty workGroupConfigurationUpdatesProperty = WorkGroupConfigurationUpdatesProperty.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) .removeBytesScannedCutoffPerQuery(false) .removeCustomerContentEncryptionConfiguration(false) .requesterPaysEnabled(false) .resultConfigurationUpdates(ResultConfigurationUpdatesProperty.builder() .aclConfiguration(AclConfigurationProperty.builder() .s3AclOption("s3AclOption") .build()) .encryptionConfiguration(EncryptionConfigurationProperty.builder() .encryptionOption("encryptionOption") // the properties below are optional .kmsKey("kmsKey") .build()) .expectedBucketOwner("expectedBucketOwner") .outputLocation("outputLocation") .removeAclConfiguration(false) .removeEncryptionConfiguration(false) .removeExpectedBucketOwner(false) .removeOutputLocation(false) .build()) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnWorkGroup.WorkGroupConfigurationUpdatesProperty
static final class
An implementation forCfnWorkGroup.WorkGroupConfigurationUpdatesProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
Additional Configuration that are passed to Athena Spark Calculations running in this workgroup.default Number
The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.default Object
Indicates the KMS key for encrypting notebook content.default Object
If set to "true", the settings for the workgroup override client-side settings.default Object
The Athena engine version for running queries.default String
Execution Role ARN required to run Athena Spark Calculations.default Object
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.default Object
Indicates that the data usage control limit per query is removed.default Object
default Object
If set to true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries.default Object
The result configuration information about the queries in this workgroup that will be updated.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAdditionalConfiguration
Additional Configuration that are passed to Athena Spark Calculations running in this workgroup.- See Also:
-
getBytesScannedCutoffPerQuery
The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.- See Also:
-
getCustomerContentEncryptionConfiguration
Indicates the KMS key for encrypting notebook content.- 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
- See Also:
-
getEngineVersion
The Athena engine version for running queries.- See Also:
-
getExecutionRole
Execution Role ARN required to run Athena Spark Calculations.- See Also:
-
getPublishCloudWatchMetricsEnabled
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.- See Also:
-
getRemoveBytesScannedCutoffPerQuery
Indicates that the data usage control limit per query is removed.- See Also:
-
getRemoveCustomerContentEncryptionConfiguration
- See Also:
-
getRequesterPaysEnabled
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.
- See Also:
-
getResultConfigurationUpdates
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.
- See Also:
-
builder
-