Class Studio
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Studio.Builder,
Studio>
Details for an Amazon EMR Studio including ID, creation time, name, and so on.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AuthMode
authMode()
Specifies whether the Amazon EMR Studio authenticates users with IAM or IAM Identity Center.final String
Specifies whether the Amazon EMR Studio authenticates users with IAM or IAM Identity Center.static Studio.Builder
builder()
final Instant
The time the Amazon EMR Studio was created.final String
The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.final String
The detailed description of the Amazon EMR Studio.final String
The KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.final String
The ID of the Engine security group associated with the Amazon EMR Studio.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SubnetIds property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The ARN of the IAM Identity Center instance the Studio application belongs to.final IdcUserAssignment
Indicates whether the Studio hasREQUIRED
orOPTIONAL
IAM Identity Center user assignment.final String
Indicates whether the Studio hasREQUIRED
orOPTIONAL
IAM Identity Center user assignment.final String
Your identity provider's authentication endpoint.final String
The name of your identity provider'sRelayState
parameter.final String
name()
The name of the Amazon EMR Studio.static Class
<? extends Studio.Builder> final String
The name of the IAM role assumed by the Amazon EMR Studio.final String
The Amazon Resource Name (ARN) of the Amazon EMR Studio.final String
studioId()
The ID of the Amazon EMR Studio.The list of IDs of the subnets associated with the Amazon EMR Studio.tags()
A list of tags associated with the Amazon EMR Studio.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Boolean
Indicates whether the Studio has Trusted identity propagation enabled.final String
url()
The unique access URL of the Amazon EMR Studio.final String
userRole()
The name of the IAM role assumed by users logged in to the Amazon EMR Studio.final String
vpcId()
The ID of the VPC associated with the Amazon EMR Studio.final String
The ID of the Workspace security group associated with the Amazon EMR Studio.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
studioId
The ID of the Amazon EMR Studio.
- Returns:
- The ID of the Amazon EMR Studio.
-
studioArn
The Amazon Resource Name (ARN) of the Amazon EMR Studio.
- Returns:
- The Amazon Resource Name (ARN) of the Amazon EMR Studio.
-
name
The name of the Amazon EMR Studio.
- Returns:
- The name of the Amazon EMR Studio.
-
description
The detailed description of the Amazon EMR Studio.
- Returns:
- The detailed description of the Amazon EMR Studio.
-
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 returnAuthMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthModeAsString()
.- Returns:
- Specifies whether the Amazon EMR Studio authenticates users with IAM or IAM Identity Center.
- See Also:
-
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 returnAuthMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthModeAsString()
.- Returns:
- Specifies whether the Amazon EMR Studio authenticates users with IAM or IAM Identity Center.
- See Also:
-
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 theisEmpty()
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
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
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
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
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
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
The unique access URL of the Amazon EMR Studio.
- Returns:
- The unique access URL of the Amazon EMR Studio.
-
creationTime
The time the Amazon EMR Studio was created.
- Returns:
- The time the Amazon EMR Studio was created.
-
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
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
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 theisEmpty()
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
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
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
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
Indicates whether the Studio has
REQUIRED
orOPTIONAL
IAM Identity Center user assignment. If the value is set toREQUIRED
, 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 returnIdcUserAssignment.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromidcUserAssignmentAsString()
.- Returns:
- Indicates whether the Studio has
REQUIRED
orOPTIONAL
IAM Identity Center user assignment. If the value is set toREQUIRED
, users must be explicitly assigned to the Studio application to access the Studio. - See Also:
-
idcUserAssignmentAsString
Indicates whether the Studio has
REQUIRED
orOPTIONAL
IAM Identity Center user assignment. If the value is set toREQUIRED
, 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 returnIdcUserAssignment.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromidcUserAssignmentAsString()
.- Returns:
- Indicates whether the Studio has
REQUIRED
orOPTIONAL
IAM Identity Center user assignment. If the value is set toREQUIRED
, users must be explicitly assigned to the Studio application to access the Studio. - See Also:
-
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
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 interfaceToCopyableBuilder<Studio.Builder,
Studio> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-