Package software.amazon.awscdk.services.s3

Interface CfnBucket.AnalyticsConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBucket.AnalyticsConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnBucket

@Stability(Stable)
public static interface CfnBucket.AnalyticsConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.s3.*;
 AnalyticsConfigurationProperty analyticsConfigurationProperty = AnalyticsConfigurationProperty.builder()
         .id("id")
         .storageClassAnalysis(StorageClassAnalysisProperty.builder()
                 .dataExport(DataExportProperty.builder()
                         .destination(DestinationProperty.builder()
                                 .bucketArn("bucketArn")
                                 .format("format")
                                 // the properties below are optional
                                 .bucketAccountId("bucketAccountId")
                                 .prefix("prefix")
                                 .build())
                         .outputSchemaVersion("outputSchemaVersion")
                         .build())
                 .build())
         // the properties below are optional
         .prefix("prefix")
         .tagFilters(List.of(TagFilterProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnBucket.AnalyticsConfigurationProperty.Builder	A builder for CfnBucket.AnalyticsConfigurationProperty
static final class	CfnBucket.AnalyticsConfigurationProperty.Jsii$Proxy	An implementation for CfnBucket.AnalyticsConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnBucket.AnalyticsConfigurationProperty.Builder	builder()
String	getId()	The ID that identifies the analytics configuration.
default String	getPrefix()	The prefix that an object must have to be included in the analytics results.
Object	getStorageClassAnalysis()	Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes.
default Object	getTagFilters()	The tags to use when evaluating an analytics filter.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getId

@Stability(Stable)
@NotNull
String getId()

The ID that identifies the analytics configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html#cfn-s3-bucket-analyticsconfiguration-id

getStorageClassAnalysis

@Stability(Stable)
@NotNull
Object getStorageClassAnalysis()

Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html#cfn-s3-bucket-analyticsconfiguration-storageclassanalysis

getPrefix

@Stability(Stable)
@Nullable
default String getPrefix()

The prefix that an object must have to be included in the analytics results.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html#cfn-s3-bucket-analyticsconfiguration-prefix

getTagFilters

@Stability(Stable)
@Nullable
default Object getTagFilters()

The tags to use when evaluating an analytics filter.

The analytics only includes objects that meet the filter's criteria. If no filter is specified, all of the contents of the bucket are included in the analysis.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html#cfn-s3-bucket-analyticsconfiguration-tagfilters

builder

@Stability(Stable)
static CfnBucket.AnalyticsConfigurationProperty.Builder builder()

Returns:

a CfnBucket.AnalyticsConfigurationProperty.Builder of CfnBucket.AnalyticsConfigurationProperty