#[non_exhaustive]pub struct PutRuleInputBuilder { /* private fields */ }
Expand description
A builder for PutRuleInput
.
Implementations§
Source§impl PutRuleInputBuilder
impl PutRuleInputBuilder
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the rule that you are creating or updating.
This field is required.Sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
The name of the rule that you are creating or updating.
Sourcepub fn get_name(&self) -> &Option<String>
pub fn get_name(&self) -> &Option<String>
The name of the rule that you are creating or updating.
Sourcepub fn schedule_expression(self, input: impl Into<String>) -> Self
pub fn schedule_expression(self, input: impl Into<String>) -> Self
The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
Sourcepub fn set_schedule_expression(self, input: Option<String>) -> Self
pub fn set_schedule_expression(self, input: Option<String>) -> Self
The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
Sourcepub fn get_schedule_expression(&self) -> &Option<String>
pub fn get_schedule_expression(&self) -> &Option<String>
The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
Sourcepub fn event_pattern(self, input: impl Into<String>) -> Self
pub fn event_pattern(self, input: impl Into<String>) -> Self
The event pattern. For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide .
Sourcepub fn set_event_pattern(self, input: Option<String>) -> Self
pub fn set_event_pattern(self, input: Option<String>) -> Self
The event pattern. For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide .
Sourcepub fn get_event_pattern(&self) -> &Option<String>
pub fn get_event_pattern(&self) -> &Option<String>
The event pattern. For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide .
Sourcepub fn state(self, input: RuleState) -> Self
pub fn state(self, input: RuleState) -> Self
The state of the rule.
Valid values include:
-
DISABLED
: The rule is disabled. EventBridge does not match any events against the rule. -
ENABLED
: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail. -
ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS
: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide .
This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.
Sourcepub fn set_state(self, input: Option<RuleState>) -> Self
pub fn set_state(self, input: Option<RuleState>) -> Self
The state of the rule.
Valid values include:
-
DISABLED
: The rule is disabled. EventBridge does not match any events against the rule. -
ENABLED
: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail. -
ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS
: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide .
This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.
Sourcepub fn get_state(&self) -> &Option<RuleState>
pub fn get_state(&self) -> &Option<RuleState>
The state of the rule.
Valid values include:
-
DISABLED
: The rule is disabled. EventBridge does not match any events against the rule. -
ENABLED
: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail. -
ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS
: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide .
This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description of the rule.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description of the rule.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the rule.
Sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the IAM role associated with the rule.
If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn
with proper permissions in the Target
structure, instead of here in this parameter.
Sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the IAM role associated with the rule.
If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn
with proper permissions in the Target
structure, instead of here in this parameter.
Sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the IAM role associated with the rule.
If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn
with proper permissions in the Target
structure, instead of here in this parameter.
Appends an item to tags
.
To override the contents of this collection use set_tags
.
The list of key-value pairs to associate with the rule.
The list of key-value pairs to associate with the rule.
The list of key-value pairs to associate with the rule.
Sourcepub fn event_bus_name(self, input: impl Into<String>) -> Self
pub fn event_bus_name(self, input: impl Into<String>) -> Self
The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used.
Sourcepub fn set_event_bus_name(self, input: Option<String>) -> Self
pub fn set_event_bus_name(self, input: Option<String>) -> Self
The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used.
Sourcepub fn get_event_bus_name(&self) -> &Option<String>
pub fn get_event_bus_name(&self) -> &Option<String>
The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used.
Sourcepub fn build(self) -> Result<PutRuleInput, BuildError>
pub fn build(self) -> Result<PutRuleInput, BuildError>
Consumes the builder and constructs a PutRuleInput
.
Source§impl PutRuleInputBuilder
impl PutRuleInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<PutRuleOutput, SdkError<PutRuleError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<PutRuleOutput, SdkError<PutRuleError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for PutRuleInputBuilder
impl Clone for PutRuleInputBuilder
Source§fn clone(&self) -> PutRuleInputBuilder
fn clone(&self) -> PutRuleInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for PutRuleInputBuilder
impl Debug for PutRuleInputBuilder
Source§impl Default for PutRuleInputBuilder
impl Default for PutRuleInputBuilder
Source§fn default() -> PutRuleInputBuilder
fn default() -> PutRuleInputBuilder
Source§impl PartialEq for PutRuleInputBuilder
impl PartialEq for PutRuleInputBuilder
impl StructuralPartialEq for PutRuleInputBuilder
Auto Trait Implementations§
impl Freeze for PutRuleInputBuilder
impl RefUnwindSafe for PutRuleInputBuilder
impl Send for PutRuleInputBuilder
impl Sync for PutRuleInputBuilder
impl Unpin for PutRuleInputBuilder
impl UnwindSafe for PutRuleInputBuilder
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);