AWS Native

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

getMetricStream

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)
// Output-based functions aren't available in Java yet
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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Package Details

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