Class CfnBucket.MetricsConfigurationProperty

Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket.

Inheritance
System.Object
CfnBucket.MetricsConfigurationProperty
Namespace: Amazon.CDK.AWS.S3
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class MetricsConfigurationProperty : Object, CfnBucket.IMetricsConfigurationProperty
Syntax (vb)
Public Class MetricsConfigurationProperty
    Inherits Object
    Implements CfnBucket.IMetricsConfigurationProperty
Remarks

If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For examples, see AWS::S3::Bucket . For more information, see PUT Bucket metrics in the Amazon S3 API Reference .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.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 metricsConfigurationProperty = new MetricsConfigurationProperty {
    Id = "id",

    // the properties below are optional
    AccessPointArn = "accessPointArn",
    Prefix = "prefix",
    TagFilters = new [] { new TagFilterProperty {
        Key = "key",
        Value = "value"
    } }
};

Synopsis

Constructors

MetricsConfigurationProperty()

Properties

AccessPointArn

The access point that was used while performing operations on the object.
Id

The ID used to identify the metrics configuration.
Prefix

The prefix that an object must have to be included in the metrics results.
TagFilters

Specifies a list of tag filters to use as a metrics configuration filter.

Constructors

MetricsConfigurationProperty()

public MetricsConfigurationProperty()

Properties

AccessPointArn

The access point that was used while performing operations on the object.

public string AccessPointArn { get; set; }
Property Value

System.String

Remarks

The metrics configuration only includes objects that meet the filter's criteria.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html#cfn-s3-bucket-metricsconfiguration-accesspointarn

Id

The ID used to identify the metrics configuration.

public string Id { get; set; }
Property Value

System.String

Remarks

This can be any value you choose that helps you identify your metrics configuration.

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

Prefix

The prefix that an object must have to be included in the metrics results.

public string Prefix { get; set; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html#cfn-s3-bucket-metricsconfiguration-prefix

TagFilters

Specifies a list of tag filters to use as a metrics configuration filter.

public object TagFilters { get; set; }
Property Value

System.Object

Remarks

The metrics configuration includes only objects that meet the filter's criteria.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html#cfn-s3-bucket-metricsconfiguration-tagfilters

Implements