ApiKey (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.appsync.model.ApiKey

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ApiKey
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ApiKey()

Constructors
Constructor and Description
`ApiKey()`

Method Summary

All Methods Instance Methods Concrete Methods
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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ApiKey
```
public ApiKey()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The API key ID.
    
    Parameters:
    
    id - The API key ID.
  - getId
```
public String getId()
```
    The API key ID.
    
    Returns:
    
    The API key ID.
  - withId
```
public ApiKey withId(String id)
```
    The API key ID.
    
    Parameters:
    
    id - The API key ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description of the purpose of the API key.
    
    Parameters:
    
    description - A description of the purpose of the API key.
  - getDescription
```
public String getDescription()
```
    A description of the purpose of the API key.
    
    Returns:
    
    A description of the purpose of the API key.
  - withDescription
```
public ApiKey withDescription(String description)
```
    A description of the purpose of the API key.
    
    Parameters:
    
    description - A description of the purpose of the API key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExpires
```
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.
    
    Parameters:
    
    expires - The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.
  - getExpires
```
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.
    
    Returns:
    
    The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.
  - withExpires
```
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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeletes
```
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.
    
    Parameters:
    
    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.
  - getDeletes
```
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.
    
    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.
  - withDeletes
```
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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ApiKey clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ApiKey

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ApiKey

Method Detail

setId

getId

withId

setDescription

getDescription

withDescription

setExpires

getExpires

withExpires

setDeletes

getDeletes

withDeletes

toString

equals

hashCode

clone

marshall