pub struct UpdateByteMatchSetFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to UpdateByteMatchSet.
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.
Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values:
-
Whether to insert or delete the object from the array. If you want to change a
ByteMatchSetUpdateobject, you delete the existing object and add a new one. -
The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the
User-Agentheader. -
The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see
TargetStringin theByteMatchTupledata type. -
Where to look, such as at the beginning or the end of a query string.
-
Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests.
To create and configure a ByteMatchSet, perform the following steps:
-
Create a
ByteMatchSet.For more information, seeCreateByteMatchSet. -
Use
GetChangeTokento get the change token that you provide in theChangeTokenparameter of anUpdateByteMatchSetrequest. -
Submit an
UpdateByteMatchSetrequest to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
Implementations§
Source§impl UpdateByteMatchSetFluentBuilder
impl UpdateByteMatchSetFluentBuilder
Sourcepub fn as_input(&self) -> &UpdateByteMatchSetInputBuilder
pub fn as_input(&self) -> &UpdateByteMatchSetInputBuilder
Access the UpdateByteMatchSet as a reference.
Sourcepub async fn send(
self,
) -> Result<UpdateByteMatchSetOutput, SdkError<UpdateByteMatchSetError, HttpResponse>>
pub async fn send( self, ) -> Result<UpdateByteMatchSetOutput, SdkError<UpdateByteMatchSetError, 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<UpdateByteMatchSetOutput, UpdateByteMatchSetError, Self>
pub fn customize( self, ) -> CustomizableOperation<UpdateByteMatchSetOutput, UpdateByteMatchSetError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn byte_match_set_id(self, input: impl Into<String>) -> Self
pub fn byte_match_set_id(self, input: impl Into<String>) -> Self
The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
Sourcepub fn set_byte_match_set_id(self, input: Option<String>) -> Self
pub fn set_byte_match_set_id(self, input: Option<String>) -> Self
The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
Sourcepub fn get_byte_match_set_id(&self) -> &Option<String>
pub fn get_byte_match_set_id(&self) -> &Option<String>
The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
Sourcepub fn change_token(self, input: impl Into<String>) -> Self
pub fn change_token(self, input: impl Into<String>) -> Self
The value returned by the most recent call to GetChangeToken.
Sourcepub fn set_change_token(self, input: Option<String>) -> Self
pub fn set_change_token(self, input: Option<String>) -> Self
The value returned by the most recent call to GetChangeToken.
Sourcepub fn get_change_token(&self) -> &Option<String>
pub fn get_change_token(&self) -> &Option<String>
The value returned by the most recent call to GetChangeToken.
Sourcepub fn updates(self, input: ByteMatchSetUpdate) -> Self
pub fn updates(self, input: ByteMatchSetUpdate) -> Self
Appends an item to Updates.
To override the contents of this collection use set_updates.
An array of ByteMatchSetUpdate objects that you want to insert into or delete from a ByteMatchSet. For more information, see the applicable data types:
-
ByteMatchSetUpdate: ContainsActionandByteMatchTuple -
ByteMatchTuple: ContainsFieldToMatch,PositionalConstraint,TargetString, andTextTransformation -
FieldToMatch: ContainsDataandType
Sourcepub fn set_updates(self, input: Option<Vec<ByteMatchSetUpdate>>) -> Self
pub fn set_updates(self, input: Option<Vec<ByteMatchSetUpdate>>) -> Self
An array of ByteMatchSetUpdate objects that you want to insert into or delete from a ByteMatchSet. For more information, see the applicable data types:
-
ByteMatchSetUpdate: ContainsActionandByteMatchTuple -
ByteMatchTuple: ContainsFieldToMatch,PositionalConstraint,TargetString, andTextTransformation -
FieldToMatch: ContainsDataandType
Sourcepub fn get_updates(&self) -> &Option<Vec<ByteMatchSetUpdate>>
pub fn get_updates(&self) -> &Option<Vec<ByteMatchSetUpdate>>
An array of ByteMatchSetUpdate objects that you want to insert into or delete from a ByteMatchSet. For more information, see the applicable data types:
-
ByteMatchSetUpdate: ContainsActionandByteMatchTuple -
ByteMatchTuple: ContainsFieldToMatch,PositionalConstraint,TargetString, andTextTransformation -
FieldToMatch: ContainsDataandType
Trait Implementations§
Source§impl Clone for UpdateByteMatchSetFluentBuilder
impl Clone for UpdateByteMatchSetFluentBuilder
Source§fn clone(&self) -> UpdateByteMatchSetFluentBuilder
fn clone(&self) -> UpdateByteMatchSetFluentBuilder
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 UpdateByteMatchSetFluentBuilder
impl !RefUnwindSafe for UpdateByteMatchSetFluentBuilder
impl Send for UpdateByteMatchSetFluentBuilder
impl Sync for UpdateByteMatchSetFluentBuilder
impl Unpin for UpdateByteMatchSetFluentBuilder
impl !UnwindSafe for UpdateByteMatchSetFluentBuilder
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit)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>
Returns self with the
fg()
set to
Color::BrightBlack.
§Example
println!("{}", value.bright_black());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>
Returns self with the
fg()
set to
Color::BrightGreen.
§Example
println!("{}", value.bright_green());Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightYellow.
§Example
println!("{}", value.bright_yellow());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>
Returns self with the
fg()
set to
Color::BrightMagenta.
§Example
println!("{}", value.bright_magenta());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>
Returns self with the
fg()
set to
Color::BrightWhite.
§Example
println!("{}", value.bright_white());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>
Returns self with the
bg()
set to
Color::BrightBlack.
§Example
println!("{}", value.on_bright_black());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>
Returns self with the
bg()
set to
Color::BrightGreen.
§Example
println!("{}", value.on_bright_green());Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightYellow.
§Example
println!("{}", value.on_bright_yellow());Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightBlue.
§Example
println!("{}", value.on_bright_blue());Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightMagenta.
§Example
println!("{}", value.on_bright_magenta());Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightCyan.
§Example
println!("{}", value.on_bright_cyan());Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightWhite.
§Example
println!("{}", value.on_bright_white());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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::Underline.
§Example
println!("{}", value.underline());Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::RapidBlink.
§Example
println!("{}", value.rapid_blink());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);