class CfnMetricStreamPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.CloudWatch.Mixins.CfnMetricStreamPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscloudwatch/mixins#CfnMetricStreamPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.cloudwatch.mixins.CfnMetricStreamPropsMixin
Python	aws_cdk.mixins_preview.aws_cloudwatch.mixins.CfnMetricStreamPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_cloudwatch » mixins » CfnMetricStreamPropsMixin

Implements IMixin

Extends Mixin

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:

• Stream metrics from all metric namespaces in the account.
• Stream metrics from all metric namespaces in the account, except for the namespaces that you list in ExcludeFilters .
• Stream metrics from only the metric namespaces that you list in IncludeFilters .

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 also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-metricstream.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as cloudwatch_mixins } from '@aws-cdk/mixins-preview/aws-cloudwatch';
const cfnMetricStreamPropsMixin = new cloudwatch_mixins.CfnMetricStreamPropsMixin({
  excludeFilters: [{
    metricNames: ['metricNames'],
    namespace: 'namespace',
  }],
  firehoseArn: 'firehoseArn',
  includeFilters: [{
    metricNames: ['metricNames'],
    namespace: 'namespace',
  }],
  includeLinkedAccountsMetrics: false,
  name: 'name',
  outputFormat: 'outputFormat',
  roleArn: 'roleArn',
  statisticsConfigurations: [{
    additionalStatistics: ['additionalStatistics'],
    includeMetrics: [{
      metricName: 'metricName',
      namespace: 'namespace',
    }],
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnMetricStreamPropsMixin(props: CfnMetricStreamMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnMetricStreamMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::CloudWatch::MetricStream.

Properties

Name	Type	Description
props	CfnMetricStreamMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnMetricStreamMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.