Show / Hide Table of Contents

Class CfnStorageLens

The AWS::S3::StorageLens resource creates an Amazon S3 Storage Lens configuration.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnStorageLens
Implements
IInspectable
ITaggable
Inherited Members
CfnResource.IsCfnResource(object)
CfnResource.AddDeletionOverride(string)
CfnResource.AddDependency(CfnResource)
CfnResource.AddDependsOn(CfnResource)
CfnResource.AddMetadata(string, object)
CfnResource.AddOverride(string, object)
CfnResource.AddPropertyDeletionOverride(string)
CfnResource.AddPropertyOverride(string, object)
CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)
CfnResource.GetAtt(string, ResolutionTypeHint?)
CfnResource.GetMetadata(string)
CfnResource.ObtainDependencies()
CfnResource.ObtainResourceDependencies()
CfnResource.RemoveDependency(CfnResource)
CfnResource.ReplaceDependency(CfnResource, CfnResource)
CfnResource.ShouldSynthesize()
CfnResource.ToString()
CfnResource.ValidateProperties(object)
CfnResource.CfnOptions
CfnResource.CfnResourceType
CfnResource.UpdatedProperites
CfnResource.UpdatedProperties
CfnRefElement.Ref
CfnElement.IsCfnElement(object)
CfnElement.OverrideLogicalId(string)
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
Namespace: Amazon.CDK.AWS.S3
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnStorageLens : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnStorageLens Inherits CfnResource Implements IInspectable, ITaggable
Remarks

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

CloudformationResource: AWS::S3::StorageLens

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 cfnStorageLens = new CfnStorageLens(this, "MyCfnStorageLens", new CfnStorageLensProps {
                 StorageLensConfiguration = new StorageLensConfigurationProperty {
                     AccountLevel = new AccountLevelProperty {
                         BucketLevel = new BucketLevelProperty {
                             ActivityMetrics = new ActivityMetricsProperty {
                                 IsEnabled = false
                             },
                             AdvancedCostOptimizationMetrics = new AdvancedCostOptimizationMetricsProperty {
                                 IsEnabled = false
                             },
                             AdvancedDataProtectionMetrics = new AdvancedDataProtectionMetricsProperty {
                                 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
                         },
                         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"
                         }
                     },
                     Exclude = new BucketsAndRegionsProperty {
                         Buckets = new [] { "buckets" },
                         Regions = new [] { "regions" }
                     },
                     Include = new BucketsAndRegionsProperty {
                         Buckets = new [] { "buckets" },
                         Regions = new [] { "regions" }
                     },
                     StorageLensArn = "storageLensArn"
                 },

                 // the properties below are optional
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnStorageLens(Construct, string, ICfnStorageLensProps)

The AWS::S3::StorageLens resource creates an Amazon S3 Storage Lens configuration.

Properties

AttrStorageLensConfigurationStorageLensArn

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

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

CfnProperties

The AWS::S3::StorageLens resource creates an Amazon S3 Storage Lens configuration.

StorageLensConfiguration

This resource contains the details Amazon S3 Storage Lens configuration.

Tags

Tag Manager which manages the tags for this resource.

TagsRaw

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

RenderProperties(IDictionary<string, object>)

The AWS::S3::StorageLens resource creates an Amazon S3 Storage Lens configuration.

Constructors

CfnStorageLens(Construct, string, ICfnStorageLensProps)

The AWS::S3::StorageLens resource creates an Amazon S3 Storage Lens configuration.

public CfnStorageLens(Construct scope, string id, ICfnStorageLensProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnStorageLensProps

Resource properties.

Remarks

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

CloudformationResource: AWS::S3::StorageLens

ExampleMetadata: fixture=_generated

Properties

AttrStorageLensConfigurationStorageLensArn

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

public virtual string AttrStorageLensConfigurationStorageLensArn { get; }
Property Value

string

Remarks

This property is read-only.

CloudformationAttribute: StorageLensConfiguration.StorageLensArn

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

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

CloudformationResource: AWS::S3::StorageLens

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::S3::StorageLens resource creates an Amazon S3 Storage Lens configuration.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
CfnResource.CfnProperties
Remarks

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

CloudformationResource: AWS::S3::StorageLens

ExampleMetadata: fixture=_generated

StorageLensConfiguration

This resource contains the details Amazon S3 Storage Lens configuration.

public virtual object StorageLensConfiguration { get; set; }
Property Value

object

Remarks

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

CloudformationResource: AWS::S3::StorageLens

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

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

CloudformationResource: AWS::S3::StorageLens

ExampleMetadata: fixture=_generated

TagsRaw

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

public virtual ICfnTag[]? TagsRaw { get; set; }
Property Value

ICfnTag[]

Remarks

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

CloudformationResource: AWS::S3::StorageLens

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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

CloudformationResource: AWS::S3::StorageLens

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::S3::StorageLens resource creates an Amazon S3 Storage Lens configuration.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
CfnResource.RenderProperties(IDictionary<string, object>)
Remarks

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

CloudformationResource: AWS::S3::StorageLens

ExampleMetadata: fixture=_generated

Implements

IInspectable
ITaggable
Back to top Generated by DocFX