rum

package
v6.32.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 19, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AppMonitor 

type AppMonitor struct {
	pulumi.CustomResourceState

	// configuration data for the app monitor. See appMonitorConfiguration below.
	AppMonitorConfiguration AppMonitorAppMonitorConfigurationOutput `pulumi:"appMonitorConfiguration"`
	// The unique ID of the app monitor. Useful for JS templates.
	AppMonitorId pulumi.StringOutput `pulumi:"appMonitorId"`
	// The Amazon Resource Name (ARN) specifying the app monitor.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// 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 AppMonitorCustomEventsOutput `pulumi:"customEvents"`
	// 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.BoolPtrOutput `pulumi:"cwLogEnabled"`
	// The name of the log group where the copies are stored.
	CwLogGroup pulumi.StringOutput `pulumi:"cwLogGroup"`
	// The top-level internet domain name for which your application has administrative authority.
	Domain pulumi.StringOutput `pulumi:"domain"`
	// The name of the log stream.
	Name pulumi.StringOutput `pulumi:"name"`
	// 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.StringMapOutput `pulumi:"tags"`
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	//
	// Deprecated: Please use `tags` instead.
	TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
}

Provides a CloudWatch RUM App Monitor resource.

## Example Usage

<!--Start PulumiCodeChooser --> ```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rum"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rum.NewAppMonitor(ctx, "example", &rum.AppMonitorArgs{
			Name:   pulumi.String("example"),
			Domain: pulumi.String("localhost"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Using `pulumi import`, import Cloudwatch RUM App Monitor using the `name`. For example:

```sh $ pulumi import aws:rum/appMonitor:AppMonitor example example ```

func GetAppMonitor 

func GetAppMonitor(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AppMonitorState, opts ...pulumi.ResourceOption) (*AppMonitor, error)

GetAppMonitor gets an existing AppMonitor resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAppMonitor 

func NewAppMonitor(ctx *pulumi.Context,
	name string, args *AppMonitorArgs, opts ...pulumi.ResourceOption) (*AppMonitor, error)

NewAppMonitor registers a new resource with the given unique name, arguments, and options.

func (*AppMonitor) ElementType 

func (*AppMonitor) ElementType() reflect.Type

func (*AppMonitor) ToAppMonitorOutput 

func (i *AppMonitor) ToAppMonitorOutput() AppMonitorOutput

func (*AppMonitor) ToAppMonitorOutputWithContext 

func (i *AppMonitor) ToAppMonitorOutputWithContext(ctx context.Context) AppMonitorOutput

type AppMonitorAppMonitorConfiguration 

type AppMonitorAppMonitorConfiguration struct {
	// If you set this to `true`, RUM web client sets two cookies, a session cookie  and a user cookie. The cookies allow the RUM web client to collect data relating to the number of users an application has and the behavior of the application across a sequence of events. Cookies are stored in the top-level domain of the current page.
	AllowCookies *bool `pulumi:"allowCookies"`
	// If you set this to `true`, RUM enables X-Ray tracing for the user sessions  that RUM samples. RUM adds an X-Ray trace header to allowed HTTP requests. It also records an X-Ray segment for allowed HTTP requests.
	EnableXray *bool `pulumi:"enableXray"`
	// A list of URLs in your website or application to exclude from RUM data collection.
	ExcludedPages []string `pulumi:"excludedPages"`
	// A list of pages in the CloudWatch RUM console that are to be displayed with a "favorite" icon.
	FavoritePages []string `pulumi:"favoritePages"`
	// The ARN of the guest IAM role that is attached to the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.
	GuestRoleArn *string `pulumi:"guestRoleArn"`
	// The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.
	IdentityPoolId *string `pulumi:"identityPoolId"`
	// If this app monitor is to collect data from only certain pages in your application, this structure lists those pages.
	IncludedPages []string `pulumi:"includedPages"`
	// Specifies the percentage of user sessions to use for RUM data collection. Choosing a higher percentage gives you more data but also incurs more costs. The number you specify is the percentage of user sessions that will be used. Default value is `0.1`.
	SessionSampleRate *float64 `pulumi:"sessionSampleRate"`
	// An array that lists the types of telemetry data that this app monitor is to collect. Valid values are `errors`, `performance`, and `http`.
	Telemetries []string `pulumi:"telemetries"`
}

type AppMonitorAppMonitorConfigurationArgs 

type AppMonitorAppMonitorConfigurationArgs struct {
	// If you set this to `true`, RUM web client sets two cookies, a session cookie  and a user cookie. The cookies allow the RUM web client to collect data relating to the number of users an application has and the behavior of the application across a sequence of events. Cookies are stored in the top-level domain of the current page.
	AllowCookies pulumi.BoolPtrInput `pulumi:"allowCookies"`
	// If you set this to `true`, RUM enables X-Ray tracing for the user sessions  that RUM samples. RUM adds an X-Ray trace header to allowed HTTP requests. It also records an X-Ray segment for allowed HTTP requests.
	EnableXray pulumi.BoolPtrInput `pulumi:"enableXray"`
	// A list of URLs in your website or application to exclude from RUM data collection.
	ExcludedPages pulumi.StringArrayInput `pulumi:"excludedPages"`
	// A list of pages in the CloudWatch RUM console that are to be displayed with a "favorite" icon.
	FavoritePages pulumi.StringArrayInput `pulumi:"favoritePages"`
	// The ARN of the guest IAM role that is attached to the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.
	GuestRoleArn pulumi.StringPtrInput `pulumi:"guestRoleArn"`
	// The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.
	IdentityPoolId pulumi.StringPtrInput `pulumi:"identityPoolId"`
	// If this app monitor is to collect data from only certain pages in your application, this structure lists those pages.
	IncludedPages pulumi.StringArrayInput `pulumi:"includedPages"`
	// Specifies the percentage of user sessions to use for RUM data collection. Choosing a higher percentage gives you more data but also incurs more costs. The number you specify is the percentage of user sessions that will be used. Default value is `0.1`.
	SessionSampleRate pulumi.Float64PtrInput `pulumi:"sessionSampleRate"`
	// An array that lists the types of telemetry data that this app monitor is to collect. Valid values are `errors`, `performance`, and `http`.
	Telemetries pulumi.StringArrayInput `pulumi:"telemetries"`
}

func (AppMonitorAppMonitorConfigurationArgs) ElementType 

func (AppMonitorAppMonitorConfigurationArgs) ElementType() reflect.Type

func (AppMonitorAppMonitorConfigurationArgs) ToAppMonitorAppMonitorConfigurationOutput 

func (i AppMonitorAppMonitorConfigurationArgs) ToAppMonitorAppMonitorConfigurationOutput() AppMonitorAppMonitorConfigurationOutput

func (AppMonitorAppMonitorConfigurationArgs) ToAppMonitorAppMonitorConfigurationOutputWithContext 

func (i AppMonitorAppMonitorConfigurationArgs) ToAppMonitorAppMonitorConfigurationOutputWithContext(ctx context.Context) AppMonitorAppMonitorConfigurationOutput

func (AppMonitorAppMonitorConfigurationArgs) ToAppMonitorAppMonitorConfigurationPtrOutput 

func (i AppMonitorAppMonitorConfigurationArgs) ToAppMonitorAppMonitorConfigurationPtrOutput() AppMonitorAppMonitorConfigurationPtrOutput

func (AppMonitorAppMonitorConfigurationArgs) ToAppMonitorAppMonitorConfigurationPtrOutputWithContext 

func (i AppMonitorAppMonitorConfigurationArgs) ToAppMonitorAppMonitorConfigurationPtrOutputWithContext(ctx context.Context) AppMonitorAppMonitorConfigurationPtrOutput

type AppMonitorAppMonitorConfigurationInput 

type AppMonitorAppMonitorConfigurationInput interface {
	pulumi.Input

	ToAppMonitorAppMonitorConfigurationOutput() AppMonitorAppMonitorConfigurationOutput
	ToAppMonitorAppMonitorConfigurationOutputWithContext(context.Context) AppMonitorAppMonitorConfigurationOutput
}

AppMonitorAppMonitorConfigurationInput is an input type that accepts AppMonitorAppMonitorConfigurationArgs and AppMonitorAppMonitorConfigurationOutput values. You can construct a concrete instance of `AppMonitorAppMonitorConfigurationInput` via: 

AppMonitorAppMonitorConfigurationArgs{...}

type AppMonitorAppMonitorConfigurationOutput 

type AppMonitorAppMonitorConfigurationOutput struct{ *pulumi.OutputState }

func (AppMonitorAppMonitorConfigurationOutput) AllowCookies 

func (o AppMonitorAppMonitorConfigurationOutput) AllowCookies() pulumi.BoolPtrOutput

If you set this to `true`, RUM web client sets two cookies, a session cookie and a user cookie. The cookies allow the RUM web client to collect data relating to the number of users an application has and the behavior of the application across a sequence of events. Cookies are stored in the top-level domain of the current page.

func (AppMonitorAppMonitorConfigurationOutput) ElementType 

func (AppMonitorAppMonitorConfigurationOutput) ElementType() reflect.Type

func (AppMonitorAppMonitorConfigurationOutput) EnableXray 

func (o AppMonitorAppMonitorConfigurationOutput) EnableXray() pulumi.BoolPtrOutput

If you set this to `true`, RUM enables X-Ray tracing for the user sessions that RUM samples. RUM adds an X-Ray trace header to allowed HTTP requests. It also records an X-Ray segment for allowed HTTP requests.

func (AppMonitorAppMonitorConfigurationOutput) ExcludedPages 

func (o AppMonitorAppMonitorConfigurationOutput) ExcludedPages() pulumi.StringArrayOutput

A list of URLs in your website or application to exclude from RUM data collection.

func (AppMonitorAppMonitorConfigurationOutput) FavoritePages 

func (o AppMonitorAppMonitorConfigurationOutput) FavoritePages() pulumi.StringArrayOutput

A list of pages in the CloudWatch RUM console that are to be displayed with a "favorite" icon.

func (AppMonitorAppMonitorConfigurationOutput) GuestRoleArn 

func (o AppMonitorAppMonitorConfigurationOutput) GuestRoleArn() pulumi.StringPtrOutput

The ARN of the guest IAM role that is attached to the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.

func (AppMonitorAppMonitorConfigurationOutput) IdentityPoolId 

func (o AppMonitorAppMonitorConfigurationOutput) IdentityPoolId() pulumi.StringPtrOutput

The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.

func (AppMonitorAppMonitorConfigurationOutput) IncludedPages 

func (o AppMonitorAppMonitorConfigurationOutput) IncludedPages() pulumi.StringArrayOutput

If this app monitor is to collect data from only certain pages in your application, this structure lists those pages.

func (AppMonitorAppMonitorConfigurationOutput) SessionSampleRate 

func (o AppMonitorAppMonitorConfigurationOutput) SessionSampleRate() pulumi.Float64PtrOutput

Specifies the percentage of user sessions to use for RUM data collection. Choosing a higher percentage gives you more data but also incurs more costs. The number you specify is the percentage of user sessions that will be used. Default value is `0.1`.

func (AppMonitorAppMonitorConfigurationOutput) Telemetries 

func (o AppMonitorAppMonitorConfigurationOutput) Telemetries() pulumi.StringArrayOutput

An array that lists the types of telemetry data that this app monitor is to collect. Valid values are `errors`, `performance`, and `http`.

func (AppMonitorAppMonitorConfigurationOutput) ToAppMonitorAppMonitorConfigurationOutput 

func (o AppMonitorAppMonitorConfigurationOutput) ToAppMonitorAppMonitorConfigurationOutput() AppMonitorAppMonitorConfigurationOutput

func (AppMonitorAppMonitorConfigurationOutput) ToAppMonitorAppMonitorConfigurationOutputWithContext 

func (o AppMonitorAppMonitorConfigurationOutput) ToAppMonitorAppMonitorConfigurationOutputWithContext(ctx context.Context) AppMonitorAppMonitorConfigurationOutput

func (AppMonitorAppMonitorConfigurationOutput) ToAppMonitorAppMonitorConfigurationPtrOutput 

func (o AppMonitorAppMonitorConfigurationOutput) ToAppMonitorAppMonitorConfigurationPtrOutput() AppMonitorAppMonitorConfigurationPtrOutput

func (AppMonitorAppMonitorConfigurationOutput) ToAppMonitorAppMonitorConfigurationPtrOutputWithContext 

func (o AppMonitorAppMonitorConfigurationOutput) ToAppMonitorAppMonitorConfigurationPtrOutputWithContext(ctx context.Context) AppMonitorAppMonitorConfigurationPtrOutput

type AppMonitorAppMonitorConfigurationPtrInput 

type AppMonitorAppMonitorConfigurationPtrInput interface {
	pulumi.Input

	ToAppMonitorAppMonitorConfigurationPtrOutput() AppMonitorAppMonitorConfigurationPtrOutput
	ToAppMonitorAppMonitorConfigurationPtrOutputWithContext(context.Context) AppMonitorAppMonitorConfigurationPtrOutput
}

AppMonitorAppMonitorConfigurationPtrInput is an input type that accepts AppMonitorAppMonitorConfigurationArgs, AppMonitorAppMonitorConfigurationPtr and AppMonitorAppMonitorConfigurationPtrOutput values. You can construct a concrete instance of `AppMonitorAppMonitorConfigurationPtrInput` via: 

        AppMonitorAppMonitorConfigurationArgs{...}

or:

        nil

func AppMonitorAppMonitorConfigurationPtr 

func AppMonitorAppMonitorConfigurationPtr(v *AppMonitorAppMonitorConfigurationArgs) AppMonitorAppMonitorConfigurationPtrInput

type AppMonitorAppMonitorConfigurationPtrOutput 

type AppMonitorAppMonitorConfigurationPtrOutput struct{ *pulumi.OutputState }

func (AppMonitorAppMonitorConfigurationPtrOutput) AllowCookies 

func (o AppMonitorAppMonitorConfigurationPtrOutput) AllowCookies() pulumi.BoolPtrOutput

If you set this to `true`, RUM web client sets two cookies, a session cookie and a user cookie. The cookies allow the RUM web client to collect data relating to the number of users an application has and the behavior of the application across a sequence of events. Cookies are stored in the top-level domain of the current page.

func (AppMonitorAppMonitorConfigurationPtrOutput) Elem 

func (o AppMonitorAppMonitorConfigurationPtrOutput) Elem() AppMonitorAppMonitorConfigurationOutput

func (AppMonitorAppMonitorConfigurationPtrOutput) ElementType 

func (AppMonitorAppMonitorConfigurationPtrOutput) ElementType() reflect.Type

func (AppMonitorAppMonitorConfigurationPtrOutput) EnableXray 

func (o AppMonitorAppMonitorConfigurationPtrOutput) EnableXray() pulumi.BoolPtrOutput

If you set this to `true`, RUM enables X-Ray tracing for the user sessions that RUM samples. RUM adds an X-Ray trace header to allowed HTTP requests. It also records an X-Ray segment for allowed HTTP requests.

func (AppMonitorAppMonitorConfigurationPtrOutput) ExcludedPages 

func (o AppMonitorAppMonitorConfigurationPtrOutput) ExcludedPages() pulumi.StringArrayOutput

A list of URLs in your website or application to exclude from RUM data collection.

func (AppMonitorAppMonitorConfigurationPtrOutput) FavoritePages 

func (o AppMonitorAppMonitorConfigurationPtrOutput) FavoritePages() pulumi.StringArrayOutput

A list of pages in the CloudWatch RUM console that are to be displayed with a "favorite" icon.

func (AppMonitorAppMonitorConfigurationPtrOutput) GuestRoleArn 

func (o AppMonitorAppMonitorConfigurationPtrOutput) GuestRoleArn() pulumi.StringPtrOutput

The ARN of the guest IAM role that is attached to the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.

func (AppMonitorAppMonitorConfigurationPtrOutput) IdentityPoolId 

func (o AppMonitorAppMonitorConfigurationPtrOutput) IdentityPoolId() pulumi.StringPtrOutput

The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.

func (AppMonitorAppMonitorConfigurationPtrOutput) IncludedPages 

func (o AppMonitorAppMonitorConfigurationPtrOutput) IncludedPages() pulumi.StringArrayOutput

If this app monitor is to collect data from only certain pages in your application, this structure lists those pages.

func (AppMonitorAppMonitorConfigurationPtrOutput) SessionSampleRate 

func (o AppMonitorAppMonitorConfigurationPtrOutput) SessionSampleRate() pulumi.Float64PtrOutput

Specifies the percentage of user sessions to use for RUM data collection. Choosing a higher percentage gives you more data but also incurs more costs. The number you specify is the percentage of user sessions that will be used. Default value is `0.1`.

func (AppMonitorAppMonitorConfigurationPtrOutput) Telemetries 

func (o AppMonitorAppMonitorConfigurationPtrOutput) Telemetries() pulumi.StringArrayOutput

An array that lists the types of telemetry data that this app monitor is to collect. Valid values are `errors`, `performance`, and `http`.

func (AppMonitorAppMonitorConfigurationPtrOutput) ToAppMonitorAppMonitorConfigurationPtrOutput 

func (o AppMonitorAppMonitorConfigurationPtrOutput) ToAppMonitorAppMonitorConfigurationPtrOutput() AppMonitorAppMonitorConfigurationPtrOutput

func (AppMonitorAppMonitorConfigurationPtrOutput) ToAppMonitorAppMonitorConfigurationPtrOutputWithContext 

func (o AppMonitorAppMonitorConfigurationPtrOutput) ToAppMonitorAppMonitorConfigurationPtrOutputWithContext(ctx context.Context) AppMonitorAppMonitorConfigurationPtrOutput

type AppMonitorArgs 

type AppMonitorArgs struct {
	// configuration data for the app monitor. See appMonitorConfiguration below.
	AppMonitorConfiguration AppMonitorAppMonitorConfigurationPtrInput
	// 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 AppMonitorCustomEventsPtrInput
	// 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.BoolPtrInput
	// The top-level internet domain name for which your application has administrative authority.
	Domain pulumi.StringInput
	// The name of the log stream.
	Name pulumi.StringPtrInput
	// 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.StringMapInput
}

The set of arguments for constructing a AppMonitor resource.

func (AppMonitorArgs) ElementType 

func (AppMonitorArgs) ElementType() reflect.Type

type AppMonitorArray 

type AppMonitorArray []AppMonitorInput

func (AppMonitorArray) ElementType 

func (AppMonitorArray) ElementType() reflect.Type

func (AppMonitorArray) ToAppMonitorArrayOutput 

func (i AppMonitorArray) ToAppMonitorArrayOutput() AppMonitorArrayOutput

func (AppMonitorArray) ToAppMonitorArrayOutputWithContext 

func (i AppMonitorArray) ToAppMonitorArrayOutputWithContext(ctx context.Context) AppMonitorArrayOutput

type AppMonitorArrayInput 

type AppMonitorArrayInput interface {
	pulumi.Input

	ToAppMonitorArrayOutput() AppMonitorArrayOutput
	ToAppMonitorArrayOutputWithContext(context.Context) AppMonitorArrayOutput
}

AppMonitorArrayInput is an input type that accepts AppMonitorArray and AppMonitorArrayOutput values. You can construct a concrete instance of `AppMonitorArrayInput` via: 

AppMonitorArray{ AppMonitorArgs{...} }

type AppMonitorArrayOutput 

type AppMonitorArrayOutput struct{ *pulumi.OutputState }

func (AppMonitorArrayOutput) ElementType 

func (AppMonitorArrayOutput) ElementType() reflect.Type

func (AppMonitorArrayOutput) Index 

func (o AppMonitorArrayOutput) Index(i pulumi.IntInput) AppMonitorOutput

func (AppMonitorArrayOutput) ToAppMonitorArrayOutput 

func (o AppMonitorArrayOutput) ToAppMonitorArrayOutput() AppMonitorArrayOutput

func (AppMonitorArrayOutput) ToAppMonitorArrayOutputWithContext 

func (o AppMonitorArrayOutput) ToAppMonitorArrayOutputWithContext(ctx context.Context) AppMonitorArrayOutput

type AppMonitorCustomEvents 

type AppMonitorCustomEvents struct {
	// Specifies whether this app monitor allows the web client to define and send custom events. The default is for custom events to be `DISABLED`. Valid values are `DISABLED` and `ENABLED`.
	Status *string `pulumi:"status"`
}

type AppMonitorCustomEventsArgs 

type AppMonitorCustomEventsArgs struct {
	// Specifies whether this app monitor allows the web client to define and send custom events. The default is for custom events to be `DISABLED`. Valid values are `DISABLED` and `ENABLED`.
	Status pulumi.StringPtrInput `pulumi:"status"`
}

func (AppMonitorCustomEventsArgs) ElementType 

func (AppMonitorCustomEventsArgs) ElementType() reflect.Type

func (AppMonitorCustomEventsArgs) ToAppMonitorCustomEventsOutput 

func (i AppMonitorCustomEventsArgs) ToAppMonitorCustomEventsOutput() AppMonitorCustomEventsOutput

func (AppMonitorCustomEventsArgs) ToAppMonitorCustomEventsOutputWithContext 

func (i AppMonitorCustomEventsArgs) ToAppMonitorCustomEventsOutputWithContext(ctx context.Context) AppMonitorCustomEventsOutput

func (AppMonitorCustomEventsArgs) ToAppMonitorCustomEventsPtrOutput 

func (i AppMonitorCustomEventsArgs) ToAppMonitorCustomEventsPtrOutput() AppMonitorCustomEventsPtrOutput

func (AppMonitorCustomEventsArgs) ToAppMonitorCustomEventsPtrOutputWithContext 

func (i AppMonitorCustomEventsArgs) ToAppMonitorCustomEventsPtrOutputWithContext(ctx context.Context) AppMonitorCustomEventsPtrOutput

type AppMonitorCustomEventsInput 

type AppMonitorCustomEventsInput interface {
	pulumi.Input

	ToAppMonitorCustomEventsOutput() AppMonitorCustomEventsOutput
	ToAppMonitorCustomEventsOutputWithContext(context.Context) AppMonitorCustomEventsOutput
}

AppMonitorCustomEventsInput is an input type that accepts AppMonitorCustomEventsArgs and AppMonitorCustomEventsOutput values. You can construct a concrete instance of `AppMonitorCustomEventsInput` via: 

AppMonitorCustomEventsArgs{...}

type AppMonitorCustomEventsOutput 

type AppMonitorCustomEventsOutput struct{ *pulumi.OutputState }

func (AppMonitorCustomEventsOutput) ElementType 

func (AppMonitorCustomEventsOutput) ElementType() reflect.Type

func (AppMonitorCustomEventsOutput) Status 

func (o AppMonitorCustomEventsOutput) Status() pulumi.StringPtrOutput

Specifies whether this app monitor allows the web client to define and send custom events. The default is for custom events to be `DISABLED`. Valid values are `DISABLED` and `ENABLED`.

func (AppMonitorCustomEventsOutput) ToAppMonitorCustomEventsOutput 

func (o AppMonitorCustomEventsOutput) ToAppMonitorCustomEventsOutput() AppMonitorCustomEventsOutput

func (AppMonitorCustomEventsOutput) ToAppMonitorCustomEventsOutputWithContext 

func (o AppMonitorCustomEventsOutput) ToAppMonitorCustomEventsOutputWithContext(ctx context.Context) AppMonitorCustomEventsOutput

func (AppMonitorCustomEventsOutput) ToAppMonitorCustomEventsPtrOutput 

func (o AppMonitorCustomEventsOutput) ToAppMonitorCustomEventsPtrOutput() AppMonitorCustomEventsPtrOutput

func (AppMonitorCustomEventsOutput) ToAppMonitorCustomEventsPtrOutputWithContext 

func (o AppMonitorCustomEventsOutput) ToAppMonitorCustomEventsPtrOutputWithContext(ctx context.Context) AppMonitorCustomEventsPtrOutput

type AppMonitorCustomEventsPtrInput 

type AppMonitorCustomEventsPtrInput interface {
	pulumi.Input

	ToAppMonitorCustomEventsPtrOutput() AppMonitorCustomEventsPtrOutput
	ToAppMonitorCustomEventsPtrOutputWithContext(context.Context) AppMonitorCustomEventsPtrOutput
}

AppMonitorCustomEventsPtrInput is an input type that accepts AppMonitorCustomEventsArgs, AppMonitorCustomEventsPtr and AppMonitorCustomEventsPtrOutput values. You can construct a concrete instance of `AppMonitorCustomEventsPtrInput` via: 

        AppMonitorCustomEventsArgs{...}

or:

        nil

func AppMonitorCustomEventsPtr 

func AppMonitorCustomEventsPtr(v *AppMonitorCustomEventsArgs) AppMonitorCustomEventsPtrInput

type AppMonitorCustomEventsPtrOutput 

type AppMonitorCustomEventsPtrOutput struct{ *pulumi.OutputState }

func (AppMonitorCustomEventsPtrOutput) Elem 

func (o AppMonitorCustomEventsPtrOutput) Elem() AppMonitorCustomEventsOutput

func (AppMonitorCustomEventsPtrOutput) ElementType 

func (AppMonitorCustomEventsPtrOutput) ElementType() reflect.Type

func (AppMonitorCustomEventsPtrOutput) Status 

func (o AppMonitorCustomEventsPtrOutput) Status() pulumi.StringPtrOutput

Specifies whether this app monitor allows the web client to define and send custom events. The default is for custom events to be `DISABLED`. Valid values are `DISABLED` and `ENABLED`.

func (AppMonitorCustomEventsPtrOutput) ToAppMonitorCustomEventsPtrOutput 

func (o AppMonitorCustomEventsPtrOutput) ToAppMonitorCustomEventsPtrOutput() AppMonitorCustomEventsPtrOutput

func (AppMonitorCustomEventsPtrOutput) ToAppMonitorCustomEventsPtrOutputWithContext 

func (o AppMonitorCustomEventsPtrOutput) ToAppMonitorCustomEventsPtrOutputWithContext(ctx context.Context) AppMonitorCustomEventsPtrOutput

type AppMonitorInput 

type AppMonitorInput interface {
	pulumi.Input

	ToAppMonitorOutput() AppMonitorOutput
	ToAppMonitorOutputWithContext(ctx context.Context) AppMonitorOutput
}

type AppMonitorMap 

type AppMonitorMap map[string]AppMonitorInput

func (AppMonitorMap) ElementType 

func (AppMonitorMap) ElementType() reflect.Type

func (AppMonitorMap) ToAppMonitorMapOutput 

func (i AppMonitorMap) ToAppMonitorMapOutput() AppMonitorMapOutput

func (AppMonitorMap) ToAppMonitorMapOutputWithContext 

func (i AppMonitorMap) ToAppMonitorMapOutputWithContext(ctx context.Context) AppMonitorMapOutput

type AppMonitorMapInput 

type AppMonitorMapInput interface {
	pulumi.Input

	ToAppMonitorMapOutput() AppMonitorMapOutput
	ToAppMonitorMapOutputWithContext(context.Context) AppMonitorMapOutput
}

AppMonitorMapInput is an input type that accepts AppMonitorMap and AppMonitorMapOutput values. You can construct a concrete instance of `AppMonitorMapInput` via: 

AppMonitorMap{ "key": AppMonitorArgs{...} }

type AppMonitorMapOutput 

type AppMonitorMapOutput struct{ *pulumi.OutputState }

func (AppMonitorMapOutput) ElementType 

func (AppMonitorMapOutput) ElementType() reflect.Type

func (AppMonitorMapOutput) MapIndex 

func (o AppMonitorMapOutput) MapIndex(k pulumi.StringInput) AppMonitorOutput

func (AppMonitorMapOutput) ToAppMonitorMapOutput 

func (o AppMonitorMapOutput) ToAppMonitorMapOutput() AppMonitorMapOutput

func (AppMonitorMapOutput) ToAppMonitorMapOutputWithContext 

func (o AppMonitorMapOutput) ToAppMonitorMapOutputWithContext(ctx context.Context) AppMonitorMapOutput

type AppMonitorOutput 

type AppMonitorOutput struct{ *pulumi.OutputState }

func (AppMonitorOutput) AppMonitorConfiguration 

func (o AppMonitorOutput) AppMonitorConfiguration() AppMonitorAppMonitorConfigurationOutput

configuration data for the app monitor. See appMonitorConfiguration below.

func (AppMonitorOutput) AppMonitorId 

func (o AppMonitorOutput) AppMonitorId() pulumi.StringOutput

The unique ID of the app monitor. Useful for JS templates.

func (AppMonitorOutput) Arn 

func (o AppMonitorOutput) Arn() pulumi.StringOutput

The Amazon Resource Name (ARN) specifying the app monitor.

func (AppMonitorOutput) CustomEvents 

func (o AppMonitorOutput) CustomEvents() AppMonitorCustomEventsOutput

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.

func (AppMonitorOutput) CwLogEnabled 

func (o AppMonitorOutput) CwLogEnabled() pulumi.BoolPtrOutput

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`.

func (AppMonitorOutput) CwLogGroup 

func (o AppMonitorOutput) CwLogGroup() pulumi.StringOutput

The name of the log group where the copies are stored.

func (AppMonitorOutput) Domain 

func (o AppMonitorOutput) Domain() pulumi.StringOutput

The top-level internet domain name for which your application has administrative authority.

func (AppMonitorOutput) ElementType 

func (AppMonitorOutput) ElementType() reflect.Type

func (AppMonitorOutput) Name 

func (o AppMonitorOutput) Name() pulumi.StringOutput

The name of the log stream.

func (AppMonitorOutput) Tags 

func (o AppMonitorOutput) Tags() pulumi.StringMapOutput

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.

func (AppMonitorOutput) TagsAll deprecated 

func (o AppMonitorOutput) TagsAll() pulumi.StringMapOutput

A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

Deprecated: Please use `tags` instead.

func (AppMonitorOutput) ToAppMonitorOutput 

func (o AppMonitorOutput) ToAppMonitorOutput() AppMonitorOutput

func (AppMonitorOutput) ToAppMonitorOutputWithContext 

func (o AppMonitorOutput) ToAppMonitorOutputWithContext(ctx context.Context) AppMonitorOutput

type AppMonitorState 

type AppMonitorState struct {
	// configuration data for the app monitor. See appMonitorConfiguration below.
	AppMonitorConfiguration AppMonitorAppMonitorConfigurationPtrInput
	// The unique ID of the app monitor. Useful for JS templates.
	AppMonitorId pulumi.StringPtrInput
	// The Amazon Resource Name (ARN) specifying the app monitor.
	Arn pulumi.StringPtrInput
	// 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 AppMonitorCustomEventsPtrInput
	// 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.BoolPtrInput
	// The name of the log group where the copies are stored.
	CwLogGroup pulumi.StringPtrInput
	// The top-level internet domain name for which your application has administrative authority.
	Domain pulumi.StringPtrInput
	// The name of the log stream.
	Name pulumi.StringPtrInput
	// 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.StringMapInput
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	//
	// Deprecated: Please use `tags` instead.
	TagsAll pulumi.StringMapInput
}

func (AppMonitorState) ElementType 

func (AppMonitorState) ElementType() reflect.Type

type MetricsDestination 

type MetricsDestination struct {
	pulumi.CustomResourceState

	// The name of the CloudWatch RUM app monitor that will send the metrics.
	AppMonitorName pulumi.StringOutput `pulumi:"appMonitorName"`
	// Defines the destination to send the metrics to. Valid values are `CloudWatch` and `Evidently`. If you specify `Evidently`, you must also specify the ARN of the CloudWatchEvidently experiment that is to be the destination and an IAM role that has permission to write to the experiment.
	Destination pulumi.StringOutput `pulumi:"destination"`
	// Use this parameter only if Destination is Evidently. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics.
	DestinationArn pulumi.StringPtrOutput `pulumi:"destinationArn"`
	// This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.
	IamRoleArn pulumi.StringPtrOutput `pulumi:"iamRoleArn"`
}

Provides a CloudWatch RUM Metrics Destination resource.

## Example Usage

<!--Start PulumiCodeChooser --> ```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rum"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rum.NewMetricsDestination(ctx, "example", &rum.MetricsDestinationArgs{
			AppMonitorName: pulumi.Any(exampleAwsRumAppMonitor.Name),
			Destination:    pulumi.String("CloudWatch"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` <!--End PulumiCodeChooser -->

## Import

Using `pulumi import`, import Cloudwatch RUM Metrics Destination using the `id`. For example:

```sh $ pulumi import aws:rum/metricsDestination:MetricsDestination example example ```

func GetMetricsDestination 

func GetMetricsDestination(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *MetricsDestinationState, opts ...pulumi.ResourceOption) (*MetricsDestination, error)

GetMetricsDestination gets an existing MetricsDestination resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewMetricsDestination 

func NewMetricsDestination(ctx *pulumi.Context,
	name string, args *MetricsDestinationArgs, opts ...pulumi.ResourceOption) (*MetricsDestination, error)

NewMetricsDestination registers a new resource with the given unique name, arguments, and options.

func (*MetricsDestination) ElementType 

func (*MetricsDestination) ElementType() reflect.Type

func (*MetricsDestination) ToMetricsDestinationOutput 

func (i *MetricsDestination) ToMetricsDestinationOutput() MetricsDestinationOutput

func (*MetricsDestination) ToMetricsDestinationOutputWithContext 

func (i *MetricsDestination) ToMetricsDestinationOutputWithContext(ctx context.Context) MetricsDestinationOutput

type MetricsDestinationArgs 

type MetricsDestinationArgs struct {
	// The name of the CloudWatch RUM app monitor that will send the metrics.
	AppMonitorName pulumi.StringInput
	// Defines the destination to send the metrics to. Valid values are `CloudWatch` and `Evidently`. If you specify `Evidently`, you must also specify the ARN of the CloudWatchEvidently experiment that is to be the destination and an IAM role that has permission to write to the experiment.
	Destination pulumi.StringInput
	// Use this parameter only if Destination is Evidently. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics.
	DestinationArn pulumi.StringPtrInput
	// This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.
	IamRoleArn pulumi.StringPtrInput
}

The set of arguments for constructing a MetricsDestination resource.

func (MetricsDestinationArgs) ElementType 

func (MetricsDestinationArgs) ElementType() reflect.Type

type MetricsDestinationArray 

type MetricsDestinationArray []MetricsDestinationInput

func (MetricsDestinationArray) ElementType 

func (MetricsDestinationArray) ElementType() reflect.Type

func (MetricsDestinationArray) ToMetricsDestinationArrayOutput 

func (i MetricsDestinationArray) ToMetricsDestinationArrayOutput() MetricsDestinationArrayOutput

func (MetricsDestinationArray) ToMetricsDestinationArrayOutputWithContext 

func (i MetricsDestinationArray) ToMetricsDestinationArrayOutputWithContext(ctx context.Context) MetricsDestinationArrayOutput

type MetricsDestinationArrayInput 

type MetricsDestinationArrayInput interface {
	pulumi.Input

	ToMetricsDestinationArrayOutput() MetricsDestinationArrayOutput
	ToMetricsDestinationArrayOutputWithContext(context.Context) MetricsDestinationArrayOutput
}

MetricsDestinationArrayInput is an input type that accepts MetricsDestinationArray and MetricsDestinationArrayOutput values. You can construct a concrete instance of `MetricsDestinationArrayInput` via: 

MetricsDestinationArray{ MetricsDestinationArgs{...} }

type MetricsDestinationArrayOutput 

type MetricsDestinationArrayOutput struct{ *pulumi.OutputState }

func (MetricsDestinationArrayOutput) ElementType 

func (MetricsDestinationArrayOutput) ElementType() reflect.Type

func (MetricsDestinationArrayOutput) Index 

func (o MetricsDestinationArrayOutput) Index(i pulumi.IntInput) MetricsDestinationOutput

func (MetricsDestinationArrayOutput) ToMetricsDestinationArrayOutput 

func (o MetricsDestinationArrayOutput) ToMetricsDestinationArrayOutput() MetricsDestinationArrayOutput

func (MetricsDestinationArrayOutput) ToMetricsDestinationArrayOutputWithContext 

func (o MetricsDestinationArrayOutput) ToMetricsDestinationArrayOutputWithContext(ctx context.Context) MetricsDestinationArrayOutput

type MetricsDestinationInput 

type MetricsDestinationInput interface {
	pulumi.Input

	ToMetricsDestinationOutput() MetricsDestinationOutput
	ToMetricsDestinationOutputWithContext(ctx context.Context) MetricsDestinationOutput
}

type MetricsDestinationMap 

type MetricsDestinationMap map[string]MetricsDestinationInput

func (MetricsDestinationMap) ElementType 

func (MetricsDestinationMap) ElementType() reflect.Type

func (MetricsDestinationMap) ToMetricsDestinationMapOutput 

func (i MetricsDestinationMap) ToMetricsDestinationMapOutput() MetricsDestinationMapOutput

func (MetricsDestinationMap) ToMetricsDestinationMapOutputWithContext 

func (i MetricsDestinationMap) ToMetricsDestinationMapOutputWithContext(ctx context.Context) MetricsDestinationMapOutput

type MetricsDestinationMapInput 

type MetricsDestinationMapInput interface {
	pulumi.Input

	ToMetricsDestinationMapOutput() MetricsDestinationMapOutput
	ToMetricsDestinationMapOutputWithContext(context.Context) MetricsDestinationMapOutput
}

MetricsDestinationMapInput is an input type that accepts MetricsDestinationMap and MetricsDestinationMapOutput values. You can construct a concrete instance of `MetricsDestinationMapInput` via: 

MetricsDestinationMap{ "key": MetricsDestinationArgs{...} }

type MetricsDestinationMapOutput 

type MetricsDestinationMapOutput struct{ *pulumi.OutputState }

func (MetricsDestinationMapOutput) ElementType 

func (MetricsDestinationMapOutput) ElementType() reflect.Type

func (MetricsDestinationMapOutput) MapIndex 

func (o MetricsDestinationMapOutput) MapIndex(k pulumi.StringInput) MetricsDestinationOutput

func (MetricsDestinationMapOutput) ToMetricsDestinationMapOutput 

func (o MetricsDestinationMapOutput) ToMetricsDestinationMapOutput() MetricsDestinationMapOutput

func (MetricsDestinationMapOutput) ToMetricsDestinationMapOutputWithContext 

func (o MetricsDestinationMapOutput) ToMetricsDestinationMapOutputWithContext(ctx context.Context) MetricsDestinationMapOutput

type MetricsDestinationOutput 

type MetricsDestinationOutput struct{ *pulumi.OutputState }

func (MetricsDestinationOutput) AppMonitorName 

func (o MetricsDestinationOutput) AppMonitorName() pulumi.StringOutput

The name of the CloudWatch RUM app monitor that will send the metrics.

func (MetricsDestinationOutput) Destination 

func (o MetricsDestinationOutput) Destination() pulumi.StringOutput

Defines the destination to send the metrics to. Valid values are `CloudWatch` and `Evidently`. If you specify `Evidently`, you must also specify the ARN of the CloudWatchEvidently experiment that is to be the destination and an IAM role that has permission to write to the experiment.

func (MetricsDestinationOutput) DestinationArn 

func (o MetricsDestinationOutput) DestinationArn() pulumi.StringPtrOutput

Use this parameter only if Destination is Evidently. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics.

func (MetricsDestinationOutput) ElementType 

func (MetricsDestinationOutput) ElementType() reflect.Type

func (MetricsDestinationOutput) IamRoleArn 

func (o MetricsDestinationOutput) IamRoleArn() pulumi.StringPtrOutput

This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.

func (MetricsDestinationOutput) ToMetricsDestinationOutput 

func (o MetricsDestinationOutput) ToMetricsDestinationOutput() MetricsDestinationOutput

func (MetricsDestinationOutput) ToMetricsDestinationOutputWithContext 

func (o MetricsDestinationOutput) ToMetricsDestinationOutputWithContext(ctx context.Context) MetricsDestinationOutput

type MetricsDestinationState 

type MetricsDestinationState struct {
	// The name of the CloudWatch RUM app monitor that will send the metrics.
	AppMonitorName pulumi.StringPtrInput
	// Defines the destination to send the metrics to. Valid values are `CloudWatch` and `Evidently`. If you specify `Evidently`, you must also specify the ARN of the CloudWatchEvidently experiment that is to be the destination and an IAM role that has permission to write to the experiment.
	Destination pulumi.StringPtrInput
	// Use this parameter only if Destination is Evidently. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics.
	DestinationArn pulumi.StringPtrInput
	// This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.
	IamRoleArn pulumi.StringPtrInput
}

func (MetricsDestinationState) ElementType 

func (MetricsDestinationState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.