#[non_exhaustive]pub struct LoggingConfigurationBuilder { /* private fields */ }
Expand description
A builder for LoggingConfiguration
.
Implementations§
Source§impl LoggingConfigurationBuilder
impl LoggingConfigurationBuilder
Sourcepub fn resource_arn(self, input: impl Into<String>) -> Self
pub fn resource_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs
.
Sourcepub fn set_resource_arn(self, input: Option<String>) -> Self
pub fn set_resource_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs
.
Sourcepub fn get_resource_arn(&self) -> &Option<String>
pub fn get_resource_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs
.
Sourcepub fn log_destination_configs(self, input: impl Into<String>) -> Self
pub fn log_destination_configs(self, input: impl Into<String>) -> Self
Appends an item to log_destination_configs
.
To override the contents of this collection use set_log_destination_configs
.
The logging destination configuration that you want to associate with the web ACL.
You can associate one logging destination to a web ACL.
Sourcepub fn set_log_destination_configs(self, input: Option<Vec<String>>) -> Self
pub fn set_log_destination_configs(self, input: Option<Vec<String>>) -> Self
The logging destination configuration that you want to associate with the web ACL.
You can associate one logging destination to a web ACL.
Sourcepub fn get_log_destination_configs(&self) -> &Option<Vec<String>>
pub fn get_log_destination_configs(&self) -> &Option<Vec<String>>
The logging destination configuration that you want to associate with the web ACL.
You can associate one logging destination to a web ACL.
Sourcepub fn redacted_fields(self, input: FieldToMatch) -> Self
pub fn redacted_fields(self, input: FieldToMatch) -> Self
Appends an item to redacted_fields
.
To override the contents of this collection use set_redacted_fields
.
The parts of the request that you want to keep out of the logs.
For example, if you redact the SingleHeader
field, the HEADER
field in the logs will be REDACTED
for all rules that use the SingleHeader
FieldToMatch
setting.
Redaction applies only to the component that's specified in the rule's FieldToMatch
setting, so the SingleHeader
redaction doesn't apply to rules that use the Headers
FieldToMatch
.
You can specify only the following fields for redaction: UriPath
, QueryString
, SingleHeader
, and Method
.
This setting has no impact on request sampling. With request sampling, the only way to exclude fields is by disabling sampling in the web ACL visibility configuration.
Sourcepub fn set_redacted_fields(self, input: Option<Vec<FieldToMatch>>) -> Self
pub fn set_redacted_fields(self, input: Option<Vec<FieldToMatch>>) -> Self
The parts of the request that you want to keep out of the logs.
For example, if you redact the SingleHeader
field, the HEADER
field in the logs will be REDACTED
for all rules that use the SingleHeader
FieldToMatch
setting.
Redaction applies only to the component that's specified in the rule's FieldToMatch
setting, so the SingleHeader
redaction doesn't apply to rules that use the Headers
FieldToMatch
.
You can specify only the following fields for redaction: UriPath
, QueryString
, SingleHeader
, and Method
.
This setting has no impact on request sampling. With request sampling, the only way to exclude fields is by disabling sampling in the web ACL visibility configuration.
Sourcepub fn get_redacted_fields(&self) -> &Option<Vec<FieldToMatch>>
pub fn get_redacted_fields(&self) -> &Option<Vec<FieldToMatch>>
The parts of the request that you want to keep out of the logs.
For example, if you redact the SingleHeader
field, the HEADER
field in the logs will be REDACTED
for all rules that use the SingleHeader
FieldToMatch
setting.
Redaction applies only to the component that's specified in the rule's FieldToMatch
setting, so the SingleHeader
redaction doesn't apply to rules that use the Headers
FieldToMatch
.
You can specify only the following fields for redaction: UriPath
, QueryString
, SingleHeader
, and Method
.
This setting has no impact on request sampling. With request sampling, the only way to exclude fields is by disabling sampling in the web ACL visibility configuration.
Sourcepub fn managed_by_firewall_manager(self, input: bool) -> Self
pub fn managed_by_firewall_manager(self, input: bool) -> Self
Indicates whether the logging configuration was created by Firewall Manager, as part of an WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration.
The logging configuration can be created by Firewall Manager for use with any web ACL that Firewall Manager is using for an WAF policy. Web ACLs that Firewall Manager creates and uses have their ManagedByFirewallManager
property set to true. Web ACLs that were created by a customer account and then retrofitted by Firewall Manager for use by a policy have their RetrofittedByFirewallManager
property set to true. For either case, any corresponding logging configuration will indicate ManagedByFirewallManager
.
Sourcepub fn set_managed_by_firewall_manager(self, input: Option<bool>) -> Self
pub fn set_managed_by_firewall_manager(self, input: Option<bool>) -> Self
Indicates whether the logging configuration was created by Firewall Manager, as part of an WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration.
The logging configuration can be created by Firewall Manager for use with any web ACL that Firewall Manager is using for an WAF policy. Web ACLs that Firewall Manager creates and uses have their ManagedByFirewallManager
property set to true. Web ACLs that were created by a customer account and then retrofitted by Firewall Manager for use by a policy have their RetrofittedByFirewallManager
property set to true. For either case, any corresponding logging configuration will indicate ManagedByFirewallManager
.
Sourcepub fn get_managed_by_firewall_manager(&self) -> &Option<bool>
pub fn get_managed_by_firewall_manager(&self) -> &Option<bool>
Indicates whether the logging configuration was created by Firewall Manager, as part of an WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration.
The logging configuration can be created by Firewall Manager for use with any web ACL that Firewall Manager is using for an WAF policy. Web ACLs that Firewall Manager creates and uses have their ManagedByFirewallManager
property set to true. Web ACLs that were created by a customer account and then retrofitted by Firewall Manager for use by a policy have their RetrofittedByFirewallManager
property set to true. For either case, any corresponding logging configuration will indicate ManagedByFirewallManager
.
Sourcepub fn logging_filter(self, input: LoggingFilter) -> Self
pub fn logging_filter(self, input: LoggingFilter) -> Self
Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.
Sourcepub fn set_logging_filter(self, input: Option<LoggingFilter>) -> Self
pub fn set_logging_filter(self, input: Option<LoggingFilter>) -> Self
Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.
Sourcepub fn get_logging_filter(&self) -> &Option<LoggingFilter>
pub fn get_logging_filter(&self) -> &Option<LoggingFilter>
Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.
Sourcepub fn log_type(self, input: LogType) -> Self
pub fn log_type(self, input: LogType) -> Self
Used to distinguish between various logging options. Currently, there is one option.
Default: WAF_LOGS
Sourcepub fn set_log_type(self, input: Option<LogType>) -> Self
pub fn set_log_type(self, input: Option<LogType>) -> Self
Used to distinguish between various logging options. Currently, there is one option.
Default: WAF_LOGS
Sourcepub fn get_log_type(&self) -> &Option<LogType>
pub fn get_log_type(&self) -> &Option<LogType>
Used to distinguish between various logging options. Currently, there is one option.
Default: WAF_LOGS
Sourcepub fn log_scope(self, input: LogScope) -> Self
pub fn log_scope(self, input: LogScope) -> Self
The owner of the logging configuration, which must be set to CUSTOMER
for the configurations that you manage.
The log scope SECURITY_LAKE
indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see Collecting data from Amazon Web Services services in the Amazon Security Lake user guide.
Default: CUSTOMER
Sourcepub fn set_log_scope(self, input: Option<LogScope>) -> Self
pub fn set_log_scope(self, input: Option<LogScope>) -> Self
The owner of the logging configuration, which must be set to CUSTOMER
for the configurations that you manage.
The log scope SECURITY_LAKE
indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see Collecting data from Amazon Web Services services in the Amazon Security Lake user guide.
Default: CUSTOMER
Sourcepub fn get_log_scope(&self) -> &Option<LogScope>
pub fn get_log_scope(&self) -> &Option<LogScope>
The owner of the logging configuration, which must be set to CUSTOMER
for the configurations that you manage.
The log scope SECURITY_LAKE
indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see Collecting data from Amazon Web Services services in the Amazon Security Lake user guide.
Default: CUSTOMER
Sourcepub fn build(self) -> Result<LoggingConfiguration, BuildError>
pub fn build(self) -> Result<LoggingConfiguration, BuildError>
Consumes the builder and constructs a LoggingConfiguration
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for LoggingConfigurationBuilder
impl Clone for LoggingConfigurationBuilder
Source§fn clone(&self) -> LoggingConfigurationBuilder
fn clone(&self) -> LoggingConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for LoggingConfigurationBuilder
impl Debug for LoggingConfigurationBuilder
Source§impl Default for LoggingConfigurationBuilder
impl Default for LoggingConfigurationBuilder
Source§fn default() -> LoggingConfigurationBuilder
fn default() -> LoggingConfigurationBuilder
impl StructuralPartialEq for LoggingConfigurationBuilder
Auto Trait Implementations§
impl Freeze for LoggingConfigurationBuilder
impl RefUnwindSafe for LoggingConfigurationBuilder
impl Send for LoggingConfigurationBuilder
impl Sync for LoggingConfigurationBuilder
impl Unpin for LoggingConfigurationBuilder
impl UnwindSafe for LoggingConfigurationBuilder
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);