AnalyticsConfiguration class

Provides a S3 bucket analytics configuration resource.

> This resource cannot be used with S3 directory buckets.

Example Usage

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

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.s3.Bucket("example", {bucket: "example"});
const analytics = new aws.s3.Bucket("analytics", {bucket: "analytics-destination"});
const example_entire_bucket = new aws.s3.AnalyticsConfiguration("example-entire-bucket", {
    storageClassAnalysis: {
        dataExport: {
            destination: {
                s3BucketDestination: {
                    bucketArn: analytics.arn,
                },
            },
        },
    },
    bucket: example.id,
    name: "EntireBucket",
});
import pulumi
import pulumi_aws as aws

example = aws.s3.Bucket("example", bucket="example")
analytics = aws.s3.Bucket("analytics", bucket="analytics-destination")
example_entire_bucket = aws.s3.AnalyticsConfiguration("example-entire-bucket",
    storage_class_analysis={
        "data_export": {
            "destination": {
                "s3_bucket_destination": {
                    "bucket_arn": analytics.arn,
                },
            },
        },
    },
    bucket=example.id,
    name="EntireBucket")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.S3.Bucket("example", new()
    {
        BucketName = "example",
    });

    var analytics = new Aws.S3.Bucket("analytics", new()
    {
        BucketName = "analytics-destination",
    });

    var example_entire_bucket = new Aws.S3.AnalyticsConfiguration("example-entire-bucket", new()
    {
        StorageClassAnalysis = new Aws.S3.Inputs.AnalyticsConfigurationStorageClassAnalysisArgs
        {
            DataExport = new Aws.S3.Inputs.AnalyticsConfigurationStorageClassAnalysisDataExportArgs
            {
                Destination = new Aws.S3.Inputs.AnalyticsConfigurationStorageClassAnalysisDataExportDestinationArgs
                {
                    S3BucketDestination = new Aws.S3.Inputs.AnalyticsConfigurationStorageClassAnalysisDataExportDestinationS3BucketDestinationArgs
                    {
                        BucketArn = analytics.Arn,
                    },
                },
            },
        },
        Bucket = example.Id,
        Name = "EntireBucket",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/s3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := s3.NewBucket(ctx, "example", &s3.BucketArgs{
			Bucket: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		analytics, err := s3.NewBucket(ctx, "analytics", &s3.BucketArgs{
			Bucket: pulumi.String("analytics-destination"),
		})
		if err != nil {
			return err
		}
		_, err = s3.NewAnalyticsConfiguration(ctx, "example-entire-bucket", &s3.AnalyticsConfigurationArgs{
			StorageClassAnalysis: &s3.AnalyticsConfigurationStorageClassAnalysisArgs{
				DataExport: &s3.AnalyticsConfigurationStorageClassAnalysisDataExportArgs{
					Destination: &s3.AnalyticsConfigurationStorageClassAnalysisDataExportDestinationArgs{
						S3BucketDestination: &s3.AnalyticsConfigurationStorageClassAnalysisDataExportDestinationS3BucketDestinationArgs{
							BucketArn: analytics.Arn,
						},
					},
				},
			},
			Bucket: example.ID().ToIDOutput().ToStringOutput(),
			Name:   pulumi.String("EntireBucket"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_s3_analyticsconfiguration" "example-entire-bucket" {
  storage_class_analysis = {
    data_export = {
      destination = {
        s3_bucket_destination = {
          bucket_arn = aws_s3_bucket.analytics.arn
        }
      }
    }
  }
  bucket = aws_s3_bucket.example.id
  name   = "EntireBucket"
}
resource "aws_s3_bucket" "example" {
  bucket = "example"
}
resource "aws_s3_bucket" "analytics" {
  bucket = "analytics-destination"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.Bucket;
import com.pulumi.aws.s3.BucketArgs;
import com.pulumi.aws.s3.AnalyticsConfiguration;
import com.pulumi.aws.s3.AnalyticsConfigurationArgs;
import com.pulumi.aws.s3.inputs.AnalyticsConfigurationStorageClassAnalysisArgs;
import com.pulumi.aws.s3.inputs.AnalyticsConfigurationStorageClassAnalysisDataExportArgs;
import com.pulumi.aws.s3.inputs.AnalyticsConfigurationStorageClassAnalysisDataExportDestinationArgs;
import com.pulumi.aws.s3.inputs.AnalyticsConfigurationStorageClassAnalysisDataExportDestinationS3BucketDestinationArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Bucket("example", BucketArgs.builder()
            .bucket("example")
            .build());

        var analytics = new Bucket("analytics", BucketArgs.builder()
            .bucket("analytics-destination")
            .build());

        var example_entire_bucket = new AnalyticsConfiguration("example-entire-bucket", AnalyticsConfigurationArgs.builder()
            .storageClassAnalysis(AnalyticsConfigurationStorageClassAnalysisArgs.builder()
                .dataExport(AnalyticsConfigurationStorageClassAnalysisDataExportArgs.builder()
                    .destination(AnalyticsConfigurationStorageClassAnalysisDataExportDestinationArgs.builder()
                        .s3BucketDestination(AnalyticsConfigurationStorageClassAnalysisDataExportDestinationS3BucketDestinationArgs.builder()
                            .bucketArn(analytics.arn())
                            .build())
                        .build())
                    .build())
                .build())
            .bucket(example.id())
            .name("EntireBucket")
            .build());

    }
}
resources:
  example-entire-bucket:
    type: aws:s3:AnalyticsConfiguration
    properties:
      storageClassAnalysis:
        dataExport:
          destination:
            s3BucketDestination:
              bucketArn: ${analytics.arn}
      bucket: ${example.id}
      name: EntireBucket
  example:
    type: aws:s3:Bucket
    properties:
      bucket: example
  analytics:
    type: aws:s3:Bucket
    properties:
      bucket: analytics-destination

Add analytics configuration with S3 object filter

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.s3.Bucket("example", {bucket: "example"});
const example_filtered = new aws.s3.AnalyticsConfiguration("example-filtered", {
    filter: {
        prefix: "documents/",
        tags: {
            priority: "high",
            "class": "blue",
        },
    },
    bucket: example.id,
    name: "ImportantBlueDocuments",
});
import pulumi
import pulumi_aws as aws

example = aws.s3.Bucket("example", bucket="example")
example_filtered = aws.s3.AnalyticsConfiguration("example-filtered",
    filter={
        "prefix": "documents/",
        "tags": {
            "priority": "high",
            "class": "blue",
        },
    },
    bucket=example.id,
    name="ImportantBlueDocuments")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.S3.Bucket("example", new()
    {
        BucketName = "example",
    });

    var example_filtered = new Aws.S3.AnalyticsConfiguration("example-filtered", new()
    {
        Filter = new Aws.S3.Inputs.AnalyticsConfigurationFilterArgs
        {
            Prefix = "documents/",
            Tags =
            {
                { "priority", "high" },
                { "class", "blue" },
            },
        },
        Bucket = example.Id,
        Name = "ImportantBlueDocuments",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/s3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := s3.NewBucket(ctx, "example", &s3.BucketArgs{
			Bucket: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		_, err = s3.NewAnalyticsConfiguration(ctx, "example-filtered", &s3.AnalyticsConfigurationArgs{
			Filter: &s3.AnalyticsConfigurationFilterArgs{
				Prefix: pulumi.String("documents/"),
				Tags: pulumi.StringMap{
					"priority": pulumi.String("high"),
					"class":    pulumi.String("blue"),
				},
			},
			Bucket: example.ID().ToIDOutput().ToStringOutput(),
			Name:   pulumi.String("ImportantBlueDocuments"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_s3_analyticsconfiguration" "example-filtered" {
  filter = {
    prefix = "documents/"
    tags = {
      "priority" = "high"
      "class"    = "blue"
    }
  }
  bucket = aws_s3_bucket.example.id
  name   = "ImportantBlueDocuments"
}
resource "aws_s3_bucket" "example" {
  bucket = "example"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.Bucket;
import com.pulumi.aws.s3.BucketArgs;
import com.pulumi.aws.s3.AnalyticsConfiguration;
import com.pulumi.aws.s3.AnalyticsConfigurationArgs;
import com.pulumi.aws.s3.inputs.AnalyticsConfigurationFilterArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Bucket("example", BucketArgs.builder()
            .bucket("example")
            .build());

        var example_filtered = new AnalyticsConfiguration("example-filtered", AnalyticsConfigurationArgs.builder()
            .filter(AnalyticsConfigurationFilterArgs.builder()
                .prefix("documents/")
                .tags(Map.ofEntries(
                    Map.entry("priority", "high"),
                    Map.entry("class", "blue")
                ))
                .build())
            .bucket(example.id())
            .name("ImportantBlueDocuments")
            .build());

    }
}
resources:
  example-filtered:
    type: aws:s3:AnalyticsConfiguration
    properties:
      filter:
        prefix: documents/
        tags:
          priority: high
          class: blue
      bucket: ${example.id}
      name: ImportantBlueDocuments
  example:
    type: aws:s3:Bucket
    properties:
      bucket: example

Import

Using pulumi import, import S3 bucket analytics configurations using bucket:analytics. For example:

$ pulumi import aws:s3/analyticsConfiguration:AnalyticsConfiguration my-bucket-entire-bucket my-bucket:EntireBucket

Constructors

AnalyticsConfiguration(String name, {AnalyticsConfigurationArgs? args, CustomResourceOptions? options})
Creates a new AnalyticsConfiguration. name The Pulumi resource name. args Arguments used to configure this AnalyticsConfiguration. The set of arguments for AnalyticsConfiguration. options Resource options controlling this resource's behavior.
AnalyticsConfiguration.reference(String urn)
Creates a typed reference to an existing AnalyticsConfiguration resource.

Properties

bucket ↔ Output<String>
Name of the bucket this analytics configuration is associated with.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
filter ↔ Output<AnalyticsConfigurationFilter?>
Object filtering that accepts a prefix, tags, or a logical AND of prefix and tags (documented below).
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>
Unique identifier of the analytics configuration for the bucket.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
storageClassAnalysis ↔ Output<AnalyticsConfigurationStorageClassAnalysis?>
Configuration for the analytics data export (documented below).
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {AnalyticsConfigurationState? state, CustomResourceOptions? options}) → AnalyticsConfiguration
Gets an existing AnalyticsConfiguration resource's state with the given name and id.