software.amazon.awssdk.services.opsworks.model

Class UpdateUserProfileRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.opsworks.model.OpsWorksRequest

software.amazon.awssdk.services.opsworks.model.UpdateUserProfileRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateUserProfileRequest.Builder,UpdateUserProfileRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateUserProfileRequest
extends OpsWorksRequest
implements ToCopyableBuilder<UpdateUserProfileRequest.Builder,UpdateUserProfileRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateUserProfileRequest.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	allowSelfManagement() Whether users can specify their own SSH public key through the My Settings page.
static UpdateUserProfileRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	iamUserArn() The user IAM ARN.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateUserProfileRequest.Builder>	serializableBuilderClass()
String	sshPublicKey() The user's new SSH public key.
String	sshUsername() The user's SSH user name.
UpdateUserProfileRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

iamUserArn

public String iamUserArn()

The user IAM ARN. This can also be a federated user's ARN.

Returns:

The user IAM ARN. This can also be a federated user's ARN.

sshUsername

public String sshUsername()

The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM user name.

Returns:

The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM user name.

sshPublicKey

public String sshPublicKey()

The user's new SSH public key.

Returns:

The user's new SSH public key.

allowSelfManagement

public Boolean allowSelfManagement()

Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.

Returns:

Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.

toBuilder

public UpdateUserProfileRequest.Builder 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 interface ToCopyableBuilder<UpdateUserProfileRequest.Builder,UpdateUserProfileRequest>

Specified by:

toBuilder in class OpsWorksRequest

Returns:

a builder for type T

builder

public static UpdateUserProfileRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateUserProfileRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public String 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.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.