Class: Aws::Athena::Types::WorkGroupConfiguration

Inherits:
Struct
  • Object
show all
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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#additional_configuration ⇒ String

Specifies a user defined JSON string that is passed to the notebook engine.

Returns:

  • (String) 


5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
 
# File 'lib/aws-sdk-athena/types.rb', line 5140

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,
  :identity_center_configuration,
  :query_results_s3_access_grants_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.

Returns:

  • (Integer) 


5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
 
# File 'lib/aws-sdk-athena/types.rb', line 5140

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,
  :identity_center_configuration,
  :query_results_s3_access_grants_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.

Returns:



5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
 
# File 'lib/aws-sdk-athena/types.rb', line 5140

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,
  :identity_center_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.

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.

Returns:

  • (Boolean) 


5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
 
# File 'lib/aws-sdk-athena/types.rb', line 5140

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,
  :identity_center_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].

[1]: docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html

Returns:

  • (Boolean) 


5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
 
# File 'lib/aws-sdk-athena/types.rb', line 5140

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,
  :identity_center_configuration,
  :query_results_s3_access_grants_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.

Returns:



5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
 
# File 'lib/aws-sdk-athena/types.rb', line 5140

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,
  :identity_center_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 IAM Identity Center enabled workgroups. This property applies only to Spark enabled workgroups and IAM Identity Center enabled workgroups. The property is required for IAM Identity Center enabled workgroups.

Returns:

  • (String) 


5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
 
# File 'lib/aws-sdk-athena/types.rb', line 5140

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,
  :identity_center_configuration,
  :query_results_s3_access_grants_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#identity_center_configuration ⇒ Types::IdentityCenterConfiguration

Specifies whether the workgroup is IAM Identity Center supported.

Returns:



5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
 
# File 'lib/aws-sdk-athena/types.rb', line 5140

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,
  :identity_center_configuration,
  :query_results_s3_access_grants_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#publish_cloud_watch_metrics_enabled ⇒ Boolean

Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.

Returns:

  • (Boolean) 


5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
 
# File 'lib/aws-sdk-athena/types.rb', line 5140

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,
  :identity_center_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.

Returns:



5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
 
# File 'lib/aws-sdk-athena/types.rb', line 5140

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,
  :identity_center_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 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

Returns:

  • (Boolean) 


5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
 
# File 'lib/aws-sdk-athena/types.rb', line 5140

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,
  :identity_center_configuration,
  :query_results_s3_access_grants_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.

Returns:



5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
 
# File 'lib/aws-sdk-athena/types.rb', line 5140

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,
  :identity_center_configuration,
  :query_results_s3_access_grants_configuration)
  SENSITIVE = []
  include Aws::Structure
end