Class Studio

java.lang.Object
software.amazon.awssdk.services.emr.model.Studio
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Studio.Builder,Studio>
@Generated("software.amazon.awssdk:codegen") public final class Studio extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Studio.Builder,Studio>

Details for an Amazon EMR Studio including ID, creation time, name, and so on.

See Also:

  • Method Details

    • studioId

      public final String studioId()

      The ID of the Amazon EMR Studio.

      Returns:
      The ID of the Amazon EMR Studio.

    • studioArn

      public final String studioArn()

      The Amazon Resource Name (ARN) of the Amazon EMR Studio.

      Returns:
      The Amazon Resource Name (ARN) of the Amazon EMR Studio.

    • name

      public final String name()

      The name of the Amazon EMR Studio.

      Returns:
      The name of the Amazon EMR Studio.

    • description

      public final String description()

      The detailed description of the Amazon EMR Studio.

      Returns:
      The detailed description of the Amazon EMR Studio.

    • authMode

      public final AuthMode authMode()

      Specifies whether the Amazon EMR Studio authenticates users with IAM or IAM Identity Center.

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

      Returns:
      Specifies whether the Amazon EMR Studio authenticates users with IAM or IAM Identity Center.
      See Also:

    • authModeAsString

      public final String authModeAsString()

      Specifies whether the Amazon EMR Studio authenticates users with IAM or IAM Identity Center.

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

      Returns:
      Specifies whether the Amazon EMR Studio authenticates users with IAM or IAM Identity Center.
      See Also:

    • vpcId

      public final String vpcId()

      The ID of the VPC associated with the Amazon EMR Studio.

      Returns:
      The ID of the VPC associated with the Amazon EMR Studio.

    • hasSubnetIds

      public final boolean hasSubnetIds()
      For responses, this returns true if the service returned a value for the SubnetIds 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.

    • subnetIds

      public final List<String> subnetIds()

      The list of IDs of the subnets associated with the Amazon EMR Studio.

      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 hasSubnetIds() method.

      Returns:
      The list of IDs of the subnets associated with the Amazon EMR Studio.

    • serviceRole

      public final String serviceRole()

      The name of the IAM role assumed by the Amazon EMR Studio.

      Returns:
      The name of the IAM role assumed by the Amazon EMR Studio.

    • userRole

      public final String userRole()

      The name of the IAM role assumed by users logged in to the Amazon EMR Studio. A Studio only requires a UserRole when you use IAM authentication.

      Returns:
      The name of the IAM role assumed by users logged in to the Amazon EMR Studio. A Studio only requires a UserRole when you use IAM authentication.

    • workspaceSecurityGroupId

      public final String workspaceSecurityGroupId()

      The ID of the Workspace security group associated with the Amazon EMR Studio. The Workspace security group allows outbound network traffic to resources in the Engine security group and to the internet.

      Returns:
      The ID of the Workspace security group associated with the Amazon EMR Studio. The Workspace security group allows outbound network traffic to resources in the Engine security group and to the internet.

    • engineSecurityGroupId

      public final String engineSecurityGroupId()

      The ID of the Engine security group associated with the Amazon EMR Studio. The Engine security group allows inbound network traffic from resources in the Workspace security group.

      Returns:
      The ID of the Engine security group associated with the Amazon EMR Studio. The Engine security group allows inbound network traffic from resources in the Workspace security group.

    • url

      public final String url()

      The unique access URL of the Amazon EMR Studio.

      Returns:
      The unique access URL of the Amazon EMR Studio.

    • creationTime

      public final Instant creationTime()

      The time the Amazon EMR Studio was created.

      Returns:
      The time the Amazon EMR Studio was created.

    • defaultS3Location

      public final String defaultS3Location()

      The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.

      Returns:
      The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.

    • idpAuthUrl

      public final String idpAuthUrl()

      Your identity provider's authentication endpoint. Amazon EMR Studio redirects federated users to this endpoint for authentication when logging in to a Studio with the Studio URL.

      Returns:
      Your identity provider's authentication endpoint. Amazon EMR Studio redirects federated users to this endpoint for authentication when logging in to a Studio with the Studio URL.

    • idpRelayStateParameterName

      public final String idpRelayStateParameterName()

      The name of your identity provider's RelayState parameter.

      Returns:
      The name of your identity provider's RelayState parameter.

    • 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 associated with the Amazon EMR Studio.

      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 associated with the Amazon EMR Studio.

    • idcInstanceArn

      public final String idcInstanceArn()

      The ARN of the IAM Identity Center instance the Studio application belongs to.

      Returns:
      The ARN of the IAM Identity Center instance the Studio application belongs to.

    • trustedIdentityPropagationEnabled

      public final Boolean trustedIdentityPropagationEnabled()

      Indicates whether the Studio has Trusted identity propagation enabled. The default value is false.

      Returns:
      Indicates whether the Studio has Trusted identity propagation enabled. The default value is false.

    • idcUserAssignment

      public final IdcUserAssignment idcUserAssignment()

      Indicates whether the Studio has REQUIRED or OPTIONAL IAM Identity Center user assignment. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio.

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

      Returns:
      Indicates whether the Studio has REQUIRED or OPTIONAL IAM Identity Center user assignment. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio.
      See Also:

    • idcUserAssignmentAsString

      public final String idcUserAssignmentAsString()

      Indicates whether the Studio has REQUIRED or OPTIONAL IAM Identity Center user assignment. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio.

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

      Returns:
      Indicates whether the Studio has REQUIRED or OPTIONAL IAM Identity Center user assignment. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio.
      See Also:

    • encryptionKeyArn

      public final String encryptionKeyArn()

      The KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.

      Returns:
      The KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.

    • toBuilder

      public Studio.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<Studio.Builder,Studio>
      Returns:
      a builder for type T

    • builder

      public static Studio.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.