Class CfnMetricStream

Creates or updates a metric stream.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnMetricStream

Implements

IInspectable

IMetricStreamRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.CloudWatch

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnMetricStream : CfnResource, IInspectable, IMetricStreamRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnMetricStream Inherits CfnResource Implements IInspectable, IMetricStreamRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html

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 AWS::CloudWatch::MetricStream.

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 running or stopped .
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Creates or updates a metric stream.
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 true to include metrics from source accounts that are linked to this monitoring account, in the metric stream.
MetricStreamRef	A reference to a MetricStream resource.
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	Tag Manager which manages the tags for this resource.
TagsRaw	An array of key-value pairs to apply to the metric stream.

Methods

ArnForMetricStream(IMetricStreamRef)	Creates or updates a metric stream.
FromMetricStreamArn(Construct, string, string)	Creates a new IMetricStreamRef from an ARN.
FromMetricStreamName(Construct, string, string)	Creates a new IMetricStreamRef from a metricStreamName.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnMetricStream(object)	Checks whether the given object is a CfnMetricStream.
RenderProperties(IDictionary<string, object>)	Creates or updates a metric stream.

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 string

Construct identifier for this resource (unique in its scope).

props ICfnMetricStreamProps

Resource properties.

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html

CloudformationResource: AWS::CloudWatch::MetricStream

ExampleMetadata: fixture=_generated

Properties

AttrArn

The ARN of the metric stream.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrCreationDate

The date that the metric stream was originally created.

public virtual string AttrCreationDate { get; }

Property Value

string

Remarks

CloudformationAttribute: CreationDate

AttrLastUpdateDate

The date that the metric stream was most recently updated.

public virtual string AttrLastUpdateDate { get; }

Property Value

string

Remarks

CloudformationAttribute: LastUpdateDate

AttrState

The state of the metric stream, either running or stopped .

public virtual string AttrState { get; }

Property Value

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

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html

CloudformationResource: AWS::CloudWatch::MetricStream

ExampleMetadata: fixture=_generated

CfnProperties

Creates or updates a metric stream.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html

CloudformationResource: AWS::CloudWatch::MetricStream

ExampleMetadata: fixture=_generated

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

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnMetricStream.IMetricStreamFilterProperty)[]

FirehoseArn

The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream.

public virtual string FirehoseArn { get; set; }

Property Value

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html

CloudformationResource: AWS::CloudWatch::MetricStream

ExampleMetadata: fixture=_generated

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

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnMetricStream.IMetricStreamFilterProperty)[]

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

object

Remarks

Type union: either bool or IResolvable

MetricStreamRef

A reference to a MetricStream resource.

public virtual IMetricStreamReference MetricStreamRef { get; }

Property Value

IMetricStreamReference

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html

CloudformationResource: AWS::CloudWatch::MetricStream

ExampleMetadata: fixture=_generated

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

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html

CloudformationResource: AWS::CloudWatch::MetricStream

ExampleMetadata: fixture=_generated

OutputFormat

The output format for the stream.

public virtual string OutputFormat { get; set; }

Property Value

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html

CloudformationResource: AWS::CloudWatch::MetricStream

ExampleMetadata: fixture=_generated

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

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html

CloudformationResource: AWS::CloudWatch::MetricStream

ExampleMetadata: fixture=_generated

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

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnMetricStream.IMetricStreamStatisticsConfigurationProperty)[]

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html

CloudformationResource: AWS::CloudWatch::MetricStream

ExampleMetadata: fixture=_generated

TagsRaw

An array of key-value pairs to apply to the metric stream.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html

CloudformationResource: AWS::CloudWatch::MetricStream

ExampleMetadata: fixture=_generated

Methods

ArnForMetricStream(IMetricStreamRef)

Creates or updates a metric stream.

public static string ArnForMetricStream(IMetricStreamRef resource)

Parameters

resource IMetricStreamRef

Returns

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html

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"
                 } }
             });

FromMetricStreamArn(Construct, string, string)

Creates a new IMetricStreamRef from an ARN.

public static IMetricStreamRef FromMetricStreamArn(Construct scope, string id, string arn)

Parameters

scope Construct

id string

arn string

Returns

IMetricStreamRef

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html

CloudformationResource: AWS::CloudWatch::MetricStream

ExampleMetadata: fixture=_generated

FromMetricStreamName(Construct, string, string)

Creates a new IMetricStreamRef from a metricStreamName.

public static IMetricStreamRef FromMetricStreamName(Construct scope, string id, string metricStreamName)

Parameters

scope Construct

id string

metricStreamName string

Returns

IMetricStreamRef

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html

CloudformationResource: AWS::CloudWatch::MetricStream

ExampleMetadata: fixture=_generated

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.

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html

CloudformationResource: AWS::CloudWatch::MetricStream

ExampleMetadata: fixture=_generated

IsCfnMetricStream(object)

Checks whether the given object is a CfnMetricStream.

public static bool IsCfnMetricStream(object x)

Parameters

x object

Returns

bool

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html

CloudformationResource: AWS::CloudWatch::MetricStream

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates or updates a metric stream.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html

CloudformationResource: AWS::CloudWatch::MetricStream

ExampleMetadata: fixture=_generated

Implements

IInspectable

IMetricStreamRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable