pub struct BatchCreateRumMetricDefinitionsFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to BatchCreateRumMetricDefinitions.
Specifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination. Valid destinations include CloudWatch and Evidently.
By default, RUM app monitors send some metrics to CloudWatch. These default metrics are listed in CloudWatch metrics that you can collect with CloudWatch RUM.
In addition to these default metrics, you can choose to send extended metrics, custom metrics, or both.
-
Extended metrics let you send metrics with additional dimensions that aren't included in the default metrics. You can also send extended metrics to both Evidently and CloudWatch. The valid dimension names for the additional dimensions for extended metrics are
BrowserName,CountryCode,DeviceType,FileType,OSName, andPageId. For more information, see Extended metrics that you can send to CloudWatch and CloudWatch Evidently. -
Custom metrics are metrics that you define. You can send custom metrics to CloudWatch. CloudWatch Evidently, or both. With custom metrics, you can use any metric name and namespace. To derive the metrics, you can use any custom events, built-in events, custom attributes, or default attributes.
You can't send custom metrics to the
AWS/RUMnamespace. You must send custom metrics to a custom namespace that you define. The namespace that you use can't start withAWS/. CloudWatch RUM prependsRUM/CustomMetrics/to the custom namespace that you define, so the final namespace for your metrics in CloudWatch isRUM/CustomMetrics/your-custom-namespace.
The maximum number of metric definitions that you can specify in one BatchCreateRumMetricDefinitions operation is 200.
The maximum number of metric definitions that one destination can contain is 2000.
Extended metrics sent to CloudWatch and RUM custom metrics are charged as CloudWatch custom metrics. Each combination of additional dimension name and dimension value counts as a custom metric. For more information, see Amazon CloudWatch Pricing.
You must have already created a destination for the metrics before you send them. For more information, see PutRumMetricsDestination.
If some metric definitions specified in a BatchCreateRumMetricDefinitions operations are not valid, those metric definitions fail and return errors, but all valid metric definitions in the same operation still succeed.
Implementations§
Source§impl BatchCreateRumMetricDefinitionsFluentBuilder
impl BatchCreateRumMetricDefinitionsFluentBuilder
Sourcepub fn as_input(&self) -> &BatchCreateRumMetricDefinitionsInputBuilder
pub fn as_input(&self) -> &BatchCreateRumMetricDefinitionsInputBuilder
Access the BatchCreateRumMetricDefinitions as a reference.
Sourcepub async fn send(
self,
) -> Result<BatchCreateRumMetricDefinitionsOutput, SdkError<BatchCreateRumMetricDefinitionsError, HttpResponse>>
pub async fn send( self, ) -> Result<BatchCreateRumMetricDefinitionsOutput, SdkError<BatchCreateRumMetricDefinitionsError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<BatchCreateRumMetricDefinitionsOutput, BatchCreateRumMetricDefinitionsError, Self>
pub fn customize( self, ) -> CustomizableOperation<BatchCreateRumMetricDefinitionsOutput, BatchCreateRumMetricDefinitionsError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn app_monitor_name(self, input: impl Into<String>) -> Self
pub fn app_monitor_name(self, input: impl Into<String>) -> Self
The name of the CloudWatch RUM app monitor that is to send the metrics.
Sourcepub fn set_app_monitor_name(self, input: Option<String>) -> Self
pub fn set_app_monitor_name(self, input: Option<String>) -> Self
The name of the CloudWatch RUM app monitor that is to send the metrics.
Sourcepub fn get_app_monitor_name(&self) -> &Option<String>
pub fn get_app_monitor_name(&self) -> &Option<String>
The name of the CloudWatch RUM app monitor that is to send the metrics.
Sourcepub fn destination(self, input: MetricDestination) -> Self
pub fn destination(self, input: MetricDestination) -> Self
The destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the Amazon Resource Name (ARN) of the CloudWatchEvidently experiment that will receive the metrics and an IAM role that has permission to write to the experiment.
Sourcepub fn set_destination(self, input: Option<MetricDestination>) -> Self
pub fn set_destination(self, input: Option<MetricDestination>) -> Self
The destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the Amazon Resource Name (ARN) of the CloudWatchEvidently experiment that will receive the metrics and an IAM role that has permission to write to the experiment.
Sourcepub fn get_destination(&self) -> &Option<MetricDestination>
pub fn get_destination(&self) -> &Option<MetricDestination>
The destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the Amazon Resource Name (ARN) of the CloudWatchEvidently experiment that will receive the metrics and an IAM role that has permission to write to the experiment.
Sourcepub fn destination_arn(self, input: impl Into<String>) -> Self
pub fn destination_arn(self, input: impl Into<String>) -> Self
This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.
This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have already defined this experiment as a valid destination. For more information, see PutRumMetricsDestination.
Sourcepub fn set_destination_arn(self, input: Option<String>) -> Self
pub fn set_destination_arn(self, input: Option<String>) -> Self
This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.
This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have already defined this experiment as a valid destination. For more information, see PutRumMetricsDestination.
Sourcepub fn get_destination_arn(&self) -> &Option<String>
pub fn get_destination_arn(&self) -> &Option<String>
This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.
This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have already defined this experiment as a valid destination. For more information, see PutRumMetricsDestination.
Sourcepub fn metric_definitions(self, input: MetricDefinitionRequest) -> Self
pub fn metric_definitions(self, input: MetricDefinitionRequest) -> Self
Appends an item to MetricDefinitions.
To override the contents of this collection use set_metric_definitions.
An array of structures which define the metrics that you want to send.
Sourcepub fn set_metric_definitions(
self,
input: Option<Vec<MetricDefinitionRequest>>,
) -> Self
pub fn set_metric_definitions( self, input: Option<Vec<MetricDefinitionRequest>>, ) -> Self
An array of structures which define the metrics that you want to send.
Sourcepub fn get_metric_definitions(&self) -> &Option<Vec<MetricDefinitionRequest>>
pub fn get_metric_definitions(&self) -> &Option<Vec<MetricDefinitionRequest>>
An array of structures which define the metrics that you want to send.
Trait Implementations§
Source§impl Clone for BatchCreateRumMetricDefinitionsFluentBuilder
impl Clone for BatchCreateRumMetricDefinitionsFluentBuilder
Source§fn clone(&self) -> BatchCreateRumMetricDefinitionsFluentBuilder
fn clone(&self) -> BatchCreateRumMetricDefinitionsFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for BatchCreateRumMetricDefinitionsFluentBuilder
impl !RefUnwindSafe for BatchCreateRumMetricDefinitionsFluentBuilder
impl Send for BatchCreateRumMetricDefinitionsFluentBuilder
impl Sync for BatchCreateRumMetricDefinitionsFluentBuilder
impl Unpin for BatchCreateRumMetricDefinitionsFluentBuilder
impl !UnwindSafe for BatchCreateRumMetricDefinitionsFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);