@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
147 lines (146 loc) • 7.01 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource Type definition for Metric Stream
*
* ## Example Usage
* ### Example
*
* ```typescript
* 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",
* },
* ],
* });
*
* ```
*/
export declare class MetricStream extends pulumi.CustomResource {
/**
* Get an existing MetricStream resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): MetricStream;
/**
* Returns true if the given object is an instance of MetricStream. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is MetricStream;
/**
* Amazon Resource Name of the metric stream.
*/
readonly arn: pulumi.Output<string>;
/**
* The date of creation of the metric stream.
*/
readonly creationDate: pulumi.Output<string>;
/**
* 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.
*/
readonly excludeFilters: pulumi.Output<outputs.cloudwatch.MetricStreamFilter[] | undefined>;
/**
* The ARN of the Kinesis Firehose where to stream the data.
*/
readonly firehoseArn: pulumi.Output<string | undefined>;
/**
* 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.
*/
readonly includeFilters: pulumi.Output<outputs.cloudwatch.MetricStreamFilter[] | undefined>;
/**
* 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.
*/
readonly includeLinkedAccountsMetrics: pulumi.Output<boolean | undefined>;
/**
* The date of the last update of the metric stream.
*/
readonly lastUpdateDate: pulumi.Output<string>;
/**
* Name of the metric stream.
*/
readonly name: pulumi.Output<string | undefined>;
/**
* The output format of the data streamed to the Kinesis Firehose.
*/
readonly outputFormat: pulumi.Output<string | undefined>;
/**
* The ARN of the role that provides access to the Kinesis Firehose.
*/
readonly roleArn: pulumi.Output<string | undefined>;
/**
* Displays the state of the Metric Stream.
*/
readonly state: pulumi.Output<string>;
/**
* 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.
*/
readonly statisticsConfigurations: pulumi.Output<outputs.cloudwatch.MetricStreamStatisticsConfiguration[] | undefined>;
/**
* A set of tags to assign to the delivery stream.
*/
readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* Create a MetricStream resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: MetricStreamArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a MetricStream resource.
*/
export interface MetricStreamArgs {
/**
* 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.
*/
excludeFilters?: pulumi.Input<pulumi.Input<inputs.cloudwatch.MetricStreamFilterArgs>[]>;
/**
* The ARN of the Kinesis Firehose where to stream the data.
*/
firehoseArn?: pulumi.Input<string>;
/**
* 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.
*/
includeFilters?: pulumi.Input<pulumi.Input<inputs.cloudwatch.MetricStreamFilterArgs>[]>;
/**
* 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.
*/
includeLinkedAccountsMetrics?: pulumi.Input<boolean>;
/**
* Name of the metric stream.
*/
name?: pulumi.Input<string>;
/**
* The output format of the data streamed to the Kinesis Firehose.
*/
outputFormat?: pulumi.Input<string>;
/**
* The ARN of the role that provides access to the Kinesis Firehose.
*/
roleArn?: pulumi.Input<string>;
/**
* 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.
*/
statisticsConfigurations?: pulumi.Input<pulumi.Input<inputs.cloudwatch.MetricStreamStatisticsConfigurationArgs>[]>;
/**
* A set of tags to assign to the delivery stream.
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
}