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,
    requester_pays_enabled: false,
    engine_version: {
      selected_engine_version: "NameString",
      effective_engine_version: "NameString",
    },
  },
  description: "WorkGroupDescriptionString",
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

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.


430
431
432
433
434
435
436
437
# File 'lib/aws-sdk-athena/types.rb', line 430

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

#descriptionString

The workgroup description.

Returns:

  • (String)

430
431
432
433
434
435
436
437
# File 'lib/aws-sdk-athena/types.rb', line 430

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

#nameString

The workgroup name.

Returns:

  • (String)

430
431
432
433
434
435
436
437
# File 'lib/aws-sdk-athena/types.rb', line 430

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

#tagsArray<Types::Tag>

A list of comma separated tags to add to the workgroup that is created.

Returns:


430
431
432
433
434
435
436
437
# File 'lib/aws-sdk-athena/types.rb', line 430

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