#[non_exhaustive]pub struct ProtectionGroupBuilder { /* private fields */ }
Expand description
A builder for ProtectionGroup
.
Implementations§
Source§impl ProtectionGroupBuilder
impl ProtectionGroupBuilder
Sourcepub fn protection_group_id(self, input: impl Into<String>) -> Self
pub fn protection_group_id(self, input: impl Into<String>) -> Self
The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
This field is required.Sourcepub fn set_protection_group_id(self, input: Option<String>) -> Self
pub fn set_protection_group_id(self, input: Option<String>) -> Self
The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
Sourcepub fn get_protection_group_id(&self) -> &Option<String>
pub fn get_protection_group_id(&self) -> &Option<String>
The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
Sourcepub fn aggregation(self, input: ProtectionGroupAggregation) -> Self
pub fn aggregation(self, input: ProtectionGroupAggregation) -> Self
Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.
-
Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.
-
Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.
-
Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront distributions and origin resources for CloudFront distributions.
Sourcepub fn set_aggregation(self, input: Option<ProtectionGroupAggregation>) -> Self
pub fn set_aggregation(self, input: Option<ProtectionGroupAggregation>) -> Self
Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.
-
Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.
-
Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.
-
Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront distributions and origin resources for CloudFront distributions.
Sourcepub fn get_aggregation(&self) -> &Option<ProtectionGroupAggregation>
pub fn get_aggregation(&self) -> &Option<ProtectionGroupAggregation>
Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.
-
Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.
-
Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.
-
Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront distributions and origin resources for CloudFront distributions.
Sourcepub fn pattern(self, input: ProtectionGroupPattern) -> Self
pub fn pattern(self, input: ProtectionGroupPattern) -> Self
The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource ARNs (Amazon Resource Names), or include all resources of a specified resource type.
This field is required.Sourcepub fn set_pattern(self, input: Option<ProtectionGroupPattern>) -> Self
pub fn set_pattern(self, input: Option<ProtectionGroupPattern>) -> Self
The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource ARNs (Amazon Resource Names), or include all resources of a specified resource type.
Sourcepub fn get_pattern(&self) -> &Option<ProtectionGroupPattern>
pub fn get_pattern(&self) -> &Option<ProtectionGroupPattern>
The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource ARNs (Amazon Resource Names), or include all resources of a specified resource type.
Sourcepub fn resource_type(self, input: ProtectedResourceType) -> Self
pub fn resource_type(self, input: ProtectedResourceType) -> Self
The resource type to include in the protection group. All protected resources of this type are included in the protection group. You must set this when you set Pattern
to BY_RESOURCE_TYPE
and you must not set it for any other Pattern
setting.
Sourcepub fn set_resource_type(self, input: Option<ProtectedResourceType>) -> Self
pub fn set_resource_type(self, input: Option<ProtectedResourceType>) -> Self
The resource type to include in the protection group. All protected resources of this type are included in the protection group. You must set this when you set Pattern
to BY_RESOURCE_TYPE
and you must not set it for any other Pattern
setting.
Sourcepub fn get_resource_type(&self) -> &Option<ProtectedResourceType>
pub fn get_resource_type(&self) -> &Option<ProtectedResourceType>
The resource type to include in the protection group. All protected resources of this type are included in the protection group. You must set this when you set Pattern
to BY_RESOURCE_TYPE
and you must not set it for any other Pattern
setting.
Sourcepub fn members(self, input: impl Into<String>) -> Self
pub fn members(self, input: impl Into<String>) -> Self
Appends an item to members
.
To override the contents of this collection use set_members
.
The ARNs (Amazon Resource Names) of the resources to include in the protection group. You must set this when you set Pattern
to ARBITRARY
and you must not set it for any other Pattern
setting.
Sourcepub fn set_members(self, input: Option<Vec<String>>) -> Self
pub fn set_members(self, input: Option<Vec<String>>) -> Self
The ARNs (Amazon Resource Names) of the resources to include in the protection group. You must set this when you set Pattern
to ARBITRARY
and you must not set it for any other Pattern
setting.
Sourcepub fn get_members(&self) -> &Option<Vec<String>>
pub fn get_members(&self) -> &Option<Vec<String>>
The ARNs (Amazon Resource Names) of the resources to include in the protection group. You must set this when you set Pattern
to ARBITRARY
and you must not set it for any other Pattern
setting.
Sourcepub fn protection_group_arn(self, input: impl Into<String>) -> Self
pub fn protection_group_arn(self, input: impl Into<String>) -> Self
The ARN (Amazon Resource Name) of the protection group.
Sourcepub fn set_protection_group_arn(self, input: Option<String>) -> Self
pub fn set_protection_group_arn(self, input: Option<String>) -> Self
The ARN (Amazon Resource Name) of the protection group.
Sourcepub fn get_protection_group_arn(&self) -> &Option<String>
pub fn get_protection_group_arn(&self) -> &Option<String>
The ARN (Amazon Resource Name) of the protection group.
Sourcepub fn build(self) -> Result<ProtectionGroup, BuildError>
pub fn build(self) -> Result<ProtectionGroup, BuildError>
Consumes the builder and constructs a ProtectionGroup
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for ProtectionGroupBuilder
impl Clone for ProtectionGroupBuilder
Source§fn clone(&self) -> ProtectionGroupBuilder
fn clone(&self) -> ProtectionGroupBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ProtectionGroupBuilder
impl Debug for ProtectionGroupBuilder
Source§impl Default for ProtectionGroupBuilder
impl Default for ProtectionGroupBuilder
Source§fn default() -> ProtectionGroupBuilder
fn default() -> ProtectionGroupBuilder
Source§impl PartialEq for ProtectionGroupBuilder
impl PartialEq for ProtectionGroupBuilder
impl StructuralPartialEq for ProtectionGroupBuilder
Auto Trait Implementations§
impl Freeze for ProtectionGroupBuilder
impl RefUnwindSafe for ProtectionGroupBuilder
impl Send for ProtectionGroupBuilder
impl Sync for ProtectionGroupBuilder
impl Unpin for ProtectionGroupBuilder
impl UnwindSafe for ProtectionGroupBuilder
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);