software.amazon.awscdk.services.s3

Class CfnStorageLens

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.s3.CfnStorageLens

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.790Z")
 @Stability(value=Stable)
public class CfnStorageLens
extends CfnResource
implements IInspectable

A CloudFormation `AWS::S3::StorageLens`.

The AWS::S3::StorageLens resource creates an instance of an 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 encryption;
 CfnStorageLens cfnStorageLens = CfnStorageLens.Builder.create(this, "MyCfnStorageLens")
         .storageLensConfiguration(StorageLensConfigurationProperty.builder()
                 .accountLevel(AccountLevelProperty.builder()
                         .bucketLevel(BucketLevelProperty.builder()
                                 .activityMetrics(ActivityMetricsProperty.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())
                         .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(encryption)
                                 .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())
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnStorageLens.AccountLevelProperty This resource contains the details of the account-level metrics for Amazon S3 Storage Lens.
static interface	CfnStorageLens.ActivityMetricsProperty This resource contains the details of the activity metrics for Amazon S3 Storage Lens.
static interface	CfnStorageLens.AwsOrgProperty This resource contains the details of the AWS Organization for Amazon S3 Storage Lens.
static interface	CfnStorageLens.BucketLevelProperty A property for the bucket-level storage metrics for Amazon S3 Storage Lens.
static interface	CfnStorageLens.BucketsAndRegionsProperty This resource contains the details of the buckets and Regions for the Amazon S3 Storage Lens configuration.
static class	CfnStorageLens.Builder A fluent builder for CfnStorageLens.
static interface	CfnStorageLens.CloudWatchMetricsProperty This resource enables the Amazon CloudWatch publishing option for S3 Storage Lens metrics.
static interface	CfnStorageLens.DataExportProperty This resource contains the details of the Amazon S3 Storage Lens metrics export.
static interface	CfnStorageLens.PrefixLevelProperty This resource contains the details of the prefix-level of the Amazon S3 Storage Lens.
static interface	CfnStorageLens.PrefixLevelStorageMetricsProperty This resource contains the details of the prefix-level storage metrics for Amazon S3 Storage Lens.
static interface	CfnStorageLens.S3BucketDestinationProperty This resource contains the details of the bucket where the Amazon S3 Storage Lens metrics export will be placed.
static interface	CfnStorageLens.SelectionCriteriaProperty This resource contains the details of the Amazon S3 Storage Lens selection criteria.
static interface	CfnStorageLens.StorageLensConfigurationProperty This is the property of the Amazon S3 Storage Lens configuration.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnStorageLens(software.constructs.Construct scope, String id, CfnStorageLensProps props) Create a new `AWS::S3::StorageLens`.
protected	CfnStorageLens(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnStorageLens(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrStorageLensConfigurationStorageLensArn() This property contains the details of the ARN of the S3 Storage Lens configuration.
protected Map<String,Object>	getCfnProperties()
Object	getStorageLensConfiguration() This resource contains the details Amazon S3 Storage Lens configuration.
TagManager	getTags() A set of tags (key–value pairs) to associate with the Storage Lens configuration.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setStorageLensConfiguration(CfnStorageLens.StorageLensConfigurationProperty value) This resource contains the details Amazon S3 Storage Lens configuration.
void	setStorageLensConfiguration(IResolvable value) This resource contains the details Amazon S3 Storage Lens configuration.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnStorageLens

protected CfnStorageLens(software.amazon.jsii.JsiiObjectRef objRef)

CfnStorageLens

protected CfnStorageLens(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnStorageLens

@Stability(value=Stable)
public CfnStorageLens(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CfnStorageLensProps props)

Create a new `AWS::S3::StorageLens`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrStorageLensConfigurationStorageLensArn

@Stability(value=Stable)
 @NotNull
public String getAttrStorageLensConfigurationStorageLensArn()

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

This property is read-only.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

A set of tags (key–value pairs) to associate with the Storage Lens configuration.

getStorageLensConfiguration

@Stability(value=Stable)
 @NotNull
public Object getStorageLensConfiguration()

This resource contains the details Amazon S3 Storage Lens configuration.

setStorageLensConfiguration

@Stability(value=Stable)
public void setStorageLensConfiguration(@NotNull
                                                                 CfnStorageLens.StorageLensConfigurationProperty value)

This resource contains the details Amazon S3 Storage Lens configuration.

setStorageLensConfiguration

@Stability(value=Stable)
public void setStorageLensConfiguration(@NotNull
                                                                 IResolvable value)

This resource contains the details Amazon S3 Storage Lens configuration.