Struct aws_sdk_wafv2::operation::create_api_key::builders::CreateApiKeyInputBuilder

#[non_exhaustive]
pub struct CreateApiKeyInputBuilder { /* private fields */ }

A builder for CreateApiKeyInput.

Implementations

impl CreateApiKeyInputBuilder

pub fn scope(self, input: Scope) -> Self

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.

This field is required.

pub fn set_scope(self, input: Option<Scope>) -> Self

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 get_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, input: impl Into<String>) -> Self

Appends an item to token_domains.

To override the contents of this collection use set_token_domains.

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.

pub fn set_token_domains(self, input: Option<Vec<String>>) -> Self

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.

pub fn get_token_domains(&self) -> &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.

pub fn build(self) -> Result<CreateApiKeyInput, BuildError>

Consumes the builder and constructs a CreateApiKeyInput.

impl CreateApiKeyInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<CreateApiKeyOutput, SdkError<CreateAPIKeyError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for CreateApiKeyInputBuilder

fn clone(&self) -> CreateApiKeyInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateApiKeyInputBuilder

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

Formats the value using the given formatter.

impl Default for CreateApiKeyInputBuilder

fn default() -> CreateApiKeyInputBuilder

Returns the “default value” for a type.

impl PartialEq for CreateApiKeyInputBuilder

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