Interface CfnBucket.IAnalyticsConfigurationProperty

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

Namespace: Amazon.CDK.AWS.S3

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnBucket.IAnalyticsConfigurationProperty

Syntax (vb)

Public Interface CfnBucket.IAnalyticsConfigurationProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.S3;

             var analyticsConfigurationProperty = new AnalyticsConfigurationProperty {
                 Id = "id",
                 StorageClassAnalysis = new StorageClassAnalysisProperty {
                     DataExport = new DataExportProperty {
                         Destination = new DestinationProperty {
                             BucketArn = "bucketArn",
                             Format = "format",

                             // the properties below are optional
                             BucketAccountId = "bucketAccountId",
                             Prefix = "prefix"
                         },
                         OutputSchemaVersion = "outputSchemaVersion"
                     }
                 },

                 // the properties below are optional
                 Prefix = "prefix",
                 TagFilters = new [] { new TagFilterProperty {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Properties

Id	The ID that identifies the analytics configuration.
Prefix	The prefix that an object must have to be included in the analytics results.
StorageClassAnalysis	Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes.
TagFilters	The tags to use when evaluating an analytics filter.

Properties

Id

The ID that identifies the analytics configuration.

string Id { get; }

Property Value

string

Remarks

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

Prefix

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

string? Prefix { get; }

Property Value

string

Remarks

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

StorageClassAnalysis

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

object StorageClassAnalysis { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnBucket.IStorageClassAnalysisProperty

TagFilters

The tags to use when evaluating an analytics filter.

object? TagFilters { get; }

Property Value

object

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-analyticsconfiguration.html#cfn-s3-bucket-analyticsconfiguration-tagfilters

Type union: either IResolvable or (either IResolvable or CfnBucket.ITagFilterProperty)[]