Package software.amazon.awscdk.services.s3

Interface CfnBucket.MetricsConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBucket.MetricsConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnBucket

@Stability(Stable)
public static interface CfnBucket.MetricsConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.s3.*;
 MetricsConfigurationProperty metricsConfigurationProperty = MetricsConfigurationProperty.builder()
         .id("id")
         // the properties below are optional
         .accessPointArn("accessPointArn")
         .prefix("prefix")
         .tagFilters(List.of(TagFilterProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-metricsconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnBucket.MetricsConfigurationProperty.Builder	A builder for CfnBucket.MetricsConfigurationProperty
static final class	CfnBucket.MetricsConfigurationProperty.Jsii$Proxy	An implementation for CfnBucket.MetricsConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnBucket.MetricsConfigurationProperty.Builder	builder()
default String	getAccessPointArn()	The access point that was used while performing operations on the object.
String	getId()	The ID used to identify the metrics configuration.
default String	getPrefix()	The prefix that an object must have to be included in the metrics results.
default Object	getTagFilters()	Specifies a list of tag filters to use as a metrics configuration filter.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getId

@Stability(Stable)
@NotNull
String getId()

The ID used to identify the metrics configuration.

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

See Also:

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

getAccessPointArn

@Stability(Stable)
@Nullable
default String getAccessPointArn()

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

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

See Also:

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

getPrefix

@Stability(Stable)
@Nullable
default String getPrefix()

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

See Also:

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

getTagFilters

@Stability(Stable)
@Nullable
default Object getTagFilters()

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

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

See Also:

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

builder

@Stability(Stable)
static CfnBucket.MetricsConfigurationProperty.Builder builder()

Returns:

a CfnBucket.MetricsConfigurationProperty.Builder of CfnBucket.MetricsConfigurationProperty