software.amazon.awscdk.services.s3

Interface BucketMetrics

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

BucketMetrics.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.735Z")
 @Stability(value=Stable)
public interface BucketMetrics
extends software.amazon.jsii.JsiiSerializable

Specifies a metrics configuration for the CloudWatch request metrics from an Amazon S3 bucket.

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.*;
 Object tagFilters;
 BucketMetrics bucketMetrics = BucketMetrics.builder()
         .id("id")
         // the properties below are optional
         .prefix("prefix")
         .tagFilters(Map.of(
                 "tagFiltersKey", tagFilters))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static BucketMetrics.Builder	builder()
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 Map<String,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 Detail

getId

@Stability(value=Stable)
 @NotNull
String getId()

The ID used to identify the metrics configuration.

getPrefix

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

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

getTagFilters

@Stability(value=Stable)
 @Nullable
default Map<String,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.

builder

@Stability(value=Stable)
static BucketMetrics.Builder builder()

Returns:

a BucketMetrics.Builder of BucketMetrics