software.amazon.awssdk.services.iam.model

Class InstanceProfile

java.lang.Object

software.amazon.awssdk.services.iam.model.InstanceProfile

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<InstanceProfile.Builder,InstanceProfile>

@Generated(value="software.amazon.awssdk:codegen")
public final class InstanceProfile
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<InstanceProfile.Builder,InstanceProfile>

Contains information about an instance profile.

This data type is used as a response element in the following operations:

• CreateInstanceProfile

• GetInstanceProfile

• ListInstanceProfiles

• ListInstanceProfilesForRole

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InstanceProfile.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The Amazon Resource Name (ARN) specifying the instance profile.
static InstanceProfile.Builder	builder()
Instant	createDate() The date when the instance profile was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRoles() For responses, this returns true if the service returned a value for the Roles property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	instanceProfileId() The stable and unique string identifying the instance profile.
String	instanceProfileName() The name identifying the instance profile.
String	path() The path to the instance profile.
List<Role>	roles() The role associated with the instance profile.
List<SdkField<?>>	sdkFields()
static Class<? extends InstanceProfile.Builder>	serializableBuilderClass()
List<Tag>	tags() A list of tags that are attached to the instance profile.
InstanceProfile.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

path

public final String path()

The path to the instance profile. For more information about paths, see IAM identifiers in the IAM User Guide.

Returns:

The path to the instance profile. For more information about paths, see IAM identifiers in the IAM User Guide.

instanceProfileName

public final String instanceProfileName()

The name identifying the instance profile.

Returns:

The name identifying the instance profile.

instanceProfileId

public final String instanceProfileId()

The stable and unique string identifying the instance profile. For more information about IDs, see IAM identifiers in the IAM User Guide.

Returns:

The stable and unique string identifying the instance profile. For more information about IDs, see IAM identifiers in the IAM User Guide.

arn

public final String arn()

The Amazon Resource Name (ARN) specifying the instance profile. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide.

Returns:

The Amazon Resource Name (ARN) specifying the instance profile. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide.

createDate

public final Instant createDate()

The date when the instance profile was created.

Returns:

The date when the instance profile was created.

hasRoles

public final boolean hasRoles()

For responses, this returns true if the service returned a value for the Roles property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

roles

public final List<Role> roles()

The role associated with the instance profile.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRoles() method.

Returns:

The role associated with the instance profile.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

A list of tags that are attached to the instance profile. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

A list of tags that are attached to the instance profile. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

toBuilder

public InstanceProfile.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InstanceProfile.Builder,InstanceProfile>

builder

public static InstanceProfile.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo