Package software.amazon.awscdk.cfnpropertymixins.services.rum

Class CfnAppMonitorPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.rum.CfnAppMonitorPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAppMonitorPropsMixin>

Enclosing class:

CfnAppMonitorPropsMixin

@Stability(Stable)
public static final class CfnAppMonitorPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAppMonitorPropsMixin>

A fluent builder for CfnAppMonitorPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnAppMonitorPropsMixin.Builder	appMonitorConfiguration(CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty appMonitorConfiguration)	A structure that contains much of the configuration data for the app monitor.
CfnAppMonitorPropsMixin.Builder	appMonitorConfiguration(IResolvable appMonitorConfiguration)	A structure that contains much of the configuration data for the app monitor.
CfnAppMonitorPropsMixin	build()
static CfnAppMonitorPropsMixin.Builder	create()
static CfnAppMonitorPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnAppMonitorPropsMixin.Builder	customEvents(CfnAppMonitorPropsMixin.CustomEventsProperty customEvents)	Specifies whether this app monitor allows the web client to define and send custom events.
CfnAppMonitorPropsMixin.Builder	customEvents(IResolvable customEvents)	Specifies whether this app monitor allows the web client to define and send custom events.
CfnAppMonitorPropsMixin.Builder	cwLogEnabled(Boolean cwLogEnabled)	Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted.
CfnAppMonitorPropsMixin.Builder	cwLogEnabled(IResolvable cwLogEnabled)	Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted.
CfnAppMonitorPropsMixin.Builder	deobfuscationConfiguration(CfnAppMonitorPropsMixin.DeobfuscationConfigurationProperty deobfuscationConfiguration)	A structure that contains the configuration for how an app monitor can deobfuscate stack traces.
CfnAppMonitorPropsMixin.Builder	deobfuscationConfiguration(IResolvable deobfuscationConfiguration)	A structure that contains the configuration for how an app monitor can deobfuscate stack traces.
CfnAppMonitorPropsMixin.Builder	domain(String domain)	The top-level internet domain name for which your application has administrative authority.
CfnAppMonitorPropsMixin.Builder	domainList(List<String> domainList)	List the domain names for which your application has administrative authority.
CfnAppMonitorPropsMixin.Builder	name(String name)	A name for the app monitor.
CfnAppMonitorPropsMixin.Builder	platform(String platform)
CfnAppMonitorPropsMixin.Builder	resourcePolicy(CfnAppMonitorPropsMixin.ResourcePolicyProperty resourcePolicy)	Use this structure to assign a resource-based policy to a CloudWatch RUM app monitor to control access to it.
CfnAppMonitorPropsMixin.Builder	resourcePolicy(IResolvable resourcePolicy)	Use this structure to assign a resource-based policy to a CloudWatch RUM app monitor to control access to it.
CfnAppMonitorPropsMixin.Builder	tags(List<? extends CfnTag> tags)	Assigns one or more tags (key-value pairs) to the app monitor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnAppMonitorPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnAppMonitorPropsMixin.Builder.

create

@Stability(Stable)
public static CfnAppMonitorPropsMixin.Builder create()

Returns:

a new instance of CfnAppMonitorPropsMixin.Builder.

appMonitorConfiguration

@Stability(Stable)
public CfnAppMonitorPropsMixin.Builder appMonitorConfiguration(IResolvable appMonitorConfiguration)

A structure that contains much of the configuration data for the app monitor.

If you are using Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the Amazon Cognito identity pool to use for authorization. If you don't include AppMonitorConfiguration , you must set up your own authorization method. For more information, see Authorize your application to send data to AWS .

If you omit this argument, the sample rate used for CloudWatch RUM is set to 10% of the user sessions.

Parameters:

appMonitorConfiguration - A structure that contains much of the configuration data for the app monitor. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-appmonitorconfiguration

appMonitorConfiguration

@Stability(Stable)
public CfnAppMonitorPropsMixin.Builder appMonitorConfiguration(CfnAppMonitorPropsMixin.AppMonitorConfigurationProperty appMonitorConfiguration)

A structure that contains much of the configuration data for the app monitor.

If you are using Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the Amazon Cognito identity pool to use for authorization. If you don't include AppMonitorConfiguration , you must set up your own authorization method. For more information, see Authorize your application to send data to AWS .

If you omit this argument, the sample rate used for CloudWatch RUM is set to 10% of the user sessions.

Parameters:

appMonitorConfiguration - A structure that contains much of the configuration data for the app monitor. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-appmonitorconfiguration

customEvents

@Stability(Stable)
public CfnAppMonitorPropsMixin.Builder customEvents(IResolvable customEvents)

Specifies whether this app monitor allows the web client to define and send custom events.

If you omit this parameter, custom events are DISABLED .

Parameters:

customEvents - Specifies whether this app monitor allows the web client to define and send custom events. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-customevents

customEvents

@Stability(Stable)
public CfnAppMonitorPropsMixin.Builder customEvents(CfnAppMonitorPropsMixin.CustomEventsProperty customEvents)

Specifies whether this app monitor allows the web client to define and send custom events.

If you omit this parameter, custom events are DISABLED .

Parameters:

customEvents - Specifies whether this app monitor allows the web client to define and send custom events. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-customevents

cwLogEnabled

@Stability(Stable)
public CfnAppMonitorPropsMixin.Builder cwLogEnabled(Boolean cwLogEnabled)

Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted.

This parameter specifies whether CloudWatch 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.

If you omit this parameter, the default is false .

Parameters:

cwLogEnabled - Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-cwlogenabled

cwLogEnabled

@Stability(Stable)
public CfnAppMonitorPropsMixin.Builder cwLogEnabled(IResolvable cwLogEnabled)

Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted.

This parameter specifies whether CloudWatch 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.

If you omit this parameter, the default is false .

Parameters:

cwLogEnabled - Data collected by CloudWatch RUM is kept by RUM for 30 days and then deleted. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-cwlogenabled

deobfuscationConfiguration

@Stability(Stable)
public CfnAppMonitorPropsMixin.Builder deobfuscationConfiguration(IResolvable deobfuscationConfiguration)

A structure that contains the configuration for how an app monitor can deobfuscate stack traces.

Parameters:

deobfuscationConfiguration - A structure that contains the configuration for how an app monitor can deobfuscate stack traces. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-deobfuscationconfiguration

deobfuscationConfiguration

@Stability(Stable)
public CfnAppMonitorPropsMixin.Builder deobfuscationConfiguration(CfnAppMonitorPropsMixin.DeobfuscationConfigurationProperty deobfuscationConfiguration)

A structure that contains the configuration for how an app monitor can deobfuscate stack traces.

Parameters:

deobfuscationConfiguration - A structure that contains the configuration for how an app monitor can deobfuscate stack traces. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-deobfuscationconfiguration

domain

@Stability(Stable)
public CfnAppMonitorPropsMixin.Builder domain(String domain)

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

This parameter or the DomainList parameter is required.

Parameters:

domain - The top-level internet domain name for which your application has administrative authority. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-domain

domainList

@Stability(Stable)
public CfnAppMonitorPropsMixin.Builder domainList(List<String> domainList)

List the domain names for which your application has administrative authority. This parameter or the Domain parameter is required.

You can have a minimum of 1 and a maximum of 5 Domain under DomainList . Each Domain must be a minimum length of 1 and a maximum of 253 characters.

Parameters:

domainList - List the domain names for which your application has administrative authority. This parameter or the Domain parameter is required. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-domainlist

name

@Stability(Stable)
public CfnAppMonitorPropsMixin.Builder name(String name)

A name for the app monitor.

This parameter is required.

Parameters:

name - A name for the app monitor. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-name

platform

@Stability(Stable)
public CfnAppMonitorPropsMixin.Builder platform(String platform)

Parameters:

platform - This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-platform

resourcePolicy

@Stability(Stable)
public CfnAppMonitorPropsMixin.Builder resourcePolicy(IResolvable resourcePolicy)

Use this structure to assign a resource-based policy to a CloudWatch RUM app monitor to control access to it.

Each app monitor can have one resource-based policy. The maximum size of the policy is 4 KB. To learn more about using resource policies with RUM, see Using resource-based policies with CloudWatch RUM .

Parameters:

resourcePolicy - Use this structure to assign a resource-based policy to a CloudWatch RUM app monitor to control access to it. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-resourcepolicy

resourcePolicy

@Stability(Stable)
public CfnAppMonitorPropsMixin.Builder resourcePolicy(CfnAppMonitorPropsMixin.ResourcePolicyProperty resourcePolicy)

Use this structure to assign a resource-based policy to a CloudWatch RUM app monitor to control access to it.

Each app monitor can have one resource-based policy. The maximum size of the policy is 4 KB. To learn more about using resource policies with RUM, see Using resource-based policies with CloudWatch RUM .

Parameters:

resourcePolicy - Use this structure to assign a resource-based policy to a CloudWatch RUM app monitor to control access to it. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-resourcepolicy

tags

@Stability(Stable)
public CfnAppMonitorPropsMixin.Builder tags(List<? extends CfnTag> tags)

Assigns one or more tags (key-value pairs) to the app monitor.

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 don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.

You can associate as many as 50 tags with an app monitor.

For more information, see Tagging AWS resources .

Parameters:

tags - Assigns one or more tags (key-value pairs) to the app monitor. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rum-appmonitor.html#cfn-rum-appmonitor-tags

build

@Stability(Stable)
public CfnAppMonitorPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnAppMonitorPropsMixin>

Returns:

a newly built instance of CfnAppMonitorPropsMixin.