OperationsMetricOptions
- class aws_cdk.aws_dynamodb.OperationsMetricOptions(*, account=None, color=None, dimensions_map=None, label=None, period=None, region=None, statistic=None, unit=None, operations=None)
Bases:
SystemErrorsForOperationsMetricOptions
Options for configuring metrics that considers multiple operations.
- Parameters:
account (
Optional
[str
]) – Account which this metric comes from. Default: - Deployment account.color (
Optional
[str
]) – The hex color code, prefixed with ‘#’ (e.g. ‘#00ff00’), to use when this metric is rendered on a graph. TheColor
class has a set of standard colors that can be used here. Default: - Automatic colordimensions_map (
Optional
[Mapping
[str
,str
]]) – Dimensions of the metric. Default: - No dimensions.label (
Optional
[str
]) – Label for this metric when added to a Graph in a Dashboard. You can use dynamic labels to show summary information about the entire displayed time series in the legend. For example, if you use:: [max: ${MAX}] MyMetric As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph’s legend. Default: - No labelperiod (
Optional
[Duration
]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)region (
Optional
[str
]) – Region which this metric comes from. Default: - Deployment region.statistic (
Optional
[str
]) – What function to use for aggregating. Use theaws_cloudwatch.Stats
helper class to construct valid input strings. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” - “tmNN.NN” | “tm(NN.NN%:NN.NN%)” - “iqm” - “wmNN.NN” | “wm(NN.NN%:NN.NN%)” - “tcNN.NN” | “tc(NN.NN%:NN.NN%)” - “tsNN.NN” | “ts(NN.NN%:NN.NN%)” Default: Averageunit (
Optional
[Unit
]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric streamoperations (
Optional
[Sequence
[Operation
]]) – The operations to apply the metric to. Default: - All operations available by DynamoDB tables will be considered.
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk as cdk from aws_cdk import aws_cloudwatch as cloudwatch from aws_cdk import aws_dynamodb as dynamodb operations_metric_options = dynamodb.OperationsMetricOptions( account="account", color="color", dimensions_map={ "dimensions_map_key": "dimensionsMap" }, label="label", operations=[dynamodb.Operation.GET_ITEM], period=cdk.Duration.minutes(30), region="region", statistic="statistic", unit=cloudwatch.Unit.SECONDS )
Attributes
- account
Account which this metric comes from.
- Default:
Deployment account.
- color
The hex color code, prefixed with ‘#’ (e.g. ‘#00ff00’), to use when this metric is rendered on a graph. The
Color
class has a set of standard colors that can be used here.- Default:
Automatic color
- dimensions_map
Dimensions of the metric.
- Default:
No dimensions.
- label
Label for this metric when added to a Graph in a Dashboard.
You can use dynamic labels to show summary information about the entire displayed time series in the legend. For example, if you use:
[max: ${MAX}] MyMetric
As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph’s legend.
- Default:
No label
- operations
The operations to apply the metric to.
- Default:
All operations available by DynamoDB tables will be considered.
- period
The period over which the specified statistic is applied.
- Default:
Duration.minutes(5)
- region
Region which this metric comes from.
- Default:
Deployment region.
- statistic
What function to use for aggregating.
Use the
aws_cloudwatch.Stats
helper class to construct valid input strings.Can be one of the following:
“Minimum” | “min”
“Maximum” | “max”
“Average” | “avg”
“Sum” | “sum”
“SampleCount | “n”
“pNN.NN”
“tmNN.NN” | “tm(NN.NN%:NN.NN%)”
“iqm”
“wmNN.NN” | “wm(NN.NN%:NN.NN%)”
“tcNN.NN” | “tc(NN.NN%:NN.NN%)”
“tsNN.NN” | “ts(NN.NN%:NN.NN%)”
- Default:
Average
- unit
Unit used to filter the metric stream.
Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units.
The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases.
CloudWatch does not honor this property for graphs.
- Default:
All metric datums in the given metric stream