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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateWorkGroupInput as input to an Aws::Client method, you can use a vanilla 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.

Returns:

  • (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.

#descriptionString

The workgroup description.

Returns:

  • (String)

    The workgroup description.

#nameString

The workgroup name.

Returns:

  • (String)

    The workgroup name.

#tagsArray<Types::Tag>

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

Returns:

  • (Array<Types::Tag>)

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