/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.elasticmapreduce.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateStudioRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* A descriptive name for the Amazon EMR Studio. *
*/ private String name; /** ** A detailed description of the Amazon EMR Studio. *
*/ private String description; /** ** Specifies whether the Studio authenticates users using IAM or IAM Identity Center. *
*/ private String authMode; /** ** The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio. *
*/ private String vpcId; /** *
* 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.
*
* 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. *
*/ private String serviceRole; /** *
* 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.
*
* 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
* .
*
* 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
.
*
* The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files. *
*/ private String defaultS3Location; /** ** 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. *
*/ private String idpAuthUrl; /** *
* 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.
*
* 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. *
*/ private com.amazonaws.internal.SdkInternalList* A descriptive name for the Amazon EMR Studio. *
* * @param name * A descriptive name for the Amazon EMR Studio. */ public void setName(String name) { this.name = name; } /** ** A descriptive name for the Amazon EMR Studio. *
* * @return A descriptive name for the Amazon EMR Studio. */ public String getName() { return this.name; } /** ** A descriptive name for the Amazon EMR Studio. *
* * @param name * A descriptive name for the Amazon EMR Studio. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateStudioRequest withName(String name) { setName(name); return this; } /** ** A detailed description of the Amazon EMR Studio. *
* * @param description * A detailed description of the Amazon EMR Studio. */ public void setDescription(String description) { this.description = description; } /** ** A detailed description of the Amazon EMR Studio. *
* * @return A detailed description of the Amazon EMR Studio. */ public String getDescription() { return this.description; } /** ** A detailed description of the Amazon EMR Studio. *
* * @param description * A detailed description of the Amazon EMR Studio. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateStudioRequest withDescription(String description) { setDescription(description); return this; } /** ** Specifies whether the Studio authenticates users using IAM or IAM Identity Center. *
* * @param authMode * Specifies whether the Studio authenticates users using IAM or IAM Identity Center. * @see AuthMode */ public void setAuthMode(String authMode) { this.authMode = authMode; } /** ** Specifies whether the Studio authenticates users using IAM or IAM Identity Center. *
* * @return Specifies whether the Studio authenticates users using IAM or IAM Identity Center. * @see AuthMode */ public String getAuthMode() { return this.authMode; } /** ** Specifies whether the Studio authenticates users using IAM or IAM Identity Center. *
* * @param authMode * Specifies whether the Studio authenticates users using IAM or IAM Identity Center. * @return Returns a reference to this object so that method calls can be chained together. * @see AuthMode */ public CreateStudioRequest withAuthMode(String authMode) { setAuthMode(authMode); return this; } /** ** Specifies whether the Studio authenticates users using IAM or IAM Identity Center. *
* * @param authMode * Specifies whether the Studio authenticates users using IAM or IAM Identity Center. * @return Returns a reference to this object so that method calls can be chained together. * @see AuthMode */ public CreateStudioRequest withAuthMode(AuthMode authMode) { this.authMode = authMode.toString(); return this; } /** ** The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio. *
* * @param vpcId * The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio. */ public void setVpcId(String vpcId) { this.vpcId = vpcId; } /** ** The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio. *
* * @return The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio. */ public String getVpcId() { return this.vpcId; } /** ** The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio. *
* * @param vpcId * The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateStudioRequest withVpcId(String vpcId) { setVpcId(vpcId); return this; } /** *
* 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.
*
VpcId
. Studio users can create a Workspace
* in any of the specified subnets.
*/
public java.util.List
* 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.
*
VpcId
. Studio users can create a Workspace in
* any of the specified subnets.
*/
public void setSubnetIds(java.util.Collection
* 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 * {@link #setSubnetIds(java.util.Collection)} or {@link #withSubnetIds(java.util.Collection)} if you want to * override the existing values. *
* * @param 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 byVpcId
. Studio users can create a Workspace in
* any of the specified subnets.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStudioRequest withSubnetIds(String... subnetIds) {
if (this.subnetIds == null) {
setSubnetIds(new com.amazonaws.internal.SdkInternalList
* 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.
*
VpcId
. Studio users can create a Workspace in
* any of the specified subnets.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStudioRequest withSubnetIds(java.util.Collection* 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. *
* * @param 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. */ public void setServiceRole(String serviceRole) { this.serviceRole = 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. *
* * @return 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. */ public String getServiceRole() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateStudioRequest withServiceRole(String serviceRole) { setServiceRole(serviceRole); return this; } /** *
* 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.
*
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.
*/
public void setUserRole(String userRole) {
this.userRole = 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.
*
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.
*/
public String getUserRole() {
return this.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.
*
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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStudioRequest withUserRole(String userRole) {
setUserRole(userRole);
return this;
}
/**
*
* 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
* .
*
VpcId
.
*/
public void setWorkspaceSecurityGroupId(String workspaceSecurityGroupId) {
this.workspaceSecurityGroupId = 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
* .
*
VpcId
.
*/
public String getWorkspaceSecurityGroupId() {
return this.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
* .
*
VpcId
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStudioRequest withWorkspaceSecurityGroupId(String workspaceSecurityGroupId) {
setWorkspaceSecurityGroupId(workspaceSecurityGroupId);
return this;
}
/**
*
* 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
.
*
VpcId
.
*/
public void setEngineSecurityGroupId(String engineSecurityGroupId) {
this.engineSecurityGroupId = 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
.
*
VpcId
* .
*/
public String getEngineSecurityGroupId() {
return this.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
.
*
VpcId
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStudioRequest withEngineSecurityGroupId(String engineSecurityGroupId) {
setEngineSecurityGroupId(engineSecurityGroupId);
return this;
}
/**
* * The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files. *
* * @param defaultS3Location * The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files. */ public void setDefaultS3Location(String defaultS3Location) { this.defaultS3Location = defaultS3Location; } /** ** The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files. *
* * @return The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files. */ public String getDefaultS3Location() { return this.defaultS3Location; } /** ** The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files. *
* * @param defaultS3Location * The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateStudioRequest withDefaultS3Location(String defaultS3Location) { setDefaultS3Location(defaultS3Location); return this; } /** ** 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. *
* * @param 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. */ public void setIdpAuthUrl(String idpAuthUrl) { this.idpAuthUrl = 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. *
* * @return 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. */ public String getIdpAuthUrl() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateStudioRequest withIdpAuthUrl(String idpAuthUrl) { setIdpAuthUrl(idpAuthUrl); return this; } /** *
* 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.
*
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.
*/
public void setIdpRelayStateParameterName(String idpRelayStateParameterName) {
this.idpRelayStateParameterName = 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.
*
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.
*/
public String getIdpRelayStateParameterName() {
return this.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.
*
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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStudioRequest withIdpRelayStateParameterName(String idpRelayStateParameterName) {
setIdpRelayStateParameterName(idpRelayStateParameterName);
return this;
}
/**
* * 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. *
* * @return 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. */ public java.util.List* 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. *
* * @param 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. */ public void setTags(java.util.Collection* 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 * {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the * existing values. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateStudioRequest withTags(Tag... tags) { if (this.tags == null) { setTags(new com.amazonaws.internal.SdkInternalList* 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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateStudioRequest withTags(java.util.Collection