Package software.amazon.awscdk.services.athena

Interface CfnWorkGroup.WorkGroupConfigurationProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnWorkGroup.WorkGroupConfigurationProperty.Jsii$Proxy
Enclosing class:
CfnWorkGroup
@Stability(Stable) public static interface CfnWorkGroup.WorkGroupConfigurationProperty extends software.amazon.jsii.JsiiSerializable
The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether Amazon CloudWatch Metrics are enabled for the workgroup, and the limit for the amount of bytes scanned (cutoff) per query, if it is specified.

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();

  • Method Details

    • getAdditionalConfiguration

      @Stability(Stable) @Nullable default String getAdditionalConfiguration()
      Specifies a user defined JSON string that is passed to the session engine.

    • getBytesScannedCutoffPerQuery

      @Stability(Stable) @Nullable default Number 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

      @Stability(Stable) @Nullable default Object 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

      @Stability(Stable) @Nullable default Object 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

      @Stability(Stable) @Nullable default Object getEngineVersion()
      The engine version that all queries running on the workgroup use.

    • getExecutionRole

      @Stability(Stable) @Nullable default String 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

      @Stability(Stable) @Nullable default Object getPublishCloudWatchMetricsEnabled()
      Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.

    • getRequesterPaysEnabled

      @Stability(Stable) @Nullable default Object 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. The default is false . For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide .

    • getResultConfiguration

      @Stability(Stable) @Nullable default Object 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

      @Stability(Stable) static CfnWorkGroup.WorkGroupConfigurationProperty.Builder builder()
      Returns:
      a CfnWorkGroup.WorkGroupConfigurationProperty.Builder of CfnWorkGroup.WorkGroupConfigurationProperty