* Contains metadata about an KMS key. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AwsKmsKeyDetails implements Serializable, Cloneable, StructuredPojo { /** ** The twelve-digit account ID of the Amazon Web Services account that owns the KMS key. *
*/ private String aWSAccountId; /** ** Indicates when the KMS key was created. *
*
* Uses the date-time format specified in RFC
* 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be
* separated by T. For example, 2020-03-22T13:22:13.933Z.
*
* The globally unique identifier for the KMS key. *
*/ private String keyId; /** ** The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon * Web Services managed. *
*/ private String keyManager; /** ** The state of the KMS key. Valid values are as follows: *
*
* Disabled
*
* Enabled
*
* PendingDeletion
*
* PendingImport
*
* Unavailable
*
* The source of the KMS key material. *
*
* When this value is AWS_KMS, KMS created the key material.
*
* When this value is EXTERNAL, the key material was imported from your existing key management
* infrastructure or the KMS key lacks key material.
*
* When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated
* with a custom key store.
*
* A description of the KMS key. *
*/ private String description; /** ** Whether the key has key rotation enabled. *
*/ private Boolean keyRotationStatus; /** ** The twelve-digit account ID of the Amazon Web Services account that owns the KMS key. *
* * @param aWSAccountId * The twelve-digit account ID of the Amazon Web Services account that owns the KMS key. */ public void setAWSAccountId(String aWSAccountId) { this.aWSAccountId = aWSAccountId; } /** ** The twelve-digit account ID of the Amazon Web Services account that owns the KMS key. *
* * @return The twelve-digit account ID of the Amazon Web Services account that owns the KMS key. */ public String getAWSAccountId() { return this.aWSAccountId; } /** ** The twelve-digit account ID of the Amazon Web Services account that owns the KMS key. *
* * @param aWSAccountId * The twelve-digit account ID of the Amazon Web Services account that owns the KMS key. * @return Returns a reference to this object so that method calls can be chained together. */ public AwsKmsKeyDetails withAWSAccountId(String aWSAccountId) { setAWSAccountId(aWSAccountId); return this; } /** ** Indicates when the KMS key was created. *
*
* Uses the date-time format specified in RFC
* 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be
* separated by T. For example, 2020-03-22T13:22:13.933Z.
*
* Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
* Format. The value cannot contain spaces, and date and time should be separated by T. For
* example, 2020-03-22T13:22:13.933Z.
*/
public void setCreationDate(Double creationDate) {
this.creationDate = creationDate;
}
/**
*
* Indicates when the KMS key was created. *
*
* Uses the date-time format specified in RFC
* 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be
* separated by T. For example, 2020-03-22T13:22:13.933Z.
*
* Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
* Format. The value cannot contain spaces, and date and time should be separated by T. For
* example, 2020-03-22T13:22:13.933Z.
*/
public Double getCreationDate() {
return this.creationDate;
}
/**
*
* Indicates when the KMS key was created. *
*
* Uses the date-time format specified in RFC
* 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be
* separated by T. For example, 2020-03-22T13:22:13.933Z.
*
* Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
* Format. The value cannot contain spaces, and date and time should be separated by T. For
* example, 2020-03-22T13:22:13.933Z.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AwsKmsKeyDetails withCreationDate(Double creationDate) {
setCreationDate(creationDate);
return this;
}
/**
*
* The globally unique identifier for the KMS key. *
* * @param keyId * The globally unique identifier for the KMS key. */ public void setKeyId(String keyId) { this.keyId = keyId; } /** ** The globally unique identifier for the KMS key. *
* * @return The globally unique identifier for the KMS key. */ public String getKeyId() { return this.keyId; } /** ** The globally unique identifier for the KMS key. *
* * @param keyId * The globally unique identifier for the KMS key. * @return Returns a reference to this object so that method calls can be chained together. */ public AwsKmsKeyDetails withKeyId(String keyId) { setKeyId(keyId); return this; } /** ** The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon * Web Services managed. *
* * @param keyManager * The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or * Amazon Web Services managed. */ public void setKeyManager(String keyManager) { this.keyManager = keyManager; } /** ** The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon * Web Services managed. *
* * @return The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or * Amazon Web Services managed. */ public String getKeyManager() { return this.keyManager; } /** ** The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon * Web Services managed. *
* * @param keyManager * The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or * Amazon Web Services managed. * @return Returns a reference to this object so that method calls can be chained together. */ public AwsKmsKeyDetails withKeyManager(String keyManager) { setKeyManager(keyManager); return this; } /** ** The state of the KMS key. Valid values are as follows: *
*
* Disabled
*
* Enabled
*
* PendingDeletion
*
* PendingImport
*
* Unavailable
*
* Disabled
*
* Enabled
*
* PendingDeletion
*
* PendingImport
*
* Unavailable
*
* The state of the KMS key. Valid values are as follows: *
*
* Disabled
*
* Enabled
*
* PendingDeletion
*
* PendingImport
*
* Unavailable
*
* Disabled
*
* Enabled
*
* PendingDeletion
*
* PendingImport
*
* Unavailable
*
* The state of the KMS key. Valid values are as follows: *
*
* Disabled
*
* Enabled
*
* PendingDeletion
*
* PendingImport
*
* Unavailable
*
* Disabled
*
* Enabled
*
* PendingDeletion
*
* PendingImport
*
* Unavailable
*
* The source of the KMS key material. *
*
* When this value is AWS_KMS, KMS created the key material.
*
* When this value is EXTERNAL, the key material was imported from your existing key management
* infrastructure or the KMS key lacks key material.
*
* When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated
* with a custom key store.
*
* When this value is AWS_KMS, KMS created the key material.
*
* When this value is EXTERNAL, the key material was imported from your existing key management
* infrastructure or the KMS key lacks key material.
*
* When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster
* associated with a custom key store.
*/
public void setOrigin(String origin) {
this.origin = origin;
}
/**
*
* The source of the KMS key material. *
*
* When this value is AWS_KMS, KMS created the key material.
*
* When this value is EXTERNAL, the key material was imported from your existing key management
* infrastructure or the KMS key lacks key material.
*
* When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated
* with a custom key store.
*
* When this value is AWS_KMS, KMS created the key material.
*
* When this value is EXTERNAL, the key material was imported from your existing key management
* infrastructure or the KMS key lacks key material.
*
* When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster
* associated with a custom key store.
*/
public String getOrigin() {
return this.origin;
}
/**
*
* The source of the KMS key material. *
*
* When this value is AWS_KMS, KMS created the key material.
*
* When this value is EXTERNAL, the key material was imported from your existing key management
* infrastructure or the KMS key lacks key material.
*
* When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated
* with a custom key store.
*
* When this value is AWS_KMS, KMS created the key material.
*
* When this value is EXTERNAL, the key material was imported from your existing key management
* infrastructure or the KMS key lacks key material.
*
* When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster
* associated with a custom key store.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AwsKmsKeyDetails withOrigin(String origin) {
setOrigin(origin);
return this;
}
/**
*
* A description of the KMS key. *
* * @param description * A description of the KMS key. */ public void setDescription(String description) { this.description = description; } /** ** A description of the KMS key. *
* * @return A description of the KMS key. */ public String getDescription() { return this.description; } /** ** A description of the KMS key. *
* * @param description * A description of the KMS key. * @return Returns a reference to this object so that method calls can be chained together. */ public AwsKmsKeyDetails withDescription(String description) { setDescription(description); return this; } /** ** Whether the key has key rotation enabled. *
* * @param keyRotationStatus * Whether the key has key rotation enabled. */ public void setKeyRotationStatus(Boolean keyRotationStatus) { this.keyRotationStatus = keyRotationStatus; } /** ** Whether the key has key rotation enabled. *
* * @return Whether the key has key rotation enabled. */ public Boolean getKeyRotationStatus() { return this.keyRotationStatus; } /** ** Whether the key has key rotation enabled. *
* * @param keyRotationStatus * Whether the key has key rotation enabled. * @return Returns a reference to this object so that method calls can be chained together. */ public AwsKmsKeyDetails withKeyRotationStatus(Boolean keyRotationStatus) { setKeyRotationStatus(keyRotationStatus); return this; } /** ** Whether the key has key rotation enabled. *
* * @return Whether the key has key rotation enabled. */ public Boolean isKeyRotationStatus() { return this.keyRotationStatus; } /** * 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 (getAWSAccountId() != null) sb.append("AWSAccountId: ").append(getAWSAccountId()).append(","); if (getCreationDate() != null) sb.append("CreationDate: ").append(getCreationDate()).append(","); if (getKeyId() != null) sb.append("KeyId: ").append(getKeyId()).append(","); if (getKeyManager() != null) sb.append("KeyManager: ").append(getKeyManager()).append(","); if (getKeyState() != null) sb.append("KeyState: ").append(getKeyState()).append(","); if (getOrigin() != null) sb.append("Origin: ").append(getOrigin()).append(","); if (getDescription() != null) sb.append("Description: ").append(getDescription()).append(","); if (getKeyRotationStatus() != null) sb.append("KeyRotationStatus: ").append(getKeyRotationStatus()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof AwsKmsKeyDetails == false) return false; AwsKmsKeyDetails other = (AwsKmsKeyDetails) obj; if (other.getAWSAccountId() == null ^ this.getAWSAccountId() == null) return false; if (other.getAWSAccountId() != null && other.getAWSAccountId().equals(this.getAWSAccountId()) == false) return false; if (other.getCreationDate() == null ^ this.getCreationDate() == null) return false; if (other.getCreationDate() != null && other.getCreationDate().equals(this.getCreationDate()) == false) return false; if (other.getKeyId() == null ^ this.getKeyId() == null) return false; if (other.getKeyId() != null && other.getKeyId().equals(this.getKeyId()) == false) return false; if (other.getKeyManager() == null ^ this.getKeyManager() == null) return false; if (other.getKeyManager() != null && other.getKeyManager().equals(this.getKeyManager()) == false) return false; if (other.getKeyState() == null ^ this.getKeyState() == null) return false; if (other.getKeyState() != null && other.getKeyState().equals(this.getKeyState()) == false) return false; if (other.getOrigin() == null ^ this.getOrigin() == null) return false; if (other.getOrigin() != null && other.getOrigin().equals(this.getOrigin()) == false) return false; if (other.getDescription() == null ^ this.getDescription() == null) return false; if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false) return false; if (other.getKeyRotationStatus() == null ^ this.getKeyRotationStatus() == null) return false; if (other.getKeyRotationStatus() != null && other.getKeyRotationStatus().equals(this.getKeyRotationStatus()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getAWSAccountId() == null) ? 0 : getAWSAccountId().hashCode()); hashCode = prime * hashCode + ((getCreationDate() == null) ? 0 : getCreationDate().hashCode()); hashCode = prime * hashCode + ((getKeyId() == null) ? 0 : getKeyId().hashCode()); hashCode = prime * hashCode + ((getKeyManager() == null) ? 0 : getKeyManager().hashCode()); hashCode = prime * hashCode + ((getKeyState() == null) ? 0 : getKeyState().hashCode()); hashCode = prime * hashCode + ((getOrigin() == null) ? 0 : getOrigin().hashCode()); hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode()); hashCode = prime * hashCode + ((getKeyRotationStatus() == null) ? 0 : getKeyRotationStatus().hashCode()); return hashCode; } @Override public AwsKmsKeyDetails clone() { try { return (AwsKmsKeyDetails) 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.securityhub.model.transform.AwsKmsKeyDetailsMarshaller.getInstance().marshall(this, protocolMarshaller); } }