Struct aws_sdk_wafv2::types::builders::LoggingConfigurationBuilder

#[non_exhaustive]
pub struct LoggingConfigurationBuilder { /* private fields */ }

A builder for LoggingConfiguration.

Implementations

impl LoggingConfigurationBuilder

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.

This field is required.

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.

pub fn get_resource_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

pub fn log_type(self, input: LogType) -> Self

Used to distinguish between various logging options. Currently, there is one option.

Default: WAF_LOGS

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

pub fn get_log_type(&self) -> &Option<LogType>

Used to distinguish between various logging options. Currently, there is one option.

Default: WAF_LOGS

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

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

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

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:

• resource_arn
• log_destination_configs

Trait Implementations

impl Clone for LoggingConfigurationBuilder

fn clone(&self) -> LoggingConfigurationBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LoggingConfigurationBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for LoggingConfigurationBuilder

fn default() -> LoggingConfigurationBuilder

Returns the “default value” for a type.

impl PartialEq for LoggingConfigurationBuilder

fn eq(&self, other: &LoggingConfigurationBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for LoggingConfigurationBuilder