Class: Aws::S3Control::Types::StorageLensConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb

Overview

Note:

When making an API call, you may pass StorageLensConfiguration data as a 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: {
      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
        },
      },
    },
    cloud_watch_metrics: {
      is_enabled: false, # required
    },
  },
  is_enabled: false, # required
  aws_org: {
    arn: "AwsOrgArn", # required
  },
  storage_lens_arn: "StorageLensArn",
}

A container for the Amazon S3 Storage Lens configuration.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_level ⇒ Types::AccountLevel

A container for all the account-level configurations of your S3 Storage Lens configuration.

Returns:



6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
 
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 6467

class StorageLensConfiguration < Struct.new(
  :id,
  :account_level,
  :include,
  :exclude,
  :data_export,
  :is_enabled,
  :aws_org,
  :storage_lens_arn)
  SENSITIVE = []
  include Aws::Structure
end

#aws_org ⇒ Types::StorageLensAwsOrg

A container for the Amazon Web Services organization for this S3 Storage Lens configuration.

Returns:



6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
 
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 6467

class StorageLensConfiguration < Struct.new(
  :id,
  :account_level,
  :include,
  :exclude,
  :data_export,
  :is_enabled,
  :aws_org,
  :storage_lens_arn)
  SENSITIVE = []
  include Aws::Structure
end

#data_export ⇒ Types::StorageLensDataExport

A container to specify the properties of your S3 Storage Lens metrics export including, the destination, schema and format.

Returns:



6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
 
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 6467

class StorageLensConfiguration < Struct.new(
  :id,
  :account_level,
  :include,
  :exclude,
  :data_export,
  :is_enabled,
  :aws_org,
  :storage_lens_arn)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:



6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
 
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 6467

class StorageLensConfiguration < Struct.new(
  :id,
  :account_level,
  :include,
  :exclude,
  :data_export,
  :is_enabled,
  :aws_org,
  :storage_lens_arn)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

A container for the Amazon S3 Storage Lens configuration ID.

Returns:

  • (String) 


6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
 
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 6467

class StorageLensConfiguration < Struct.new(
  :id,
  :account_level,
  :include,
  :exclude,
  :data_export,
  :is_enabled,
  :aws_org,
  :storage_lens_arn)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:



6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
 
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 6467

class StorageLensConfiguration < Struct.new(
  :id,
  :account_level,
  :include,
  :exclude,
  :data_export,
  :is_enabled,
  :aws_org,
  :storage_lens_arn)
  SENSITIVE = []
  include Aws::Structure
end

#is_enabled ⇒ Boolean

A container for whether the S3 Storage Lens configuration is enabled.

Returns:

  • (Boolean) 


6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
 
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 6467

class StorageLensConfiguration < Struct.new(
  :id,
  :account_level,
  :include,
  :exclude,
  :data_export,
  :is_enabled,
  :aws_org,
  :storage_lens_arn)
  SENSITIVE = []
  include Aws::Structure
end

#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

Returns:

  • (String) 


6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
 
# File 'gems/aws-sdk-s3control/lib/aws-sdk-s3control/types.rb', line 6467

class StorageLensConfiguration < Struct.new(
  :id,
  :account_level,
  :include,
  :exclude,
  :data_export,
  :is_enabled,
  :aws_org,
  :storage_lens_arn)
  SENSITIVE = []
  include Aws::Structure
end