rum

package
v5.15.0 Latest Latest
Warning

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

Go to latest
Published: Sep 22, 2022 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

	AppMonitorConfiguration AppMonitorAppMonitorConfigurationOutput `pulumi:"appMonitorConfiguration"`
	// The Amazon Resource Name (ARN) specifying the app monitor.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// 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"`
	// configuration data for the app monitor. See appMonitorConfiguration below.
	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.
	TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
}

Provides a CloudWatch RUM App Monitor resource.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-aws/sdk/v5/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{
			Domain: pulumi.String("localhost"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Cloudwatch RUM App Monitor can be imported using the `name`, e.g.,

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

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) EnableXray

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

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

func (AppMonitorAppMonitorConfigurationOutput) FavoritePages

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

func (AppMonitorAppMonitorConfigurationOutput) GuestRoleArn

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

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

func (AppMonitorAppMonitorConfigurationOutput) IncludedPages

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

func (AppMonitorAppMonitorConfigurationOutput) SessionSampleRate

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

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

type AppMonitorAppMonitorConfigurationPtrOutput

type AppMonitorAppMonitorConfigurationPtrOutput struct{ *pulumi.OutputState }

func (AppMonitorAppMonitorConfigurationPtrOutput) AllowCookies

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 (AppMonitorAppMonitorConfigurationPtrOutput) ElementType

func (AppMonitorAppMonitorConfigurationPtrOutput) EnableXray

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

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

func (AppMonitorAppMonitorConfigurationPtrOutput) FavoritePages

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

func (AppMonitorAppMonitorConfigurationPtrOutput) GuestRoleArn

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

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

func (AppMonitorAppMonitorConfigurationPtrOutput) IncludedPages

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

func (AppMonitorAppMonitorConfigurationPtrOutput) SessionSampleRate

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

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 {
	AppMonitorConfiguration AppMonitorAppMonitorConfigurationPtrInput
	// 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
	// configuration data for the app monitor. See appMonitorConfiguration below.
	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 (AppMonitorArrayOutput) ToAppMonitorArrayOutput

func (o AppMonitorArrayOutput) ToAppMonitorArrayOutput() AppMonitorArrayOutput

func (AppMonitorArrayOutput) ToAppMonitorArrayOutputWithContext

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

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 (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

func (AppMonitorOutput) Arn

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

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

configuration data for the app monitor. See appMonitorConfiguration below.

func (AppMonitorOutput) ElementType

func (AppMonitorOutput) ElementType() reflect.Type

func (AppMonitorOutput) Name

The name of the log stream.

func (AppMonitorOutput) Tags

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

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

func (AppMonitorOutput) ToAppMonitorOutput

func (o AppMonitorOutput) ToAppMonitorOutput() AppMonitorOutput

func (AppMonitorOutput) ToAppMonitorOutputWithContext

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

type AppMonitorState

type AppMonitorState struct {
	AppMonitorConfiguration AppMonitorAppMonitorConfigurationPtrInput
	// The Amazon Resource Name (ARN) specifying the app monitor.
	Arn pulumi.StringPtrInput
	// 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
	// configuration data for the app monitor. See appMonitorConfiguration below.
	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.
	TagsAll pulumi.StringMapInput
}

func (AppMonitorState) ElementType

func (AppMonitorState) ElementType() reflect.Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL