Class: Aws::Athena::Types::WorkGroupConfiguration
- Inherits:
-
Struct
- Object
- Struct
- Aws::Athena::Types::WorkGroupConfiguration
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-athena/types.rb
Overview
The configuration of the workgroup, which includes the location in Amazon S3 where query and calculation results are stored, the encryption option, if any, used for query and calculation results, whether the Amazon CloudWatch Metrics are enabled for the workgroup and whether workgroup settings override query settings, and the data usage limits for the amount of data scanned per query or per workgroup. The workgroup settings override is specified in ‘EnforceWorkGroupConfiguration` (true/false) in the `WorkGroupConfiguration`. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#additional_configuration ⇒ String
Specifies a user defined JSON string that is passed to the notebook engine.
-
#bytes_scanned_cutoff_per_query ⇒ Integer
The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
-
#customer_content_encryption_configuration ⇒ Types::CustomerContentEncryptionConfiguration
Specifies the KMS key that is used to encrypt the user’s data stores in Athena.
-
#enable_minimum_encryption_configuration ⇒ Boolean
Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3.
-
#enforce_work_group_configuration ⇒ Boolean
If set to “true”, the settings for the workgroup override client-side settings.
-
#engine_version ⇒ Types::EngineVersion
The engine version that all queries running on the workgroup use.
-
#execution_role ⇒ String
Role used in a Spark session for accessing the user’s resources.
-
#publish_cloud_watch_metrics_enabled ⇒ Boolean
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
-
#requester_pays_enabled ⇒ Boolean
If set to ‘true`, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries.
-
#result_configuration ⇒ Types::ResultConfiguration
The configuration for the workgroup, which includes the location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results.
Instance Attribute Details
#additional_configuration ⇒ String
Specifies a user defined JSON string that is passed to the notebook engine.
4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 |
# File 'lib/aws-sdk-athena/types.rb', line 4863 class WorkGroupConfiguration < Struct.new( :result_configuration, :enforce_work_group_configuration, :publish_cloud_watch_metrics_enabled, :bytes_scanned_cutoff_per_query, :requester_pays_enabled, :engine_version, :additional_configuration, :execution_role, :customer_content_encryption_configuration, :enable_minimum_encryption_configuration) SENSITIVE = [] include Aws::Structure end |
#bytes_scanned_cutoff_per_query ⇒ Integer
The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 |
# File 'lib/aws-sdk-athena/types.rb', line 4863 class WorkGroupConfiguration < Struct.new( :result_configuration, :enforce_work_group_configuration, :publish_cloud_watch_metrics_enabled, :bytes_scanned_cutoff_per_query, :requester_pays_enabled, :engine_version, :additional_configuration, :execution_role, :customer_content_encryption_configuration, :enable_minimum_encryption_configuration) SENSITIVE = [] include Aws::Structure end |
#customer_content_encryption_configuration ⇒ Types::CustomerContentEncryptionConfiguration
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.
4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 |
# File 'lib/aws-sdk-athena/types.rb', line 4863 class WorkGroupConfiguration < Struct.new( :result_configuration, :enforce_work_group_configuration, :publish_cloud_watch_metrics_enabled, :bytes_scanned_cutoff_per_query, :requester_pays_enabled, :engine_version, :additional_configuration, :execution_role, :customer_content_encryption_configuration, :enable_minimum_encryption_configuration) SENSITIVE = [] include Aws::Structure end |
#enable_minimum_encryption_configuration ⇒ Boolean
Enforces a minimal level of encryption for the workgroup for query and calculation results that are written to Amazon S3. When enabled, workgroup users can set encryption only to the minimum level set by the administrator or higher when they submit queries.
The ‘EnforceWorkGroupConfiguration` setting takes precedence over the `EnableMinimumEncryptionConfiguration` flag. This means that if `EnforceWorkGroupConfiguration` is true, the `EnableMinimumEncryptionConfiguration` flag is ignored, and the workgroup configuration for encryption is used.
4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 |
# File 'lib/aws-sdk-athena/types.rb', line 4863 class WorkGroupConfiguration < Struct.new( :result_configuration, :enforce_work_group_configuration, :publish_cloud_watch_metrics_enabled, :bytes_scanned_cutoff_per_query, :requester_pays_enabled, :engine_version, :additional_configuration, :execution_role, :customer_content_encryption_configuration, :enable_minimum_encryption_configuration) SENSITIVE = [] include Aws::Structure end |
#enforce_work_group_configuration ⇒ Boolean
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].
[1]: docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html
4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 |
# File 'lib/aws-sdk-athena/types.rb', line 4863 class WorkGroupConfiguration < Struct.new( :result_configuration, :enforce_work_group_configuration, :publish_cloud_watch_metrics_enabled, :bytes_scanned_cutoff_per_query, :requester_pays_enabled, :engine_version, :additional_configuration, :execution_role, :customer_content_encryption_configuration, :enable_minimum_encryption_configuration) SENSITIVE = [] include Aws::Structure end |
#engine_version ⇒ Types::EngineVersion
The engine version that all queries running on the workgroup use. Queries on the ‘AmazonAthenaPreviewFunctionality` workgroup run on the preview engine regardless of this setting.
4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 |
# File 'lib/aws-sdk-athena/types.rb', line 4863 class WorkGroupConfiguration < Struct.new( :result_configuration, :enforce_work_group_configuration, :publish_cloud_watch_metrics_enabled, :bytes_scanned_cutoff_per_query, :requester_pays_enabled, :engine_version, :additional_configuration, :execution_role, :customer_content_encryption_configuration, :enable_minimum_encryption_configuration) SENSITIVE = [] include Aws::Structure end |
#execution_role ⇒ String
Role used in a Spark session for accessing the user’s resources. This property applies only to Spark-enabled workgroups.
4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 |
# File 'lib/aws-sdk-athena/types.rb', line 4863 class WorkGroupConfiguration < Struct.new( :result_configuration, :enforce_work_group_configuration, :publish_cloud_watch_metrics_enabled, :bytes_scanned_cutoff_per_query, :requester_pays_enabled, :engine_version, :additional_configuration, :execution_role, :customer_content_encryption_configuration, :enable_minimum_encryption_configuration) SENSITIVE = [] include Aws::Structure end |
#publish_cloud_watch_metrics_enabled ⇒ Boolean
Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 |
# File 'lib/aws-sdk-athena/types.rb', line 4863 class WorkGroupConfiguration < Struct.new( :result_configuration, :enforce_work_group_configuration, :publish_cloud_watch_metrics_enabled, :bytes_scanned_cutoff_per_query, :requester_pays_enabled, :engine_version, :additional_configuration, :execution_role, :customer_content_encryption_configuration, :enable_minimum_encryption_configuration) SENSITIVE = [] include Aws::Structure end |
#requester_pays_enabled ⇒ Boolean
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*.
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html
4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 |
# File 'lib/aws-sdk-athena/types.rb', line 4863 class WorkGroupConfiguration < Struct.new( :result_configuration, :enforce_work_group_configuration, :publish_cloud_watch_metrics_enabled, :bytes_scanned_cutoff_per_query, :requester_pays_enabled, :engine_version, :additional_configuration, :execution_role, :customer_content_encryption_configuration, :enable_minimum_encryption_configuration) SENSITIVE = [] include Aws::Structure end |
#result_configuration ⇒ Types::ResultConfiguration
The configuration for the workgroup, which includes the location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided. For more information, see [Working with query results, recent queries, and output files].
4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 |
# File 'lib/aws-sdk-athena/types.rb', line 4863 class WorkGroupConfiguration < Struct.new( :result_configuration, :enforce_work_group_configuration, :publish_cloud_watch_metrics_enabled, :bytes_scanned_cutoff_per_query, :requester_pays_enabled, :engine_version, :additional_configuration, :execution_role, :customer_content_encryption_configuration, :enable_minimum_encryption_configuration) SENSITIVE = [] include Aws::Structure end |