Struct aws_sdk_wafv2::types::ApiKeySummary

#[non_exhaustive]
pub struct ApiKeySummary {
    pub token_domains: Option<Vec<String>>,
    pub api_key: Option<String>,
    pub creation_timestamp: Option<DateTime>,
    pub version: i32,
}

Information for a single API key.

API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.

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.

token_domains: Option<Vec<String>>

The token domains that are defined in this API key.

api_key: Option<String>

The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.

creation_timestamp: Option<DateTime>

The date and time that the key was created.

version: i32

Internal value used by WAF to manage the key.

Implementations

impl ApiKeySummary

pub fn token_domains(&self) -> &[String]

The token domains that are defined in this API key.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .token_domains.is_none().

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

The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.

pub fn creation_timestamp(&self) -> Option<&DateTime>

The date and time that the key was created.

pub fn version(&self) -> i32

Internal value used by WAF to manage the key.

impl ApiKeySummary

pub fn builder() -> ApiKeySummaryBuilder

Creates a new builder-style object to manufacture ApiKeySummary.

Trait Implementations

impl Clone for ApiKeySummary

fn clone(&self) -> ApiKeySummary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ApiKeySummary

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

Formats the value using the given formatter.

impl PartialEq for ApiKeySummary

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