Struct aws_sdk_apigateway::types::ApiKey

#[non_exhaustive]
pub struct ApiKey {
    pub id: Option<String>,
    pub value: Option<String>,
    pub name: Option<String>,
    pub customer_id: Option<String>,
    pub description: Option<String>,
    pub enabled: bool,
    pub created_date: Option<DateTime>,
    pub last_updated_date: Option<DateTime>,
    pub stage_keys: Option<Vec<String>>,
    pub tags: Option<HashMap<String, String>>,
}

A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.

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.

id: Option<String>

The identifier of the API Key.

value: Option<String>

The value of the API Key.

name: Option<String>

The name of the API Key.

customer_id: Option<String>

An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.

description: Option<String>

The description of the API Key.

enabled: bool

Specifies whether the API Key can be used by callers.

created_date: Option<DateTime>

The timestamp when the API Key was created.

last_updated_date: Option<DateTime>

The timestamp when the API Key was last updated.

stage_keys: Option<Vec<String>>

A list of Stage resources that are associated with the ApiKey resource.

tags: Option<HashMap<String, String>>

The collection of tags. Each tag element is associated with a given resource.

Implementations

impl ApiKey

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

The identifier of the API Key.

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

The value of the API Key.

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

The name of the API Key.

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

An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.

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

The description of the API Key.

pub fn enabled(&self) -> bool

Specifies whether the API Key can be used by callers.

pub fn created_date(&self) -> Option<&DateTime>

The timestamp when the API Key was created.

pub fn last_updated_date(&self) -> Option<&DateTime>

The timestamp when the API Key was last updated.

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

A list of Stage resources that are associated with the ApiKey resource.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .stage_keys.is_none().

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

The collection of tags. Each tag element is associated with a given resource.

impl ApiKey

pub fn builder() -> ApiKeyBuilder

Creates a new builder-style object to manufacture ApiKey.

Trait Implementations

impl Clone for ApiKey

fn clone(&self) -> ApiKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ApiKey

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

Formats the value using the given formatter.

impl PartialEq for ApiKey

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