@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AppMonitorConfiguration extends Object implements Serializable, Cloneable, StructuredPojo
This structure contains much of the configuration data for the app monitor.
Constructor and Description |
---|
AppMonitorConfiguration() |
Modifier and Type | Method and Description |
---|---|
AppMonitorConfiguration |
clone() |
boolean |
equals(Object obj) |
Boolean |
getAllowCookies()
If you set this to
true , the RUM web client sets two cookies, a session cookie and a user cookie. |
Boolean |
getEnableXRay()
If you set this to
true , RUM enables X-Ray tracing for the user sessions that RUM samples. |
List<String> |
getExcludedPages()
A list of URLs in your website or application to exclude from RUM data collection.
|
List<String> |
getFavoritePages()
A list of pages in the CloudWatch RUM console that are to be displayed with a "favorite" icon.
|
String |
getGuestRoleArn()
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.
|
String |
getIdentityPoolId()
The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.
|
List<String> |
getIncludedPages()
If this app monitor is to collect data from only certain pages in your application, this structure lists those
pages.
|
Double |
getSessionSampleRate()
Specifies the percentage of user sessions to use for RUM data collection.
|
List<String> |
getTelemetries()
An array that lists the types of telemetry data that this app monitor is to collect.
|
int |
hashCode() |
Boolean |
isAllowCookies()
If you set this to
true , the RUM web client sets two cookies, a session cookie and a user cookie. |
Boolean |
isEnableXRay()
If you set this to
true , RUM enables X-Ray tracing for the user sessions that RUM samples. |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAllowCookies(Boolean allowCookies)
If you set this to
true , the RUM web client sets two cookies, a session cookie and a user cookie. |
void |
setEnableXRay(Boolean enableXRay)
If you set this to
true , RUM enables X-Ray tracing for the user sessions that RUM samples. |
void |
setExcludedPages(Collection<String> excludedPages)
A list of URLs in your website or application to exclude from RUM data collection.
|
void |
setFavoritePages(Collection<String> favoritePages)
A list of pages in the CloudWatch RUM console that are to be displayed with a "favorite" icon.
|
void |
setGuestRoleArn(String 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.
|
void |
setIdentityPoolId(String identityPoolId)
The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.
|
void |
setIncludedPages(Collection<String> includedPages)
If this app monitor is to collect data from only certain pages in your application, this structure lists those
pages.
|
void |
setSessionSampleRate(Double sessionSampleRate)
Specifies the percentage of user sessions to use for RUM data collection.
|
void |
setTelemetries(Collection<String> telemetries)
An array that lists the types of telemetry data that this app monitor is to collect.
|
String |
toString()
Returns a string representation of this object.
|
AppMonitorConfiguration |
withAllowCookies(Boolean allowCookies)
If you set this to
true , the RUM web client sets two cookies, a session cookie and a user cookie. |
AppMonitorConfiguration |
withEnableXRay(Boolean enableXRay)
If you set this to
true , RUM enables X-Ray tracing for the user sessions that RUM samples. |
AppMonitorConfiguration |
withExcludedPages(Collection<String> excludedPages)
A list of URLs in your website or application to exclude from RUM data collection.
|
AppMonitorConfiguration |
withExcludedPages(String... excludedPages)
A list of URLs in your website or application to exclude from RUM data collection.
|
AppMonitorConfiguration |
withFavoritePages(Collection<String> favoritePages)
A list of pages in the CloudWatch RUM console that are to be displayed with a "favorite" icon.
|
AppMonitorConfiguration |
withFavoritePages(String... favoritePages)
A list of pages in the CloudWatch RUM console that are to be displayed with a "favorite" icon.
|
AppMonitorConfiguration |
withGuestRoleArn(String 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.
|
AppMonitorConfiguration |
withIdentityPoolId(String identityPoolId)
The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.
|
AppMonitorConfiguration |
withIncludedPages(Collection<String> includedPages)
If this app monitor is to collect data from only certain pages in your application, this structure lists those
pages.
|
AppMonitorConfiguration |
withIncludedPages(String... includedPages)
If this app monitor is to collect data from only certain pages in your application, this structure lists those
pages.
|
AppMonitorConfiguration |
withSessionSampleRate(Double sessionSampleRate)
Specifies the percentage of user sessions to use for RUM data collection.
|
AppMonitorConfiguration |
withTelemetries(Collection<String> telemetries)
An array that lists the types of telemetry data that this app monitor is to collect.
|
AppMonitorConfiguration |
withTelemetries(String... telemetries)
An array that lists the types of telemetry data that this app monitor is to collect.
|
AppMonitorConfiguration |
withTelemetries(Telemetry... telemetries)
An array that lists the types of telemetry data that this app monitor is to collect.
|
public void setAllowCookies(Boolean allowCookies)
If you set this to true
, the 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
- If you set this to true
, the 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.public Boolean getAllowCookies()
If you set this to true
, the 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.
true
, the 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.public AppMonitorConfiguration withAllowCookies(Boolean allowCookies)
If you set this to true
, the 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
- If you set this to true
, the 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.public Boolean isAllowCookies()
If you set this to true
, the 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.
true
, the 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.public void setEnableXRay(Boolean 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. You
can see traces and segments from these user sessions in the X-Ray console and the CloudWatch ServiceLens console.
For more information, see What is
X-Ray?
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. You can see traces and segments from these user sessions in the X-Ray console and the CloudWatch
ServiceLens console. For more information, see What is X-Ray?public Boolean getEnableXRay()
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. You
can see traces and segments from these user sessions in the X-Ray console and the CloudWatch ServiceLens console.
For more information, see What is
X-Ray?
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. You can see traces and segments from these user sessions in the X-Ray console and the
CloudWatch ServiceLens console. For more information, see What is X-Ray?public AppMonitorConfiguration withEnableXRay(Boolean 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. You
can see traces and segments from these user sessions in the X-Ray console and the CloudWatch ServiceLens console.
For more information, see What is
X-Ray?
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. You can see traces and segments from these user sessions in the X-Ray console and the CloudWatch
ServiceLens console. For more information, see What is X-Ray?public Boolean isEnableXRay()
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. You
can see traces and segments from these user sessions in the X-Ray console and the CloudWatch ServiceLens console.
For more information, see What is
X-Ray?
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. You can see traces and segments from these user sessions in the X-Ray console and the
CloudWatch ServiceLens console. For more information, see What is X-Ray?public List<String> getExcludedPages()
A list of URLs in your website or application to exclude from RUM data collection.
You can't include both ExcludedPages
and IncludedPages
in the same operation.
You can't include both ExcludedPages
and IncludedPages
in the same operation.
public void setExcludedPages(Collection<String> excludedPages)
A list of URLs in your website or application to exclude from RUM data collection.
You can't include both ExcludedPages
and IncludedPages
in the same operation.
excludedPages
- A list of URLs in your website or application to exclude from RUM data collection.
You can't include both ExcludedPages
and IncludedPages
in the same operation.
public AppMonitorConfiguration withExcludedPages(String... excludedPages)
A list of URLs in your website or application to exclude from RUM data collection.
You can't include both ExcludedPages
and IncludedPages
in the same operation.
NOTE: This method appends the values to the existing list (if any). Use
setExcludedPages(java.util.Collection)
or withExcludedPages(java.util.Collection)
if you want
to override the existing values.
excludedPages
- A list of URLs in your website or application to exclude from RUM data collection.
You can't include both ExcludedPages
and IncludedPages
in the same operation.
public AppMonitorConfiguration withExcludedPages(Collection<String> excludedPages)
A list of URLs in your website or application to exclude from RUM data collection.
You can't include both ExcludedPages
and IncludedPages
in the same operation.
excludedPages
- A list of URLs in your website or application to exclude from RUM data collection.
You can't include both ExcludedPages
and IncludedPages
in the same operation.
public List<String> getFavoritePages()
A list of pages in the CloudWatch RUM console that are to be displayed with a "favorite" icon.
public void setFavoritePages(Collection<String> favoritePages)
A list of pages in the CloudWatch RUM console that are to be displayed with a "favorite" icon.
favoritePages
- A list of pages in the CloudWatch RUM console that are to be displayed with a "favorite" icon.public AppMonitorConfiguration withFavoritePages(String... favoritePages)
A list of pages in the CloudWatch RUM console that are to be displayed with a "favorite" icon.
NOTE: This method appends the values to the existing list (if any). Use
setFavoritePages(java.util.Collection)
or withFavoritePages(java.util.Collection)
if you want
to override the existing values.
favoritePages
- A list of pages in the CloudWatch RUM console that are to be displayed with a "favorite" icon.public AppMonitorConfiguration withFavoritePages(Collection<String> favoritePages)
A list of pages in the CloudWatch RUM console that are to be displayed with a "favorite" icon.
favoritePages
- A list of pages in the CloudWatch RUM console that are to be displayed with a "favorite" icon.public void setGuestRoleArn(String 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.
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.public String getGuestRoleArn()
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.
public AppMonitorConfiguration withGuestRoleArn(String 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.
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.public void setIdentityPoolId(String identityPoolId)
The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.
identityPoolId
- The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.public String getIdentityPoolId()
The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.
public AppMonitorConfiguration withIdentityPoolId(String identityPoolId)
The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.
identityPoolId
- The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.public List<String> getIncludedPages()
If this app monitor is to collect data from only certain pages in your application, this structure lists those pages.
<p>You can't include both <code>ExcludedPages</code> and <code>IncludedPages</code> in the same operation.</p>
<p>You can't include both <code>ExcludedPages</code> and <code>IncludedPages</code> in the same operation.</p>
public void setIncludedPages(Collection<String> includedPages)
If this app monitor is to collect data from only certain pages in your application, this structure lists those pages.
<p>You can't include both <code>ExcludedPages</code> and <code>IncludedPages</code> in the same operation.</p>
includedPages
- If this app monitor is to collect data from only certain pages in your application, this structure lists
those pages.
<p>You can't include both <code>ExcludedPages</code> and <code>IncludedPages</code> in the same operation.</p>
public AppMonitorConfiguration withIncludedPages(String... includedPages)
If this app monitor is to collect data from only certain pages in your application, this structure lists those pages.
<p>You can't include both <code>ExcludedPages</code> and <code>IncludedPages</code> in the same operation.</p>
NOTE: This method appends the values to the existing list (if any). Use
setIncludedPages(java.util.Collection)
or withIncludedPages(java.util.Collection)
if you want
to override the existing values.
includedPages
- If this app monitor is to collect data from only certain pages in your application, this structure lists
those pages.
<p>You can't include both <code>ExcludedPages</code> and <code>IncludedPages</code> in the same operation.</p>
public AppMonitorConfiguration withIncludedPages(Collection<String> includedPages)
If this app monitor is to collect data from only certain pages in your application, this structure lists those pages.
<p>You can't include both <code>ExcludedPages</code> and <code>IncludedPages</code> in the same operation.</p>
includedPages
- If this app monitor is to collect data from only certain pages in your application, this structure lists
those pages.
<p>You can't include both <code>ExcludedPages</code> and <code>IncludedPages</code> in the same operation.</p>
public void setSessionSampleRate(Double 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.
If you omit this parameter, the default of 10 is used.
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.
If you omit this parameter, the default of 10 is used.
public Double getSessionSampleRate()
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.
If you omit this parameter, the default of 10 is used.
The number you specify is the percentage of user sessions that will be used.
If you omit this parameter, the default of 10 is used.
public AppMonitorConfiguration withSessionSampleRate(Double 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.
If you omit this parameter, the default of 10 is used.
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.
If you omit this parameter, the default of 10 is used.
public List<String> getTelemetries()
An array that lists the types of telemetry data that this app monitor is to collect.
errors
indicates that RUM collects data about unhandled JavaScript errors raised by your
application.
performance
indicates that RUM collects performance data about how your application and its
resources are loaded and rendered. This includes Core Web Vitals.
http
indicates that RUM collects data about HTTP errors thrown by your application.
errors
indicates that RUM collects data about unhandled JavaScript errors raised by your
application.
performance
indicates that RUM collects performance data about how your application and its
resources are loaded and rendered. This includes Core Web Vitals.
http
indicates that RUM collects data about HTTP errors thrown by your application.
Telemetry
public void setTelemetries(Collection<String> telemetries)
An array that lists the types of telemetry data that this app monitor is to collect.
errors
indicates that RUM collects data about unhandled JavaScript errors raised by your
application.
performance
indicates that RUM collects performance data about how your application and its
resources are loaded and rendered. This includes Core Web Vitals.
http
indicates that RUM collects data about HTTP errors thrown by your application.
telemetries
- An array that lists the types of telemetry data that this app monitor is to collect.
errors
indicates that RUM collects data about unhandled JavaScript errors raised by your
application.
performance
indicates that RUM collects performance data about how your application and its
resources are loaded and rendered. This includes Core Web Vitals.
http
indicates that RUM collects data about HTTP errors thrown by your application.
Telemetry
public AppMonitorConfiguration withTelemetries(String... telemetries)
An array that lists the types of telemetry data that this app monitor is to collect.
errors
indicates that RUM collects data about unhandled JavaScript errors raised by your
application.
performance
indicates that RUM collects performance data about how your application and its
resources are loaded and rendered. This includes Core Web Vitals.
http
indicates that RUM collects data about HTTP errors thrown by your application.
NOTE: This method appends the values to the existing list (if any). Use
setTelemetries(java.util.Collection)
or withTelemetries(java.util.Collection)
if you want to
override the existing values.
telemetries
- An array that lists the types of telemetry data that this app monitor is to collect.
errors
indicates that RUM collects data about unhandled JavaScript errors raised by your
application.
performance
indicates that RUM collects performance data about how your application and its
resources are loaded and rendered. This includes Core Web Vitals.
http
indicates that RUM collects data about HTTP errors thrown by your application.
Telemetry
public AppMonitorConfiguration withTelemetries(Collection<String> telemetries)
An array that lists the types of telemetry data that this app monitor is to collect.
errors
indicates that RUM collects data about unhandled JavaScript errors raised by your
application.
performance
indicates that RUM collects performance data about how your application and its
resources are loaded and rendered. This includes Core Web Vitals.
http
indicates that RUM collects data about HTTP errors thrown by your application.
telemetries
- An array that lists the types of telemetry data that this app monitor is to collect.
errors
indicates that RUM collects data about unhandled JavaScript errors raised by your
application.
performance
indicates that RUM collects performance data about how your application and its
resources are loaded and rendered. This includes Core Web Vitals.
http
indicates that RUM collects data about HTTP errors thrown by your application.
Telemetry
public AppMonitorConfiguration withTelemetries(Telemetry... telemetries)
An array that lists the types of telemetry data that this app monitor is to collect.
errors
indicates that RUM collects data about unhandled JavaScript errors raised by your
application.
performance
indicates that RUM collects performance data about how your application and its
resources are loaded and rendered. This includes Core Web Vitals.
http
indicates that RUM collects data about HTTP errors thrown by your application.
telemetries
- An array that lists the types of telemetry data that this app monitor is to collect.
errors
indicates that RUM collects data about unhandled JavaScript errors raised by your
application.
performance
indicates that RUM collects performance data about how your application and its
resources are loaded and rendered. This includes Core Web Vitals.
http
indicates that RUM collects data about HTTP errors thrown by your application.
Telemetry
public String toString()
toString
in class Object
Object.toString()
public AppMonitorConfiguration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.