Class: Aws::Athena::Types::CreateWorkGroupInput

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 CreateWorkGroupInput data as a hash:

{
  name: "WorkGroupName", # required
  configuration: {
    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,
  },
  description: "WorkGroupDescriptionString",
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#configuration ⇒ Types::WorkGroupConfiguration

The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified, and whether workgroup’s settings (specified with EnforceWorkGroupConfiguration) in the WorkGroupConfiguration override client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

Returns:



263
264
265
266
267
268
269
 
# File 'lib/aws-sdk-athena/types.rb', line 263

class CreateWorkGroupInput < Struct.new(
  :name,
  :configuration,
  :description,
  :tags)
  include Aws::Structure
end

#description ⇒ String

The workgroup description.

Returns:

  • (String) 


263
264
265
266
267
268
269
 
# File 'lib/aws-sdk-athena/types.rb', line 263

class CreateWorkGroupInput < Struct.new(
  :name,
  :configuration,
  :description,
  :tags)
  include Aws::Structure
end

#name ⇒ String

The workgroup name.

Returns:

  • (String) 


263
264
265
266
267
268
269
 
# File 'lib/aws-sdk-athena/types.rb', line 263

class CreateWorkGroupInput < Struct.new(
  :name,
  :configuration,
  :description,
  :tags)
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

One or more tags, separated by commas, that you want to attach to the workgroup as you create it.

Returns:



263
264
265
266
267
268
269
 
# File 'lib/aws-sdk-athena/types.rb', line 263

class CreateWorkGroupInput < Struct.new(
  :name,
  :configuration,
  :description,
  :tags)
  include Aws::Structure
end