Class: Aws::Athena::Types::WorkGroupConfigurationUpdates
- Inherits:
-
Struct
- Object
- Struct
- Aws::Athena::Types::WorkGroupConfigurationUpdates
- Defined in:
- gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb
Overview
The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query and calculation 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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#additional_configuration ⇒ String
Contains a user defined string in JSON format for a Spark-enabled workgroup.
-
#bytes_scanned_cutoff_per_query ⇒ Integer
The upper 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 customer managed 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 requested when a workgroup is updated.
-
#execution_role ⇒ String
The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups.
-
#publish_cloud_watch_metrics_enabled ⇒ Boolean
Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
-
#query_results_s3_access_grants_configuration ⇒ Types::QueryResultsS3AccessGrantsConfiguration
Specifies whether Amazon S3 access grants are enabled for query results.
-
#remove_bytes_scanned_cutoff_per_query ⇒ Boolean
Indicates that the data usage control limit per query is removed.
-
#remove_customer_content_encryption_configuration ⇒ Boolean
Removes content encryption configuration from an Apache Spark-enabled Athena workgroup.
-
#requester_pays_enabled ⇒ Boolean
If set to
true
, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries. -
#result_configuration_updates ⇒ Types::ResultConfigurationUpdates
The result configuration information about the queries in this workgroup that will be updated.
Instance Attribute Details
#additional_configuration ⇒ String
Contains a user defined string in JSON format for a Spark-enabled workgroup.
5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 5111 class WorkGroupConfigurationUpdates < Struct.new( :enforce_work_group_configuration, :result_configuration_updates, :publish_cloud_watch_metrics_enabled, :bytes_scanned_cutoff_per_query, :remove_bytes_scanned_cutoff_per_query, :requester_pays_enabled, :engine_version, :remove_customer_content_encryption_configuration, :additional_configuration, :execution_role, :customer_content_encryption_configuration, :enable_minimum_encryption_configuration, :query_results_s3_access_grants_configuration) SENSITIVE = [] include Aws::Structure end |
#bytes_scanned_cutoff_per_query ⇒ Integer
The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 5111 class WorkGroupConfigurationUpdates < Struct.new( :enforce_work_group_configuration, :result_configuration_updates, :publish_cloud_watch_metrics_enabled, :bytes_scanned_cutoff_per_query, :remove_bytes_scanned_cutoff_per_query, :requester_pays_enabled, :engine_version, :remove_customer_content_encryption_configuration, :additional_configuration, :execution_role, :customer_content_encryption_configuration, :enable_minimum_encryption_configuration, :query_results_s3_access_grants_configuration) SENSITIVE = [] include Aws::Structure end |
#customer_content_encryption_configuration ⇒ Types::CustomerContentEncryptionConfiguration
Specifies the customer managed KMS key that is used to encrypt the user's data stores in Athena. When an Amazon Web Services managed key is used, this value is null. This setting does not apply to Athena SQL workgroups.
5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 5111 class WorkGroupConfigurationUpdates < Struct.new( :enforce_work_group_configuration, :result_configuration_updates, :publish_cloud_watch_metrics_enabled, :bytes_scanned_cutoff_per_query, :remove_bytes_scanned_cutoff_per_query, :requester_pays_enabled, :engine_version, :remove_customer_content_encryption_configuration, :additional_configuration, :execution_role, :customer_content_encryption_configuration, :enable_minimum_encryption_configuration, :query_results_s3_access_grants_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. This setting does not apply to Spark-enabled workgroups.
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.
5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 5111 class WorkGroupConfigurationUpdates < Struct.new( :enforce_work_group_configuration, :result_configuration_updates, :publish_cloud_watch_metrics_enabled, :bytes_scanned_cutoff_per_query, :remove_bytes_scanned_cutoff_per_query, :requester_pays_enabled, :engine_version, :remove_customer_content_encryption_configuration, :additional_configuration, :execution_role, :customer_content_encryption_configuration, :enable_minimum_encryption_configuration, :query_results_s3_access_grants_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.
5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 5111 class WorkGroupConfigurationUpdates < Struct.new( :enforce_work_group_configuration, :result_configuration_updates, :publish_cloud_watch_metrics_enabled, :bytes_scanned_cutoff_per_query, :remove_bytes_scanned_cutoff_per_query, :requester_pays_enabled, :engine_version, :remove_customer_content_encryption_configuration, :additional_configuration, :execution_role, :customer_content_encryption_configuration, :enable_minimum_encryption_configuration, :query_results_s3_access_grants_configuration) SENSITIVE = [] include Aws::Structure end |
#engine_version ⇒ Types::EngineVersion
The engine version requested when a workgroup is updated. After the
update, all queries on the workgroup run on the requested engine
version. If no value was previously set, the default is Auto.
Queries on the AmazonAthenaPreviewFunctionality
workgroup run on
the preview engine regardless of this setting.
5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 5111 class WorkGroupConfigurationUpdates < Struct.new( :enforce_work_group_configuration, :result_configuration_updates, :publish_cloud_watch_metrics_enabled, :bytes_scanned_cutoff_per_query, :remove_bytes_scanned_cutoff_per_query, :requester_pays_enabled, :engine_version, :remove_customer_content_encryption_configuration, :additional_configuration, :execution_role, :customer_content_encryption_configuration, :enable_minimum_encryption_configuration, :query_results_s3_access_grants_configuration) SENSITIVE = [] include Aws::Structure end |
#execution_role ⇒ String
The ARN of the execution role used to access user resources for Spark sessions and Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and Identity Center enabled workgroups.
5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 5111 class WorkGroupConfigurationUpdates < Struct.new( :enforce_work_group_configuration, :result_configuration_updates, :publish_cloud_watch_metrics_enabled, :bytes_scanned_cutoff_per_query, :remove_bytes_scanned_cutoff_per_query, :requester_pays_enabled, :engine_version, :remove_customer_content_encryption_configuration, :additional_configuration, :execution_role, :customer_content_encryption_configuration, :enable_minimum_encryption_configuration, :query_results_s3_access_grants_configuration) SENSITIVE = [] include Aws::Structure end |
#publish_cloud_watch_metrics_enabled ⇒ Boolean
Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 5111 class WorkGroupConfigurationUpdates < Struct.new( :enforce_work_group_configuration, :result_configuration_updates, :publish_cloud_watch_metrics_enabled, :bytes_scanned_cutoff_per_query, :remove_bytes_scanned_cutoff_per_query, :requester_pays_enabled, :engine_version, :remove_customer_content_encryption_configuration, :additional_configuration, :execution_role, :customer_content_encryption_configuration, :enable_minimum_encryption_configuration, :query_results_s3_access_grants_configuration) SENSITIVE = [] include Aws::Structure end |
#query_results_s3_access_grants_configuration ⇒ Types::QueryResultsS3AccessGrantsConfiguration
Specifies whether Amazon S3 access grants are enabled for query results.
5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 5111 class WorkGroupConfigurationUpdates < Struct.new( :enforce_work_group_configuration, :result_configuration_updates, :publish_cloud_watch_metrics_enabled, :bytes_scanned_cutoff_per_query, :remove_bytes_scanned_cutoff_per_query, :requester_pays_enabled, :engine_version, :remove_customer_content_encryption_configuration, :additional_configuration, :execution_role, :customer_content_encryption_configuration, :enable_minimum_encryption_configuration, :query_results_s3_access_grants_configuration) SENSITIVE = [] include Aws::Structure end |
#remove_bytes_scanned_cutoff_per_query ⇒ Boolean
Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery
5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 5111 class WorkGroupConfigurationUpdates < Struct.new( :enforce_work_group_configuration, :result_configuration_updates, :publish_cloud_watch_metrics_enabled, :bytes_scanned_cutoff_per_query, :remove_bytes_scanned_cutoff_per_query, :requester_pays_enabled, :engine_version, :remove_customer_content_encryption_configuration, :additional_configuration, :execution_role, :customer_content_encryption_configuration, :enable_minimum_encryption_configuration, :query_results_s3_access_grants_configuration) SENSITIVE = [] include Aws::Structure end |
#remove_customer_content_encryption_configuration ⇒ Boolean
Removes content encryption configuration from an Apache Spark-enabled Athena workgroup.
5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 5111 class WorkGroupConfigurationUpdates < Struct.new( :enforce_work_group_configuration, :result_configuration_updates, :publish_cloud_watch_metrics_enabled, :bytes_scanned_cutoff_per_query, :remove_bytes_scanned_cutoff_per_query, :requester_pays_enabled, :engine_version, :remove_customer_content_encryption_configuration, :additional_configuration, :execution_role, :customer_content_encryption_configuration, :enable_minimum_encryption_configuration, :query_results_s3_access_grants_configuration) SENSITIVE = [] include Aws::Structure end |
#requester_pays_enabled ⇒ Boolean
If set to true
, allows members assigned to a workgroup to specify
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.
5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 5111 class WorkGroupConfigurationUpdates < Struct.new( :enforce_work_group_configuration, :result_configuration_updates, :publish_cloud_watch_metrics_enabled, :bytes_scanned_cutoff_per_query, :remove_bytes_scanned_cutoff_per_query, :requester_pays_enabled, :engine_version, :remove_customer_content_encryption_configuration, :additional_configuration, :execution_role, :customer_content_encryption_configuration, :enable_minimum_encryption_configuration, :query_results_s3_access_grants_configuration) SENSITIVE = [] include Aws::Structure end |
#result_configuration_updates ⇒ Types::ResultConfigurationUpdates
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.
5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 |
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 5111 class WorkGroupConfigurationUpdates < Struct.new( :enforce_work_group_configuration, :result_configuration_updates, :publish_cloud_watch_metrics_enabled, :bytes_scanned_cutoff_per_query, :remove_bytes_scanned_cutoff_per_query, :requester_pays_enabled, :engine_version, :remove_customer_content_encryption_configuration, :additional_configuration, :execution_role, :customer_content_encryption_configuration, :enable_minimum_encryption_configuration, :query_results_s3_access_grants_configuration) SENSITIVE = [] include Aws::Structure end |