@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
182 lines (181 loc) • 8.09 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides a CloudWatch RUM App Monitor resource.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.rum.AppMonitor("example", {
* name: "example",
* domain: "localhost",
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import Cloudwatch RUM App Monitor using the `name`. For example:
*
* ```sh
* $ pulumi import aws:rum/appMonitor:AppMonitor example example
* ```
*/
export declare class AppMonitor extends pulumi.CustomResource {
/**
* Get an existing AppMonitor 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 state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AppMonitorState, opts?: pulumi.CustomResourceOptions): AppMonitor;
/**
* Returns true if the given object is an instance of AppMonitor. 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 AppMonitor;
/**
* configuration data for the app monitor. See appMonitorConfiguration below.
*/
readonly appMonitorConfiguration: pulumi.Output<outputs.rum.AppMonitorAppMonitorConfiguration>;
/**
* The unique ID of the app monitor. Useful for JS templates.
*/
readonly appMonitorId: pulumi.Output<string>;
/**
* The Amazon Resource Name (ARN) specifying the app monitor.
*/
readonly arn: pulumi.Output<string>;
/**
* Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are `DISABLED`. See customEvents below.
*/
readonly customEvents: pulumi.Output<outputs.rum.AppMonitorCustomEvents>;
/**
* Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges. Default value is `false`.
*/
readonly cwLogEnabled: pulumi.Output<boolean | undefined>;
/**
* The name of the log group where the copies are stored.
*/
readonly cwLogGroup: pulumi.Output<string>;
readonly domain: pulumi.Output<string | undefined>;
readonly domainLists: pulumi.Output<string[] | undefined>;
/**
* The name of the log stream.
*/
readonly name: pulumi.Output<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a AppMonitor 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?: AppMonitorArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AppMonitor resources.
*/
export interface AppMonitorState {
/**
* configuration data for the app monitor. See appMonitorConfiguration below.
*/
appMonitorConfiguration?: pulumi.Input<inputs.rum.AppMonitorAppMonitorConfiguration>;
/**
* The unique ID of the app monitor. Useful for JS templates.
*/
appMonitorId?: pulumi.Input<string>;
/**
* The Amazon Resource Name (ARN) specifying the app monitor.
*/
arn?: pulumi.Input<string>;
/**
* Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are `DISABLED`. See customEvents below.
*/
customEvents?: pulumi.Input<inputs.rum.AppMonitorCustomEvents>;
/**
* Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges. Default value is `false`.
*/
cwLogEnabled?: pulumi.Input<boolean>;
/**
* The name of the log group where the copies are stored.
*/
cwLogGroup?: pulumi.Input<string>;
domain?: pulumi.Input<string>;
domainLists?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The name of the log stream.
*/
name?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}
/**
* The set of arguments for constructing a AppMonitor resource.
*/
export interface AppMonitorArgs {
/**
* configuration data for the app monitor. See appMonitorConfiguration below.
*/
appMonitorConfiguration?: pulumi.Input<inputs.rum.AppMonitorAppMonitorConfiguration>;
/**
* Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are `DISABLED`. See customEvents below.
*/
customEvents?: pulumi.Input<inputs.rum.AppMonitorCustomEvents>;
/**
* Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges. Default value is `false`.
*/
cwLogEnabled?: pulumi.Input<boolean>;
domain?: pulumi.Input<string>;
domainLists?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The name of the log stream.
*/
name?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}