Class CfnMetricStream

Creates or updates a metric stream.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnMetricStream
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.CloudWatch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnMetricStream : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnMetricStream
    Inherits CfnResource
    Implements IInspectable, 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(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
    CfnMetricStream(Construct, String, ICfnMetricStreamProps)

    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
    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.
    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

    Inspect(TreeInspector)

    Examines the CloudFormation resource and discloses attributes.
    RenderProperties(IDictionary<String, Object>)

    Constructors

    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

    CfnMetricStream(Construct, String, ICfnMetricStreamProps)

    public CfnMetricStream(Construct scope, string id, ICfnMetricStreamProps props)
    Parameters
    scope Constructs.Construct

    Scope in which this resource is defined.

    id System.String

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

    props ICfnMetricStreamProps

    Resource properties.

    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

    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

    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

    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

    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

    OutputFormat

    The output format for the stream.

    public virtual string OutputFormat { get; set; }
    Property Value

    System.String

    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

    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

    Tags

    Tag Manager which manages the tags for this resource.

    public virtual TagManager Tags { get; }
    Property Value

    TagManager

    TagsRaw

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

    public virtual ICfnTag[] TagsRaw { get; set; }
    Property Value

    ICfnTag[]

    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>

    Overrides

    Implements