» Resource: aws_athena_workgroup

Provides an Athena Workgroup.

» Example Usage

resource "aws_athena_workgroup" "example" {
  name = "example"

  configuration {
    enforce_workgroup_configuration    = true
    publish_cloudwatch_metrics_enabled = true

    result_configuration {
      output_location = "s3://{aws_s3_bucket.example.bucket}/output/"

      encryption_configuration {
        encryption_option = "SSE_KMS"
        kms_key_arn       = "${aws_kms_key.example.arn}"
      }
    }
  }
}

» Argument Reference

The following arguments are supported:

  • name - (Required) Name of the workgroup.
  • configuration - (Optional) Configuration block with various settings for the workgroup. Documented below.
  • description - (Optional) Description of the workgroup.
  • state - (Optional) State of the workgroup. Valid values are DISABLED or ENABLED. Defaults to ENABLED.
  • tags - (Optional) Key-value mapping of resource tags for the workgroup.

» configuration Argument Reference

The configuration configuration block supports the following arguments:

» result_configuration Argument Reference

The result_configuration configuration block within the configuration supports the following arguments:

» encryption_configuration Argument Reference

The encryption_configuration configuration block within the result_configuration of the configuration supports the following arguments:

  • encryption_option - (Required) Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE-S3), server-side encryption with KMS-managed keys (SSE-KMS), or client-side encryption with KMS-managed keys (CSE-KMS) is used. If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.
  • kms_key_arn - (Optional) For SSE-KMS and CSE-KMS, this is the KMS key Amazon Resource Name (ARN).

» Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • arn - Amazon Resource Name (ARN) of the workgroup
  • id - The workgroup name

» Import

Athena Workgroups can be imported using their name, e.g.

$ terraform import aws_athena_workgroup.example example