You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::S3Control::Types::StorageLensConfiguration
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3Control::Types::StorageLensConfiguration
- Defined in:
- (unknown)
Overview
When passing StorageLensConfiguration as input to an Aws::Client method, you can use a vanilla Hash:
{
id: "ConfigId", # required
account_level: { # required
activity_metrics: {
is_enabled: false,
},
bucket_level: { # required
activity_metrics: {
is_enabled: false,
},
prefix_level: {
storage_metrics: { # required
is_enabled: false,
selection_criteria: {
delimiter: "StorageLensPrefixLevelDelimiter",
max_depth: 1,
min_storage_bytes_percentage: 1.0,
},
},
},
},
},
include: {
buckets: ["S3BucketArnString"],
regions: ["S3AWSRegion"],
},
exclude: {
buckets: ["S3BucketArnString"],
regions: ["S3AWSRegion"],
},
data_export: {
s3_bucket_destination: { # required
format: "CSV", # required, accepts CSV, Parquet
output_schema_version: "V_1", # required, accepts V_1
account_id: "AccountId", # required
arn: "S3BucketArnString", # required
prefix: "Prefix",
encryption: {
sses3: {
},
ssekms: {
key_id: "SSEKMSKeyId", # required
},
},
},
},
is_enabled: false, # required
aws_org: {
arn: "AwsOrgArn", # required
},
storage_lens_arn: "StorageLensArn",
}
A container for the Amazon S3 Storage Lens configuration.
Returned by:
Instance Attribute Summary collapse
-
#account_level ⇒ Types::AccountLevel
A container for all the account-level configurations of your S3 Storage Lens configuration.
-
#aws_org ⇒ Types::StorageLensAwsOrg
A container for the AWS organization for this S3 Storage Lens configuration.
-
#data_export ⇒ Types::StorageLensDataExport
A container to specify the properties of your S3 Storage Lens metrics export including, the destination, schema and format.
-
#exclude ⇒ Types::Exclude
A container for what is excluded in this configuration.
-
#id ⇒ String
A container for the Amazon S3 Storage Lens configuration ID.
-
#include ⇒ Types::Include
A container for what is included in this configuration.
-
#is_enabled ⇒ Boolean
A container for whether the S3 Storage Lens configuration is enabled.
-
#storage_lens_arn ⇒ String
The Amazon Resource Name (ARN) of the S3 Storage Lens configuration.
Instance Attribute Details
#account_level ⇒ Types::AccountLevel
A container for all the account-level configurations of your S3 Storage Lens configuration.
#aws_org ⇒ Types::StorageLensAwsOrg
A container for the AWS organization for this S3 Storage Lens configuration.
#data_export ⇒ Types::StorageLensDataExport
A container to specify the properties of your S3 Storage Lens metrics export including, the destination, schema and format.
#exclude ⇒ Types::Exclude
A container for what is excluded in this configuration. This container
can only be valid if there is no Include
container submitted, and
it\'s not empty.
#id ⇒ String
A container for the Amazon S3 Storage Lens configuration ID.
#include ⇒ Types::Include
A container for what is included in this configuration. This container
can only be valid if there is no Exclude
container submitted, and
it\'s not empty.
#is_enabled ⇒ Boolean
A container for whether the S3 Storage Lens configuration is enabled.
#storage_lens_arn ⇒ String
The Amazon Resource Name (ARN) of the S3 Storage Lens configuration.
This property is read-only and follows the following format:
arn:aws:s3:us-east-1:example-account-id:storage-lens/your-dashboard-name