AWS Native

v0.43.0 published on Thursday, Dec 1, 2022 by Pulumi

MetricStream

Resource Type definition for Metric Stream

Example Usage

Example

using System.Collections.Generic;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var myMetricStream = new AwsNative.CloudWatch.MetricStream("myMetricStream", new()
    {
        OutputFormat = "json",
        FirehoseArn = "arn:aws:firehose:us-east-1:123456789012:deliverystream/MyDeliveryStream",
        RoleArn = "arn:aws:iam::123456789012:role/service-role/MyRole",
        IncludeFilters = new[]
        {
            new AwsNative.CloudWatch.Inputs.MetricStreamFilterArgs
            {
                Namespace = "AWS/ELB",
            },
            new AwsNative.CloudWatch.Inputs.MetricStreamFilterArgs
            {
                Namespace = "AWS/EC2",
            },
        },
    });

});

Coming soon!

Coming soon!

import pulumi
import pulumi_aws_native as aws_native

my_metric_stream = aws_native.cloudwatch.MetricStream("myMetricStream",
    output_format="json",
    firehose_arn="arn:aws:firehose:us-east-1:123456789012:deliverystream/MyDeliveryStream",
    role_arn="arn:aws:iam::123456789012:role/service-role/MyRole",
    include_filters=[
        aws_native.cloudwatch.MetricStreamFilterArgs(
            namespace="AWS/ELB",
        ),
        aws_native.cloudwatch.MetricStreamFilterArgs(
            namespace="AWS/EC2",
        ),
    ])
import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const myMetricStream = new aws_native.cloudwatch.MetricStream("myMetricStream", {
    outputFormat: "json",
    firehoseArn: "arn:aws:firehose:us-east-1:123456789012:deliverystream/MyDeliveryStream",
    roleArn: "arn:aws:iam::123456789012:role/service-role/MyRole",
    includeFilters: [
        {
            namespace: "AWS/ELB",
        },
        {
            namespace: "AWS/EC2",
        },
    ],
});

Coming soon!

Create MetricStream Resource

new MetricStream(name: string, args: MetricStreamArgs, opts?: CustomResourceOptions);
@overload
def MetricStream(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 exclude_filters: Optional[Sequence[MetricStreamFilterArgs]] = None,
                 firehose_arn: Optional[str] = None,
                 include_filters: Optional[Sequence[MetricStreamFilterArgs]] = None,
                 name: Optional[str] = None,
                 output_format: Optional[str] = None,
                 role_arn: Optional[str] = None,
                 statistics_configurations: Optional[Sequence[MetricStreamStatisticsConfigurationArgs]] = None,
                 tags: Optional[Sequence[MetricStreamTagArgs]] = None)
@overload
def MetricStream(resource_name: str,
                 args: MetricStreamArgs,
                 opts: Optional[ResourceOptions] = None)
func NewMetricStream(ctx *Context, name string, args MetricStreamArgs, opts ...ResourceOption) (*MetricStream, error)
public MetricStream(string name, MetricStreamArgs args, CustomResourceOptions? opts = null)
public MetricStream(String name, MetricStreamArgs args)
public MetricStream(String name, MetricStreamArgs args, CustomResourceOptions options)
type: aws-native:cloudwatch:MetricStream
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args MetricStreamArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args MetricStreamArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args MetricStreamArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args MetricStreamArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args MetricStreamArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

MetricStream Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The MetricStream resource accepts the following input properties:

FirehoseArn string

The ARN of the Kinesis Firehose where to stream the data.

OutputFormat string

The output format of the data streamed to the Kinesis Firehose.

RoleArn string

The ARN of the role that provides access to the Kinesis Firehose.

ExcludeFilters List<Pulumi.AwsNative.CloudWatch.Inputs.MetricStreamFilterArgs>

Define which metrics will be not streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.

IncludeFilters List<Pulumi.AwsNative.CloudWatch.Inputs.MetricStreamFilterArgs>

Define which metrics will be streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.

Name string

Name of the metric stream.

StatisticsConfigurations List<Pulumi.AwsNative.CloudWatch.Inputs.MetricStreamStatisticsConfigurationArgs>

By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. 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.

Tags List<Pulumi.AwsNative.CloudWatch.Inputs.MetricStreamTagArgs>

A set of tags to assign to the delivery stream.

FirehoseArn string

The ARN of the Kinesis Firehose where to stream the data.

OutputFormat string

The output format of the data streamed to the Kinesis Firehose.

RoleArn string

The ARN of the role that provides access to the Kinesis Firehose.

ExcludeFilters []MetricStreamFilterArgs

Define which metrics will be not streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.

IncludeFilters []MetricStreamFilterArgs

Define which metrics will be streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.

Name string

Name of the metric stream.

StatisticsConfigurations []MetricStreamStatisticsConfigurationArgs

By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. 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.

Tags []MetricStreamTagArgs

A set of tags to assign to the delivery stream.

firehoseArn String

The ARN of the Kinesis Firehose where to stream the data.

outputFormat String

The output format of the data streamed to the Kinesis Firehose.

roleArn String

The ARN of the role that provides access to the Kinesis Firehose.

excludeFilters List<MetricStreamFilterArgs>

Define which metrics will be not streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.

includeFilters List<MetricStreamFilterArgs>

Define which metrics will be streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.

name String

Name of the metric stream.

statisticsConfigurations List<MetricStreamStatisticsConfigurationArgs>

By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. 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.

tags List<MetricStreamTagArgs>

A set of tags to assign to the delivery stream.

firehoseArn string

The ARN of the Kinesis Firehose where to stream the data.

outputFormat string

The output format of the data streamed to the Kinesis Firehose.

roleArn string

The ARN of the role that provides access to the Kinesis Firehose.

excludeFilters MetricStreamFilterArgs[]

Define which metrics will be not streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.

includeFilters MetricStreamFilterArgs[]

Define which metrics will be streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.

name string

Name of the metric stream.

statisticsConfigurations MetricStreamStatisticsConfigurationArgs[]

By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. 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.

tags MetricStreamTagArgs[]

A set of tags to assign to the delivery stream.

firehose_arn str

The ARN of the Kinesis Firehose where to stream the data.

output_format str

The output format of the data streamed to the Kinesis Firehose.

role_arn str

The ARN of the role that provides access to the Kinesis Firehose.

exclude_filters Sequence[MetricStreamFilterArgs]

Define which metrics will be not streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.

include_filters Sequence[MetricStreamFilterArgs]

Define which metrics will be streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.

name str

Name of the metric stream.

statistics_configurations Sequence[MetricStreamStatisticsConfigurationArgs]

By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. 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.

tags Sequence[MetricStreamTagArgs]

A set of tags to assign to the delivery stream.

firehoseArn String

The ARN of the Kinesis Firehose where to stream the data.

outputFormat String

The output format of the data streamed to the Kinesis Firehose.

roleArn String

The ARN of the role that provides access to the Kinesis Firehose.

excludeFilters List<Property Map>

Define which metrics will be not streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.

includeFilters List<Property Map>

Define which metrics will be streamed. Metrics matched by multiple instances of MetricStreamFilter are joined with an OR operation by default. If both IncludeFilters and ExcludeFilters are omitted, all metrics in the account will be streamed. IncludeFilters and ExcludeFilters are mutually exclusive. Default to null.

name String

Name of the metric stream.

statisticsConfigurations List<Property Map>

By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. 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.

tags List<Property Map>

A set of tags to assign to the delivery stream.

Outputs

All input properties are implicitly available as output properties. Additionally, the MetricStream resource produces the following output properties:

Arn string

Amazon Resource Name of the metric stream.

CreationDate string

The date of creation of the metric stream.

Id string

The provider-assigned unique ID for this managed resource.

LastUpdateDate string

The date of the last update of the metric stream.

State string

Displays the state of the Metric Stream.

Arn string

Amazon Resource Name of the metric stream.

CreationDate string

The date of creation of the metric stream.

Id string

The provider-assigned unique ID for this managed resource.

LastUpdateDate string

The date of the last update of the metric stream.

State string

Displays the state of the Metric Stream.

arn String

Amazon Resource Name of the metric stream.

creationDate String

The date of creation of the metric stream.

id String

The provider-assigned unique ID for this managed resource.

lastUpdateDate String

The date of the last update of the metric stream.

state String

Displays the state of the Metric Stream.

arn string

Amazon Resource Name of the metric stream.

creationDate string

The date of creation of the metric stream.

id string

The provider-assigned unique ID for this managed resource.

lastUpdateDate string

The date of the last update of the metric stream.

state string

Displays the state of the Metric Stream.

arn str

Amazon Resource Name of the metric stream.

creation_date str

The date of creation of the metric stream.

id str

The provider-assigned unique ID for this managed resource.

last_update_date str

The date of the last update of the metric stream.

state str

Displays the state of the Metric Stream.

arn String

Amazon Resource Name of the metric stream.

creationDate String

The date of creation of the metric stream.

id String

The provider-assigned unique ID for this managed resource.

lastUpdateDate String

The date of the last update of the metric stream.

state String

Displays the state of the Metric Stream.

Supporting Types

MetricStreamFilter

Namespace string

Only metrics with Namespace matching this value will be streamed.

Namespace string

Only metrics with Namespace matching this value will be streamed.

namespace String

Only metrics with Namespace matching this value will be streamed.

namespace string

Only metrics with Namespace matching this value will be streamed.

namespace str

Only metrics with Namespace matching this value will be streamed.

namespace String

Only metrics with Namespace matching this value will be streamed.

MetricStreamStatisticsConfiguration

AdditionalStatistics List<string>

The additional statistics to stream for the metrics listed in IncludeMetrics.

IncludeMetrics List<Pulumi.AwsNative.CloudWatch.Inputs.MetricStreamStatisticsMetric>

An array that defines the metrics that are to have additional statistics streamed.

AdditionalStatistics []string

The additional statistics to stream for the metrics listed in IncludeMetrics.

IncludeMetrics []MetricStreamStatisticsMetric

An array that defines the metrics that are to have additional statistics streamed.

additionalStatistics List<String>

The additional statistics to stream for the metrics listed in IncludeMetrics.

includeMetrics List<MetricStreamStatisticsMetric>

An array that defines the metrics that are to have additional statistics streamed.

additionalStatistics string[]

The additional statistics to stream for the metrics listed in IncludeMetrics.

includeMetrics MetricStreamStatisticsMetric[]

An array that defines the metrics that are to have additional statistics streamed.

additional_statistics Sequence[str]

The additional statistics to stream for the metrics listed in IncludeMetrics.

include_metrics Sequence[MetricStreamStatisticsMetric]

An array that defines the metrics that are to have additional statistics streamed.

additionalStatistics List<String>

The additional statistics to stream for the metrics listed in IncludeMetrics.

includeMetrics List<Property Map>

An array that defines the metrics that are to have additional statistics streamed.

MetricStreamStatisticsMetric

MetricName string

The name of the metric.

Namespace string

The namespace of the metric.

MetricName string

The name of the metric.

Namespace string

The namespace of the metric.

metricName String

The name of the metric.

namespace String

The namespace of the metric.

metricName string

The name of the metric.

namespace string

The namespace of the metric.

metric_name str

The name of the metric.

namespace str

The namespace of the metric.

metricName String

The name of the metric.

namespace String

The namespace of the metric.

MetricStreamTag

Key string

A unique identifier for the tag.

Value string

An optional string, which you can use to describe or define the tag.

Key string

A unique identifier for the tag.

Value string

An optional string, which you can use to describe or define the tag.

key String

A unique identifier for the tag.

value String

An optional string, which you can use to describe or define the tag.

key string

A unique identifier for the tag.

value string

An optional string, which you can use to describe or define the tag.

key str

A unique identifier for the tag.

value str

An optional string, which you can use to describe or define the tag.

key String

A unique identifier for the tag.

value String

An optional string, which you can use to describe or define the tag.

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0