Package com.pulumi.aws.s3

Class AnalyticsConfiguration

java.lang.Object

com.pulumi.resources.Resource

com.pulumi.resources.CustomResource

com.pulumi.aws.s3.AnalyticsConfiguration

public class AnalyticsConfiguration
extends com.pulumi.resources.CustomResource

Provides a S3 bucket [analytics configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html) 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 <!--Start PulumiCodeChooser -->

 
 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());
 
     }
 }
 
 

<!--End PulumiCodeChooser --> ### Add analytics configuration with S3 object filter <!--Start PulumiCodeChooser -->

 
 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());
 
     }
 }
 
 

<!--End PulumiCodeChooser --> ## Import Using `pulumi import`, import S3 bucket analytics configurations using `bucket:analytics`. For example: ```sh $ pulumi import aws:s3/analyticsConfiguration:AnalyticsConfiguration my-bucket-entire-bucket my-bucket:EntireBucket ```

Nested Class Summary

Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

com.pulumi.resources.CustomResource.CustomResourceInternal

Nested classes/interfaces inherited from class com.pulumi.resources.Resource

com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

Field Summary

Fields inherited from class com.pulumi.resources.Resource

childResources, remote

Constructor Summary

Constructors

Constructor	Description
AnalyticsConfiguration(java.lang.String name)
AnalyticsConfiguration(java.lang.String name, AnalyticsConfigurationArgs args)
AnalyticsConfiguration(java.lang.String name, AnalyticsConfigurationArgs args, com.pulumi.resources.CustomResourceOptions options)

Method Summary

Modifier and Type	Method	Description
com.pulumi.core.Output<java.lang.String>	bucket()
com.pulumi.core.Output<java.util.Optional<AnalyticsConfigurationFilter>>	filter()
static AnalyticsConfiguration	get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AnalyticsConfigurationState state, com.pulumi.resources.CustomResourceOptions options)	Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
com.pulumi.core.Output<java.lang.String>	name()
com.pulumi.core.Output<java.util.Optional<AnalyticsConfigurationStorageClassAnalysis>>	storageClassAnalysis()

Methods inherited from class com.pulumi.resources.CustomResource

getId, id, idFuture

Methods inherited from class com.pulumi.resources.Resource

getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AnalyticsConfiguration

public AnalyticsConfiguration(java.lang.String name)

Parameters:

name - The _unique_ name of the resulting resource.

AnalyticsConfiguration

public AnalyticsConfiguration(java.lang.String name,
                              AnalyticsConfigurationArgs args)

Parameters:

name - The _unique_ name of the resulting resource.

args - The arguments to use to populate this resource's properties.

AnalyticsConfiguration

public AnalyticsConfiguration(java.lang.String name,
                              AnalyticsConfigurationArgs args,
                              @Nullable
                              com.pulumi.resources.CustomResourceOptions options)

Parameters:

name - The _unique_ name of the resulting resource.

args - The arguments to use to populate this resource's properties.

options - A bag of options that control this resource's behavior.

Method Detail

bucket

public com.pulumi.core.Output<java.lang.String> bucket()

Returns:

Name of the bucket this analytics configuration is associated with.

filter

public com.pulumi.core.Output<java.util.Optional<AnalyticsConfigurationFilter>> filter()

Returns:

Object filtering that accepts a prefix, tags, or a logical AND of prefix and tags (documented below).

name

public com.pulumi.core.Output<java.lang.String> name()

Returns:

Unique identifier of the analytics configuration for the bucket.

storageClassAnalysis

public com.pulumi.core.Output<java.util.Optional<AnalyticsConfigurationStorageClassAnalysis>> storageClassAnalysis()

Returns:

Configuration for the analytics data export (documented below).

get

public static AnalyticsConfiguration get(java.lang.String name,
                                         com.pulumi.core.Output<java.lang.String> id,
                                         @Nullable
                                         AnalyticsConfigurationState state,
                                         @Nullable
                                         com.pulumi.resources.CustomResourceOptions options)

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

Parameters:

name - The _unique_ name of the resulting resource.

id - The _unique_ provider ID of the resource to lookup.

state -

options - Optional settings to control the behavior of the CustomResource.