1. Packages
  2. AWS Classic
  3. API Docs
  4. s3
  5. AnalyticsConfiguration

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

aws.s3.AnalyticsConfiguration

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

    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.BucketV2("example", {bucket: "example"});
    const analytics = new aws.s3.BucketV2("analytics", {bucket: "analytics destination"});
    const example_entire_bucket = new aws.s3.AnalyticsConfiguration("example-entire-bucket", {
        bucket: example.id,
        name: "EntireBucket",
        storageClassAnalysis: {
            dataExport: {
                destination: {
                    s3BucketDestination: {
                        bucketArn: analytics.arn,
                    },
                },
            },
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.s3.BucketV2("example", bucket="example")
    analytics = aws.s3.BucketV2("analytics", bucket="analytics destination")
    example_entire_bucket = aws.s3.AnalyticsConfiguration("example-entire-bucket",
        bucket=example.id,
        name="EntireBucket",
        storage_class_analysis=aws.s3.AnalyticsConfigurationStorageClassAnalysisArgs(
            data_export=aws.s3.AnalyticsConfigurationStorageClassAnalysisDataExportArgs(
                destination=aws.s3.AnalyticsConfigurationStorageClassAnalysisDataExportDestinationArgs(
                    s3_bucket_destination=aws.s3.AnalyticsConfigurationStorageClassAnalysisDataExportDestinationS3BucketDestinationArgs(
                        bucket_arn=analytics.arn,
                    ),
                ),
            ),
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/s3"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := s3.NewBucketV2(ctx, "example", &s3.BucketV2Args{
    			Bucket: pulumi.String("example"),
    		})
    		if err != nil {
    			return err
    		}
    		analytics, err := s3.NewBucketV2(ctx, "analytics", &s3.BucketV2Args{
    			Bucket: pulumi.String("analytics destination"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = s3.NewAnalyticsConfiguration(ctx, "example-entire-bucket", &s3.AnalyticsConfigurationArgs{
    			Bucket: example.ID(),
    			Name:   pulumi.String("EntireBucket"),
    			StorageClassAnalysis: &s3.AnalyticsConfigurationStorageClassAnalysisArgs{
    				DataExport: &s3.AnalyticsConfigurationStorageClassAnalysisDataExportArgs{
    					Destination: &s3.AnalyticsConfigurationStorageClassAnalysisDataExportDestinationArgs{
    						S3BucketDestination: &s3.AnalyticsConfigurationStorageClassAnalysisDataExportDestinationS3BucketDestinationArgs{
    							BucketArn: analytics.Arn,
    						},
    					},
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.S3.BucketV2("example", new()
        {
            Bucket = "example",
        });
    
        var analytics = new Aws.S3.BucketV2("analytics", new()
        {
            Bucket = "analytics destination",
        });
    
        var example_entire_bucket = new Aws.S3.AnalyticsConfiguration("example-entire-bucket", new()
        {
            Bucket = example.Id,
            Name = "EntireBucket",
            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,
                        },
                    },
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.s3.BucketV2;
    import com.pulumi.aws.s3.BucketV2Args;
    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.List;
    import java.util.ArrayList;
    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 BucketV2("example", BucketV2Args.builder()
                .bucket("example")
                .build());
    
            var analytics = new BucketV2("analytics", BucketV2Args.builder()
                .bucket("analytics destination")
                .build());
    
            var example_entire_bucket = new AnalyticsConfiguration("example-entire-bucket", AnalyticsConfigurationArgs.builder()
                .bucket(example.id())
                .name("EntireBucket")
                .storageClassAnalysis(AnalyticsConfigurationStorageClassAnalysisArgs.builder()
                    .dataExport(AnalyticsConfigurationStorageClassAnalysisDataExportArgs.builder()
                        .destination(AnalyticsConfigurationStorageClassAnalysisDataExportDestinationArgs.builder()
                            .s3BucketDestination(AnalyticsConfigurationStorageClassAnalysisDataExportDestinationS3BucketDestinationArgs.builder()
                                .bucketArn(analytics.arn())
                                .build())
                            .build())
                        .build())
                    .build())
                .build());
    
        }
    }
    
    resources:
      example-entire-bucket:
        type: aws:s3:AnalyticsConfiguration
        properties:
          bucket: ${example.id}
          name: EntireBucket
          storageClassAnalysis:
            dataExport:
              destination:
                s3BucketDestination:
                  bucketArn: ${analytics.arn}
      example:
        type: aws:s3:BucketV2
        properties:
          bucket: example
      analytics:
        type: aws:s3:BucketV2
        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.BucketV2("example", {bucket: "example"});
    const example_filtered = new aws.s3.AnalyticsConfiguration("example-filtered", {
        bucket: example.id,
        name: "ImportantBlueDocuments",
        filter: {
            prefix: "documents/",
            tags: {
                priority: "high",
                "class": "blue",
            },
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.s3.BucketV2("example", bucket="example")
    example_filtered = aws.s3.AnalyticsConfiguration("example-filtered",
        bucket=example.id,
        name="ImportantBlueDocuments",
        filter=aws.s3.AnalyticsConfigurationFilterArgs(
            prefix="documents/",
            tags={
                "priority": "high",
                "class": "blue",
            },
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/s3"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := s3.NewBucketV2(ctx, "example", &s3.BucketV2Args{
    			Bucket: pulumi.String("example"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = s3.NewAnalyticsConfiguration(ctx, "example-filtered", &s3.AnalyticsConfigurationArgs{
    			Bucket: example.ID(),
    			Name:   pulumi.String("ImportantBlueDocuments"),
    			Filter: &s3.AnalyticsConfigurationFilterArgs{
    				Prefix: pulumi.String("documents/"),
    				Tags: pulumi.StringMap{
    					"priority": pulumi.String("high"),
    					"class":    pulumi.String("blue"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.S3.BucketV2("example", new()
        {
            Bucket = "example",
        });
    
        var example_filtered = new Aws.S3.AnalyticsConfiguration("example-filtered", new()
        {
            Bucket = example.Id,
            Name = "ImportantBlueDocuments",
            Filter = new Aws.S3.Inputs.AnalyticsConfigurationFilterArgs
            {
                Prefix = "documents/",
                Tags = 
                {
                    { "priority", "high" },
                    { "class", "blue" },
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.s3.BucketV2;
    import com.pulumi.aws.s3.BucketV2Args;
    import com.pulumi.aws.s3.AnalyticsConfiguration;
    import com.pulumi.aws.s3.AnalyticsConfigurationArgs;
    import com.pulumi.aws.s3.inputs.AnalyticsConfigurationFilterArgs;
    import java.util.List;
    import java.util.ArrayList;
    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 BucketV2("example", BucketV2Args.builder()
                .bucket("example")
                .build());
    
            var example_filtered = new AnalyticsConfiguration("example-filtered", AnalyticsConfigurationArgs.builder()
                .bucket(example.id())
                .name("ImportantBlueDocuments")
                .filter(AnalyticsConfigurationFilterArgs.builder()
                    .prefix("documents/")
                    .tags(Map.ofEntries(
                        Map.entry("priority", "high"),
                        Map.entry("class", "blue")
                    ))
                    .build())
                .build());
    
        }
    }
    
    resources:
      example-filtered:
        type: aws:s3:AnalyticsConfiguration
        properties:
          bucket: ${example.id}
          name: ImportantBlueDocuments
          filter:
            prefix: documents/
            tags:
              priority: high
              class: blue
      example:
        type: aws:s3:BucketV2
        properties:
          bucket: example
    

    Create AnalyticsConfiguration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AnalyticsConfiguration(name: string, args: AnalyticsConfigurationArgs, opts?: CustomResourceOptions);
    @overload
    def AnalyticsConfiguration(resource_name: str,
                               args: AnalyticsConfigurationArgs,
                               opts: Optional[ResourceOptions] = None)
    
    @overload
    def AnalyticsConfiguration(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               bucket: Optional[str] = None,
                               filter: Optional[AnalyticsConfigurationFilterArgs] = None,
                               name: Optional[str] = None,
                               storage_class_analysis: Optional[AnalyticsConfigurationStorageClassAnalysisArgs] = None)
    func NewAnalyticsConfiguration(ctx *Context, name string, args AnalyticsConfigurationArgs, opts ...ResourceOption) (*AnalyticsConfiguration, error)
    public AnalyticsConfiguration(string name, AnalyticsConfigurationArgs args, CustomResourceOptions? opts = null)
    public AnalyticsConfiguration(String name, AnalyticsConfigurationArgs args)
    public AnalyticsConfiguration(String name, AnalyticsConfigurationArgs args, CustomResourceOptions options)
    
    type: aws:s3:AnalyticsConfiguration
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args AnalyticsConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AnalyticsConfigurationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AnalyticsConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AnalyticsConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AnalyticsConfigurationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var analyticsConfigurationResource = new Aws.S3.AnalyticsConfiguration("analyticsConfigurationResource", new()
    {
        Bucket = "string",
        Filter = new Aws.S3.Inputs.AnalyticsConfigurationFilterArgs
        {
            Prefix = "string",
            Tags = 
            {
                { "string", "string" },
            },
        },
        Name = "string",
        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 = "string",
                        BucketAccountId = "string",
                        Format = "string",
                        Prefix = "string",
                    },
                },
                OutputSchemaVersion = "string",
            },
        },
    });
    
    example, err := s3.NewAnalyticsConfiguration(ctx, "analyticsConfigurationResource", &s3.AnalyticsConfigurationArgs{
    	Bucket: pulumi.String("string"),
    	Filter: &s3.AnalyticsConfigurationFilterArgs{
    		Prefix: pulumi.String("string"),
    		Tags: pulumi.StringMap{
    			"string": pulumi.String("string"),
    		},
    	},
    	Name: pulumi.String("string"),
    	StorageClassAnalysis: &s3.AnalyticsConfigurationStorageClassAnalysisArgs{
    		DataExport: &s3.AnalyticsConfigurationStorageClassAnalysisDataExportArgs{
    			Destination: &s3.AnalyticsConfigurationStorageClassAnalysisDataExportDestinationArgs{
    				S3BucketDestination: &s3.AnalyticsConfigurationStorageClassAnalysisDataExportDestinationS3BucketDestinationArgs{
    					BucketArn:       pulumi.String("string"),
    					BucketAccountId: pulumi.String("string"),
    					Format:          pulumi.String("string"),
    					Prefix:          pulumi.String("string"),
    				},
    			},
    			OutputSchemaVersion: pulumi.String("string"),
    		},
    	},
    })
    
    var analyticsConfigurationResource = new AnalyticsConfiguration("analyticsConfigurationResource", AnalyticsConfigurationArgs.builder()
        .bucket("string")
        .filter(AnalyticsConfigurationFilterArgs.builder()
            .prefix("string")
            .tags(Map.of("string", "string"))
            .build())
        .name("string")
        .storageClassAnalysis(AnalyticsConfigurationStorageClassAnalysisArgs.builder()
            .dataExport(AnalyticsConfigurationStorageClassAnalysisDataExportArgs.builder()
                .destination(AnalyticsConfigurationStorageClassAnalysisDataExportDestinationArgs.builder()
                    .s3BucketDestination(AnalyticsConfigurationStorageClassAnalysisDataExportDestinationS3BucketDestinationArgs.builder()
                        .bucketArn("string")
                        .bucketAccountId("string")
                        .format("string")
                        .prefix("string")
                        .build())
                    .build())
                .outputSchemaVersion("string")
                .build())
            .build())
        .build());
    
    analytics_configuration_resource = aws.s3.AnalyticsConfiguration("analyticsConfigurationResource",
        bucket="string",
        filter=aws.s3.AnalyticsConfigurationFilterArgs(
            prefix="string",
            tags={
                "string": "string",
            },
        ),
        name="string",
        storage_class_analysis=aws.s3.AnalyticsConfigurationStorageClassAnalysisArgs(
            data_export=aws.s3.AnalyticsConfigurationStorageClassAnalysisDataExportArgs(
                destination=aws.s3.AnalyticsConfigurationStorageClassAnalysisDataExportDestinationArgs(
                    s3_bucket_destination=aws.s3.AnalyticsConfigurationStorageClassAnalysisDataExportDestinationS3BucketDestinationArgs(
                        bucket_arn="string",
                        bucket_account_id="string",
                        format="string",
                        prefix="string",
                    ),
                ),
                output_schema_version="string",
            ),
        ))
    
    const analyticsConfigurationResource = new aws.s3.AnalyticsConfiguration("analyticsConfigurationResource", {
        bucket: "string",
        filter: {
            prefix: "string",
            tags: {
                string: "string",
            },
        },
        name: "string",
        storageClassAnalysis: {
            dataExport: {
                destination: {
                    s3BucketDestination: {
                        bucketArn: "string",
                        bucketAccountId: "string",
                        format: "string",
                        prefix: "string",
                    },
                },
                outputSchemaVersion: "string",
            },
        },
    });
    
    type: aws:s3:AnalyticsConfiguration
    properties:
        bucket: string
        filter:
            prefix: string
            tags:
                string: string
        name: string
        storageClassAnalysis:
            dataExport:
                destination:
                    s3BucketDestination:
                        bucketAccountId: string
                        bucketArn: string
                        format: string
                        prefix: string
                outputSchemaVersion: string
    

    AnalyticsConfiguration Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The AnalyticsConfiguration resource accepts the following input properties:

    Bucket string
    Name of the bucket this analytics configuration is associated with.
    Filter AnalyticsConfigurationFilter
    Object filtering that accepts a prefix, tags, or a logical AND of prefix and tags (documented below).
    Name string
    Unique identifier of the analytics configuration for the bucket.
    StorageClassAnalysis AnalyticsConfigurationStorageClassAnalysis
    Configuration for the analytics data export (documented below).
    Bucket string
    Name of the bucket this analytics configuration is associated with.
    Filter AnalyticsConfigurationFilterArgs
    Object filtering that accepts a prefix, tags, or a logical AND of prefix and tags (documented below).
    Name string
    Unique identifier of the analytics configuration for the bucket.
    StorageClassAnalysis AnalyticsConfigurationStorageClassAnalysisArgs
    Configuration for the analytics data export (documented below).
    bucket String
    Name of the bucket this analytics configuration is associated with.
    filter AnalyticsConfigurationFilter
    Object filtering that accepts a prefix, tags, or a logical AND of prefix and tags (documented below).
    name String
    Unique identifier of the analytics configuration for the bucket.
    storageClassAnalysis AnalyticsConfigurationStorageClassAnalysis
    Configuration for the analytics data export (documented below).
    bucket string
    Name of the bucket this analytics configuration is associated with.
    filter AnalyticsConfigurationFilter
    Object filtering that accepts a prefix, tags, or a logical AND of prefix and tags (documented below).
    name string
    Unique identifier of the analytics configuration for the bucket.
    storageClassAnalysis AnalyticsConfigurationStorageClassAnalysis
    Configuration for the analytics data export (documented below).
    bucket str
    Name of the bucket this analytics configuration is associated with.
    filter AnalyticsConfigurationFilterArgs
    Object filtering that accepts a prefix, tags, or a logical AND of prefix and tags (documented below).
    name str
    Unique identifier of the analytics configuration for the bucket.
    storage_class_analysis AnalyticsConfigurationStorageClassAnalysisArgs
    Configuration for the analytics data export (documented below).
    bucket String
    Name of the bucket this analytics configuration is associated with.
    filter Property Map
    Object filtering that accepts a prefix, tags, or a logical AND of prefix and tags (documented below).
    name String
    Unique identifier of the analytics configuration for the bucket.
    storageClassAnalysis Property Map
    Configuration for the analytics data export (documented below).

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AnalyticsConfiguration resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AnalyticsConfiguration Resource

    Get an existing AnalyticsConfiguration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AnalyticsConfigurationState, opts?: CustomResourceOptions): AnalyticsConfiguration
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            bucket: Optional[str] = None,
            filter: Optional[AnalyticsConfigurationFilterArgs] = None,
            name: Optional[str] = None,
            storage_class_analysis: Optional[AnalyticsConfigurationStorageClassAnalysisArgs] = None) -> AnalyticsConfiguration
    func GetAnalyticsConfiguration(ctx *Context, name string, id IDInput, state *AnalyticsConfigurationState, opts ...ResourceOption) (*AnalyticsConfiguration, error)
    public static AnalyticsConfiguration Get(string name, Input<string> id, AnalyticsConfigurationState? state, CustomResourceOptions? opts = null)
    public static AnalyticsConfiguration get(String name, Output<String> id, AnalyticsConfigurationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Bucket string
    Name of the bucket this analytics configuration is associated with.
    Filter AnalyticsConfigurationFilter
    Object filtering that accepts a prefix, tags, or a logical AND of prefix and tags (documented below).
    Name string
    Unique identifier of the analytics configuration for the bucket.
    StorageClassAnalysis AnalyticsConfigurationStorageClassAnalysis
    Configuration for the analytics data export (documented below).
    Bucket string
    Name of the bucket this analytics configuration is associated with.
    Filter AnalyticsConfigurationFilterArgs
    Object filtering that accepts a prefix, tags, or a logical AND of prefix and tags (documented below).
    Name string
    Unique identifier of the analytics configuration for the bucket.
    StorageClassAnalysis AnalyticsConfigurationStorageClassAnalysisArgs
    Configuration for the analytics data export (documented below).
    bucket String
    Name of the bucket this analytics configuration is associated with.
    filter AnalyticsConfigurationFilter
    Object filtering that accepts a prefix, tags, or a logical AND of prefix and tags (documented below).
    name String
    Unique identifier of the analytics configuration for the bucket.
    storageClassAnalysis AnalyticsConfigurationStorageClassAnalysis
    Configuration for the analytics data export (documented below).
    bucket string
    Name of the bucket this analytics configuration is associated with.
    filter AnalyticsConfigurationFilter
    Object filtering that accepts a prefix, tags, or a logical AND of prefix and tags (documented below).
    name string
    Unique identifier of the analytics configuration for the bucket.
    storageClassAnalysis AnalyticsConfigurationStorageClassAnalysis
    Configuration for the analytics data export (documented below).
    bucket str
    Name of the bucket this analytics configuration is associated with.
    filter AnalyticsConfigurationFilterArgs
    Object filtering that accepts a prefix, tags, or a logical AND of prefix and tags (documented below).
    name str
    Unique identifier of the analytics configuration for the bucket.
    storage_class_analysis AnalyticsConfigurationStorageClassAnalysisArgs
    Configuration for the analytics data export (documented below).
    bucket String
    Name of the bucket this analytics configuration is associated with.
    filter Property Map
    Object filtering that accepts a prefix, tags, or a logical AND of prefix and tags (documented below).
    name String
    Unique identifier of the analytics configuration for the bucket.
    storageClassAnalysis Property Map
    Configuration for the analytics data export (documented below).

    Supporting Types

    AnalyticsConfigurationFilter, AnalyticsConfigurationFilterArgs

    Prefix string
    Object prefix for filtering.
    Tags Dictionary<string, string>
    Set of object tags for filtering.
    Prefix string
    Object prefix for filtering.
    Tags map[string]string
    Set of object tags for filtering.
    prefix String
    Object prefix for filtering.
    tags Map<String,String>
    Set of object tags for filtering.
    prefix string
    Object prefix for filtering.
    tags {[key: string]: string}
    Set of object tags for filtering.
    prefix str
    Object prefix for filtering.
    tags Mapping[str, str]
    Set of object tags for filtering.
    prefix String
    Object prefix for filtering.
    tags Map<String>
    Set of object tags for filtering.

    AnalyticsConfigurationStorageClassAnalysis, AnalyticsConfigurationStorageClassAnalysisArgs

    DataExport AnalyticsConfigurationStorageClassAnalysisDataExport
    Data export configuration (documented below).
    DataExport AnalyticsConfigurationStorageClassAnalysisDataExport
    Data export configuration (documented below).
    dataExport AnalyticsConfigurationStorageClassAnalysisDataExport
    Data export configuration (documented below).
    dataExport AnalyticsConfigurationStorageClassAnalysisDataExport
    Data export configuration (documented below).
    data_export AnalyticsConfigurationStorageClassAnalysisDataExport
    Data export configuration (documented below).
    dataExport Property Map
    Data export configuration (documented below).

    AnalyticsConfigurationStorageClassAnalysisDataExport, AnalyticsConfigurationStorageClassAnalysisDataExportArgs

    Destination AnalyticsConfigurationStorageClassAnalysisDataExportDestination
    Specifies the destination for the exported analytics data (documented below).
    OutputSchemaVersion string
    Schema version of exported analytics data. Allowed values: V_1. Default value: V_1.
    Destination AnalyticsConfigurationStorageClassAnalysisDataExportDestination
    Specifies the destination for the exported analytics data (documented below).
    OutputSchemaVersion string
    Schema version of exported analytics data. Allowed values: V_1. Default value: V_1.
    destination AnalyticsConfigurationStorageClassAnalysisDataExportDestination
    Specifies the destination for the exported analytics data (documented below).
    outputSchemaVersion String
    Schema version of exported analytics data. Allowed values: V_1. Default value: V_1.
    destination AnalyticsConfigurationStorageClassAnalysisDataExportDestination
    Specifies the destination for the exported analytics data (documented below).
    outputSchemaVersion string
    Schema version of exported analytics data. Allowed values: V_1. Default value: V_1.
    destination AnalyticsConfigurationStorageClassAnalysisDataExportDestination
    Specifies the destination for the exported analytics data (documented below).
    output_schema_version str
    Schema version of exported analytics data. Allowed values: V_1. Default value: V_1.
    destination Property Map
    Specifies the destination for the exported analytics data (documented below).
    outputSchemaVersion String
    Schema version of exported analytics data. Allowed values: V_1. Default value: V_1.

    AnalyticsConfigurationStorageClassAnalysisDataExportDestination, AnalyticsConfigurationStorageClassAnalysisDataExportDestinationArgs

    S3BucketDestination AnalyticsConfigurationStorageClassAnalysisDataExportDestinationS3BucketDestination
    Analytics data export currently only supports an S3 bucket destination (documented below).
    S3BucketDestination AnalyticsConfigurationStorageClassAnalysisDataExportDestinationS3BucketDestination
    Analytics data export currently only supports an S3 bucket destination (documented below).
    s3BucketDestination AnalyticsConfigurationStorageClassAnalysisDataExportDestinationS3BucketDestination
    Analytics data export currently only supports an S3 bucket destination (documented below).
    s3BucketDestination AnalyticsConfigurationStorageClassAnalysisDataExportDestinationS3BucketDestination
    Analytics data export currently only supports an S3 bucket destination (documented below).
    s3_bucket_destination AnalyticsConfigurationStorageClassAnalysisDataExportDestinationS3BucketDestination
    Analytics data export currently only supports an S3 bucket destination (documented below).
    s3BucketDestination Property Map
    Analytics data export currently only supports an S3 bucket destination (documented below).

    AnalyticsConfigurationStorageClassAnalysisDataExportDestinationS3BucketDestination, AnalyticsConfigurationStorageClassAnalysisDataExportDestinationS3BucketDestinationArgs

    BucketArn string
    ARN of the destination bucket.
    BucketAccountId string
    Account ID that owns the destination bucket.
    Format string
    Output format of exported analytics data. Allowed values: CSV. Default value: CSV.
    Prefix string
    Prefix to append to exported analytics data.
    BucketArn string
    ARN of the destination bucket.
    BucketAccountId string
    Account ID that owns the destination bucket.
    Format string
    Output format of exported analytics data. Allowed values: CSV. Default value: CSV.
    Prefix string
    Prefix to append to exported analytics data.
    bucketArn String
    ARN of the destination bucket.
    bucketAccountId String
    Account ID that owns the destination bucket.
    format String
    Output format of exported analytics data. Allowed values: CSV. Default value: CSV.
    prefix String
    Prefix to append to exported analytics data.
    bucketArn string
    ARN of the destination bucket.
    bucketAccountId string
    Account ID that owns the destination bucket.
    format string
    Output format of exported analytics data. Allowed values: CSV. Default value: CSV.
    prefix string
    Prefix to append to exported analytics data.
    bucket_arn str
    ARN of the destination bucket.
    bucket_account_id str
    Account ID that owns the destination bucket.
    format str
    Output format of exported analytics data. Allowed values: CSV. Default value: CSV.
    prefix str
    Prefix to append to exported analytics data.
    bucketArn String
    ARN of the destination bucket.
    bucketAccountId String
    Account ID that owns the destination bucket.
    format String
    Output format of exported analytics data. Allowed values: CSV. Default value: CSV.
    prefix String
    Prefix to append to exported analytics data.

    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
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi