AccessKey (AWS Java SDK for Amazon Lightsail 1.12.336 API)

java.lang.Object
- com.amazonaws.services.lightsail.model.AccessKey

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AccessKey
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes an access key for an Amazon Lightsail bucket.

Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the CreateBucketAccessKey action to create an access key for a specific bucket. For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.

The secretAccessKey value is returned only in response to the CreateBucketAccessKey action. You can get a secret access key only when you first create an access key; you cannot get the secret access key later. If you lose the secret access key, you must create a new access key.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AccessKey()

Constructors
Constructor and Description
`AccessKey()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AccessKey`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAccessKeyId()` The ID of the access key.
`Date`	`getCreatedAt()` The timestamp when the access key was created.
`AccessKeyLastUsed`	`getLastUsed()` An object that describes the last time the access key was used.
`String`	`getSecretAccessKey()` The secret access key used to sign requests.
`String`	`getStatus()` The status of the access key.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setAccessKeyId(String accessKeyId)` The ID of the access key.
`void`	`setCreatedAt(Date createdAt)` The timestamp when the access key was created.
`void`	`setLastUsed(AccessKeyLastUsed lastUsed)` An object that describes the last time the access key was used.
`void`	`setSecretAccessKey(String secretAccessKey)` The secret access key used to sign requests.
`void`	`setStatus(String status)` The status of the access key.
`String`	`toString()` Returns a string representation of this object.
`AccessKey`	`withAccessKeyId(String accessKeyId)` The ID of the access key.
`AccessKey`	`withCreatedAt(Date createdAt)` The timestamp when the access key was created.
`AccessKey`	`withLastUsed(AccessKeyLastUsed lastUsed)` An object that describes the last time the access key was used.
`AccessKey`	`withSecretAccessKey(String secretAccessKey)` The secret access key used to sign requests.
`AccessKey`	`withStatus(StatusType status)` The status of the access key.
`AccessKey`	`withStatus(String status)` The status of the access key.

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

- Constructor Detail
  - AccessKey
```
public AccessKey()
```
- Method Detail
  - setAccessKeyId
```
public void setAccessKeyId(String accessKeyId)
```
    The ID of the access key.
    
    Parameters:
    
    accessKeyId - The ID of the access key.
  - getAccessKeyId
```
public String getAccessKeyId()
```
    The ID of the access key.
    
    Returns:
    
    The ID of the access key.
  - withAccessKeyId
```
public AccessKey withAccessKeyId(String accessKeyId)
```
    The ID of the access key.
    
    Parameters:
    
    accessKeyId - The ID of the access key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSecretAccessKey
```
public void setSecretAccessKey(String secretAccessKey)
```
    The secret access key used to sign requests.
    
    You should store the secret access key in a safe location. We recommend that you delete the access key if the secret access key is compromised.
    
    Parameters:
    
    secretAccessKey - The secret access key used to sign requests.
    
    You should store the secret access key in a safe location. We recommend that you delete the access key if the secret access key is compromised.
  - getSecretAccessKey
```
public String getSecretAccessKey()
```
    The secret access key used to sign requests.
    
    You should store the secret access key in a safe location. We recommend that you delete the access key if the secret access key is compromised.
    
    Returns:
    
    The secret access key used to sign requests.
    
    You should store the secret access key in a safe location. We recommend that you delete the access key if the secret access key is compromised.
  - withSecretAccessKey
```
public AccessKey withSecretAccessKey(String secretAccessKey)
```
    The secret access key used to sign requests.
    
    You should store the secret access key in a safe location. We recommend that you delete the access key if the secret access key is compromised.
    
    Parameters:
    
    secretAccessKey - The secret access key used to sign requests.
    
    You should store the secret access key in a safe location. We recommend that you delete the access key if the secret access key is compromised.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of the access key.
    
    A status of Active means that the key is valid, while Inactive means it is not.
    
    Parameters:
    
    status - The status of the access key.
    
    A status of Active means that the key is valid, while Inactive means it is not.
    
    See Also:
    
    StatusType
  - getStatus
```
public String getStatus()
```
    The status of the access key.
    
    A status of Active means that the key is valid, while Inactive means it is not.
    
    Returns:
    
    The status of the access key.
    
    A status of Active means that the key is valid, while Inactive means it is not.
    
    See Also:
    
    StatusType
  - withStatus
```
public AccessKey withStatus(String status)
```
    The status of the access key.
    
    A status of Active means that the key is valid, while Inactive means it is not.
    
    Parameters:
    
    status - The status of the access key.
    
    A status of Active means that the key is valid, while Inactive means it is not.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StatusType
  - withStatus
```
public AccessKey withStatus(StatusType status)
```
    The status of the access key.
    
    A status of Active means that the key is valid, while Inactive means it is not.
    
    Parameters:
    
    status - The status of the access key.
    
    A status of Active means that the key is valid, while Inactive means it is not.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StatusType
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The timestamp when the access key was created.
    
    Parameters:
    
    createdAt - The timestamp when the access key was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The timestamp when the access key was created.
    
    Returns:
    
    The timestamp when the access key was created.
  - withCreatedAt
```
public AccessKey withCreatedAt(Date createdAt)
```
    The timestamp when the access key was created.
    
    Parameters:
    
    createdAt - The timestamp when the access key was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUsed
```
public void setLastUsed(AccessKeyLastUsed lastUsed)
```
    An object that describes the last time the access key was used.
    
    This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the region and serviceName values are N/A, and the lastUsedDate value is null.
    
    Parameters:
    
    lastUsed - An object that describes the last time the access key was used.
    
    This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the region and serviceName values are N/A, and the lastUsedDate value is null.
  - getLastUsed
```
public AccessKeyLastUsed getLastUsed()
```
    An object that describes the last time the access key was used.
    
    This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the region and serviceName values are N/A, and the lastUsedDate value is null.
    
    Returns:
    
    An object that describes the last time the access key was used.
    
    This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the region and serviceName values are N/A, and the lastUsedDate value is null.
  - withLastUsed
```
public AccessKey withLastUsed(AccessKeyLastUsed lastUsed)
```
    An object that describes the last time the access key was used.
    
    This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the region and serviceName values are N/A, and the lastUsedDate value is null.
    
    Parameters:
    
    lastUsed - An object that describes the last time the access key was used.
    
    This object does not include data in the response of a CreateBucketAccessKey action. If the access key has not been used, the region and serviceName values are N/A, and the lastUsedDate value is null.
    
    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 AccessKey clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class AccessKey

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AccessKey

Method Detail

setAccessKeyId

getAccessKeyId

withAccessKeyId

setSecretAccessKey

getSecretAccessKey

withSecretAccessKey

setStatus

getStatus

withStatus

withStatus

setCreatedAt

getCreatedAt

withCreatedAt

setLastUsed

getLastUsed

withLastUsed

toString

equals

hashCode

clone

marshall