Show / Hide Table of Contents

Class CfnStorageLens.StorageLensConfigurationProperty

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

Inheritance
object
CfnStorageLens.StorageLensConfigurationProperty
Implements
CfnStorageLens.IStorageLensConfigurationProperty
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.S3
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnStorageLens.StorageLensConfigurationProperty : CfnStorageLens.IStorageLensConfigurationProperty
Syntax (vb)
Public Class CfnStorageLens.StorageLensConfigurationProperty Implements CfnStorageLens.IStorageLensConfigurationProperty
Remarks

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.S3;

             var sses3;

             var storageLensConfigurationProperty = new StorageLensConfigurationProperty {
                 AccountLevel = new AccountLevelProperty {
                     BucketLevel = new BucketLevelProperty {
                         ActivityMetrics = new ActivityMetricsProperty {
                             IsEnabled = false
                         },
                         AdvancedCostOptimizationMetrics = new AdvancedCostOptimizationMetricsProperty {
                             IsEnabled = false
                         },
                         AdvancedDataProtectionMetrics = new AdvancedDataProtectionMetricsProperty {
                             IsEnabled = false
                         },
                         AdvancedPerformanceMetrics = new AdvancedPerformanceMetricsProperty {
                             IsEnabled = false
                         },
                         DetailedStatusCodesMetrics = new DetailedStatusCodesMetricsProperty {
                             IsEnabled = false
                         },
                         PrefixLevel = new PrefixLevelProperty {
                             StorageMetrics = new PrefixLevelStorageMetricsProperty {
                                 IsEnabled = false,
                                 SelectionCriteria = new SelectionCriteriaProperty {
                                     Delimiter = "delimiter",
                                     MaxDepth = 123,
                                     MinStorageBytesPercentage = 123
                                 }
                             }
                         }
                     },

                     // the properties below are optional
                     ActivityMetrics = new ActivityMetricsProperty {
                         IsEnabled = false
                     },
                     AdvancedCostOptimizationMetrics = new AdvancedCostOptimizationMetricsProperty {
                         IsEnabled = false
                     },
                     AdvancedDataProtectionMetrics = new AdvancedDataProtectionMetricsProperty {
                         IsEnabled = false
                     },
                     AdvancedPerformanceMetrics = new AdvancedPerformanceMetricsProperty {
                         IsEnabled = false
                     },
                     DetailedStatusCodesMetrics = new DetailedStatusCodesMetricsProperty {
                         IsEnabled = false
                     },
                     StorageLensGroupLevel = new StorageLensGroupLevelProperty {
                         StorageLensGroupSelectionCriteria = new StorageLensGroupSelectionCriteriaProperty {
                             Exclude = new [] { "exclude" },
                             Include = new [] { "include" }
                         }
                     }
                 },
                 Id = "id",
                 IsEnabled = false,

                 // the properties below are optional
                 AwsOrg = new AwsOrgProperty {
                     Arn = "arn"
                 },
                 DataExport = new DataExportProperty {
                     CloudWatchMetrics = new CloudWatchMetricsProperty {
                         IsEnabled = false
                     },
                     S3BucketDestination = new S3BucketDestinationProperty {
                         AccountId = "accountId",
                         Arn = "arn",
                         Format = "format",
                         OutputSchemaVersion = "outputSchemaVersion",

                         // the properties below are optional
                         Encryption = new EncryptionProperty {
                             Ssekms = new SSEKMSProperty {
                                 KeyId = "keyId"
                             },
                             Sses3 = sses3
                         },
                         Prefix = "prefix"
                     },
                     StorageLensTableDestination = new StorageLensTableDestinationProperty {
                         IsEnabled = false,

                         // the properties below are optional
                         Encryption = new EncryptionProperty {
                             Ssekms = new SSEKMSProperty {
                                 KeyId = "keyId"
                             },
                             Sses3 = sses3
                         }
                     }
                 },
                 Exclude = new BucketsAndRegionsProperty {
                     Buckets = new [] { "buckets" },
                     Regions = new [] { "regions" }
                 },
                 ExpandedPrefixesDataExport = new StorageLensExpandedPrefixesDataExportProperty {
                     S3BucketDestination = new S3BucketDestinationProperty {
                         AccountId = "accountId",
                         Arn = "arn",
                         Format = "format",
                         OutputSchemaVersion = "outputSchemaVersion",

                         // the properties below are optional
                         Encryption = new EncryptionProperty {
                             Ssekms = new SSEKMSProperty {
                                 KeyId = "keyId"
                             },
                             Sses3 = sses3
                         },
                         Prefix = "prefix"
                     },
                     StorageLensTableDestination = new StorageLensTableDestinationProperty {
                         IsEnabled = false,

                         // the properties below are optional
                         Encryption = new EncryptionProperty {
                             Ssekms = new SSEKMSProperty {
                                 KeyId = "keyId"
                             },
                             Sses3 = sses3
                         }
                     }
                 },
                 Include = new BucketsAndRegionsProperty {
                     Buckets = new [] { "buckets" },
                     Regions = new [] { "regions" }
                 },
                 PrefixDelimiter = "prefixDelimiter",
                 StorageLensArn = "storageLensArn"
             };

Synopsis

Constructors

StorageLensConfigurationProperty()

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

Properties

AccountLevel

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

AwsOrg

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

DataExport

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

Exclude

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

ExpandedPrefixesDataExport

This property configures your S3 Storage Lens expanded prefixes metrics report.

Id

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

Include

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

IsEnabled

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

PrefixDelimiter

The delimiter to divide S3 key into hierarchy of prefixes.

StorageLensArn

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

Constructors

StorageLensConfigurationProperty()

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

public StorageLensConfigurationProperty()
Remarks

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.S3;

             var sses3;

             var storageLensConfigurationProperty = new StorageLensConfigurationProperty {
                 AccountLevel = new AccountLevelProperty {
                     BucketLevel = new BucketLevelProperty {
                         ActivityMetrics = new ActivityMetricsProperty {
                             IsEnabled = false
                         },
                         AdvancedCostOptimizationMetrics = new AdvancedCostOptimizationMetricsProperty {
                             IsEnabled = false
                         },
                         AdvancedDataProtectionMetrics = new AdvancedDataProtectionMetricsProperty {
                             IsEnabled = false
                         },
                         AdvancedPerformanceMetrics = new AdvancedPerformanceMetricsProperty {
                             IsEnabled = false
                         },
                         DetailedStatusCodesMetrics = new DetailedStatusCodesMetricsProperty {
                             IsEnabled = false
                         },
                         PrefixLevel = new PrefixLevelProperty {
                             StorageMetrics = new PrefixLevelStorageMetricsProperty {
                                 IsEnabled = false,
                                 SelectionCriteria = new SelectionCriteriaProperty {
                                     Delimiter = "delimiter",
                                     MaxDepth = 123,
                                     MinStorageBytesPercentage = 123
                                 }
                             }
                         }
                     },

                     // the properties below are optional
                     ActivityMetrics = new ActivityMetricsProperty {
                         IsEnabled = false
                     },
                     AdvancedCostOptimizationMetrics = new AdvancedCostOptimizationMetricsProperty {
                         IsEnabled = false
                     },
                     AdvancedDataProtectionMetrics = new AdvancedDataProtectionMetricsProperty {
                         IsEnabled = false
                     },
                     AdvancedPerformanceMetrics = new AdvancedPerformanceMetricsProperty {
                         IsEnabled = false
                     },
                     DetailedStatusCodesMetrics = new DetailedStatusCodesMetricsProperty {
                         IsEnabled = false
                     },
                     StorageLensGroupLevel = new StorageLensGroupLevelProperty {
                         StorageLensGroupSelectionCriteria = new StorageLensGroupSelectionCriteriaProperty {
                             Exclude = new [] { "exclude" },
                             Include = new [] { "include" }
                         }
                     }
                 },
                 Id = "id",
                 IsEnabled = false,

                 // the properties below are optional
                 AwsOrg = new AwsOrgProperty {
                     Arn = "arn"
                 },
                 DataExport = new DataExportProperty {
                     CloudWatchMetrics = new CloudWatchMetricsProperty {
                         IsEnabled = false
                     },
                     S3BucketDestination = new S3BucketDestinationProperty {
                         AccountId = "accountId",
                         Arn = "arn",
                         Format = "format",
                         OutputSchemaVersion = "outputSchemaVersion",

                         // the properties below are optional
                         Encryption = new EncryptionProperty {
                             Ssekms = new SSEKMSProperty {
                                 KeyId = "keyId"
                             },
                             Sses3 = sses3
                         },
                         Prefix = "prefix"
                     },
                     StorageLensTableDestination = new StorageLensTableDestinationProperty {
                         IsEnabled = false,

                         // the properties below are optional
                         Encryption = new EncryptionProperty {
                             Ssekms = new SSEKMSProperty {
                                 KeyId = "keyId"
                             },
                             Sses3 = sses3
                         }
                     }
                 },
                 Exclude = new BucketsAndRegionsProperty {
                     Buckets = new [] { "buckets" },
                     Regions = new [] { "regions" }
                 },
                 ExpandedPrefixesDataExport = new StorageLensExpandedPrefixesDataExportProperty {
                     S3BucketDestination = new S3BucketDestinationProperty {
                         AccountId = "accountId",
                         Arn = "arn",
                         Format = "format",
                         OutputSchemaVersion = "outputSchemaVersion",

                         // the properties below are optional
                         Encryption = new EncryptionProperty {
                             Ssekms = new SSEKMSProperty {
                                 KeyId = "keyId"
                             },
                             Sses3 = sses3
                         },
                         Prefix = "prefix"
                     },
                     StorageLensTableDestination = new StorageLensTableDestinationProperty {
                         IsEnabled = false,

                         // the properties below are optional
                         Encryption = new EncryptionProperty {
                             Ssekms = new SSEKMSProperty {
                                 KeyId = "keyId"
                             },
                             Sses3 = sses3
                         }
                     }
                 },
                 Include = new BucketsAndRegionsProperty {
                     Buckets = new [] { "buckets" },
                     Regions = new [] { "regions" }
                 },
                 PrefixDelimiter = "prefixDelimiter",
                 StorageLensArn = "storageLensArn"
             };

Properties

AccountLevel

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

public object AccountLevel { get; set; }
Property Value

object

Remarks

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

Type union: either IResolvable or CfnStorageLens.IAccountLevelProperty

AwsOrg

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

public object? AwsOrg { get; set; }
Property Value

object

Remarks

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

Type union: either IResolvable or CfnStorageLens.IAwsOrgProperty

DataExport

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

public object? DataExport { get; set; }
Property Value

object

Remarks

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

Type union: either IResolvable or CfnStorageLens.IDataExportProperty

Exclude

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

public object? Exclude { get; set; }
Property Value

object

Remarks

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

Type union: either IResolvable or CfnStorageLens.IBucketsAndRegionsProperty

ExpandedPrefixesDataExport

This property configures your S3 Storage Lens expanded prefixes metrics report.

public object? ExpandedPrefixesDataExport { get; set; }
Property Value

object

Remarks

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

Type union: either IResolvable or CfnStorageLens.IStorageLensExpandedPrefixesDataExportProperty

Id

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

public string Id { get; set; }
Property Value

string

Remarks

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

Include

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

public object? Include { get; set; }
Property Value

object

Remarks

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

Type union: either IResolvable or CfnStorageLens.IBucketsAndRegionsProperty

IsEnabled

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

public object IsEnabled { get; set; }
Property Value

object

Remarks

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

Type union: either bool or IResolvable

PrefixDelimiter

The delimiter to divide S3 key into hierarchy of prefixes.

public string? PrefixDelimiter { get; set; }
Property Value

string

Remarks

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

StorageLensArn

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

public string? StorageLensArn { get; set; }
Property Value

string

Remarks

This property is read-only.

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

Implements

CfnStorageLens.IStorageLensConfigurationProperty
Back to top Generated by DocFX