Interface CfnBucket.MetricsConfigurationProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnBucket.MetricsConfigurationProperty extends
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 .


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 MetricsConfigurationProperty metricsConfigurationProperty = MetricsConfigurationProperty.builder()
         // the properties below are optional
  • 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.

    • 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.

    • getPrefix

      @Stability(Stable) @Nullable default String getPrefix()
      The prefix that an object must have to be included in the metrics results.
    • 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.

    • builder

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