Struct aws_sdk_wafv2::types::IpSetSummary

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

High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.

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 IP set. You cannot change the name of an IPSet after you create it.

id: Option<String>

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

description: Option<String>

A description of the IP 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.

Implementations

impl IpSetSummary

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

The name of the IP set. You cannot change the name of an IPSet after you create it.

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

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

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

A description of the IP 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.

impl IpSetSummary

pub fn builder() -> IpSetSummaryBuilder

Creates a new builder-style object to manufacture IpSetSummary.

Trait Implementations

impl Clone for IpSetSummary

fn clone(&self) -> IpSetSummary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IpSetSummary

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

Formats the value using the given formatter.

impl PartialEq for IpSetSummary

fn eq(&self, other: &IpSetSummary) -> 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 IpSetSummary