Interface S3MetricChange

Interface for all the parts of a metric that can be changed.

interface S3MetricChange {
    bucket?: any;
    color?: any;
    dimensions?: any;
    extendedStatistic?: any;
    filterId?: string;
    label?: any;
    period?: any;
    statistic?: any;
    storageType?: "StandardStorage" | "IntelligentTieringAAStorage" | "IntelligentTieringDAAStorage" | "IntelligentTieringFAStorage" | "IntelligentTieringIAStorage" | "StandardIAStorage" | "StandardIASizeOverhead" | "IntAAObjectOverhead" | "IntAAS3ObjectOverhead" | "IntDAAObjectOverhead" | "IntDAAS3ObjectOverhead" | "OneZoneIAStorage" | "OneZoneIASizeOverhead" | "ReducedRedundancyStorage" | "GlacierStorage" | "GlacierStagingStorage" | "GlacierObjectOverhead" | "GlacierS3ObjectOverhead" | "DeepArchiveStorage" | "DeepArchiveObjectOverhead" | "DeepArchiveS3ObjectOverhead" | "DeepArchiveStagingStorage" | "AllStorageTypes";
    unit?: any;
    visible?: any;
    yAxis?: any;
}

Hierarchy (view full)

Properties

bucket? color? dimensions? extendedStatistic? filterId? label? period? statistic? storageType? unit? visible? yAxis?

Properties

Optional bucket

bucket?: any

Optional bucket to filter metrics down to.

Optional color

color?: any

The six-digit HTML hex color code to be used for this metric.

Only used if this metric is displayed in a [Dashboard] with a [MetricWidget].

Optional dimensions

dimensions?: any

The new dimension for this metric. If this object is missing this property, then no change will be made. However, if the property is there by set to [undefined] then the value will be cleared.

Optional extendedStatistic

extendedStatistic?: any

The new percentile statistic for the metric associated with the alarm. If this object is missing this property, then no change will be made. However, if the property is there by set to [undefined] then the value will be set to the default.

Optional filterId

filterId?: string

This dimension filters metrics configurations that you specify for request metrics on a bucket, for example, a prefix or a tag. You specify a filter id when you create a metrics configuration. For more information, see Metrics-Configurations-for-Buckets.

Optional label

label?: any

The label to display for this metric in the graph legend. If this is not specified, the metric is given an autogenerated label that distinguishes it from the other metrics in the widget.

Only used if this metric is displayed in a [Dashboard] with a [MetricWidget].

Optional period

period?: any

The new period in seconds over which the specified stat is applied. If this object is missing this property, then no change will be made. However, if the property is there by set to [undefined] then the value will be set to the default (300s).

Optional statistic

statistic?: any

The new statistic to apply to the alarm's associated metric. If this object is missing this property, then no change will be made. However, if the property is there by set to [undefined] then the value will be set to the default.

Optional storageType

storageType?: "StandardStorage" | "IntelligentTieringAAStorage" | "IntelligentTieringDAAStorage" | "IntelligentTieringFAStorage" | "IntelligentTieringIAStorage" | "StandardIAStorage" | "StandardIASizeOverhead" | "IntAAObjectOverhead" | "IntAAS3ObjectOverhead" | "IntDAAObjectOverhead" | "IntDAAS3ObjectOverhead" | "OneZoneIAStorage" | "OneZoneIASizeOverhead" | "ReducedRedundancyStorage" | "GlacierStorage" | "GlacierStagingStorage" | "GlacierObjectOverhead" | "GlacierS3ObjectOverhead" | "DeepArchiveStorage" | "DeepArchiveObjectOverhead" | "DeepArchiveS3ObjectOverhead" | "DeepArchiveStagingStorage" | "AllStorageTypes"

This dimension filters the data that you have stored in a bucket by the following types of storage:

  • StandardStorage - The number of bytes used for objects in the STANDARD storage class.
  • IntelligentTieringAAStorage - The number of bytes used for objects in the Archive Access tier of INTELLIGENT_TIERING storage class.
  • IntelligentTieringDAAStorage - The number of bytes used for objects in the Deep Archive Access tier of INTELLIGENT_TIERING storage class.
  • IntelligentTieringFAStorage - The number of bytes used for objects in the Frequent Access tier of INTELLIGENT_TIERING storage class.
  • IntelligentTieringIAStorage - The number of bytes used for objects in the Infrequent Access tier of INTELLIGENT_TIERING storage class.
  • StandardIAStorage - The number of bytes used for objects in the Standard-Infrequent Access (STANDARD_IA) storage class. This extra data is necessary to identify and restore your object. You are charged GLACIER rates for this additional storage.
  • StandardIASizeOverhead - The number of bytes used for objects smaller than 128 KB in size in the STANDARD_IA storage class.
  • IntAAObjectOverhead - For each object in INTELLIGENT_TIERING storage class in the Archive Access tier, GLACIER adds 32 KB of storage for index and related metadata. This extra data is necessary to identify and restore your object. You are charged GLACIER rates for this additional storage.
  • IntAAS3ObjectOverhead - For each object in INTELLIGENT_TIERING storage class in the Archive Access tier, Amazon S3 uses 8 KB of storage for the name of the object and other metadata. You are charged STANDARD rates for this additional storage.
  • IntDAAObjectOverhead - For each object in INTELLIGENT_TIERING storage class in the Deep Archive Access tier, GLACIER adds 32 KB of storage for index and related metadata. This extra data is necessary to identify and restore your object. You are charged S3 Glacier Deep Archive storage rates for this additional storage.
  • IntDAAS3ObjectOverhead - For each object in INTELLIGENT_TIERING storage class in the Deep Archive Access tier, Amazon S3 adds 8 KB of storage for index and related metadata. This extra data is necessary to identify and restore your object. You are charged STANDARD rates for this additional storage.
  • OneZoneIAStorage - The number of bytes used for objects in the OneZone-Infrequent Access (ONEZONE_IA) storage class.
  • OneZoneIASizeOverhead - The number of bytes used for objects smaller than 128 KB in size in the ONEZONE_IA storage class.
  • ReducedRedundancyStorage - The number of bytes used for objects in the Reduced Redundancy Storage (RRS) class.
  • GlacierStorage - The number of bytes used for objects in the GLACIER storage class.
  • GlacierStagingStorage - The number of bytes used for parts of Multipart objects before the CompleteMultipartUpload request is completed on objects in the GLACIER storage class.
  • GlacierObjectOverhead - For each archived object, GLACIER adds 32 KB of storage for index and related metadata. This extra data is necessary to identify and restore your object. You are charged GLACIER rates for this additional storage.
  • GlacierS3ObjectOverhead - For each object archived to GLACIER , Amazon S3 uses 8 KB of storage for the name of the object and other metadata. You are charged STANDARD rates for this additional storage.
  • DeepArchiveStorage - The number of bytes used for objects in the S3 Glacier Deep Archive storage class.
  • DeepArchiveObjectOverhead - For each archived object, S3 Glacier Deep Archive adds 32 KB of storage for index and related metadata. This extra data is necessary to identify and restore your object. You are charged S3 Glacier Deep Archive rates for this additional storage.
  • DeepArchiveS3ObjectOverhead - For each object archived to S3 Glacier Deep Archive, Amazon S3 uses 8 KB of storage for the name of the object and other metadata. You are charged STANDARD rates for this additional storage.
  • DeepArchiveStagingStorage – The number of bytes used for parts of Multipart objects before the CompleteMultipartUpload request is completed on objects in the S3 Glacier Deep Archive storage class.
  • AllStorageTypes - All available storage types, used by NumberOfObjects metric

For more information, see Metrics-and-dimensions.

Optional unit

unit?: any

The new unit for this metric. If this object is missing this property, then no change will be made. However, if the property is there by set to [undefined] then the value will be set to the default.

Optional visible

visible?: any

Set this to true to have the metric appear in the graph, or false to have it be hidden. The default is true.

Only used if this metric is displayed in a [Dashboard] with a [MetricWidget].

Optional yAxis

yAxis?: any

Where on the graph to display the y-axis for this metric. The default is left.

Only used if this metric is displayed in a [Dashboard] with a [MetricWidget].

Settings

Member Visibility

Theme

On This Page

bucketcolordimensionsextendedStatisticfilterIdlabelperiodstatisticstorageTypeunitvisibleyAxis

Generated using TypeDoc