You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-athena/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,
    requester_pays_enabled: false,
  },
  description: "WorkGroupDescriptionString",
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#configurationTypes::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.



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

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

#descriptionString

The workgroup description.

Returns:

  • (String)


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

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

#nameString

The workgroup name.

Returns:

  • (String)


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

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

#tagsArray<Types::Tag>

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

Returns:



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

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