Struct ApiKey

#[non_exhaustive]
pub struct ApiKey {
    pub id: Option<String>,
    pub description: Option<String>,
    pub expires: i64,
    pub deletes: i64,
}

Describes an API key.

Customers invoke AppSync GraphQL API operations with API keys as an identity mechanism. There are two key versions:

da1: We introduced this version at launch in November 2017. These keys always expire after 7 days. Amazon DynamoDB TTL manages key expiration. These keys ceased to be valid after February 21, 2018, and they should no longer be used.

• ListApiKeys returns the expiration time in milliseconds.

• CreateApiKey returns the expiration time in milliseconds.

• UpdateApiKey is not available for this key version.

• DeleteApiKey deletes the item from the table.

• Expiration is stored in DynamoDB as milliseconds. This results in a bug where keys are not automatically deleted because DynamoDB expects the TTL to be stored in seconds. As a one-time action, we deleted these keys from the table on February 21, 2018.

da2: We introduced this version in February 2018 when AppSync added support to extend key expiration.

• ListApiKeys returns the expiration time and deletion time in seconds.

• CreateApiKey returns the expiration time and deletion time in seconds and accepts a user-provided expiration time in seconds.

• UpdateApiKey returns the expiration time and and deletion time in seconds and accepts a user-provided expiration time in seconds. Expired API keys are kept for 60 days after the expiration time. You can update the key expiration time as long as the key isn't deleted.

• DeleteApiKey deletes the item from the table.

• Expiration is stored in DynamoDB as seconds. After the expiration time, using the key to authenticate will fail. However, you can reinstate the key before deletion.

• Deletion is stored in DynamoDB as seconds. The key is deleted after deletion time.

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 API key ID.

description: Option<String>

A description of the purpose of the API key.

expires: i64

The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.

deletes: i64

The time after which the API key is deleted. The date is represented as seconds since the epoch, rounded down to the nearest hour.

Implementations

impl ApiKey

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

The API key ID.

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

A description of the purpose of the API key.

pub fn expires(&self) -> i64

The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.

pub fn deletes(&self) -> i64

The time after which the API key is deleted. The date is represented as seconds since the epoch, rounded down to the nearest hour.

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 duplicate 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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ApiKey