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 Summary

Modifier and Type	Method and Description
CreateStudioRequest.Builder	authMode(AuthMode authMode) Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO.
CreateStudioRequest.Builder	authMode(String authMode) Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO.
CreateStudioRequest.Builder	defaultS3Location(String defaultS3Location) The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
CreateStudioRequest.Builder	description(String description) A detailed description of the Amazon EMR Studio.
CreateStudioRequest.Builder	engineSecurityGroupId(String engineSecurityGroupId) The ID of the Amazon EMR Studio Engine security group.
CreateStudioRequest.Builder	idpAuthUrl(String idpAuthUrl) The authentication endpoint of your identity provider (IdP).
CreateStudioRequest.Builder	idpRelayStateParameterName(String idpRelayStateParameterName) The name that your identity provider (IdP) uses for its RelayState parameter.
CreateStudioRequest.Builder	name(String name) A descriptive name for the Amazon EMR Studio.
CreateStudioRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateStudioRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateStudioRequest.Builder	serviceRole(String serviceRole) The IAM role that the Amazon EMR Studio assumes.
CreateStudioRequest.Builder	subnetIds(Collection<String> subnetIds) A list of subnet IDs to associate with the Amazon EMR Studio.
CreateStudioRequest.Builder	subnetIds(String... subnetIds) A list of subnet IDs to associate with the Amazon EMR Studio.
CreateStudioRequest.Builder	tags(Collection<Tag> tags) A list of tags to associate with the Amazon EMR Studio.
CreateStudioRequest.Builder	tags(Consumer<Tag.Builder>... tags) A list of tags to associate with the Amazon EMR Studio.
CreateStudioRequest.Builder	tags(Tag... tags) A list of tags to associate with the Amazon EMR Studio.
CreateStudioRequest.Builder	userRole(String userRole) The IAM user role that users and groups assume when logged in to an Amazon EMR Studio.
CreateStudioRequest.Builder	vpcId(String vpcId) The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
CreateStudioRequest.Builder	workspaceSecurityGroupId(String workspaceSecurityGroupId) The ID of the Amazon EMR Studio Workspace security group.

Methods inherited from interface software.amazon.awssdk.services.emr.model.EmrRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

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 Amazon Web Services SSO.

Parameters:

authMode - Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthMode, AuthMode

authMode

CreateStudioRequest.Builder authMode(AuthMode authMode)

Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO.

Parameters:

authMode - Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthMode, AuthMode

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 Amazon Web Services SSO 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 Amazon Web Services SSO 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 List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(List)

overrideConfiguration

CreateStudioRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateStudioRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder