Struct aws_sdk_wafv2::operation::create_api_key::CreateApiKeyInput
source · #[non_exhaustive]pub struct CreateApiKeyInput {
pub scope: Option<Scope>,
pub token_domains: Option<Vec<String>>,
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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§
source§impl CreateApiKeyInput
impl CreateApiKeyInput
sourcepub fn scope(&self) -> Option<&Scope>
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.
sourcepub fn token_domains(&self) -> &[String]
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()
.
source§impl CreateApiKeyInput
impl CreateApiKeyInput
sourcepub fn builder() -> CreateApiKeyInputBuilder
pub fn builder() -> CreateApiKeyInputBuilder
Creates a new builder-style object to manufacture CreateApiKeyInput
.
Trait Implementations§
source§impl Clone for CreateApiKeyInput
impl Clone for CreateApiKeyInput
source§fn clone(&self) -> CreateApiKeyInput
fn clone(&self) -> CreateApiKeyInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for CreateApiKeyInput
impl Debug for CreateApiKeyInput
source§impl PartialEq for CreateApiKeyInput
impl PartialEq for CreateApiKeyInput
source§fn eq(&self, other: &CreateApiKeyInput) -> bool
fn eq(&self, other: &CreateApiKeyInput) -> bool
self
and other
values to be equal, and is used
by ==
.