com.amazonaws.services.elasticmapreduce.model

Class CreateStudioRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticmapreduce.model.CreateStudioRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateStudioRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateStudioRequest()

Method Summary

Modifier and Type	Method and Description
CreateStudioRequest	clone()
boolean	equals(Object obj)
String	getAuthMode() Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM.
String	getDefaultS3Location() The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
String	getDescription() A detailed description of the Amazon EMR Studio.
String	getEngineSecurityGroupId() The ID of the Amazon EMR Studio Engine security group.
String	getName() A descriptive name for the Amazon EMR Studio.
String	getServiceRole() The IAM role that will be assumed by the Amazon EMR Studio.
List<String>	getSubnetIds() A list of subnet IDs to associate with the Amazon EMR Studio.
List<Tag>	getTags() A list of tags to associate with the Amazon EMR Studio.
String	getUserRole() The IAM user role that will be assumed by users and groups logged in to an Amazon EMR Studio.
String	getVpcId() The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
String	getWorkspaceSecurityGroupId() The ID of the Amazon EMR Studio Workspace security group.
int	hashCode()
void	setAuthMode(String authMode) Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM.
void	setDefaultS3Location(String defaultS3Location) The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
void	setDescription(String description) A detailed description of the Amazon EMR Studio.
void	setEngineSecurityGroupId(String engineSecurityGroupId) The ID of the Amazon EMR Studio Engine security group.
void	setName(String name) A descriptive name for the Amazon EMR Studio.
void	setServiceRole(String serviceRole) The IAM role that will be assumed by the Amazon EMR Studio.
void	setSubnetIds(Collection<String> subnetIds) A list of subnet IDs to associate with the Amazon EMR Studio.
void	setTags(Collection<Tag> tags) A list of tags to associate with the Amazon EMR Studio.
void	setUserRole(String userRole) The IAM user role that will be assumed by users and groups logged in to an Amazon EMR Studio.
void	setVpcId(String vpcId) The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
void	setWorkspaceSecurityGroupId(String workspaceSecurityGroupId) The ID of the Amazon EMR Studio Workspace security group.
String	toString() Returns a string representation of this object.
CreateStudioRequest	withAuthMode(AuthMode authMode) Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM.
CreateStudioRequest	withAuthMode(String authMode) Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM.
CreateStudioRequest	withDefaultS3Location(String defaultS3Location) The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
CreateStudioRequest	withDescription(String description) A detailed description of the Amazon EMR Studio.
CreateStudioRequest	withEngineSecurityGroupId(String engineSecurityGroupId) The ID of the Amazon EMR Studio Engine security group.
CreateStudioRequest	withName(String name) A descriptive name for the Amazon EMR Studio.
CreateStudioRequest	withServiceRole(String serviceRole) The IAM role that will be assumed by the Amazon EMR Studio.
CreateStudioRequest	withSubnetIds(Collection<String> subnetIds) A list of subnet IDs to associate with the Amazon EMR Studio.
CreateStudioRequest	withSubnetIds(String... subnetIds) A list of subnet IDs to associate with the Amazon EMR Studio.
CreateStudioRequest	withTags(Collection<Tag> tags) A list of tags to associate with the Amazon EMR Studio.
CreateStudioRequest	withTags(Tag... tags) A list of tags to associate with the Amazon EMR Studio.
CreateStudioRequest	withUserRole(String userRole) The IAM user role that will be assumed by users and groups logged in to an Amazon EMR Studio.
CreateStudioRequest	withVpcId(String vpcId) The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
CreateStudioRequest	withWorkspaceSecurityGroupId(String workspaceSecurityGroupId) The ID of the Amazon EMR Studio Workspace security group.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateStudioRequest

public CreateStudioRequest()

Method Detail

setName

public void setName(String name)

A descriptive name for the Amazon EMR Studio.

Parameters:

name - A descriptive name for the Amazon EMR Studio.

getName

public String getName()

A descriptive name for the Amazon EMR Studio.

Returns:

A descriptive name for the Amazon EMR Studio.

withName

public CreateStudioRequest withName(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.

setDescription

public void setDescription(String description)

A detailed description of the Amazon EMR Studio.

Parameters:

description - A detailed description of the Amazon EMR Studio.

getDescription

public String getDescription()

A detailed description of the Amazon EMR Studio.

Returns:

A detailed description of the Amazon EMR Studio.

withDescription

public CreateStudioRequest withDescription(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.

setAuthMode

public void setAuthMode(String authMode)

Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication.

Parameters:

authMode - Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication.

See Also:

AuthMode

getAuthMode

public String getAuthMode()

Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication.

Returns:

Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication.

See Also:

AuthMode

withAuthMode

public CreateStudioRequest withAuthMode(String authMode)

Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication.

Parameters:

authMode - Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication.

Returns:

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

See Also:

AuthMode

withAuthMode

public CreateStudioRequest withAuthMode(AuthMode authMode)

Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication.

Parameters:

authMode - Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication.

Returns:

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

See Also:

AuthMode

setVpcId

public void setVpcId(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.

getVpcId

public String getVpcId()

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.

withVpcId

public CreateStudioRequest withVpcId(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.

getSubnetIds

public List<String> getSubnetIds()

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:

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.

setSubnetIds

public void setSubnetIds(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.

withSubnetIds

public CreateStudioRequest withSubnetIds(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.

NOTE: This method appends the values to the existing list (if any). Use setSubnetIds(java.util.Collection) or withSubnetIds(java.util.Collection) if you want to override the existing values.

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.

withSubnetIds

public CreateStudioRequest withSubnetIds(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.

setServiceRole

public void setServiceRole(String serviceRole)

The IAM role that will be assumed by the Amazon EMR Studio. The service role provides a way for Amazon EMR Studio to interoperate with other AWS services.

Parameters:

serviceRole - The IAM role that will be assumed by the Amazon EMR Studio. The service role provides a way for Amazon EMR Studio to interoperate with other AWS services.

getServiceRole

public String getServiceRole()

The IAM role that will be assumed by the Amazon EMR Studio. The service role provides a way for Amazon EMR Studio to interoperate with other AWS services.

Returns:

The IAM role that will be assumed by the Amazon EMR Studio. The service role provides a way for Amazon EMR Studio to interoperate with other AWS services.

withServiceRole

public CreateStudioRequest withServiceRole(String serviceRole)

The IAM role that will be assumed by the Amazon EMR Studio. The service role provides a way for Amazon EMR Studio to interoperate with other AWS services.

Parameters:

serviceRole - The IAM role that will be assumed by the Amazon EMR Studio. The service role provides a way for Amazon EMR Studio to interoperate with other AWS services.

Returns:

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

setUserRole

public void setUserRole(String userRole)

The IAM user role that will be assumed by users and groups logged in to an Amazon EMR Studio. The permissions attached to this IAM role can be scoped down for each user or group using session policies.

Parameters:

userRole - The IAM user role that will be assumed by users and groups logged in to an Amazon EMR Studio. The permissions attached to this IAM role can be scoped down for each user or group using session policies.

getUserRole

public String getUserRole()

The IAM user role that will be assumed by users and groups logged in to an Amazon EMR Studio. The permissions attached to this IAM role can be scoped down for each user or group using session policies.

Returns:

The IAM user role that will be assumed by users and groups logged in to an Amazon EMR Studio. The permissions attached to this IAM role can be scoped down for each user or group using session policies.

withUserRole

public CreateStudioRequest withUserRole(String userRole)

The IAM user role that will be assumed by users and groups logged in to an Amazon EMR Studio. The permissions attached to this IAM role can be scoped down for each user or group using session policies.

Parameters:

userRole - The IAM user role that will be assumed by users and groups logged in to an Amazon EMR Studio. The permissions attached to this IAM role 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.

setWorkspaceSecurityGroupId

public void setWorkspaceSecurityGroupId(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.

getWorkspaceSecurityGroupId

public String getWorkspaceSecurityGroupId()

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.

withWorkspaceSecurityGroupId

public CreateStudioRequest withWorkspaceSecurityGroupId(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.

setEngineSecurityGroupId

public void setEngineSecurityGroupId(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.

getEngineSecurityGroupId

public String getEngineSecurityGroupId()

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 .

withEngineSecurityGroupId

public CreateStudioRequest withEngineSecurityGroupId(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.

setDefaultS3Location

public void setDefaultS3Location(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.

getDefaultS3Location

public String getDefaultS3Location()

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.

withDefaultS3Location

public CreateStudioRequest withDefaultS3Location(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.

getTags

public List<Tag> getTags()

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:

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.

setTags

public void setTags(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.

withTags

public CreateStudioRequest withTags(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.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

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.

withTags

public CreateStudioRequest withTags(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateStudioRequest clone()

Overrides:

clone in class AmazonWebServiceRequest