Struct aws_sdk_wafv2::operation::create_api_key::CreateApiKeyInput

#[non_exhaustive]
pub struct CreateApiKeyInput {
    pub scope: Option<Scope>,
    pub token_domains: Option<Vec<String>>,
}

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.

scope: Option<Scope>

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

• CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

token_domains: Option<Vec<String>>

The client application domains that you want to use this API key for.

Example JSON: "TokenDomains": \["abc.com", "store.abc.com"\]

Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.

Implementations

impl CreateApiKeyInput

pub fn scope(&self) -> Option<&Scope>

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

• CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

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

The client application domains that you want to use this API key for.

Example JSON: "TokenDomains": \["abc.com", "store.abc.com"\]

Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains.

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().

impl CreateApiKeyInput

pub fn builder() -> CreateApiKeyInputBuilder

Creates a new builder-style object to manufacture CreateApiKeyInput.

Trait Implementations

impl Clone for CreateApiKeyInput

fn clone(&self) -> CreateApiKeyInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateApiKeyInput

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

Formats the value using the given formatter.

impl PartialEq for CreateApiKeyInput

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