software.amazon.awssdk.services.appsync.model

Class ApiKey

java.lang.Object

software.amazon.awssdk.services.appsync.model.ApiKey

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ApiKey.Builder,ApiKey>

@Generated(value="software.amazon.awssdk:codegen")
public final class ApiKey
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ApiKey.Builder,ApiKey>

Describes an API key.

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

da1: This version was introduced at launch in November 2017. These keys always expire after 7 days. Key expiration is managed by Amazon DynamoDB TTL. The keys ceased to be valid after February 21, 2018 and should not be used after that date.

• 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 Amazon 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 will delete these keys from the table after February 21, 2018.

da2: This version was introduced 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. Key expiration time can be updated while the key is not deleted.

• DeleteApiKey deletes the item from the table.

• Expiration is stored in Amazon DynamoDB as seconds. After the expiration time, using the key to authenticate will fail. But the key can be reinstated before deletion.

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ApiKey.Builder

Method Summary

Modifier and Type	Method and Description
static ApiKey.Builder	builder()
Long	deletes() The time after which the API key is deleted.
String	description() A description of the purpose of the API key.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Long	expires() The time after which the API key expires.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() The API key ID.
List<SdkField<?>>	sdkFields()
static Class<? extends ApiKey.Builder>	serializableBuilderClass()
ApiKey.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

id

public final String id()

The API key ID.

Returns:

The API key ID.

description

public final String description()

A description of the purpose of the API key.

Returns:

A description of the purpose of the API key.

expires

public final Long expires()

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

Returns:

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

deletes

public final Long deletes()

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

Returns:

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

toBuilder

public ApiKey.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ApiKey.Builder,ApiKey>

builder

public static ApiKey.Builder builder()

serializableBuilderClass

public static Class<? extends ApiKey.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo