Struct aws_sdk_wafv2::types::ManagedRuleSetSummary

#[non_exhaustive]
pub struct ManagedRuleSetSummary {
    pub name: Option<String>,
    pub id: Option<String>,
    pub description: Option<String>,
    pub lock_token: Option<String>,
    pub arn: Option<String>,
    pub label_namespace: Option<String>,
}

High-level information for a managed rule set.

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

This name is assigned to the corresponding managed rule group, which your customers can access and use.

id: Option<String>

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

description: Option<String>

A description of the set that helps with identification.

lock_token: Option<String>

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

arn: Option<String>

The Amazon Resource Name (ARN) of the entity.

label_namespace: Option<String>

The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.

• The syntax for the label namespace prefix for a managed rule group is the following:

  awswaf:managed: : :

• When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

  :

Implementations

impl ManagedRuleSetSummary

pub fn name(&self) -> Option<&str>

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

This name is assigned to the corresponding managed rule group, which your customers can access and use.

pub fn id(&self) -> Option<&str>

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

pub fn description(&self) -> Option<&str>

A description of the set that helps with identification.

pub fn lock_token(&self) -> Option<&str>

A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

pub fn arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the entity.

pub fn label_namespace(&self) -> Option<&str>

The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.

• The syntax for the label namespace prefix for a managed rule group is the following:

  awswaf:managed: : :

• When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

  :

impl ManagedRuleSetSummary

pub fn builder() -> ManagedRuleSetSummaryBuilder

Creates a new builder-style object to manufacture ManagedRuleSetSummary.

Trait Implementations

impl Clone for ManagedRuleSetSummary

fn clone(&self) -> ManagedRuleSetSummary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ManagedRuleSetSummary

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

Formats the value using the given formatter.

impl PartialEq for ManagedRuleSetSummary

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ManagedRuleSetSummary