Package software.amazon.awssdk.services.emr.model

Interface CreateStudioRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateStudioRequest.Builder,CreateStudioRequest>, EmrRequest.Builder, SdkBuilder<CreateStudioRequest.Builder,CreateStudioRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateStudioRequest
public static interface CreateStudioRequest.Builder extends EmrRequest.Builder, SdkPojo, CopyableBuilder<CreateStudioRequest.Builder,CreateStudioRequest>

  • Method Details

    • name

      CreateStudioRequest.Builder name(String name)

      A descriptive name for the Amazon EMR Studio.

      Parameters:
      name - A descriptive name for the Amazon EMR Studio.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateStudioRequest.Builder description(String description)

      A detailed description of the Amazon EMR Studio.

      Parameters:
      description - A detailed description of the Amazon EMR Studio.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authMode

      CreateStudioRequest.Builder authMode(String authMode)

      Specifies whether the Studio authenticates users using IAM or IAM Identity Center.

      Parameters:
      authMode - Specifies whether the Studio authenticates users using IAM or IAM Identity Center.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authMode

      CreateStudioRequest.Builder authMode(AuthMode authMode)

      Specifies whether the Studio authenticates users using IAM or IAM Identity Center.

      Parameters:
      authMode - Specifies whether the Studio authenticates users using IAM or IAM Identity Center.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vpcId

      CreateStudioRequest.Builder vpcId(String vpcId)

      The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.

      Parameters:
      vpcId - The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subnetIds

      CreateStudioRequest.Builder subnetIds(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subnetIds

      CreateStudioRequest.Builder subnetIds(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serviceRole

      CreateStudioRequest.Builder serviceRole(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • userRole

      CreateStudioRequest.Builder userRole(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • workspaceSecurityGroupId

      CreateStudioRequest.Builder workspaceSecurityGroupId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • engineSecurityGroupId

      CreateStudioRequest.Builder engineSecurityGroupId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • defaultS3Location

      CreateStudioRequest.Builder defaultS3Location(String defaultS3Location)

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

      Parameters:
      defaultS3Location - The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • idpAuthUrl

      CreateStudioRequest.Builder idpAuthUrl(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • idpRelayStateParameterName

      CreateStudioRequest.Builder idpRelayStateParameterName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateStudioRequest.Builder tags(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateStudioRequest.Builder tags(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateStudioRequest.Builder tags(Consumer<Tag.Builder>... 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.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • trustedIdentityPropagationEnabled

      CreateStudioRequest.Builder trustedIdentityPropagationEnabled(Boolean trustedIdentityPropagationEnabled)

      A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.

      Parameters:
      trustedIdentityPropagationEnabled - A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • idcUserAssignment

      CreateStudioRequest.Builder idcUserAssignment(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • idcUserAssignment

      CreateStudioRequest.Builder idcUserAssignment(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • idcInstanceArn

      CreateStudioRequest.Builder idcInstanceArn(String idcInstanceArn)

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

      Parameters:
      idcInstanceArn - The ARN of the IAM Identity Center instance to create the Studio application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryptionKeyArn

      CreateStudioRequest.Builder encryptionKeyArn(String encryptionKeyArn)

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

      Parameters:
      encryptionKeyArn - The KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateStudioRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateStudioRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.