Class CfnMetricStream
A CloudFormation AWS::CloudWatch::MetricStream
.
Inherited Members
Namespace: Amazon.CDK.AWS.CloudWatch
Assembly: Amazon.CDK.AWS.CloudWatch.dll
Syntax (csharp)
public class CfnMetricStream : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnMetricStream
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates or updates a metric stream. Metrics streams can automatically stream CloudWatch metrics to AWS destinations including Amazon S3 and to many third-party solutions. For more information, see Metric streams .
To create a metric stream, you must be logged on to an account that has the iam:PassRole
permission and either the CloudWatchFullAccess policy or the cloudwatch:PutMetricStream
permission.
When you create or update a metric stream, you choose one of the following:
When you create a metric stream, the stream is created in the running
state. If you update an existing metric stream, the state does not change.
If you create a metric stream in an account that has been set up as a monitoring account in CloudWatch cross-account observability, you can choose whether to include metrics from linked source accounts in the metric stream.
CloudformationResource: AWS::CloudWatch::MetricStream
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 cfnMetricStream = new CfnMetricStream(this, "MyCfnMetricStream", new CfnMetricStreamProps {
FirehoseArn = "firehoseArn",
OutputFormat = "outputFormat",
RoleArn = "roleArn",
// the properties below are optional
ExcludeFilters = new [] { new MetricStreamFilterProperty {
Namespace = "namespace",
// the properties below are optional
MetricNames = new [] { "metricNames" }
} },
IncludeFilters = new [] { new MetricStreamFilterProperty {
Namespace = "namespace",
// the properties below are optional
MetricNames = new [] { "metricNames" }
} },
IncludeLinkedAccountsMetrics = false,
Name = "name",
StatisticsConfigurations = new [] { new MetricStreamStatisticsConfigurationProperty {
AdditionalStatistics = new [] { "additionalStatistics" },
IncludeMetrics = new [] { new MetricStreamStatisticsMetricProperty {
MetricName = "metricName",
Namespace = "namespace"
} }
} },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnMetricStream(Construct, String, ICfnMetricStreamProps) | Create a new |
CfnMetricStream(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnMetricStream(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The ARN of the metric stream. |
AttrCreationDate | The date that the metric stream was originally created. |
AttrLastUpdateDate | The date that the metric stream was most recently updated. |
AttrState | The state of the metric stream, either |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ExcludeFilters | If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here. |
FirehoseArn | The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream. |
IncludeFilters | If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here. |
IncludeLinkedAccountsMetrics | If you are creating a metric stream in a monitoring account, specify |
Name | If you are creating a new metric stream, this is the name for the new stream. |
OutputFormat | The output format for the stream. |
RoleArn | The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Firehose resources. |
StatisticsConfigurations | By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. |
Tags | An array of key-value pairs to apply to the metric stream. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnMetricStream(Construct, String, ICfnMetricStreamProps)
Create a new AWS::CloudWatch::MetricStream
.
public CfnMetricStream(Construct scope, string id, ICfnMetricStreamProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnMetricStreamProps
- resource properties.
CfnMetricStream(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnMetricStream(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnMetricStream(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnMetricStream(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The ARN of the metric stream.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrCreationDate
The date that the metric stream was originally created.
public virtual string AttrCreationDate { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreationDate
AttrLastUpdateDate
The date that the metric stream was most recently updated.
public virtual string AttrLastUpdateDate { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LastUpdateDate
AttrState
The state of the metric stream, either running
or stopped
.
public virtual string AttrState { get; }
Property Value
System.String
Remarks
CloudformationAttribute: State
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ExcludeFilters
If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here.
public virtual object ExcludeFilters { get; set; }
Property Value
System.Object
Remarks
You cannot specify both IncludeFilters
and ExcludeFilters
in the same metric stream.
When you modify the IncludeFilters
or ExcludeFilters
of an existing metric stream in any way, the metric stream is effectively restarted, so after such a change you will get only the datapoints that have a timestamp after the time of the update.
FirehoseArn
The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream.
public virtual string FirehoseArn { get; set; }
Property Value
System.String
Remarks
This Amazon Kinesis Firehose delivery stream must already exist and must be in the same account as the metric stream.
IncludeFilters
If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here.
public virtual object IncludeFilters { get; set; }
Property Value
System.Object
Remarks
You cannot specify both IncludeFilters
and ExcludeFilters
in the same metric stream.
When you modify the IncludeFilters
or ExcludeFilters
of an existing metric stream in any way, the metric stream is effectively restarted, so after such a change you will get only the datapoints that have a timestamp after the time of the update.
IncludeLinkedAccountsMetrics
If you are creating a metric stream in a monitoring account, specify true
to include metrics from source accounts that are linked to this monitoring account, in the metric stream.
public virtual object IncludeLinkedAccountsMetrics { get; set; }
Property Value
System.Object
Remarks
The default is false
.
For more information about linking accounts, see CloudWatch cross-account observability
Name
If you are creating a new metric stream, this is the name for the new stream.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
The name must be different than the names of other metric streams in this account and Region.
If you are updating a metric stream, specify the name of that stream here.
OutputFormat
The output format for the stream.
public virtual string OutputFormat { get; set; }
Property Value
System.String
Remarks
Valid values are json
and opentelemetry0.7
For more information about metric stream output formats, see Metric streams output formats .
This parameter is required.
RoleArn
The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Firehose resources.
public virtual string RoleArn { get; set; }
Property Value
System.String
Remarks
This IAM role must already exist and must be in the same account as the metric stream. This IAM role must include the firehose:PutRecord
and firehose:PutRecordBatch
permissions.
StatisticsConfigurations
By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed.
public virtual object StatisticsConfigurations { get; set; }
Property Value
System.Object
Remarks
You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members.
For each entry in this array, you specify one or more metrics and the list of additional statistics to stream for those metrics. The additional statistics that you can stream depend on the stream's OutputFormat
. If the OutputFormat
is json
, you can stream any additional statistic that is supported by CloudWatch , listed in CloudWatch statistics definitions . If the OutputFormat
is opentelemetry0
.7, you can stream percentile statistics (p??) .
Tags
An array of key-value pairs to apply to the metric stream.
public virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Tag .
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>