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:

  • Method Details

    • 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:

    • 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:

    • 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()
      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<StudioMembership.Builder,StudioMembership>
      Returns:
      a builder for type T

    • 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)
      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 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.