@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ApiKey extends Object implements Serializable, Cloneable, StructuredPojo
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.
| Constructor and Description |
|---|
ApiKey() |
| Modifier and Type | Method and Description |
|---|---|
ApiKey |
clone() |
boolean |
equals(Object obj) |
Long |
getDeletes()
The time after which the API key is deleted.
|
String |
getDescription()
A description of the purpose of the API key.
|
Long |
getExpires()
The time after which the API key expires.
|
String |
getId()
The API key ID.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller. |
void |
setDeletes(Long deletes)
The time after which the API key is deleted.
|
void |
setDescription(String description)
A description of the purpose of the API key.
|
void |
setExpires(Long expires)
The time after which the API key expires.
|
void |
setId(String id)
The API key ID.
|
String |
toString()
Returns a string representation of this object.
|
ApiKey |
withDeletes(Long deletes)
The time after which the API key is deleted.
|
ApiKey |
withDescription(String description)
A description of the purpose of the API key.
|
ApiKey |
withExpires(Long expires)
The time after which the API key expires.
|
ApiKey |
withId(String id)
The API key ID.
|
public void setId(String id)
The API key ID.
id - The API key ID.public String getId()
The API key ID.
public ApiKey withId(String id)
The API key ID.
id - The API key ID.public void setDescription(String description)
A description of the purpose of the API key.
description - A description of the purpose of the API key.public String getDescription()
A description of the purpose of the API key.
public ApiKey withDescription(String description)
A description of the purpose of the API key.
description - A description of the purpose of the API key.public void setExpires(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.
expires - The time after which the API key expires. The date is represented as seconds since the epoch, rounded down
to the nearest hour.public Long getExpires()
The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.
public ApiKey withExpires(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.
expires - The time after which the API key expires. The date is represented as seconds since the epoch, rounded down
to the nearest hour.public void setDeletes(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.
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.public Long getDeletes()
The time after which the API key is deleted. The date is represented as seconds since the epoch, rounded down to the nearest hour.
public ApiKey withDeletes(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.
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.public String toString()
toString in class ObjectObject.toString()public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojoProtocolMarshaller.marshall in interface StructuredPojoprotocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.