Class AccessKey
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AccessKey.Builder,
AccessKey>
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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The ID of the access key.static AccessKey.Builder
builder()
final Instant
The timestamp when the access key was created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final AccessKeyLastUsed
lastUsed()
An object that describes the last time the access key was used.final String
The secret access key used to sign requests.static Class
<? extends AccessKey.Builder> final StatusType
status()
The status of the access key.final String
The status of the access key.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
accessKeyId
The ID of the access key.
- Returns:
- The ID of the access key.
-
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:
- 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.
-
status
The status of the access key.
A status of
Active
means that the key is valid, whileInactive
means it is not.If the service returns an enum value that is not available in the current SDK version,
status
will returnStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the access key.
A status of
Active
means that the key is valid, whileInactive
means it is not. - See Also:
-
statusAsString
The status of the access key.
A status of
Active
means that the key is valid, whileInactive
means it is not.If the service returns an enum value that is not available in the current SDK version,
status
will returnStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the access key.
A status of
Active
means that the key is valid, whileInactive
means it is not. - See Also:
-
createdAt
The timestamp when the access key was created.
- Returns:
- The timestamp when the access key was created.
-
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
andserviceName
values areN/A
, and thelastUsedDate
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
andserviceName
values areN/A
, and thelastUsedDate
value is null.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AccessKey.Builder,
AccessKey> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-