Studio (AWS Java SDK :: Services :: Amazon EMR 2.20.4 API)

java.lang.Object
- software.amazon.awssdk.services.emr.model.Studio

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Studio.Builder,Studio>
```
@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Studio.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Studio.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AuthMode`	`authMode()` Specifies whether the Amazon EMR Studio authenticates users using IAM or IAM Identity Center.
`String`	`authModeAsString()` Specifies whether the Amazon EMR Studio authenticates users using IAM or IAM Identity Center.
`static Studio.Builder`	`builder()`
`Instant`	`creationTime()` The time the Amazon EMR Studio was created.
`String`	`defaultS3Location()` The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
`String`	`description()` The detailed description of the Amazon EMR Studio.
`String`	`engineSecurityGroupId()` The ID of the Engine security group associated with the Amazon EMR Studio.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSubnetIds()` For responses, this returns true if the service returned a value for the SubnetIds property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`idpAuthUrl()` Your identity provider's authentication endpoint.
`String`	`idpRelayStateParameterName()` The name of your identity provider's `RelayState` parameter.
`String`	`name()` The name of the Amazon EMR Studio.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Studio.Builder>`	`serializableBuilderClass()`
`String`	`serviceRole()` The name of the IAM role assumed by the Amazon EMR Studio.
`String`	`studioArn()` The Amazon Resource Name (ARN) of the Amazon EMR Studio.
`String`	`studioId()` The ID of the Amazon EMR Studio.
`List<String>`	`subnetIds()` The list of IDs of the subnets associated with the Amazon EMR Studio.
`List<Tag>`	`tags()` A list of tags associated with the Amazon EMR Studio.
`Studio.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`url()` The unique access URL of the Amazon EMR Studio.
`String`	`userRole()` The name of the IAM role assumed by users logged in to the Amazon EMR Studio.
`String`	`vpcId()` The ID of the VPC associated with the Amazon EMR Studio.
`String`	`workspaceSecurityGroupId()` The ID of the Workspace security group associated with the Amazon EMR Studio.

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
  - 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 using 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 using IAM or IAM Identity Center.
    
    See Also:
    
    AuthMode
  - authModeAsString
```
public final String authModeAsString()
```
    Specifies whether the Amazon EMR Studio authenticates users using 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 using IAM or IAM Identity Center.
    
    See Also:
    
    AuthMode
  - 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.
  - toBuilder
```
public Studio.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Studio.Builder,Studio>
  - 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)
```
    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

Class Studio

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

studioId

studioArn

name

description

authMode

authModeAsString

vpcId

hasSubnetIds

subnetIds

serviceRole

userRole

workspaceSecurityGroupId

engineSecurityGroupId

url

creationTime

defaultS3Location

idpAuthUrl

idpRelayStateParameterName

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields