@propulsionworks/cloudformation 0.0.2 → 0.1.0

package/out/exports/resources.generated/aws-cloudwatch-anomalydetector.d.ts

@@ -0,0 +1,232 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type CloudWatchAnomalyDetector = ResourceDefinitionWithAttributes<"AWS::CloudWatch::AnomalyDetector", CloudWatchAnomalyDetectorProps, CloudWatchAnomalyDetectorAttribs>;
+/**
+ * The `AWS::CloudWatch::AnomalyDetector` type specifies an anomaly detection band for a certain metric and statistic. The band represents the expected "normal" range for the metric values. Anomaly detection bands can be used for visualization of a metric's expected values, and for alarms.
+ *
+ * For more information see [Using CloudWatch anomaly detection.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Anomaly_Detection.html) .
+ */
+export type CloudWatchAnomalyDetectorProps = {
+    /**
+     * Specifies details about how the anomaly detection model is to be trained, including time ranges to exclude when training and updating the model. The configuration can also include the time zone to use for the metric.
+     */
+    Configuration?: Configuration | undefined;
+    /**
+     * The dimensions of the metric associated with the anomaly detection band.
+     */
+    Dimensions?: Dimension[] | undefined;
+    /**
+     * Use this object to include parameters to provide information about your metric to CloudWatch to help it build more accurate anomaly detection models. Currently, it includes the `PeriodicSpikes` parameter.
+     */
+    MetricCharacteristics?: MetricCharacteristics | undefined;
+    /**
+     * The CloudWatch metric math expression for this anomaly detector.
+     */
+    MetricMathAnomalyDetector?: MetricMathAnomalyDetector | undefined;
+    /**
+     * The name of the metric associated with the anomaly detection band.
+     */
+    MetricName?: string | undefined;
+    /**
+     * The namespace of the metric associated with the anomaly detection band.
+     */
+    Namespace?: string | undefined;
+    /**
+     * The CloudWatch metric and statistic for this anomaly detector.
+     */
+    SingleMetricAnomalyDetector?: SingleMetricAnomalyDetector | undefined;
+    /**
+     * The statistic of the metric associated with the anomaly detection band.
+     */
+    Stat?: string | undefined;
+};
+export type CloudWatchAnomalyDetectorAttribs = {
+    Id: string;
+};
+/**
+ * Specifies details about how the anomaly detection model is to be trained, including time ranges to exclude when training and updating the model. The configuration can also include the time zone to use for the metric.
+ */
+export type Configuration = {
+    /**
+     * Specifies an array of time ranges to exclude from use when the anomaly detection model is trained and updated. Use this to make sure that events that could cause unusual values for the metric, such as deployments, aren't used when CloudWatch creates or updates the model.
+     */
+    ExcludedTimeRanges?: Range[] | undefined;
+    /**
+     * The time zone to use for the metric. This is useful to enable the model to automatically account for daylight savings time changes if the metric is sensitive to such time changes.
+     *
+     * To specify a time zone, use the name of the time zone as specified in the standard tz database. For more information, see [tz database](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Tz_database) .
+     */
+    MetricTimeZone?: string | undefined;
+};
+/**
+ * A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish `InstanceId` as a dimension name, and the actual instance ID as the value for that dimension.
+ *
+ * You can assign up to 30 dimensions to a metric.
+ */
+export type Dimension = {
+    /**
+     * The name of the dimension.
+     */
+    Name: string;
+    /**
+     * The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.
+     */
+    Value: string;
+};
+/**
+ * Represents a specific metric.
+ */
+export type Metric = {
+    /**
+     * The dimensions for the metric.
+     */
+    Dimensions?: Dimension[] | undefined;
+    /**
+     * The name of the metric. This is a required field.
+     */
+    MetricName: string;
+    /**
+     * The namespace of the metric.
+     */
+    Namespace: string;
+};
+/**
+ * This object includes parameters that you can use to provide information to CloudWatch to help it build more accurate anomaly detection models.
+ */
+export type MetricCharacteristics = {
+    /**
+     * Set this parameter to true if values for this metric consistently include spikes that should not be considered to be anomalies. With this set to true, CloudWatch will expect to see spikes that occurred consistently during the model training period, and won't flag future similar spikes as anomalies.
+     */
+    PeriodicSpikes?: boolean | undefined;
+};
+/**
+ * This structure is used in both `GetMetricData` and `PutMetricAlarm` . The supported use of this structure is different for those two operations.
+ *
+ * When used in `GetMetricData` , it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A single `GetMetricData` call can include up to 500 `MetricDataQuery` structures.
+ *
+ * When used in `PutMetricAlarm` , it enables you to create an alarm based on a metric math expression. Each `MetricDataQuery` in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single `PutMetricAlarm` call can include up to 20 `MetricDataQuery` structures in the array. The 20 structures can include as many as 10 structures that contain a `MetricStat` parameter to retrieve a metric, and as many as 10 structures that contain the `Expression` parameter to perform a math expression. Of those `Expression` structures, one must have `true` as the value for `ReturnData` . The result of this expression is the value the alarm watches.
+ *
+ * Any expression used in a `PutMetricAlarm` operation must return a single time series. For more information, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *Amazon CloudWatch User Guide* .
+ *
+ * Some of the parameters of this structure also have different uses whether you are using this structure in a `GetMetricData` operation or a `PutMetricAlarm` operation. These differences are explained in the following parameter list.
+ */
+export type MetricDataQuery = {
+    /**
+     * The ID of the account where the metrics are located.
+     *
+     * If you are performing a `GetMetricData` operation in a monitoring account, use this to specify which account to retrieve this metric from.
+     *
+     * If you are performing a `PutMetricAlarm` operation, use this to specify which account contains the metric that the alarm is watching.
+     */
+    AccountId?: string | undefined;
+    /**
+     * This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data. For more information about Metrics Insights queries, see [Metrics Insights query components and syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-metrics-insights-querylanguage) in the *Amazon CloudWatch User Guide* .
+     *
+     * A math expression can use the `Id` of the other metrics or queries to refer to those metrics, and can also use the `Id` of other expressions to use the result of those expressions. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *Amazon CloudWatch User Guide* .
+     *
+     * Within each MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both.
+     */
+    Expression?: string | undefined;
+    /**
+     * A short name used to tie this object to the results in the response. This name must be unique within a single call to `GetMetricData` . If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
+     */
+    Id: string;
+    /**
+     * A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.
+     *
+     * You can put dynamic expressions into a label, so that it is more descriptive. For more information, see [Using Dynamic Labels](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html) .
+     */
+    Label?: string | undefined;
+    /**
+     * The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.
+     *
+     * Within one MetricDataQuery object, you must specify either `Expression` or `MetricStat` but not both.
+     */
+    MetricStat?: MetricStat | undefined;
+    /**
+     * The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a `PutMetricData` operation that includes a `StorageResolution of 1 second` .
+     */
+    Period?: number | undefined;
+    /**
+     * When used in `GetMetricData` , this option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify `false` . If you omit this, the default of `true` is used.
+     *
+     * When used in `PutMetricAlarm` , specify `true` for the one expression result to use as the alarm. For all other metrics and expressions in the same `PutMetricAlarm` operation, specify `ReturnData` as False.
+     */
+    ReturnData?: boolean | undefined;
+};
+/**
+ * Indicates the CloudWatch math expression that provides the time series the anomaly detector uses as input. The designated math expression must return a single time series.
+ */
+export type MetricMathAnomalyDetector = {
+    /**
+     * An array of metric data query structures that enables you to create an anomaly detector based on the result of a metric math expression. Each item in `MetricDataQueries` gets a metric or performs a math expression. One item in `MetricDataQueries` is the expression that provides the time series that the anomaly detector uses as input. Designate the expression by setting `ReturnData` to `true` for this object in the array. For all other expressions and metrics, set `ReturnData` to `false` . The designated expression must return a single time series.
+     */
+    MetricDataQueries?: MetricDataQuery[] | undefined;
+};
+/**
+ * This structure defines the metric to be returned, along with the statistics, period, and units.
+ */
+export type MetricStat = {
+    /**
+     * The metric to return, including the metric name, namespace, and dimensions.
+     */
+    Metric: Metric;
+    /**
+     * The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a `PutMetricData` call that includes a `StorageResolution` of 1 second.
+     *
+     * If the `StartTime` parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
+     *
+     * - Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
+     * - Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
+     * - Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
+     */
+    Period: number;
+    /**
+     * The statistic to return. It can include any CloudWatch statistic or extended statistic.
+     */
+    Stat: string;
+    /**
+     * When you are using a `Put` operation, this defines what unit you want to use when storing the metric.
+     *
+     * In a `Get` operation, if you omit `Unit` then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.
+     */
+    Unit?: string | undefined;
+};
+/**
+ * Each `Range` specifies one range of days or times to exclude from use for training or updating an anomaly detection model.
+ */
+export type Range = {
+    /**
+     * The end time of the range to exclude. The format is `yyyy-MM-dd'T'HH:mm:ss` . For example, `2019-07-01T23:59:59` .
+     */
+    EndTime: string;
+    /**
+     * The start time of the range to exclude. The format is `yyyy-MM-dd'T'HH:mm:ss` . For example, `2019-07-01T23:59:59` .
+     */
+    StartTime: string;
+};
+/**
+ * Designates the CloudWatch metric and statistic that provides the time series the anomaly detector uses as input. If you have enabled unified cross-account observability, and this account is a monitoring account, the metric can be in the same account or a source account.
+ */
+export type SingleMetricAnomalyDetector = {
+    /**
+     * If the CloudWatch metric that provides the time series that the anomaly detector uses as input is in another account, specify that account ID here. If you omit this parameter, the current account is used.
+     */
+    AccountId?: string | undefined;
+    /**
+     * The metric dimensions to create the anomaly detection model for.
+     */
+    Dimensions?: Dimension[] | undefined;
+    /**
+     * The name of the metric to create the anomaly detection model for.
+     */
+    MetricName?: string | undefined;
+    /**
+     * The namespace of the metric to create the anomaly detection model for.
+     */
+    Namespace?: string | undefined;
+    /**
+     * The statistic to use for the metric and anomaly detection model.
+     */
+    Stat?: string | undefined;
+};
+//# sourceMappingURL=aws-cloudwatch-anomalydetector.d.ts.map

package/out/exports/resources.generated/aws-cloudwatch-compositealarm.d.ts

@@ -0,0 +1,98 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type CloudWatchCompositeAlarm = ResourceDefinitionWithAttributes<"AWS::CloudWatch::CompositeAlarm", CloudWatchCompositeAlarmProps, CloudWatchCompositeAlarmAttribs>;
+/**
+ * The `AWS::CloudWatch::CompositeAlarm` type creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.
+ *
+ * The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.
+ *
+ * Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.
+ *
+ * When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in INSUFFICIENT_DATA state.
+ *
+ * When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
+ */
+export type CloudWatchCompositeAlarmProps = {
+    /**
+     * Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. The default is TRUE.
+     */
+    ActionsEnabled?: boolean | undefined;
+    /**
+     * Actions will be suppressed if the suppressor alarm is in the `ALARM` state. `ActionsSuppressor` can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.
+     * @minLength 1
+     * @maxLength 1600
+     */
+    ActionsSuppressor?: string | undefined;
+    /**
+     * The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the `ALARM` state. After this time, the composite alarm performs its actions.
+     *
+     * > `ExtensionPeriod` is required only when `ActionsSuppressor` is specified.
+     * @min 0
+     */
+    ActionsSuppressorExtensionPeriod?: number | undefined;
+    /**
+     * The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the `ALARM` state. After this time, the composite alarm performs its actions.
+     *
+     * > `WaitPeriod` is required only when `ActionsSuppressor` is specified.
+     * @min 0
+     */
+    ActionsSuppressorWaitPeriod?: number | undefined;
+    /**
+     * The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutCompositeAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutCompositeAlarm.html) in the *Amazon CloudWatch API Reference* .
+     */
+    AlarmActions?: string[] | undefined;
+    /**
+     * The description for the composite alarm.
+     * @minLength 0
+     * @maxLength 1024
+     */
+    AlarmDescription?: string | undefined;
+    /**
+     * The name for the composite alarm. This name must be unique within your AWS account.
+     * @minLength 1
+     * @maxLength 255
+     */
+    AlarmName?: string | undefined;
+    /**
+     * An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state. For each alarm that you reference, you designate a function that specifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT_DATA state. You can use operators (AND, OR and NOT) to combine multiple functions in a single expression. You can use parenthesis to logically group the functions in your expression.
+     *
+     * You can use either alarm names or ARNs to reference the other alarms that are to be evaluated.
+     *
+     * Functions can include the following:
+     *
+     * - ALARM("alarm-name or alarm-ARN") is TRUE if the named alarm is in ALARM state.
+     * - OK("alarm-name or alarm-ARN") is TRUE if the named alarm is in OK state.
+     * - INSUFFICIENT_DATA("alarm-name or alarm-ARN") is TRUE if the named alarm is in INSUFFICIENT_DATA state.
+     * - TRUE always evaluates to TRUE.
+     * - FALSE always evaluates to FALSE.
+     *
+     * TRUE and FALSE are useful for testing a complex AlarmRule structure, and for testing your alarm actions.
+     *
+     * For more information about `AlarmRule` syntax, see [PutCompositeAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutCompositeAlarm.html) in the *Amazon CloudWatch API Reference* .
+     * @minLength 1
+     * @maxLength 10240
+     */
+    AlarmRule: string;
+    /**
+     * The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutCompositeAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutCompositeAlarm.html) in the *Amazon CloudWatch API Reference* .
+     */
+    InsufficientDataActions?: string[] | undefined;
+    /**
+     * The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutCompositeAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutCompositeAlarm.html) in the *Amazon CloudWatch API Reference* .
+     */
+    OKActions?: string[] | undefined;
+    /**
+     * A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm. To be able to associate tags with the alarm when you create the alarm, you must have the `cloudwatch:TagResource` permission.
+     *
+     * Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
+     */
+    Tags?: Tag[] | undefined;
+};
+export type CloudWatchCompositeAlarmAttribs = {
+    /**
+     * The ARN of the composite alarm, such as `arn:aws:cloudwatch:us-west-2:123456789012:alarm/CompositeAlarmName` .
+     * @minLength 1
+     * @maxLength 1600
+     */
+    Arn: string;
+};
+//# sourceMappingURL=aws-cloudwatch-compositealarm.d.ts.map

package/out/exports/resources.generated/aws-cloudwatch-dashboard.d.ts

@@ -0,0 +1,20 @@
+import type { ResourceDefinition } from "../main.ts";
+export type CloudWatchDashboard = ResourceDefinition<"AWS::CloudWatch::Dashboard", CloudWatchDashboardProps>;
+/**
+ * The `AWS::CloudWatch::Dashboard` resource specifies an Amazon CloudWatch dashboard. A dashboard is a customizable home page in the CloudWatch console that you can use to monitor your AWS resources in a single view.
+ *
+ * All dashboards in your account are global, not region-specific.
+ */
+export type CloudWatchDashboardProps = {
+    /**
+     * The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard. This parameter is required.
+     *
+     * For more information about the syntax, see [Dashboard Body Structure and Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html) .
+     */
+    DashboardBody: string;
+    /**
+     * The name of the dashboard. The name must be between 1 and 255 characters. If you do not specify a name, one will be generated automatically.
+     */
+    DashboardName?: string | undefined;
+};
+//# sourceMappingURL=aws-cloudwatch-dashboard.d.ts.map

package/out/exports/resources.generated/aws-cloudwatch-insightrule.d.ts

@@ -0,0 +1,39 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type CloudWatchInsightRule = ResourceDefinitionWithAttributes<"AWS::CloudWatch::InsightRule", CloudWatchInsightRuleProps, CloudWatchInsightRuleAttribs>;
+/**
+ * Creates or updates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, see [Using Contributor Insights to Analyze High-Cardinality Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html) in the *Amazon CloudWatch User Guide* .
+ */
+export type CloudWatchInsightRuleProps = {
+    /**
+     * The definition of the rule, as a JSON object. For details about the syntax, see [Contributor Insights Rule Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html) in the *Amazon CloudWatch User Guide* .
+     */
+    RuleBody: string;
+    /**
+     * The name of the rule.
+     */
+    RuleName: string;
+    /**
+     * The current state of the rule. Valid values are `ENABLED` and `DISABLED` .
+     */
+    RuleState: string;
+    /**
+     * A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a rule.
+     *
+     * Tags can help you organize and categorize your resources. For more information, see [Tagging Your Amazon CloudWatch Resources](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Tagging.html) .
+     *
+     * To be able to associate tags with a rule, you must have the `cloudwatch:TagResource` permission in addition to the `cloudwatch:PutInsightRule` permission.
+     */
+    Tags?: Record<string, unknown> | undefined;
+};
+export type CloudWatchInsightRuleAttribs = {
+    /**
+     * The ARN of the Contributor Insights rule, such as `arn:aws:cloudwatch:us-west-2:123456789012:insight-rule/MyInsightRuleName` .
+     */
+    Arn: string;
+    Id: string;
+    /**
+     * The name of the Contributor Insights rule.
+     */
+    RuleName: string;
+};
+//# sourceMappingURL=aws-cloudwatch-insightrule.d.ts.map

package/out/exports/resources.generated/aws-cloudwatch-metricstream.d.ts

@@ -0,0 +1,218 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type CloudWatchMetricStream = ResourceDefinitionWithAttributes<"AWS::CloudWatch::MetricStream", CloudWatchMetricStreamProps, CloudWatchMetricStreamAttribs>;
+/**
+ * Creates or updates a metric stream. 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](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html) .
+ *
+ * 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:
+ *
+ * - Stream metrics from all metric namespaces in the account.
+ * - Stream metrics from all metric namespaces in the account, except for the namespaces that you list in `ExcludeFilters` .
+ * - Stream metrics from only the metric namespaces that you list in `IncludeFilters` .
+ *
+ * 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.
+ */
+export type CloudWatchMetricStreamProps = {
+    /**
+     * If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here. You cannot specify both `IncludeFilters` and `ExcludeFilters` in the same metric stream.
+     *
+     * When you modify the `IncludeFilters` or `ExcludeFilters` of an existing metric stream in any way, the metric stream is effectively restarted, so after such a change you will get only the datapoints that have a timestamp after the time of the update.
+     */
+    ExcludeFilters?: MetricStreamFilter[] | undefined;
+    /**
+     * The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream. This Amazon Kinesis Firehose delivery stream must already exist and must be in the same account as the metric stream.
+     * @minLength 20
+     * @maxLength 2048
+     */
+    FirehoseArn: string;
+    /**
+     * If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here. You cannot specify both `IncludeFilters` and `ExcludeFilters` in the same metric stream.
+     *
+     * When you modify the `IncludeFilters` or `ExcludeFilters` of an existing metric stream in any way, the metric stream is effectively restarted, so after such a change you will get only the datapoints that have a timestamp after the time of the update.
+     */
+    IncludeFilters?: 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` .
+     *
+     * For more information about linking accounts, see [CloudWatch cross-account observability](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html)
+     */
+    IncludeLinkedAccountsMetrics?: boolean | undefined;
+    /**
+     * If you are creating a new metric stream, this is the name for the new stream. The name must be different than the names of other metric streams in this account and Region.
+     *
+     * If you are updating a metric stream, specify the name of that stream here.
+     * @minLength 1
+     * @maxLength 255
+     */
+    Name?: string | undefined;
+    /**
+     * The output format for the stream. Valid values are `json` , `opentelemetry1.0` and `opentelemetry0.7` For more information about metric stream output formats, see [Metric streams output formats](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html) .
+     *
+     * This parameter is required.
+     * @minLength 1
+     * @maxLength 255
+     */
+    OutputFormat: string;
+    /**
+     * The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Firehose resources. This IAM role must already exist and must be in the same account as the metric stream. This IAM role must include the `firehose:PutRecord` and `firehose:PutRecordBatch` permissions.
+     * @minLength 20
+     * @maxLength 2048
+     */
+    RoleArn: 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.
+     *
+     * For each entry in this array, you specify one or more metrics and the list of additional statistics to stream for those metrics. The additional statistics that you can stream depend on the stream's `OutputFormat` . If the `OutputFormat` is `json` , you can stream any additional statistic that is supported by CloudWatch , listed in [CloudWatch statistics definitions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html) . If the `OutputFormat` is OpenTelemetry, you can stream percentile statistics.
+     */
+    StatisticsConfigurations?: MetricStreamStatisticsConfiguration[] | undefined;
+    /**
+     * An array of key-value pairs to apply to the metric stream.
+     *
+     * For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
+     */
+    Tags?: Tag[] | undefined;
+} | {
+    /**
+     * If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here. You cannot specify both `IncludeFilters` and `ExcludeFilters` in the same metric stream.
+     *
+     * When you modify the `IncludeFilters` or `ExcludeFilters` of an existing metric stream in any way, the metric stream is effectively restarted, so after such a change you will get only the datapoints that have a timestamp after the time of the update.
+     */
+    ExcludeFilters: MetricStreamFilter[];
+    /**
+     * The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream. This Amazon Kinesis Firehose delivery stream must already exist and must be in the same account as the metric stream.
+     * @minLength 20
+     * @maxLength 2048
+     */
+    FirehoseArn: string;
+    /**
+     * If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here. You cannot specify both `IncludeFilters` and `ExcludeFilters` in the same metric stream.
+     *
+     * When you modify the `IncludeFilters` or `ExcludeFilters` of an existing metric stream in any way, the metric stream is effectively restarted, so after such a change you will get only the datapoints that have a timestamp after the time of the update.
+     */
+    IncludeFilters: MetricStreamFilter[];
+    /**
+     * 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` .
+     *
+     * For more information about linking accounts, see [CloudWatch cross-account observability](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html)
+     */
+    IncludeLinkedAccountsMetrics?: boolean | undefined;
+    /**
+     * If you are creating a new metric stream, this is the name for the new stream. The name must be different than the names of other metric streams in this account and Region.
+     *
+     * If you are updating a metric stream, specify the name of that stream here.
+     * @minLength 1
+     * @maxLength 255
+     */
+    Name?: string | undefined;
+    /**
+     * The output format for the stream. Valid values are `json` , `opentelemetry1.0` and `opentelemetry0.7` For more information about metric stream output formats, see [Metric streams output formats](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html) .
+     *
+     * This parameter is required.
+     * @minLength 1
+     * @maxLength 255
+     */
+    OutputFormat: string;
+    /**
+     * The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Firehose resources. This IAM role must already exist and must be in the same account as the metric stream. This IAM role must include the `firehose:PutRecord` and `firehose:PutRecordBatch` permissions.
+     * @minLength 20
+     * @maxLength 2048
+     */
+    RoleArn: 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.
+     *
+     * For each entry in this array, you specify one or more metrics and the list of additional statistics to stream for those metrics. The additional statistics that you can stream depend on the stream's `OutputFormat` . If the `OutputFormat` is `json` , you can stream any additional statistic that is supported by CloudWatch , listed in [CloudWatch statistics definitions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html) . If the `OutputFormat` is OpenTelemetry, you can stream percentile statistics.
+     */
+    StatisticsConfigurations?: MetricStreamStatisticsConfiguration[] | undefined;
+    /**
+     * An array of key-value pairs to apply to the metric stream.
+     *
+     * For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
+     */
+    Tags?: Tag[] | undefined;
+};
+export type CloudWatchMetricStreamAttribs = {
+    /**
+     * The ARN of the metric stream.
+     * @minLength 20
+     * @maxLength 2048
+     */
+    Arn: string;
+    /**
+     * The date that the metric stream was originally created.
+     * @format timestamp
+     * @format date-time
+     */
+    CreationDate: string;
+    /**
+     * The date that the metric stream was most recently updated.
+     * @format timestamp
+     * @format date-time
+     */
+    LastUpdateDate: string;
+    /**
+     * The state of the metric stream, either `running` or `stopped` .
+     * @minLength 1
+     * @maxLength 255
+     */
+    State: string;
+};
+/**
+ * This structure contains a metric namespace and optionally, a list of metric names, to either include in a metric ' stream or exclude from a metric stream.
+ *
+ * A metric stream's filters can include up to 1000 total names. This limit applies to the sum of namespace names and metric names in the filters. For example, this could include 10 metric namespace filters with 99 metrics each, or 20 namespace filters with 49 metrics specified in each filter.
+ */
+export type MetricStreamFilter = {
+    /**
+     * The names of the metrics to either include or exclude from the metric stream.
+     *
+     * If you omit this parameter, all metrics in the namespace are included or excluded, depending on whether this filter is specified as an exclude filter or an include filter.
+     *
+     * Each metric name can contain only ASCII printable characters (ASCII range 32 through 126). Each metric name must contain at least one non-whitespace character.
+     */
+    MetricNames?: string[] | undefined;
+    /**
+     * The name of the metric namespace in the filter.
+     *
+     * The namespace can contain only ASCII printable characters (ASCII range 32 through 126). It must contain at least one non-whitespace character.
+     * @minLength 1
+     * @maxLength 255
+     */
+    Namespace: string;
+};
+/**
+ * This structure specifies a list of additional statistics to stream, and the metrics to stream those additional statistics for.
+ *
+ * All metrics that match the combination of metric name and namespace will be streamed with the additional statistics, no matter their dimensions.
+ */
+export type MetricStreamStatisticsConfiguration = {
+    /**
+     * The additional statistics to stream for the metrics listed in `IncludeMetrics` .
+     */
+    AdditionalStatistics: string[];
+    /**
+     * An array that defines the metrics that are to have additional statistics streamed.
+     */
+    IncludeMetrics: MetricStreamStatisticsMetric[];
+};
+/**
+ * A structure that specifies the metric name and namespace for one metric that is going to have additional statistics included in the stream.
+ */
+export type MetricStreamStatisticsMetric = {
+    /**
+     * The name of the metric.
+     * @minLength 1
+     * @maxLength 255
+     */
+    MetricName: string;
+    /**
+     * The namespace of the metric.
+     * @minLength 1
+     * @maxLength 255
+     */
+    Namespace: string;
+};
+//# sourceMappingURL=aws-cloudwatch-metricstream.d.ts.map