latest--aws-s3-storagelens

shared
Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-s3-storagelens.json
Parent schema serverless-framework-configuration
Type: object

The AWS::S3::StorageLens resource is an Amazon S3 resource type that you can use to create Storage Lens configurations.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-s3-storagelens

Properties

StorageLensConfiguration object required

Specifies the details of Amazon S3 Storage Lens configuration.

8 nested properties
Id string | Aws_CF_FunctionString required

The ID that identifies the Amazon S3 Storage Lens configuration.

AccountLevel object required

Account-level metrics configurations.

5 nested properties
BucketLevel object required

Bucket-level metrics configurations.

5 nested properties
ActivityMetrics object

Enables activity metrics.

AdvancedCostOptimizationMetrics object

Enables advanced cost optimization metrics.

AdvancedDataProtectionMetrics object

Enables advanced data protection metrics.

DetailedStatusCodesMetrics object

Enables detailed status codes metrics.

PrefixLevel object

Prefix-level metrics configurations.

ActivityMetrics object

Enables activity metrics.

1 nested properties
IsEnabled boolean

Specifies whether activity metrics are enabled or disabled.

AdvancedCostOptimizationMetrics object

Enables advanced cost optimization metrics.

1 nested properties
IsEnabled boolean

Specifies whether advanced cost optimization metrics are enabled or disabled.

AdvancedDataProtectionMetrics object

Enables advanced data protection metrics.

1 nested properties
IsEnabled boolean

Specifies whether advanced data protection metrics are enabled or disabled.

DetailedStatusCodesMetrics object

Enables detailed status codes metrics.

1 nested properties
IsEnabled boolean

Specifies whether detailed status codes metrics are enabled or disabled.

IsEnabled boolean required

Specifies whether the Amazon S3 Storage Lens configuration is enabled or disabled.

Include object

S3 buckets and Regions to include/exclude in the Amazon S3 Storage Lens configuration.

2 nested properties
Buckets Arn[]
uniqueItems=true
Regions string[]
uniqueItems=true
Exclude object

S3 buckets and Regions to include/exclude in the Amazon S3 Storage Lens configuration.

2 nested properties
Buckets Arn[]
uniqueItems=true
Regions string[]
uniqueItems=true
AwsOrg object

The AWS Organizations ARN to use in the Amazon S3 Storage Lens configuration.

1 nested properties
Arn string | Aws_CF_FunctionString required

The Amazon Resource Name (ARN) of the specified resource.

DataExport object

Specifies how Amazon S3 Storage Lens metrics should be exported.

2 nested properties
S3BucketDestination object

S3 bucket destination settings for the Amazon S3 Storage Lens metrics export.

6 nested properties
OutputSchemaVersion string | Aws_CF_FunctionString required

The version of the output schema to use when exporting Amazon S3 Storage Lens metrics.

Format string | Aws_CF_FunctionString required

Specifies the file format to use when exporting Amazon S3 Storage Lens metrics export.

AccountId string | Aws_CF_FunctionString required

The AWS account ID that owns the destination S3 bucket.

Arn string | Aws_CF_FunctionString required

The ARN of the bucket to which Amazon S3 Storage Lens exports will be placed.

Prefix string | Aws_CF_FunctionString

The prefix to use for Amazon S3 Storage Lens export.

Encryption object

Configures the server-side encryption for Amazon S3 Storage Lens report files with either S3-managed keys (SSE-S3) or KMS-managed keys (SSE-KMS).

One of: object object, object object
CloudWatchMetrics object

CloudWatch metrics settings for the Amazon S3 Storage Lens metrics export.

1 nested properties
IsEnabled boolean required

Specifies whether CloudWatch metrics are enabled or disabled.

StorageLensArn string | Aws_CF_FunctionString

The ARN for the Amazon S3 Storage Lens configuration.

Tags Tag[]

A set of tags (key-value pairs) for this Amazon S3 Storage Lens configuration.

maxItems=50uniqueItems=true

Definitions

Id string | Aws_CF_FunctionString

The ID that identifies the Amazon S3 Storage Lens configuration.

Arn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the specified resource.

BucketsAndRegions object

S3 buckets and Regions to include/exclude in the Amazon S3 Storage Lens configuration.

Buckets Arn[]
uniqueItems=true
Regions string[]
uniqueItems=true
AwsOrg object

The AWS Organizations ARN to use in the Amazon S3 Storage Lens configuration.

Arn string | Aws_CF_FunctionString required

The Amazon Resource Name (ARN) of the specified resource.

ActivityMetrics object

Enables activity metrics.

IsEnabled boolean

Specifies whether activity metrics are enabled or disabled.

AdvancedCostOptimizationMetrics object

Enables advanced cost optimization metrics.

IsEnabled boolean

Specifies whether advanced cost optimization metrics are enabled or disabled.

AdvancedDataProtectionMetrics object

Enables advanced data protection metrics.

IsEnabled boolean

Specifies whether advanced data protection metrics are enabled or disabled.

DetailedStatusCodesMetrics object

Enables detailed status codes metrics.

IsEnabled boolean

Specifies whether detailed status codes metrics are enabled or disabled.

SelectionCriteria object

Selection criteria for prefix-level metrics.

MaxDepth integer

Max depth of prefixes of S3 key that Amazon S3 Storage Lens will analyze.

Delimiter string | Aws_CF_FunctionString

Delimiter to divide S3 key into hierarchy of prefixes.

MinStorageBytesPercentage number

The minimum storage bytes threshold for the prefixes to be included in the analysis.

PrefixLevelStorageMetrics object
IsEnabled boolean

Specifies whether prefix-level storage metrics are enabled or disabled.

SelectionCriteria object

Selection criteria for prefix-level metrics.

3 nested properties
MaxDepth integer

Max depth of prefixes of S3 key that Amazon S3 Storage Lens will analyze.

Delimiter string | Aws_CF_FunctionString

Delimiter to divide S3 key into hierarchy of prefixes.

MinStorageBytesPercentage number

The minimum storage bytes threshold for the prefixes to be included in the analysis.

PrefixLevel object

Prefix-level metrics configurations.

StorageMetrics object required
2 nested properties
IsEnabled boolean

Specifies whether prefix-level storage metrics are enabled or disabled.

SelectionCriteria object

Selection criteria for prefix-level metrics.

3 nested properties
MaxDepth integer

Max depth of prefixes of S3 key that Amazon S3 Storage Lens will analyze.

Delimiter string | Aws_CF_FunctionString

Delimiter to divide S3 key into hierarchy of prefixes.

MinStorageBytesPercentage number

The minimum storage bytes threshold for the prefixes to be included in the analysis.

BucketLevel object

Bucket-level metrics configurations.

ActivityMetrics object

Enables activity metrics.

1 nested properties
IsEnabled boolean

Specifies whether activity metrics are enabled or disabled.

AdvancedCostOptimizationMetrics object

Enables advanced cost optimization metrics.

1 nested properties
IsEnabled boolean

Specifies whether advanced cost optimization metrics are enabled or disabled.

AdvancedDataProtectionMetrics object

Enables advanced data protection metrics.

1 nested properties
IsEnabled boolean

Specifies whether advanced data protection metrics are enabled or disabled.

DetailedStatusCodesMetrics object

Enables detailed status codes metrics.

1 nested properties
IsEnabled boolean

Specifies whether detailed status codes metrics are enabled or disabled.

PrefixLevel object

Prefix-level metrics configurations.

1 nested properties
StorageMetrics object required
2 nested properties
IsEnabled boolean

Specifies whether prefix-level storage metrics are enabled or disabled.

SelectionCriteria object

Selection criteria for prefix-level metrics.

AccountLevel object

Account-level metrics configurations.

BucketLevel object required

Bucket-level metrics configurations.

5 nested properties
ActivityMetrics object

Enables activity metrics.

1 nested properties
IsEnabled boolean

Specifies whether activity metrics are enabled or disabled.

AdvancedCostOptimizationMetrics object

Enables advanced cost optimization metrics.

1 nested properties
IsEnabled boolean

Specifies whether advanced cost optimization metrics are enabled or disabled.

AdvancedDataProtectionMetrics object

Enables advanced data protection metrics.

1 nested properties
IsEnabled boolean

Specifies whether advanced data protection metrics are enabled or disabled.

DetailedStatusCodesMetrics object

Enables detailed status codes metrics.

1 nested properties
IsEnabled boolean

Specifies whether detailed status codes metrics are enabled or disabled.

PrefixLevel object

Prefix-level metrics configurations.

1 nested properties
StorageMetrics object required
ActivityMetrics object

Enables activity metrics.

1 nested properties
IsEnabled boolean

Specifies whether activity metrics are enabled or disabled.

AdvancedCostOptimizationMetrics object

Enables advanced cost optimization metrics.

1 nested properties
IsEnabled boolean

Specifies whether advanced cost optimization metrics are enabled or disabled.

AdvancedDataProtectionMetrics object

Enables advanced data protection metrics.

1 nested properties
IsEnabled boolean

Specifies whether advanced data protection metrics are enabled or disabled.

DetailedStatusCodesMetrics object

Enables detailed status codes metrics.

1 nested properties
IsEnabled boolean

Specifies whether detailed status codes metrics are enabled or disabled.

SSEKMS object

AWS KMS server-side encryption.

KeyId string | Aws_CF_FunctionString required

The ARN of the KMS key to use for encryption.

Encryption object

Configures the server-side encryption for Amazon S3 Storage Lens report files with either S3-managed keys (SSE-S3) or KMS-managed keys (SSE-KMS).

S3BucketDestination object

S3 bucket destination settings for the Amazon S3 Storage Lens metrics export.

OutputSchemaVersion string | Aws_CF_FunctionString required

The version of the output schema to use when exporting Amazon S3 Storage Lens metrics.

Format string | Aws_CF_FunctionString required

Specifies the file format to use when exporting Amazon S3 Storage Lens metrics export.

AccountId string | Aws_CF_FunctionString required

The AWS account ID that owns the destination S3 bucket.

Arn string | Aws_CF_FunctionString required

The ARN of the bucket to which Amazon S3 Storage Lens exports will be placed.

Prefix string | Aws_CF_FunctionString

The prefix to use for Amazon S3 Storage Lens export.

Encryption object

Configures the server-side encryption for Amazon S3 Storage Lens report files with either S3-managed keys (SSE-S3) or KMS-managed keys (SSE-KMS).

One of: object object, object object
CloudWatchMetrics object

CloudWatch metrics settings for the Amazon S3 Storage Lens metrics export.

IsEnabled boolean required

Specifies whether CloudWatch metrics are enabled or disabled.

DataExport object

Specifies how Amazon S3 Storage Lens metrics should be exported.

S3BucketDestination object

S3 bucket destination settings for the Amazon S3 Storage Lens metrics export.

6 nested properties
OutputSchemaVersion string | Aws_CF_FunctionString required

The version of the output schema to use when exporting Amazon S3 Storage Lens metrics.

Format string | Aws_CF_FunctionString required

Specifies the file format to use when exporting Amazon S3 Storage Lens metrics export.

AccountId string | Aws_CF_FunctionString required

The AWS account ID that owns the destination S3 bucket.

Arn string | Aws_CF_FunctionString required

The ARN of the bucket to which Amazon S3 Storage Lens exports will be placed.

Prefix string | Aws_CF_FunctionString

The prefix to use for Amazon S3 Storage Lens export.

Encryption object

Configures the server-side encryption for Amazon S3 Storage Lens report files with either S3-managed keys (SSE-S3) or KMS-managed keys (SSE-KMS).

One of: object object, object object
CloudWatchMetrics object

CloudWatch metrics settings for the Amazon S3 Storage Lens metrics export.

1 nested properties
IsEnabled boolean required

Specifies whether CloudWatch metrics are enabled or disabled.

Tag object
Key string | Aws_CF_FunctionString required
Value string | Aws_CF_FunctionString required
StorageLensConfiguration object

Specifies the details of Amazon S3 Storage Lens configuration.

Id string | Aws_CF_FunctionString required

The ID that identifies the Amazon S3 Storage Lens configuration.

AccountLevel object required

Account-level metrics configurations.

5 nested properties
BucketLevel object required

Bucket-level metrics configurations.

5 nested properties
ActivityMetrics object

Enables activity metrics.

AdvancedCostOptimizationMetrics object

Enables advanced cost optimization metrics.

AdvancedDataProtectionMetrics object

Enables advanced data protection metrics.

DetailedStatusCodesMetrics object

Enables detailed status codes metrics.

PrefixLevel object

Prefix-level metrics configurations.

ActivityMetrics object

Enables activity metrics.

1 nested properties
IsEnabled boolean

Specifies whether activity metrics are enabled or disabled.

AdvancedCostOptimizationMetrics object

Enables advanced cost optimization metrics.

1 nested properties
IsEnabled boolean

Specifies whether advanced cost optimization metrics are enabled or disabled.

AdvancedDataProtectionMetrics object

Enables advanced data protection metrics.

1 nested properties
IsEnabled boolean

Specifies whether advanced data protection metrics are enabled or disabled.

DetailedStatusCodesMetrics object

Enables detailed status codes metrics.

1 nested properties
IsEnabled boolean

Specifies whether detailed status codes metrics are enabled or disabled.

IsEnabled boolean required

Specifies whether the Amazon S3 Storage Lens configuration is enabled or disabled.

Include object

S3 buckets and Regions to include/exclude in the Amazon S3 Storage Lens configuration.

2 nested properties
Buckets Arn[]
uniqueItems=true
Regions string[]
uniqueItems=true
Exclude object

S3 buckets and Regions to include/exclude in the Amazon S3 Storage Lens configuration.

2 nested properties
Buckets Arn[]
uniqueItems=true
Regions string[]
uniqueItems=true
AwsOrg object

The AWS Organizations ARN to use in the Amazon S3 Storage Lens configuration.

1 nested properties
Arn string | Aws_CF_FunctionString required

The Amazon Resource Name (ARN) of the specified resource.

DataExport object

Specifies how Amazon S3 Storage Lens metrics should be exported.

2 nested properties
S3BucketDestination object

S3 bucket destination settings for the Amazon S3 Storage Lens metrics export.

6 nested properties
OutputSchemaVersion string | Aws_CF_FunctionString required

The version of the output schema to use when exporting Amazon S3 Storage Lens metrics.

Format string | Aws_CF_FunctionString required

Specifies the file format to use when exporting Amazon S3 Storage Lens metrics export.

AccountId string | Aws_CF_FunctionString required

The AWS account ID that owns the destination S3 bucket.

Arn string | Aws_CF_FunctionString required

The ARN of the bucket to which Amazon S3 Storage Lens exports will be placed.

Prefix string | Aws_CF_FunctionString

The prefix to use for Amazon S3 Storage Lens export.

Encryption object

Configures the server-side encryption for Amazon S3 Storage Lens report files with either S3-managed keys (SSE-S3) or KMS-managed keys (SSE-KMS).

One of: object object, object object
CloudWatchMetrics object

CloudWatch metrics settings for the Amazon S3 Storage Lens metrics export.

1 nested properties
IsEnabled boolean required

Specifies whether CloudWatch metrics are enabled or disabled.

StorageLensArn string | Aws_CF_FunctionString

The ARN for the Amazon S3 Storage Lens configuration.