Struct aws_sdk_apigateway::operation::create_api_key::CreateApiKeyInput

#[non_exhaustive]
pub struct CreateApiKeyInput {
    pub name: Option<String>,
    pub description: Option<String>,
    pub enabled: bool,
    pub generate_distinct_id: bool,
    pub value: Option<String>,
    pub stage_keys: Option<Vec<StageKey>>,
    pub customer_id: Option<String>,
    pub tags: Option<HashMap<String, String>>,
}

Request to create an ApiKey resource.

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.

name: Option<String>

The name of the ApiKey.

description: Option<String>

The description of the ApiKey.

enabled: bool

Specifies whether the ApiKey can be used by callers.

generate_distinct_id: bool

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.

value: Option<String>

Specifies a value of the API key.

stage_keys: Option<Vec<StageKey>>

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

customer_id: Option<String>

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

tags: Option<HashMap<String, String>>

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.

Implementations

impl CreateApiKeyInput

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

The name of the ApiKey.

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

The description of the ApiKey.

pub fn enabled(&self) -> bool

Specifies whether the ApiKey can be used by callers.

pub fn generate_distinct_id(&self) -> bool

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) -> Option<&str>

Specifies a value of the API key.

pub fn stage_keys(&self) -> Option<&[StageKey]>

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

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

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

pub fn tags(&self) -> Option<&HashMap<String, String>>

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.

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<CreateApiKeyInput> for CreateApiKeyInput

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