Class WorkgroupConfiguration


  • public final class WorkgroupConfiguration
    extends java.lang.Object
    • Method Detail

      • bytesScannedCutoffPerQuery

        public java.util.Optional<java.lang.Integer> bytesScannedCutoffPerQuery()
        Returns:
        Integer for the upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. Must be at least `10485760`.
      • customerContentEncryptionConfiguration

        public java.util.Optional<WorkgroupConfigurationCustomerContentEncryptionConfiguration> customerContentEncryptionConfiguration()
        Returns:
        Configuration block to specify the KMS key that is used to encrypt the user's data stores in Athena. This setting applies to the PySpark engine for Athena notebooks. See Customer Content Encryption Configuration below.
      • enableMinimumEncryptionConfiguration

        public java.util.Optional<java.lang.Boolean> enableMinimumEncryptionConfiguration()
        Returns:
        Boolean indicating whether a minimum level of encryption is enforced for the workgroup for query and calculation results written to Amazon S3.
      • enforceWorkgroupConfiguration

        public java.util.Optional<java.lang.Boolean> enforceWorkgroupConfiguration()
        Returns:
        Boolean whether the settings for the workgroup override client-side settings. For more information, see [Workgroup Settings Override Client-Side Settings](https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). Defaults to `true`.
      • engineVersion

        public java.util.Optional<WorkgroupConfigurationEngineVersion> engineVersion()
        Returns:
        Configuration block for the Athena Engine Versioning. For more information, see [Athena Engine Versioning](https://docs.aws.amazon.com/athena/latest/ug/engine-versions.html). See Engine Version below.
      • executionRole

        public java.util.Optional<java.lang.String> executionRole()
        Returns:
        Role used to access user resources in notebook sessions and IAM Identity Center enabled workgroups. The property is required for IAM Identity Center enabled workgroups.
      • identityCenterConfiguration

        public java.util.Optional<WorkgroupConfigurationIdentityCenterConfiguration> identityCenterConfiguration()
        Returns:
        Configuration block to set up an IAM Identity Center enabled workgroup. See Identity Center Configuration below.
      • managedQueryResultsConfiguration

        public java.util.Optional<WorkgroupConfigurationManagedQueryResultsConfiguration> managedQueryResultsConfiguration()
        Returns:
        Configuration block for storing results in Athena owned storage. See Managed Query Results Configuration below.
      • monitoringConfiguration

        public java.util.Optional<WorkgroupConfigurationMonitoringConfiguration> monitoringConfiguration()
        Returns:
        Configuration block for managed log persistence, delivering logs to Amazon S3 buckets, Amazon CloudWatch log groups etc. Only applicable to Apache Spark engine. See Monitoring Configuration below.
      • publishCloudwatchMetricsEnabled

        public java.util.Optional<java.lang.Boolean> publishCloudwatchMetricsEnabled()
        Returns:
        Boolean whether Amazon CloudWatch metrics are enabled for the workgroup. Defaults to `true`.
      • requesterPaysEnabled

        public java.util.Optional<java.lang.Boolean> requesterPaysEnabled()
        Returns:
        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](https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html) in the S3 Developer Guide.