Class CreateStudioRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.emr.model.EmrRequest
software.amazon.awssdk.services.emr.model.CreateStudioRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateStudioRequest.Builder,CreateStudioRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateStudioRequest extends EmrRequest implements ToCopyableBuilder<CreateStudioRequest.Builder,CreateStudioRequest>

  • Method Details

    • name

      public final String name()

      A descriptive name for the Amazon EMR Studio.

      Returns:
      A descriptive name for the Amazon EMR Studio.

    • description

      public final String description()

      A detailed description of the Amazon EMR Studio.

      Returns:
      A detailed description of the Amazon EMR Studio.

    • authMode

      public final AuthMode 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 return AuthMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authModeAsString().

      Returns:
      Specifies whether the Studio authenticates users using IAM or IAM Identity Center.
      See Also:

    • authModeAsString

      public final String 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 return AuthMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authModeAsString().

      Returns:
      Specifies whether the Studio authenticates users using IAM or IAM Identity Center.
      See Also:

    • vpcId

      public final String 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 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()

      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

      public final String 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

      public final String 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 the UserRole 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 the UserRole can be scoped down for each user or group using session policies.

    • workspaceSecurityGroupId

      public final String 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

      public final String 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

      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()

      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

      public final String idpRelayStateParameterName()

      The name that your identity provider (IdP) uses for its RelayState parameter. For example, RelayState or TargetSource. Specify this value when you use IAM authentication and want to let federated users log in to a Studio using the Studio URL. The RelayState parameter differs by IdP.

      Returns:
      The name that your identity provider (IdP) uses for its RelayState parameter. For example, RelayState or TargetSource. Specify this value when you use IAM authentication and want to let federated users log in to a Studio using the Studio URL. The RelayState 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 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 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

      public final Boolean 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

      public final IdcUserAssignment idcUserAssignment()

      Specifies whether IAM Identity Center user assignment is REQUIRED or OPTIONAL. 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:
      Specifies whether IAM Identity Center user assignment is REQUIRED or OPTIONAL. 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()

      Specifies whether IAM Identity Center user assignment is REQUIRED or OPTIONAL. 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:
      Specifies whether IAM Identity Center user assignment is REQUIRED or OPTIONAL. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio.
      See Also:

    • idcInstanceArn

      public final String 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

      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 CreateStudioRequest.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<CreateStudioRequest.Builder,CreateStudioRequest>
      Specified by:
      toBuilder in class EmrRequest
      Returns:
      a builder for type T

    • builder

      public static CreateStudioRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateStudioRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      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.