com.amazonaws.services.ec2.model.KeyPair Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2019-2024 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.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* Describes a key pair.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class KeyPair implements Serializable, Cloneable {
/**
*
* -
*
* For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
*
*
* -
*
* For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for
* OpenSSH, starting with OpenSSH 6.8.
*
*
*
*/
private String keyFingerprint;
/**
*
* An unencrypted PEM encoded RSA or ED25519 private key.
*
*/
private String keyMaterial;
/**
*
* The name of the key pair.
*
*/
private String keyName;
/**
*
* The ID of the key pair.
*
*/
private String keyPairId;
/**
*
* Any tags applied to the key pair.
*
*/
private com.amazonaws.internal.SdkInternalList tags;
/**
*
* -
*
* For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
*
*
* -
*
* For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for
* OpenSSH, starting with OpenSSH 6.8.
*
*
*
*
* @param keyFingerprint
*
*
* For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
*
*
*
* For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for
* OpenSSH, starting with OpenSSH 6.8.
*
*
*/
public void setKeyFingerprint(String keyFingerprint) {
this.keyFingerprint = keyFingerprint;
}
/**
*
* -
*
* For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
*
*
* -
*
* For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for
* OpenSSH, starting with OpenSSH 6.8.
*
*
*
*
* @return
*
* For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
*
*
*
* For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for
* OpenSSH, starting with OpenSSH 6.8.
*
*
*/
public String getKeyFingerprint() {
return this.keyFingerprint;
}
/**
*
* -
*
* For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
*
*
* -
*
* For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for
* OpenSSH, starting with OpenSSH 6.8.
*
*
*
*
* @param keyFingerprint
*
*
* For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
*
*
*
* For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for
* OpenSSH, starting with OpenSSH 6.8.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KeyPair withKeyFingerprint(String keyFingerprint) {
setKeyFingerprint(keyFingerprint);
return this;
}
/**
*
* An unencrypted PEM encoded RSA or ED25519 private key.
*
*
* @param keyMaterial
* An unencrypted PEM encoded RSA or ED25519 private key.
*/
public void setKeyMaterial(String keyMaterial) {
this.keyMaterial = keyMaterial;
}
/**
*
* An unencrypted PEM encoded RSA or ED25519 private key.
*
*
* @return An unencrypted PEM encoded RSA or ED25519 private key.
*/
public String getKeyMaterial() {
return this.keyMaterial;
}
/**
*
* An unencrypted PEM encoded RSA or ED25519 private key.
*
*
* @param keyMaterial
* An unencrypted PEM encoded RSA or ED25519 private key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KeyPair withKeyMaterial(String keyMaterial) {
setKeyMaterial(keyMaterial);
return this;
}
/**
*
* The name of the key pair.
*
*
* @param keyName
* The name of the key pair.
*/
public void setKeyName(String keyName) {
this.keyName = keyName;
}
/**
*
* The name of the key pair.
*
*
* @return The name of the key pair.
*/
public String getKeyName() {
return this.keyName;
}
/**
*
* The name of the key pair.
*
*
* @param keyName
* The name of the key pair.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KeyPair withKeyName(String keyName) {
setKeyName(keyName);
return this;
}
/**
*
* The ID of the key pair.
*
*
* @param keyPairId
* The ID of the key pair.
*/
public void setKeyPairId(String keyPairId) {
this.keyPairId = keyPairId;
}
/**
*
* The ID of the key pair.
*
*
* @return The ID of the key pair.
*/
public String getKeyPairId() {
return this.keyPairId;
}
/**
*
* The ID of the key pair.
*
*
* @param keyPairId
* The ID of the key pair.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KeyPair withKeyPairId(String keyPairId) {
setKeyPairId(keyPairId);
return this;
}
/**
*
* Any tags applied to the key pair.
*
*
* @return Any tags applied to the key pair.
*/
public java.util.List getTags() {
if (tags == null) {
tags = new com.amazonaws.internal.SdkInternalList();
}
return tags;
}
/**
*
* Any tags applied to the key pair.
*
*
* @param tags
* Any tags applied to the key pair.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new com.amazonaws.internal.SdkInternalList(tags);
}
/**
*
* Any tags applied to the key pair.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* Any tags applied to the key pair.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KeyPair withTags(Tag... tags) {
if (this.tags == null) {
setTags(new com.amazonaws.internal.SdkInternalList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* Any tags applied to the key pair.
*
*
* @param tags
* Any tags applied to the key pair.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KeyPair withTags(java.util.Collection tags) {
setTags(tags);
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 (getKeyFingerprint() != null)
sb.append("KeyFingerprint: ").append(getKeyFingerprint()).append(",");
if (getKeyMaterial() != null)
sb.append("KeyMaterial: ").append("***Sensitive Data Redacted***").append(",");
if (getKeyName() != null)
sb.append("KeyName: ").append(getKeyName()).append(",");
if (getKeyPairId() != null)
sb.append("KeyPairId: ").append(getKeyPairId()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof KeyPair == false)
return false;
KeyPair other = (KeyPair) obj;
if (other.getKeyFingerprint() == null ^ this.getKeyFingerprint() == null)
return false;
if (other.getKeyFingerprint() != null && other.getKeyFingerprint().equals(this.getKeyFingerprint()) == false)
return false;
if (other.getKeyMaterial() == null ^ this.getKeyMaterial() == null)
return false;
if (other.getKeyMaterial() != null && other.getKeyMaterial().equals(this.getKeyMaterial()) == false)
return false;
if (other.getKeyName() == null ^ this.getKeyName() == null)
return false;
if (other.getKeyName() != null && other.getKeyName().equals(this.getKeyName()) == false)
return false;
if (other.getKeyPairId() == null ^ this.getKeyPairId() == null)
return false;
if (other.getKeyPairId() != null && other.getKeyPairId().equals(this.getKeyPairId()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getKeyFingerprint() == null) ? 0 : getKeyFingerprint().hashCode());
hashCode = prime * hashCode + ((getKeyMaterial() == null) ? 0 : getKeyMaterial().hashCode());
hashCode = prime * hashCode + ((getKeyName() == null) ? 0 : getKeyName().hashCode());
hashCode = prime * hashCode + ((getKeyPairId() == null) ? 0 : getKeyPairId().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public KeyPair clone() {
try {
return (KeyPair) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}