Package software.amazon.awscdk.services.s3

Interface CfnStorageLens.StorageLensConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStorageLens.StorageLensConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnStorageLens

@Stability(Stable)
public static interface CfnStorageLens.StorageLensConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

This is the property of the Amazon S3 Storage Lens configuration.

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.*;
 Object sses3;
 StorageLensConfigurationProperty storageLensConfigurationProperty = StorageLensConfigurationProperty.builder()
         .accountLevel(AccountLevelProperty.builder()
                 .bucketLevel(BucketLevelProperty.builder()
                         .activityMetrics(ActivityMetricsProperty.builder()
                                 .isEnabled(false)
                                 .build())
                         .advancedCostOptimizationMetrics(AdvancedCostOptimizationMetricsProperty.builder()
                                 .isEnabled(false)
                                 .build())
                         .advancedDataProtectionMetrics(AdvancedDataProtectionMetricsProperty.builder()
                                 .isEnabled(false)
                                 .build())
                         .detailedStatusCodesMetrics(DetailedStatusCodesMetricsProperty.builder()
                                 .isEnabled(false)
                                 .build())
                         .prefixLevel(PrefixLevelProperty.builder()
                                 .storageMetrics(PrefixLevelStorageMetricsProperty.builder()
                                         .isEnabled(false)
                                         .selectionCriteria(SelectionCriteriaProperty.builder()
                                                 .delimiter("delimiter")
                                                 .maxDepth(123)
                                                 .minStorageBytesPercentage(123)
                                                 .build())
                                         .build())
                                 .build())
                         .build())
                 // the properties below are optional
                 .activityMetrics(ActivityMetricsProperty.builder()
                         .isEnabled(false)
                         .build())
                 .advancedCostOptimizationMetrics(AdvancedCostOptimizationMetricsProperty.builder()
                         .isEnabled(false)
                         .build())
                 .advancedDataProtectionMetrics(AdvancedDataProtectionMetricsProperty.builder()
                         .isEnabled(false)
                         .build())
                 .detailedStatusCodesMetrics(DetailedStatusCodesMetricsProperty.builder()
                         .isEnabled(false)
                         .build())
                 .storageLensGroupLevel(StorageLensGroupLevelProperty.builder()
                         .storageLensGroupSelectionCriteria(StorageLensGroupSelectionCriteriaProperty.builder()
                                 .exclude(List.of("exclude"))
                                 .include(List.of("include"))
                                 .build())
                         .build())
                 .build())
         .id("id")
         .isEnabled(false)
         // the properties below are optional
         .awsOrg(AwsOrgProperty.builder()
                 .arn("arn")
                 .build())
         .dataExport(DataExportProperty.builder()
                 .cloudWatchMetrics(CloudWatchMetricsProperty.builder()
                         .isEnabled(false)
                         .build())
                 .s3BucketDestination(S3BucketDestinationProperty.builder()
                         .accountId("accountId")
                         .arn("arn")
                         .format("format")
                         .outputSchemaVersion("outputSchemaVersion")
                         // the properties below are optional
                         .encryption(EncryptionProperty.builder()
                                 .ssekms(SSEKMSProperty.builder()
                                         .keyId("keyId")
                                         .build())
                                 .sses3(sses3)
                                 .build())
                         .prefix("prefix")
                         .build())
                 .build())
         .exclude(BucketsAndRegionsProperty.builder()
                 .buckets(List.of("buckets"))
                 .regions(List.of("regions"))
                 .build())
         .include(BucketsAndRegionsProperty.builder()
                 .buckets(List.of("buckets"))
                 .regions(List.of("regions"))
                 .build())
         .storageLensArn("storageLensArn")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnStorageLens.StorageLensConfigurationProperty.Builder	builder()
Object	getAccountLevel()	This property contains the details of the account-level metrics for Amazon S3 Storage Lens configuration.
default Object	getAwsOrg()	This property contains the details of the AWS Organization for the S3 Storage Lens configuration.
default Object	getDataExport()	This property contains the details of this S3 Storage Lens configuration's metrics export.
default Object	getExclude()	This property contains the details of the bucket and or Regions excluded for Amazon S3 Storage Lens configuration.
String	getId()	This property contains the details of the ID of the S3 Storage Lens configuration.
default Object	getInclude()	This property contains the details of the bucket and or Regions included for Amazon S3 Storage Lens configuration.
Object	getIsEnabled()	This property contains the details of whether the Amazon S3 Storage Lens configuration is enabled.
default String	getStorageLensArn()	This property contains the details of the ARN of the S3 Storage Lens configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccountLevel

@Stability(Stable)
@NotNull
Object getAccountLevel()

This property contains the details of the account-level metrics for Amazon S3 Storage Lens configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-accountlevel

getId

@Stability(Stable)
@NotNull
String getId()

This property contains the details of the ID of the S3 Storage Lens configuration.

See Also:

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

getIsEnabled

@Stability(Stable)
@NotNull
Object getIsEnabled()

This property contains the details of whether the Amazon S3 Storage Lens configuration is enabled.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-isenabled

getAwsOrg

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

This property contains the details of the AWS Organization for the S3 Storage Lens configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-awsorg

getDataExport

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

This property contains the details of this S3 Storage Lens configuration's metrics export.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-dataexport

getExclude

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

This property contains the details of the bucket and or Regions excluded for Amazon S3 Storage Lens configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-exclude

getInclude

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

This property contains the details of the bucket and or Regions included for Amazon S3 Storage Lens configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-include

getStorageLensArn

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

This property contains the details of the ARN of the S3 Storage Lens configuration.

This property is read-only.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-storagelensarn

builder

@Stability(Stable)
static CfnStorageLens.StorageLensConfigurationProperty.Builder builder()

Returns:

a CfnStorageLens.StorageLensConfigurationProperty.Builder of CfnStorageLens.StorageLensConfigurationProperty