com.amazonaws.services.lightsail.model.AccessKey Maven / Gradle / Ivy
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.lightsail.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* 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 AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AccessKey implements Serializable, Cloneable, StructuredPojo {
/**
*
* The ID of the access key.
*
*/
private String accessKeyId;
/**
*
* 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.
*
*/
private String secretAccessKey;
/**
*
* The status of the access key.
*
*
* A status of Active means that the key is valid, while Inactive means it is not.
*
*/
private String status;
/**
*
* The timestamp when the access key was created.
*
*/
private java.util.Date createdAt;
/**
*
* 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.
*
*
*/
private AccessKeyLastUsed lastUsed;
/**
*
* The ID of the access key.
*
*
* @param accessKeyId
* The ID of the access key.
*/
public void setAccessKeyId(String accessKeyId) {
this.accessKeyId = accessKeyId;
}
/**
*
* The ID of the access key.
*
*
* @return The ID of the access key.
*/
public String getAccessKeyId() {
return this.accessKeyId;
}
/**
*
* The ID of the access key.
*
*
* @param accessKeyId
* The ID of the access key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AccessKey withAccessKeyId(String accessKeyId) {
setAccessKeyId(accessKeyId);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setSecretAccessKey(String secretAccessKey) {
this.secretAccessKey = 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.
*
*
* @return 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.
*/
public String getSecretAccessKey() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AccessKey withSecretAccessKey(String secretAccessKey) {
setSecretAccessKey(secretAccessKey);
return this;
}
/**
*
* The status of the access key.
*
*
* A status of Active means that the key is valid, while Inactive means it is not.
*
*
* @param status
* The status of the access key.
*
* A status of Active means that the key is valid, while Inactive means it is not.
* @see StatusType
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The status of the access key.
*
*
* A status of Active means that the key is valid, while Inactive means it is not.
*
*
* @return The status of the access key.
*
* A status of Active means that the key is valid, while Inactive means it is not.
* @see StatusType
*/
public String getStatus() {
return this.status;
}
/**
*
* The status of the access key.
*
*
* A status of Active means that the key is valid, while Inactive means it is not.
*
*
* @param status
* The status of the access key.
*
* A status of Active means that the key is valid, while Inactive means it is not.
* @return Returns a reference to this object so that method calls can be chained together.
* @see StatusType
*/
public AccessKey withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The status of the access key.
*
*
* A status of Active means that the key is valid, while Inactive means it is not.
*
*
* @param status
* The status of the access key.
*
* A status of Active means that the key is valid, while Inactive means it is not.
* @return Returns a reference to this object so that method calls can be chained together.
* @see StatusType
*/
public AccessKey withStatus(StatusType status) {
this.status = status.toString();
return this;
}
/**
*
* The timestamp when the access key was created.
*
*
* @param createdAt
* The timestamp when the access key was created.
*/
public void setCreatedAt(java.util.Date createdAt) {
this.createdAt = createdAt;
}
/**
*
* The timestamp when the access key was created.
*
*
* @return The timestamp when the access key was created.
*/
public java.util.Date getCreatedAt() {
return this.createdAt;
}
/**
*
* The timestamp when the access key was created.
*
*
* @param createdAt
* The timestamp when the access key was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AccessKey withCreatedAt(java.util.Date createdAt) {
setCreatedAt(createdAt);
return this;
}
/**
*
* 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.
*
*
*
* @param 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.
*
*/
public void setLastUsed(AccessKeyLastUsed lastUsed) {
this.lastUsed = 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.
*
*
*
* @return 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.
*
*/
public AccessKeyLastUsed getLastUsed() {
return this.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.
*
*
*
* @param 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AccessKey withLastUsed(AccessKeyLastUsed lastUsed) {
setLastUsed(lastUsed);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getAccessKeyId() != null)
sb.append("AccessKeyId: ").append("***Sensitive Data Redacted***").append(",");
if (getSecretAccessKey() != null)
sb.append("SecretAccessKey: ").append(getSecretAccessKey()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getCreatedAt() != null)
sb.append("CreatedAt: ").append(getCreatedAt()).append(",");
if (getLastUsed() != null)
sb.append("LastUsed: ").append(getLastUsed());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof AccessKey == false)
return false;
AccessKey other = (AccessKey) obj;
if (other.getAccessKeyId() == null ^ this.getAccessKeyId() == null)
return false;
if (other.getAccessKeyId() != null && other.getAccessKeyId().equals(this.getAccessKeyId()) == false)
return false;
if (other.getSecretAccessKey() == null ^ this.getSecretAccessKey() == null)
return false;
if (other.getSecretAccessKey() != null && other.getSecretAccessKey().equals(this.getSecretAccessKey()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getCreatedAt() == null ^ this.getCreatedAt() == null)
return false;
if (other.getCreatedAt() != null && other.getCreatedAt().equals(this.getCreatedAt()) == false)
return false;
if (other.getLastUsed() == null ^ this.getLastUsed() == null)
return false;
if (other.getLastUsed() != null && other.getLastUsed().equals(this.getLastUsed()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAccessKeyId() == null) ? 0 : getAccessKeyId().hashCode());
hashCode = prime * hashCode + ((getSecretAccessKey() == null) ? 0 : getSecretAccessKey().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getCreatedAt() == null) ? 0 : getCreatedAt().hashCode());
hashCode = prime * hashCode + ((getLastUsed() == null) ? 0 : getLastUsed().hashCode());
return hashCode;
}
@Override
public AccessKey clone() {
try {
return (AccessKey) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.lightsail.model.transform.AccessKeyMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}