Struct aws_sdk_apigateway::client::fluent_builders::CreateApiKey

pub struct CreateApiKey<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to CreateApiKey.

Create an ApiKey resource.

AWS CLI

Implementations

impl<C, M, R> CreateApiKey<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<CreateApiKeyOutput, SdkError<CreateApiKeyError>> where
    R::Policy: SmithyRetryPolicy<CreateApiKeyInputOperationOutputAlias, CreateApiKeyOutput, CreateApiKeyError, CreateApiKeyInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn name(self, input: impl Into<String>) -> Self

The name of the ApiKey.

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

The name of the ApiKey.

pub fn description(self, input: impl Into<String>) -> Self

The description of the ApiKey.

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

The description of the ApiKey.

pub fn enabled(self, input: bool) -> Self

Specifies whether the ApiKey can be used by callers.

pub fn set_enabled(self, input: Option<bool>) -> Self

Specifies whether the ApiKey can be used by callers.

pub fn generate_distinct_id(self, input: bool) -> Self

Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.

pub fn set_generate_distinct_id(self, input: Option<bool>) -> Self

Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.

pub fn value(self, input: impl Into<String>) -> Self

Specifies a value of the API key.

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

Specifies a value of the API key.

pub fn stage_keys(self, input: StageKey) -> Self

Appends an item to stageKeys.

To override the contents of this collection use set_stage_keys.

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

pub fn set_stage_keys(self, input: Option<Vec<StageKey>>) -> Self

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

pub fn customer_id(self, input: impl Into<String>) -> Self

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

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

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to tags.

To override the contents of this collection use set_tags.

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

pub fn set_tags(self, input: Option<HashMap<String, String>>) -> Self

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for CreateApiKey<C, M, R>

fn clone(&self) -> CreateApiKey<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for CreateApiKey<C, M, R>

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

Formats the value using the given formatter.