pub struct CreateScraperFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to CreateScraper.
The CreateScraper operation creates a scraper to collect metrics. A scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS cluster, and sends them to your Amazon Managed Service for Prometheus workspace. Scrapers are flexible, and can be configured to control what metrics are collected, the frequency of collection, what transformations are applied to the metrics, and more.
An IAM role will be created for you that Amazon Managed Service for Prometheus uses to access the metrics in your cluster. You must configure this role with a policy that allows it to scrape metrics from your cluster. For more information, see Configuring your Amazon EKS cluster in the Amazon Managed Service for Prometheus User Guide.
The scrapeConfiguration parameter contains the base-64 encoded YAML configuration for the scraper.
When creating a scraper, the service creates a Network Interface in each Availability Zone that are passed into CreateScraper through subnets. These network interfaces are used to connect to the Amazon EKS cluster within the VPC for scraping metrics.
For more information about collectors, including what metrics are collected, and how to configure the scraper, see Using an Amazon Web Services managed collector in the Amazon Managed Service for Prometheus User Guide.
Implementations§
Source§impl CreateScraperFluentBuilder
impl CreateScraperFluentBuilder
Sourcepub fn as_input(&self) -> &CreateScraperInputBuilder
pub fn as_input(&self) -> &CreateScraperInputBuilder
Access the CreateScraper as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateScraperOutput, SdkError<CreateScraperError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateScraperOutput, SdkError<CreateScraperError, 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<CreateScraperOutput, CreateScraperError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateScraperOutput, CreateScraperError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn alias(self, input: impl Into<String>) -> Self
pub fn alias(self, input: impl Into<String>) -> Self
(optional) An alias to associate with the scraper. This is for your use, and does not need to be unique.
Sourcepub fn set_alias(self, input: Option<String>) -> Self
pub fn set_alias(self, input: Option<String>) -> Self
(optional) An alias to associate with the scraper. This is for your use, and does not need to be unique.
Sourcepub fn get_alias(&self) -> &Option<String>
pub fn get_alias(&self) -> &Option<String>
(optional) An alias to associate with the scraper. This is for your use, and does not need to be unique.
Sourcepub fn scrape_configuration(self, input: ScrapeConfiguration) -> Self
pub fn scrape_configuration(self, input: ScrapeConfiguration) -> Self
The configuration file to use in the new scraper. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User Guide.
Sourcepub fn set_scrape_configuration(
self,
input: Option<ScrapeConfiguration>,
) -> Self
pub fn set_scrape_configuration( self, input: Option<ScrapeConfiguration>, ) -> Self
The configuration file to use in the new scraper. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User Guide.
Sourcepub fn get_scrape_configuration(&self) -> &Option<ScrapeConfiguration>
pub fn get_scrape_configuration(&self) -> &Option<ScrapeConfiguration>
The configuration file to use in the new scraper. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User Guide.
Sourcepub fn source(self, input: Source) -> Self
pub fn source(self, input: Source) -> Self
The Amazon EKS cluster from which the scraper will collect metrics.
Sourcepub fn set_source(self, input: Option<Source>) -> Self
pub fn set_source(self, input: Option<Source>) -> Self
The Amazon EKS cluster from which the scraper will collect metrics.
Sourcepub fn get_source(&self) -> &Option<Source>
pub fn get_source(&self) -> &Option<Source>
The Amazon EKS cluster from which the scraper will collect metrics.
Sourcepub fn destination(self, input: Destination) -> Self
pub fn destination(self, input: Destination) -> Self
The Amazon Managed Service for Prometheus workspace to send metrics to.
Sourcepub fn set_destination(self, input: Option<Destination>) -> Self
pub fn set_destination(self, input: Option<Destination>) -> Self
The Amazon Managed Service for Prometheus workspace to send metrics to.
Sourcepub fn get_destination(&self) -> &Option<Destination>
pub fn get_destination(&self) -> &Option<Destination>
The Amazon Managed Service for Prometheus workspace to send metrics to.
Sourcepub fn role_configuration(self, input: RoleConfiguration) -> Self
pub fn role_configuration(self, input: RoleConfiguration) -> Self
Use this structure to enable cross-account access, so that you can use a target account to access Prometheus metrics from source accounts.
Sourcepub fn set_role_configuration(self, input: Option<RoleConfiguration>) -> Self
pub fn set_role_configuration(self, input: Option<RoleConfiguration>) -> Self
Use this structure to enable cross-account access, so that you can use a target account to access Prometheus metrics from source accounts.
Sourcepub fn get_role_configuration(&self) -> &Option<RoleConfiguration>
pub fn get_role_configuration(&self) -> &Option<RoleConfiguration>
Use this structure to enable cross-account access, so that you can use a target account to access Prometheus metrics from source accounts.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.
Adds a key-value pair to tags.
To override the contents of this collection use set_tags.
(Optional) The list of tag keys and values to associate with the scraper.
(Optional) The list of tag keys and values to associate with the scraper.
(Optional) The list of tag keys and values to associate with the scraper.
Trait Implementations§
Source§impl Clone for CreateScraperFluentBuilder
impl Clone for CreateScraperFluentBuilder
Source§fn clone(&self) -> CreateScraperFluentBuilder
fn clone(&self) -> CreateScraperFluentBuilder
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 CreateScraperFluentBuilder
impl !RefUnwindSafe for CreateScraperFluentBuilder
impl Send for CreateScraperFluentBuilder
impl Sync for CreateScraperFluentBuilder
impl Unpin for CreateScraperFluentBuilder
impl !UnwindSafe for CreateScraperFluentBuilder
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);