Package software.amazon.awssdk.services.nimble.model

Class StudioMembership

java.lang.Object

software.amazon.awssdk.services.nimble.model.StudioMembership

All Implemented Interfaces:

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

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

A studio member is an association of a user from your studio identity source to elevated permissions that they are granted in the studio.

When you add a user to your studio using the Nimble Studio console, they are given access to the studio's IAM Identity Center application and are given access to log in to the Nimble Studio portal. These users have the permissions provided by the studio's user IAM role and do not appear in the studio membership collection. Only studio admins appear in studio membership.

When you add a user to studio membership with the ADMIN persona, upon logging in to the Nimble Studio portal, they are granted permissions specified by the Studio's Admin IAM role.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StudioMembership.Builder

Method Summary

Modifier and Type	Method	Description
static StudioMembership.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	identityStoreId()	The ID of the identity store.
StudioPersona	persona()	The persona.
String	personaAsString()	The persona.
String	principalId()	The principal ID.
List<SdkField<?>>	sdkFields()
static Class<? extends StudioMembership.Builder>	serializableBuilderClass()
String	sid()	The Active Directory Security Identifier for this user, if available.
StudioMembership.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

identityStoreId

public final String identityStoreId()

The ID of the identity store.

Returns:

The ID of the identity store.

persona

public final StudioPersona persona()

The persona.

If the service returns an enum value that is not available in the current SDK version, persona will return StudioPersona.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from personaAsString().

Returns:

The persona.

See Also:

StudioPersona

personaAsString

public final String personaAsString()

The persona.

If the service returns an enum value that is not available in the current SDK version, persona will return StudioPersona.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from personaAsString().

Returns:

The persona.

See Also:

StudioPersona

principalId

public final String principalId()

The principal ID.

Returns:

The principal ID.

sid

public final String sid()

The Active Directory Security Identifier for this user, if available.

Returns:

The Active Directory Security Identifier for this user, if available.

toBuilder

public StudioMembership.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StudioMembership.Builder,StudioMembership>

builder

public static StudioMembership.Builder builder()

serializableBuilderClass

public static Class<? extends StudioMembership.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