Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. cloudwatch
  5. getMetricStream

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.cloudwatch.getMetricStream

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for Metric Stream

    Using getMetricStream

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getMetricStream(args: GetMetricStreamArgs, opts?: InvokeOptions): Promise<GetMetricStreamResult>
function getMetricStreamOutput(args: GetMetricStreamOutputArgs, opts?: InvokeOptions): Output<GetMetricStreamResult>
    def get_metric_stream(name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetMetricStreamResult
def get_metric_stream_output(name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetMetricStreamResult]
    func LookupMetricStream(ctx *Context, args *LookupMetricStreamArgs, opts ...InvokeOption) (*LookupMetricStreamResult, error)
func LookupMetricStreamOutput(ctx *Context, args *LookupMetricStreamOutputArgs, opts ...InvokeOption) LookupMetricStreamResultOutput

    > Note: This function is named LookupMetricStream in the Go SDK.

    public static class GetMetricStream 
{
    public static Task<GetMetricStreamResult> InvokeAsync(GetMetricStreamArgs args, InvokeOptions? opts = null)
    public static Output<GetMetricStreamResult> Invoke(GetMetricStreamInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetMetricStreamResult> getMetricStream(GetMetricStreamArgs args, InvokeOptions options)
public static Output<GetMetricStreamResult> getMetricStream(GetMetricStreamArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:cloudwatch:getMetricStream
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    Name of the metric stream.
    Name string
    Name of the metric stream.
    name String
    Name of the metric stream.
    name string
    Name of the metric stream.
    name str
    Name of the metric stream.
    name String
    Name of the metric stream.

    getMetricStream Result

    The following output properties are available:

    Arn string
    Amazon Resource Name of the metric stream.
    CreationDate string
    The date of creation of the metric stream.
    ExcludeFilters List<Pulumi.AwsNative.CloudWatch.Outputs.MetricStreamFilter>
    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.
    FirehoseArn string
    The ARN of the Kinesis Firehose where to stream the data.
    IncludeFilters List<Pulumi.AwsNative.CloudWatch.Outputs.MetricStreamFilter>
    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.
    IncludeLinkedAccountsMetrics bool
    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. The default is false.
    LastUpdateDate string
    The date of the last update of the metric stream.
    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.
    State string
    Displays the state of the Metric Stream.
    StatisticsConfigurations List<Pulumi.AwsNative.CloudWatch.Outputs.MetricStreamStatisticsConfiguration>
    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.Outputs.Tag>
    A set of tags to assign to the delivery stream.
    Arn string
    Amazon Resource Name of the metric stream.
    CreationDate string
    The date of creation of the metric stream.
    ExcludeFilters []MetricStreamFilter
    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.
    FirehoseArn string
    The ARN of the Kinesis Firehose where to stream the data.
    IncludeFilters []MetricStreamFilter
    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.
    IncludeLinkedAccountsMetrics bool
    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. The default is false.
    LastUpdateDate string
    The date of the last update of the metric stream.
    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.
    State string
    Displays the state of the Metric Stream.
    StatisticsConfigurations []MetricStreamStatisticsConfiguration
    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 Tag
    A set of tags to assign to the delivery stream.
    arn String
    Amazon Resource Name of the metric stream.
    creationDate String
    The date of creation of the metric stream.
    excludeFilters List<MetricStreamFilter>
    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.
    firehoseArn String
    The ARN of the Kinesis Firehose where to stream the data.
    includeFilters List<MetricStreamFilter>
    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.
    includeLinkedAccountsMetrics Boolean
    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. The default is false.
    lastUpdateDate String
    The date of the last update of the metric stream.
    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.
    state String
    Displays the state of the Metric Stream.
    statisticsConfigurations List<MetricStreamStatisticsConfiguration>
    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<Tag>
    A set of tags to assign to the delivery stream.
    arn string
    Amazon Resource Name of the metric stream.
    creationDate string
    The date of creation of the metric stream.
    excludeFilters MetricStreamFilter[]
    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.
    firehoseArn string
    The ARN of the Kinesis Firehose where to stream the data.
    includeFilters MetricStreamFilter[]
    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.
    includeLinkedAccountsMetrics boolean
    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. The default is false.
    lastUpdateDate string
    The date of the last update of the metric stream.
    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.
    state string
    Displays the state of the Metric Stream.
    statisticsConfigurations MetricStreamStatisticsConfiguration[]
    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 Tag[]
    A set of tags to assign to the delivery stream.
    arn str
    Amazon Resource Name of the metric stream.
    creation_date str
    The date of creation of the metric stream.
    exclude_filters Sequence[MetricStreamFilter]
    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.
    firehose_arn str
    The ARN of the Kinesis Firehose where to stream the data.
    include_filters Sequence[MetricStreamFilter]
    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.
    include_linked_accounts_metrics bool
    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. The default is false.
    last_update_date str
    The date of the last update of the metric stream.
    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.
    state str
    Displays the state of the Metric Stream.
    statistics_configurations Sequence[MetricStreamStatisticsConfiguration]
    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[root_Tag]
    A set of tags to assign to the delivery stream.
    arn String
    Amazon Resource Name of the metric stream.
    creationDate String
    The date of creation of the metric stream.
    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.
    firehoseArn String
    The ARN of the Kinesis Firehose where to stream the data.
    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.
    includeLinkedAccountsMetrics Boolean
    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. The default is false.
    lastUpdateDate String
    The date of the last update of the metric stream.
    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.
    state String
    Displays the state 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.

    Supporting Types

    MetricStreamFilter

    Namespace string
    Only metrics with Namespace matching this value will be streamed.
    MetricNames List<string>
    Only metrics with MetricNames matching these values will be streamed. Must be set together with Namespace.
    Namespace string
    Only metrics with Namespace matching this value will be streamed.
    MetricNames []string
    Only metrics with MetricNames matching these values will be streamed. Must be set together with Namespace.
    namespace String
    Only metrics with Namespace matching this value will be streamed.
    metricNames List<String>
    Only metrics with MetricNames matching these values will be streamed. Must be set together with Namespace.
    namespace string
    Only metrics with Namespace matching this value will be streamed.
    metricNames string[]
    Only metrics with MetricNames matching these values will be streamed. Must be set together with Namespace.
    namespace str
    Only metrics with Namespace matching this value will be streamed.
    metric_names Sequence[str]
    Only metrics with MetricNames matching these values will be streamed. Must be set together with Namespace.
    namespace String
    Only metrics with Namespace matching this value will be streamed.
    metricNames List<String>
    Only metrics with MetricNames matching these values will be streamed. Must be set together with Namespace.

    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.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native