Struct aws_sdk_wafv2::types::LoggingConfiguration
source · #[non_exhaustive]pub struct LoggingConfiguration {
pub resource_arn: String,
pub log_destination_configs: Vec<String>,
pub redacted_fields: Option<Vec<FieldToMatch>>,
pub managed_by_firewall_manager: bool,
pub logging_filter: Option<LoggingFilter>,
}
Expand description
Defines an association between logging destinations and a web ACL resource, for logging from WAF. As part of the association, you can specify parts of the standard logging fields to keep out of the logs and you can specify filters so that you log only a subset of the logging records.
You can define one logging destination per web ACL.
You can access information about the traffic that WAF inspects using the following steps:
-
Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose.
The name that you give the destination must start with
aws-waf-logs-
. Depending on the type of destination, you might need to configure additional settings or permissions.For configuration requirements and pricing information for each destination type, see Logging web ACL traffic in the WAF Developer Guide.
-
Associate your logging destination to your web ACL using a
PutLoggingConfiguration
request.
When you successfully enable logging using a PutLoggingConfiguration
request, WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.
For additional information about web ACL logging, see Logging web ACL traffic information in the WAF Developer Guide.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.resource_arn: String
The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs
.
log_destination_configs: 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.
redacted_fields: 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
.
managed_by_firewall_manager: 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.
logging_filter: 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.
Implementations§
source§impl LoggingConfiguration
impl LoggingConfiguration
sourcepub fn resource_arn(&self) -> &str
pub fn resource_arn(&self) -> &str
The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs
.
sourcepub fn log_destination_configs(&self) -> &[String]
pub fn log_destination_configs(&self) -> &[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) -> &[FieldToMatch]
pub fn redacted_fields(&self) -> &[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
.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .redacted_fields.is_none()
.
sourcepub fn managed_by_firewall_manager(&self) -> bool
pub fn managed_by_firewall_manager(&self) -> 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.
sourcepub fn logging_filter(&self) -> Option<&LoggingFilter>
pub fn 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.
source§impl LoggingConfiguration
impl LoggingConfiguration
sourcepub fn builder() -> LoggingConfigurationBuilder
pub fn builder() -> LoggingConfigurationBuilder
Creates a new builder-style object to manufacture LoggingConfiguration
.
Trait Implementations§
source§impl Clone for LoggingConfiguration
impl Clone for LoggingConfiguration
source§fn clone(&self) -> LoggingConfiguration
fn clone(&self) -> LoggingConfiguration
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for LoggingConfiguration
impl Debug for LoggingConfiguration
source§impl PartialEq for LoggingConfiguration
impl PartialEq for LoggingConfiguration
source§fn eq(&self, other: &LoggingConfiguration) -> bool
fn eq(&self, other: &LoggingConfiguration) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for LoggingConfiguration
Auto Trait Implementations§
impl Freeze for LoggingConfiguration
impl RefUnwindSafe for LoggingConfiguration
impl Send for LoggingConfiguration
impl Sync for LoggingConfiguration
impl Unpin for LoggingConfiguration
impl UnwindSafe for LoggingConfiguration
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> 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 more