Show / Hide Table of Contents

Interface IMetricWidgetProps

Basic properties for widgets that display metrics.

Namespace: Amazon.CDK.AWS.CloudWatch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IMetricWidgetProps
Syntax (vb)
Public Interface IMetricWidgetProps
Remarks

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.CloudWatch;

            var metricWidgetProps = new MetricWidgetProps {
                AccountId = "accountId",
                Height = 123,
                Region = "region",
                Title = "title",
                Width = 123
            };

Synopsis

Properties

AccountId

The AWS account ID where the metrics are located.

Height

Height of the widget.

Region

The region the metrics of this graph should be taken from.

Title

Title for the graph.

Width

Width of the widget, in a grid of 24 units wide.

Properties

AccountId

The AWS account ID where the metrics are located.

string? AccountId { get; }
Property Value

string

Remarks

This enables cross-account functionality for CloudWatch dashboards. Before using this feature, ensure that proper cross-account sharing is configured between the monitoring account and source account.

For more information, see: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html

Default: - Current account

Height

Height of the widget.

double? Height { get; }
Property Value

double?

Remarks

Default: - 6 for Alarm and Graph widgets. 3 for single value widgets where most recent value of a metric is displayed.

Region

The region the metrics of this graph should be taken from.

string? Region { get; }
Property Value

string

Remarks

Default: - Current region

Title

Title for the graph.

string? Title { get; }
Property Value

string

Remarks

Default: - None

Width

Width of the widget, in a grid of 24 units wide.

double? Width { get; }
Property Value

double?

Remarks

Default: 6

Back to top Generated by DocFX