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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-athena/types.rb

Overview

Note:

When making an API call, you may pass WorkGroupConfiguration data as a hash:

{
  result_configuration: {
    output_location: "String",
    encryption_configuration: {
      encryption_option: "SSE_S3", # required, accepts SSE_S3, SSE_KMS, CSE_KMS
      kms_key: "String",
    },
  },
  enforce_work_group_configuration: false,
  publish_cloud_watch_metrics_enabled: false,
  bytes_scanned_cutoff_per_query: 1,
}

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 the Amazon CloudWatch Metrics are enabled for the workgroup and whether workgroup settings override query settings, and the data usage limit for the amount of data scanned per query, if it is specified. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#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) 


1479
1480
1481
1482
1483
1484
1485
 
# File 'lib/aws-sdk-athena/types.rb', line 1479

class WorkGroupConfiguration < Struct.new(
  :result_configuration,
  :enforce_work_group_configuration,
  :publish_cloud_watch_metrics_enabled,
  :bytes_scanned_cutoff_per_query)
  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) 


1479
1480
1481
1482
1483
1484
1485
 
# File 'lib/aws-sdk-athena/types.rb', line 1479

class WorkGroupConfiguration < Struct.new(
  :result_configuration,
  :enforce_work_group_configuration,
  :publish_cloud_watch_metrics_enabled,
  :bytes_scanned_cutoff_per_query)
  include Aws::Structure
end

#publish_cloud_watch_metrics_enabled ⇒ Boolean

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

Returns:

  • (Boolean) 


1479
1480
1481
1482
1483
1484
1485
 
# File 'lib/aws-sdk-athena/types.rb', line 1479

class WorkGroupConfiguration < Struct.new(
  :result_configuration,
  :enforce_work_group_configuration,
  :publish_cloud_watch_metrics_enabled,
  :bytes_scanned_cutoff_per_query)
  include Aws::Structure
end

#result_configuration ⇒ Types::ResultConfiguration

The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results.

Returns:



1479
1480
1481
1482
1483
1484
1485
 
# File 'lib/aws-sdk-athena/types.rb', line 1479

class WorkGroupConfiguration < Struct.new(
  :result_configuration,
  :enforce_work_group_configuration,
  :publish_cloud_watch_metrics_enabled,
  :bytes_scanned_cutoff_per_query)
  include Aws::Structure
end