pub struct CreateScheduledQueryFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to CreateScheduledQuery.
Creates a scheduled query that runs CloudWatch Logs Insights queries at regular intervals. Scheduled queries enable proactive monitoring by automatically executing queries to detect patterns and anomalies in your log data. Query results can be delivered to Amazon S3 for analysis or further processing.
Implementations§
Source§impl CreateScheduledQueryFluentBuilder
impl CreateScheduledQueryFluentBuilder
Sourcepub fn as_input(&self) -> &CreateScheduledQueryInputBuilder
pub fn as_input(&self) -> &CreateScheduledQueryInputBuilder
Access the CreateScheduledQuery as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateScheduledQueryOutput, SdkError<CreateScheduledQueryError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateScheduledQueryOutput, SdkError<CreateScheduledQueryError, 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<CreateScheduledQueryOutput, CreateScheduledQueryError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateScheduledQueryOutput, CreateScheduledQueryError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the scheduled query. The name must be unique within your account and region. Valid characters are alphanumeric characters, hyphens, underscores, and periods. Length must be between 1 and 255 characters.
Sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
The name of the scheduled query. The name must be unique within your account and region. Valid characters are alphanumeric characters, hyphens, underscores, and periods. Length must be between 1 and 255 characters.
Sourcepub fn get_name(&self) -> &Option<String>
pub fn get_name(&self) -> &Option<String>
The name of the scheduled query. The name must be unique within your account and region. Valid characters are alphanumeric characters, hyphens, underscores, and periods. Length must be between 1 and 255 characters.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
An optional description for the scheduled query to help identify its purpose and functionality.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
An optional description for the scheduled query to help identify its purpose and functionality.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
An optional description for the scheduled query to help identify its purpose and functionality.
Sourcepub fn query_language(self, input: QueryLanguage) -> Self
pub fn query_language(self, input: QueryLanguage) -> Self
The query language to use for the scheduled query. Valid values are LogsQL, PPL, and SQL.
Sourcepub fn set_query_language(self, input: Option<QueryLanguage>) -> Self
pub fn set_query_language(self, input: Option<QueryLanguage>) -> Self
The query language to use for the scheduled query. Valid values are LogsQL, PPL, and SQL.
Sourcepub fn get_query_language(&self) -> &Option<QueryLanguage>
pub fn get_query_language(&self) -> &Option<QueryLanguage>
The query language to use for the scheduled query. Valid values are LogsQL, PPL, and SQL.
Sourcepub fn query_string(self, input: impl Into<String>) -> Self
pub fn query_string(self, input: impl Into<String>) -> Self
The query string to execute. This is the same query syntax used in CloudWatch Logs Insights. Maximum length is 10,000 characters.
Sourcepub fn set_query_string(self, input: Option<String>) -> Self
pub fn set_query_string(self, input: Option<String>) -> Self
The query string to execute. This is the same query syntax used in CloudWatch Logs Insights. Maximum length is 10,000 characters.
Sourcepub fn get_query_string(&self) -> &Option<String>
pub fn get_query_string(&self) -> &Option<String>
The query string to execute. This is the same query syntax used in CloudWatch Logs Insights. Maximum length is 10,000 characters.
Sourcepub fn log_group_identifiers(self, input: impl Into<String>) -> Self
pub fn log_group_identifiers(self, input: impl Into<String>) -> Self
Appends an item to logGroupIdentifiers.
To override the contents of this collection use set_log_group_identifiers.
An array of log group names or ARNs to query. You can specify between 1 and 50 log groups. Log groups can be identified by name or full ARN.
Sourcepub fn set_log_group_identifiers(self, input: Option<Vec<String>>) -> Self
pub fn set_log_group_identifiers(self, input: Option<Vec<String>>) -> Self
An array of log group names or ARNs to query. You can specify between 1 and 50 log groups. Log groups can be identified by name or full ARN.
Sourcepub fn get_log_group_identifiers(&self) -> &Option<Vec<String>>
pub fn get_log_group_identifiers(&self) -> &Option<Vec<String>>
An array of log group names or ARNs to query. You can specify between 1 and 50 log groups. Log groups can be identified by name or full ARN.
Sourcepub fn schedule_expression(self, input: impl Into<String>) -> Self
pub fn schedule_expression(self, input: impl Into<String>) -> Self
A cron expression that defines when the scheduled query runs. The expression uses standard cron syntax and supports minute-level precision. Maximum length is 256 characters.
Sourcepub fn set_schedule_expression(self, input: Option<String>) -> Self
pub fn set_schedule_expression(self, input: Option<String>) -> Self
A cron expression that defines when the scheduled query runs. The expression uses standard cron syntax and supports minute-level precision. Maximum length is 256 characters.
Sourcepub fn get_schedule_expression(&self) -> &Option<String>
pub fn get_schedule_expression(&self) -> &Option<String>
A cron expression that defines when the scheduled query runs. The expression uses standard cron syntax and supports minute-level precision. Maximum length is 256 characters.
Sourcepub fn timezone(self, input: impl Into<String>) -> Self
pub fn timezone(self, input: impl Into<String>) -> Self
The timezone for evaluating the schedule expression. This determines when the scheduled query executes relative to the specified timezone.
Sourcepub fn set_timezone(self, input: Option<String>) -> Self
pub fn set_timezone(self, input: Option<String>) -> Self
The timezone for evaluating the schedule expression. This determines when the scheduled query executes relative to the specified timezone.
Sourcepub fn get_timezone(&self) -> &Option<String>
pub fn get_timezone(&self) -> &Option<String>
The timezone for evaluating the schedule expression. This determines when the scheduled query executes relative to the specified timezone.
Sourcepub fn start_time_offset(self, input: i64) -> Self
pub fn start_time_offset(self, input: i64) -> Self
The time offset in seconds that defines the lookback period for the query. This determines how far back in time the query searches from the execution time.
Sourcepub fn set_start_time_offset(self, input: Option<i64>) -> Self
pub fn set_start_time_offset(self, input: Option<i64>) -> Self
The time offset in seconds that defines the lookback period for the query. This determines how far back in time the query searches from the execution time.
Sourcepub fn get_start_time_offset(&self) -> &Option<i64>
pub fn get_start_time_offset(&self) -> &Option<i64>
The time offset in seconds that defines the lookback period for the query. This determines how far back in time the query searches from the execution time.
Sourcepub fn destination_configuration(self, input: DestinationConfiguration) -> Self
pub fn destination_configuration(self, input: DestinationConfiguration) -> Self
Configuration for where to deliver query results. Currently supports Amazon S3 destinations for storing query output.
Sourcepub fn set_destination_configuration(
self,
input: Option<DestinationConfiguration>,
) -> Self
pub fn set_destination_configuration( self, input: Option<DestinationConfiguration>, ) -> Self
Configuration for where to deliver query results. Currently supports Amazon S3 destinations for storing query output.
Sourcepub fn get_destination_configuration(&self) -> &Option<DestinationConfiguration>
pub fn get_destination_configuration(&self) -> &Option<DestinationConfiguration>
Configuration for where to deliver query results. Currently supports Amazon S3 destinations for storing query output.
Sourcepub fn schedule_start_time(self, input: i64) -> Self
pub fn schedule_start_time(self, input: i64) -> Self
The start time for the scheduled query in Unix epoch format. The query will not execute before this time.
Sourcepub fn set_schedule_start_time(self, input: Option<i64>) -> Self
pub fn set_schedule_start_time(self, input: Option<i64>) -> Self
The start time for the scheduled query in Unix epoch format. The query will not execute before this time.
Sourcepub fn get_schedule_start_time(&self) -> &Option<i64>
pub fn get_schedule_start_time(&self) -> &Option<i64>
The start time for the scheduled query in Unix epoch format. The query will not execute before this time.
Sourcepub fn schedule_end_time(self, input: i64) -> Self
pub fn schedule_end_time(self, input: i64) -> Self
The end time for the scheduled query in Unix epoch format. The query will stop executing after this time.
Sourcepub fn set_schedule_end_time(self, input: Option<i64>) -> Self
pub fn set_schedule_end_time(self, input: Option<i64>) -> Self
The end time for the scheduled query in Unix epoch format. The query will stop executing after this time.
Sourcepub fn get_schedule_end_time(&self) -> &Option<i64>
pub fn get_schedule_end_time(&self) -> &Option<i64>
The end time for the scheduled query in Unix epoch format. The query will stop executing after this time.
Sourcepub fn execution_role_arn(self, input: impl Into<String>) -> Self
pub fn execution_role_arn(self, input: impl Into<String>) -> Self
The ARN of the IAM role that grants permissions to execute the query and deliver results to the specified destination. The role must have permissions to read from the specified log groups and write to the destination.
Sourcepub fn set_execution_role_arn(self, input: Option<String>) -> Self
pub fn set_execution_role_arn(self, input: Option<String>) -> Self
The ARN of the IAM role that grants permissions to execute the query and deliver results to the specified destination. The role must have permissions to read from the specified log groups and write to the destination.
Sourcepub fn get_execution_role_arn(&self) -> &Option<String>
pub fn get_execution_role_arn(&self) -> &Option<String>
The ARN of the IAM role that grants permissions to execute the query and deliver results to the specified destination. The role must have permissions to read from the specified log groups and write to the destination.
Sourcepub fn state(self, input: ScheduledQueryState) -> Self
pub fn state(self, input: ScheduledQueryState) -> Self
The initial state of the scheduled query. Valid values are ENABLED and DISABLED. Default is ENABLED.
Sourcepub fn set_state(self, input: Option<ScheduledQueryState>) -> Self
pub fn set_state(self, input: Option<ScheduledQueryState>) -> Self
The initial state of the scheduled query. Valid values are ENABLED and DISABLED. Default is ENABLED.
Sourcepub fn get_state(&self) -> &Option<ScheduledQueryState>
pub fn get_state(&self) -> &Option<ScheduledQueryState>
The initial state of the scheduled query. Valid values are ENABLED and DISABLED. Default is ENABLED.
Adds a key-value pair to tags.
To override the contents of this collection use set_tags.
Key-value pairs to associate with the scheduled query for resource management and cost allocation.
Key-value pairs to associate with the scheduled query for resource management and cost allocation.
Key-value pairs to associate with the scheduled query for resource management and cost allocation.
Trait Implementations§
Source§impl Clone for CreateScheduledQueryFluentBuilder
impl Clone for CreateScheduledQueryFluentBuilder
Source§fn clone(&self) -> CreateScheduledQueryFluentBuilder
fn clone(&self) -> CreateScheduledQueryFluentBuilder
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 CreateScheduledQueryFluentBuilder
impl !RefUnwindSafe for CreateScheduledQueryFluentBuilder
impl Send for CreateScheduledQueryFluentBuilder
impl Sync for CreateScheduledQueryFluentBuilder
impl Unpin for CreateScheduledQueryFluentBuilder
impl !UnwindSafe for CreateScheduledQueryFluentBuilder
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);