Class CreateStudioRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateStudioRequest.Builder,
CreateStudioRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal AuthMode
authMode()
Specifies whether the Studio authenticates users using IAM or IAM Identity Center.final String
Specifies whether the Studio authenticates users using IAM or IAM Identity Center.static CreateStudioRequest.Builder
builder()
final String
The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.final String
A 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 Amazon EMR Studio Engine security group.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) Used to retrieve the value of a field from any class that extendsSdkRequest
.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 to create the Studio application.final IdcUserAssignment
Specifies whether IAM Identity Center user assignment isREQUIRED
orOPTIONAL
.final String
Specifies whether IAM Identity Center user assignment isREQUIRED
orOPTIONAL
.final String
The authentication endpoint of your identity provider (IdP).final String
The name that your identity provider (IdP) uses for itsRelayState
parameter.final String
name()
A descriptive name for the Amazon EMR Studio.static Class
<? extends CreateStudioRequest.Builder> final String
The IAM role that the Amazon EMR Studio assumes.A list of subnet IDs to associate with the Amazon EMR Studio.tags()
A list of tags to associate 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
A Boolean indicating whether to enable Trusted identity propagation for the Studio.final String
userRole()
The IAM user role that users and groups assume when logged in to an Amazon EMR Studio.final String
vpcId()
The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.final String
The ID of the Amazon EMR Studio Workspace security group.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
A descriptive name for the Amazon EMR Studio.
- Returns:
- A descriptive name for the Amazon EMR Studio.
-
description
A detailed description of the Amazon EMR Studio.
- Returns:
- A detailed description of the Amazon EMR Studio.
-
authMode
Specifies whether the 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 returnAuthMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthModeAsString()
.- Returns:
- Specifies whether the Studio authenticates users using IAM or IAM Identity Center.
- See Also:
-
authModeAsString
Specifies whether the 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 returnAuthMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthModeAsString()
.- Returns:
- Specifies whether the Studio authenticates users using IAM or IAM Identity Center.
- See Also:
-
vpcId
The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
- Returns:
- The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the 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
A list of subnet IDs to associate with the Amazon EMR Studio. A Studio can have a maximum of 5 subnets. The subnets must belong to the VPC specified by
VpcId
. Studio users can create a Workspace in any of the specified subnets.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:
- A list of subnet IDs to associate with the Amazon EMR Studio. A Studio can have a maximum of 5 subnets.
The subnets must belong to the VPC specified by
VpcId
. Studio users can create a Workspace in any of the specified subnets.
-
serviceRole
The IAM role that the Amazon EMR Studio assumes. The service role provides a way for Amazon EMR Studio to interoperate with other Amazon Web Services services.
- Returns:
- The IAM role that the Amazon EMR Studio assumes. The service role provides a way for Amazon EMR Studio to interoperate with other Amazon Web Services services.
-
userRole
The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a
UserRole
when you use IAM Identity Center authentication. The permissions attached to theUserRole
can be scoped down for each user or group using session policies.- Returns:
- The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a
UserRole
when you use IAM Identity Center authentication. The permissions attached to theUserRole
can be scoped down for each user or group using session policies.
-
workspaceSecurityGroupId
The ID of the Amazon EMR Studio Workspace security group. The Workspace security group allows outbound network traffic to resources in the Engine security group, and it must be in the same VPC specified by
VpcId
.- Returns:
- The ID of the Amazon EMR Studio Workspace security group. The Workspace security group allows outbound
network traffic to resources in the Engine security group, and it must be in the same VPC specified by
VpcId
.
-
engineSecurityGroupId
The ID of the Amazon EMR Studio Engine security group. The Engine security group allows inbound network traffic from the Workspace security group, and it must be in the same VPC specified by
VpcId
.- Returns:
- The ID of the Amazon EMR Studio Engine security group. The Engine security group allows inbound network
traffic from the Workspace security group, and it must be in the same VPC specified by
VpcId
.
-
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
The authentication endpoint of your identity provider (IdP). Specify this value when you use IAM authentication and want to let federated users log in to a Studio with the Studio URL and credentials from your IdP. Amazon EMR Studio redirects users to this endpoint to enter credentials.
- Returns:
- The authentication endpoint of your identity provider (IdP). Specify this value when you use IAM authentication and want to let federated users log in to a Studio with the Studio URL and credentials from your IdP. Amazon EMR Studio redirects users to this endpoint to enter credentials.
-
idpRelayStateParameterName
The name that your identity provider (IdP) uses for its
RelayState
parameter. For example,RelayState
orTargetSource
. Specify this value when you use IAM authentication and want to let federated users log in to a Studio using the Studio URL. TheRelayState
parameter differs by IdP.- Returns:
- The name that your identity provider (IdP) uses for its
RelayState
parameter. For example,RelayState
orTargetSource
. Specify this value when you use IAM authentication and want to let federated users log in to a Studio using the Studio URL. TheRelayState
parameter differs by IdP.
-
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 to associate with the Amazon EMR Studio. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.
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 to associate with the Amazon EMR Studio. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.
-
trustedIdentityPropagationEnabled
A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is
false
.- Returns:
- A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is
false
.
-
idcUserAssignment
Specifies whether IAM Identity Center user assignment is
REQUIRED
orOPTIONAL
. 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:
- Specifies whether IAM Identity Center user assignment is
REQUIRED
orOPTIONAL
. If the value is set toREQUIRED
, users must be explicitly assigned to the Studio application to access the Studio. - See Also:
-
idcUserAssignmentAsString
Specifies whether IAM Identity Center user assignment is
REQUIRED
orOPTIONAL
. 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:
- Specifies whether IAM Identity Center user assignment is
REQUIRED
orOPTIONAL
. If the value is set toREQUIRED
, users must be explicitly assigned to the Studio application to access the Studio. - See Also:
-
idcInstanceArn
The ARN of the IAM Identity Center instance to create the Studio application.
- Returns:
- The ARN of the IAM Identity Center instance to create the Studio application.
-
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<CreateStudioRequest.Builder,
CreateStudioRequest> - Specified by:
toBuilder
in classEmrRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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
-
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-