» Resource: aws_s3_bucket_analytics_configuration

Provides a S3 bucket analytics configuration resource.

» Example Usage

» Add analytics configuration for entire S3 bucket and export results to a second S3 bucket

resource "aws_s3_bucket_analytics_configuration" "example-entire-bucket" {
  bucket = aws_s3_bucket.example.bucket
  name   = "EntireBucket"

  storage_class_analysis {
    data_export {
      destination {
        s3_bucket_destination {
          bucket_arn = aws_s3_bucket.analytics.arn
        }
      }
    }
  }
}

resource "aws_s3_bucket" "example" {
  bucket = "example"
}

resource "aws_s3_bucket" "analytics" {
  bucket = "analytics destination"
}

» Add analytics configuration with S3 bucket object filter

resource "aws_s3_bucket_analytics_configuration" "example-filtered" {
  bucket = aws_s3_bucket.example.bucket
  name   = "ImportantBlueDocuments"

  filter {
    prefix = "documents/"

    tags = {
      priority = "high"
      class    = "blue"
    }
  }
}

resource "aws_s3_bucket" "example" {
  bucket = "example"
}

» Argument Reference

The following arguments are supported:

  • bucket - (Required) The name of the bucket this analytics configuration is associated with.
  • name - (Required) Unique identifier of the analytics configuration for the bucket.
  • filter - (Optional) Object filtering that accepts a prefix, tags, or a logical AND of prefix and tags (documented below).
  • storage_class_analysis - (Optional) Configuration for the analytics data export (documented below).

The filter configuration supports the following:

  • prefix - (Optional) Object prefix for filtering.
  • tags - (Optional) Set of object tags for filtering.

The storage_class_analysis configuration supports the following:

  • data_export - (Required) Data export configuration (documented below).

The data_export configuration supports the following:

  • output_schema_version - (Optional) The schema version of exported analytics data. Allowed values: V_1. Default value: V_1.
  • destination - (Required) Specifies the destination for the exported analytics data (documented below).

The destination configuration supports the following:

  • s3_bucket_destination - (Required) Analytics data export currently only supports an S3 bucket destination (documented below).

The s3_bucket_destination configuration supports the following:

  • bucket_arn - (Required) The ARN of the destination bucket.
  • bucket_account_id - (Optional) The account ID that owns the destination bucket.
  • format - (Optional) The output format of exported analytics data. Allowed values: CSV. Default value: CSV.
  • prefix - (Optional) The prefix to append to exported analytics data.

» Import

S3 bucket analytics configurations can be imported using bucket:analytics, e.g.

$ terraform import aws_s3_bucket_analytics_configuration.my-bucket-entire-bucket my-bucket:EntireBucket