com.amazonaws.services.identitymanagement.model.UploadSSHPublicKeyRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-iam Show documentation
/*
* Copyright 2020-2025 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.identitymanagement.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class UploadSSHPublicKeyRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the IAM user to associate the SSH public key with.
*
*
* This parameter allows (through its regex pattern) a string of
* characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
* the following characters: _+=,.@-
*
*/
private String userName;
/**
*
* The SSH public key. The public key must be encoded in ssh-rsa format or PEM format. The minimum bit-length of the
* public key is 2048 bits. For example, you can generate a 2048-bit key, and the resulting PEM file is 1679 bytes
* long.
*
*
* The regex pattern used to validate this parameter is a string of
* characters consisting of the following:
*
*
* -
*
* Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII
* character range
*
*
* -
*
* The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
*
*
* -
*
* The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D
* )
*
*
*
*/
private String sSHPublicKeyBody;
/**
*
* The name of the IAM user to associate the SSH public key with.
*
*
* This parameter allows (through its regex pattern) a string of
* characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
* the following characters: _+=,.@-
*
*
* @param userName
* The name of the IAM user to associate the SSH public key with.
*
* This parameter allows (through its regex pattern) a string
* of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also
* include any of the following characters: _+=,.@-
*/
public void setUserName(String userName) {
this.userName = userName;
}
/**
*
* The name of the IAM user to associate the SSH public key with.
*
*
* This parameter allows (through its regex pattern) a string of
* characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
* the following characters: _+=,.@-
*
*
* @return The name of the IAM user to associate the SSH public key with.
*
* This parameter allows (through its regex pattern) a string
* of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also
* include any of the following characters: _+=,.@-
*/
public String getUserName() {
return this.userName;
}
/**
*
* The name of the IAM user to associate the SSH public key with.
*
*
* This parameter allows (through its regex pattern) a string of
* characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
* the following characters: _+=,.@-
*
*
* @param userName
* The name of the IAM user to associate the SSH public key with.
*
* This parameter allows (through its regex pattern) a string
* of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also
* include any of the following characters: _+=,.@-
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UploadSSHPublicKeyRequest withUserName(String userName) {
setUserName(userName);
return this;
}
/**
*
* The SSH public key. The public key must be encoded in ssh-rsa format or PEM format. The minimum bit-length of the
* public key is 2048 bits. For example, you can generate a 2048-bit key, and the resulting PEM file is 1679 bytes
* long.
*
*
* The regex pattern used to validate this parameter is a string of
* characters consisting of the following:
*
*
* -
*
* Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII
* character range
*
*
* -
*
* The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
*
*
* -
*
* The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D
* )
*
*
*
*
* @param sSHPublicKeyBody
* The SSH public key. The public key must be encoded in ssh-rsa format or PEM format. The minimum bit-length
* of the public key is 2048 bits. For example, you can generate a 2048-bit key, and the resulting PEM file
* is 1679 bytes long.
*
* The regex pattern used to validate this parameter is a
* string of characters consisting of the following:
*
*
* -
*
* Any printable ASCII character ranging from the space character (\u0020) through the end of
* the ASCII character range
*
*
* -
*
* The printable characters in the Basic Latin and Latin-1 Supplement character set (through
* \u00FF)
*
*
* -
*
* The special characters tab (\u0009), line feed (\u000A), and carriage return (
* \u000D)
*
*
*/
public void setSSHPublicKeyBody(String sSHPublicKeyBody) {
this.sSHPublicKeyBody = sSHPublicKeyBody;
}
/**
*
* The SSH public key. The public key must be encoded in ssh-rsa format or PEM format. The minimum bit-length of the
* public key is 2048 bits. For example, you can generate a 2048-bit key, and the resulting PEM file is 1679 bytes
* long.
*
*
* The regex pattern used to validate this parameter is a string of
* characters consisting of the following:
*
*
* -
*
* Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII
* character range
*
*
* -
*
* The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
*
*
* -
*
* The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D
* )
*
*
*
*
* @return The SSH public key. The public key must be encoded in ssh-rsa format or PEM format. The minimum
* bit-length of the public key is 2048 bits. For example, you can generate a 2048-bit key, and the
* resulting PEM file is 1679 bytes long.
*
* The regex pattern used to validate this parameter is a
* string of characters consisting of the following:
*
*
* -
*
* Any printable ASCII character ranging from the space character (\u0020) through the end of
* the ASCII character range
*
*
* -
*
* The printable characters in the Basic Latin and Latin-1 Supplement character set (through
* \u00FF)
*
*
* -
*
* The special characters tab (\u0009), line feed (\u000A), and carriage return (
* \u000D)
*
*
*/
public String getSSHPublicKeyBody() {
return this.sSHPublicKeyBody;
}
/**
*
* The SSH public key. The public key must be encoded in ssh-rsa format or PEM format. The minimum bit-length of the
* public key is 2048 bits. For example, you can generate a 2048-bit key, and the resulting PEM file is 1679 bytes
* long.
*
*
* The regex pattern used to validate this parameter is a string of
* characters consisting of the following:
*
*
* -
*
* Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII
* character range
*
*
* -
*
* The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
*
*
* -
*
* The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D
* )
*
*
*
*
* @param sSHPublicKeyBody
* The SSH public key. The public key must be encoded in ssh-rsa format or PEM format. The minimum bit-length
* of the public key is 2048 bits. For example, you can generate a 2048-bit key, and the resulting PEM file
* is 1679 bytes long.
*
* The regex pattern used to validate this parameter is a
* string of characters consisting of the following:
*
*
* -
*
* Any printable ASCII character ranging from the space character (\u0020) through the end of
* the ASCII character range
*
*
* -
*
* The printable characters in the Basic Latin and Latin-1 Supplement character set (through
* \u00FF)
*
*
* -
*
* The special characters tab (\u0009), line feed (\u000A), and carriage return (
* \u000D)
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UploadSSHPublicKeyRequest withSSHPublicKeyBody(String sSHPublicKeyBody) {
setSSHPublicKeyBody(sSHPublicKeyBody);
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 (getUserName() != null)
sb.append("UserName: ").append(getUserName()).append(",");
if (getSSHPublicKeyBody() != null)
sb.append("SSHPublicKeyBody: ").append(getSSHPublicKeyBody());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof UploadSSHPublicKeyRequest == false)
return false;
UploadSSHPublicKeyRequest other = (UploadSSHPublicKeyRequest) obj;
if (other.getUserName() == null ^ this.getUserName() == null)
return false;
if (other.getUserName() != null && other.getUserName().equals(this.getUserName()) == false)
return false;
if (other.getSSHPublicKeyBody() == null ^ this.getSSHPublicKeyBody() == null)
return false;
if (other.getSSHPublicKeyBody() != null && other.getSSHPublicKeyBody().equals(this.getSSHPublicKeyBody()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getUserName() == null) ? 0 : getUserName().hashCode());
hashCode = prime * hashCode + ((getSSHPublicKeyBody() == null) ? 0 : getSSHPublicKeyBody().hashCode());
return hashCode;
}
@Override
public UploadSSHPublicKeyRequest clone() {
return (UploadSSHPublicKeyRequest) super.clone();
}
}