Package software.amazon.awscdk.services.emr

Class CfnStudio.Builder

java.lang.Object

software.amazon.awscdk.services.emr.CfnStudio.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnStudio>

Enclosing class:

CfnStudio

@Stability(Stable)
public static final class CfnStudio.Builder
extends Object
implements software.amazon.jsii.Builder<CfnStudio>

A fluent builder for CfnStudio.

Method Summary

Modifier and Type	Method	Description
CfnStudio.Builder	authMode(String authMode)	Specifies whether the Studio authenticates users using IAM Identity Center or IAM.
CfnStudio	build()
static CfnStudio.Builder	create(software.constructs.Construct scope, String id)
CfnStudio.Builder	defaultS3Location(String defaultS3Location)	The Amazon S3 location to back up EMR Studio Workspaces and notebook files.
CfnStudio.Builder	description(String description)	A detailed description of the Amazon EMR Studio.
CfnStudio.Builder	encryptionKeyArn(String encryptionKeyArn)	The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
CfnStudio.Builder	engineSecurityGroupId(String engineSecurityGroupId)	The ID of the Amazon EMR Studio Engine security group.
CfnStudio.Builder	idcInstanceArn(String idcInstanceArn)	The ARN of the IAM Identity Center instance the Studio application belongs to.
CfnStudio.Builder	idcUserAssignment(String idcUserAssignment)	Indicates whether the Studio has REQUIRED or OPTIONAL IAM Identity Center user assignment.
CfnStudio.Builder	idpAuthUrl(String idpAuthUrl)	Your identity provider's authentication endpoint.
CfnStudio.Builder	idpRelayStateParameterName(String idpRelayStateParameterName)	The name of your identity provider's RelayState parameter.
CfnStudio.Builder	name(String name)	A descriptive name for the Amazon EMR Studio.
CfnStudio.Builder	serviceRole(String serviceRole)	The Amazon Resource Name (ARN) of the IAM role that will be assumed by the Amazon EMR Studio.
CfnStudio.Builder	subnetIds(List<String> subnetIds)	A list of subnet IDs to associate with the Amazon EMR Studio.
CfnStudio.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs to apply to this resource.
CfnStudio.Builder	trustedIdentityPropagationEnabled(Boolean trustedIdentityPropagationEnabled)	Indicates whether the Studio has Trusted identity propagation enabled.
CfnStudio.Builder	trustedIdentityPropagationEnabled(IResolvable trustedIdentityPropagationEnabled)	Indicates whether the Studio has Trusted identity propagation enabled.
CfnStudio.Builder	userRole(String userRole)	The Amazon Resource Name (ARN) of the IAM user role that will be assumed by users and groups logged in to a Studio.
CfnStudio.Builder	vpcId(String vpcId)	The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
CfnStudio.Builder	workspaceSecurityGroupId(String workspaceSecurityGroupId)	The ID of the Workspace security group associated with the Amazon EMR Studio.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnStudio.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnStudio.Builder.

authMode

@Stability(Stable)
public CfnStudio.Builder authMode(String authMode)

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

Parameters:

authMode - Specifies whether the Studio authenticates users using IAM Identity Center or IAM. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-authmode

defaultS3Location

@Stability(Stable)
public CfnStudio.Builder defaultS3Location(String defaultS3Location)

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

Parameters:

defaultS3Location - The Amazon S3 location to back up EMR Studio Workspaces and notebook files. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-defaults3location

engineSecurityGroupId

@Stability(Stable)
public CfnStudio.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-enginesecuritygroupid

name

@Stability(Stable)
public CfnStudio.Builder name(String name)

A descriptive name for the Amazon EMR Studio.

Parameters:

name - A descriptive name for the Amazon EMR Studio. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-name

serviceRole

@Stability(Stable)
public CfnStudio.Builder serviceRole(String serviceRole)

The Amazon Resource Name (ARN) of 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 Amazon Resource Name (ARN) of the IAM role that will be assumed by the Amazon EMR Studio. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-servicerole

subnetIds

@Stability(Stable)
public CfnStudio.Builder subnetIds(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.

Parameters:

subnetIds - A list of subnet IDs to associate with the Amazon EMR Studio. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-subnetids

vpcId

@Stability(Stable)
public CfnStudio.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-vpcid

workspaceSecurityGroupId

@Stability(Stable)
public CfnStudio.Builder workspaceSecurityGroupId(String workspaceSecurityGroupId)

The ID of the Workspace security group associated with the Amazon EMR Studio.

The Workspace security group allows outbound network traffic to resources in the Engine security group and to the internet.

Parameters:

workspaceSecurityGroupId - The ID of the Workspace security group associated with the Amazon EMR Studio. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-workspacesecuritygroupid

description

@Stability(Stable)
public CfnStudio.Builder description(String description)

A detailed description of the Amazon EMR Studio.

Parameters:

description - A detailed description of the Amazon EMR Studio. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-description

encryptionKeyArn

@Stability(Stable)
public CfnStudio.Builder encryptionKeyArn(String encryptionKeyArn)

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

Parameters:

encryptionKeyArn - The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-encryptionkeyarn

idcInstanceArn

@Stability(Stable)
public CfnStudio.Builder idcInstanceArn(String idcInstanceArn)

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

Parameters:

idcInstanceArn - The ARN of the IAM Identity Center instance the Studio application belongs to. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-idcinstancearn

idcUserAssignment

@Stability(Stable)
public CfnStudio.Builder idcUserAssignment(String idcUserAssignment)

Indicates whether the Studio has REQUIRED or OPTIONAL IAM Identity Center user assignment.

If the value is set to REQUIRED , users must be explicitly assigned to the Studio application to access the Studio.

Parameters:

idcUserAssignment - Indicates whether the Studio has REQUIRED or OPTIONAL IAM Identity Center user assignment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-idcuserassignment

idpAuthUrl

@Stability(Stable)
public CfnStudio.Builder idpAuthUrl(String idpAuthUrl)

Your identity provider's authentication endpoint.

Amazon EMR Studio redirects federated users to this endpoint for authentication when logging in to a Studio with the Studio URL.

Parameters:

idpAuthUrl - Your identity provider's authentication endpoint. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-idpauthurl

idpRelayStateParameterName

@Stability(Stable)
public CfnStudio.Builder idpRelayStateParameterName(String idpRelayStateParameterName)

The name of your identity provider's RelayState parameter.

Parameters:

idpRelayStateParameterName - The name of your identity provider's RelayState parameter. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-idprelaystateparametername

tags

@Stability(Stable)
public CfnStudio.Builder tags(List<? extends CfnTag> tags)

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-tags

trustedIdentityPropagationEnabled

@Stability(Stable)
public CfnStudio.Builder trustedIdentityPropagationEnabled(Boolean trustedIdentityPropagationEnabled)

Indicates whether the Studio has Trusted identity propagation enabled.

The default value is false .

Parameters:

trustedIdentityPropagationEnabled - Indicates whether the Studio has Trusted identity propagation enabled. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-trustedidentitypropagationenabled

trustedIdentityPropagationEnabled

@Stability(Stable)
public CfnStudio.Builder trustedIdentityPropagationEnabled(IResolvable trustedIdentityPropagationEnabled)

Indicates whether the Studio has Trusted identity propagation enabled.

The default value is false .

Parameters:

trustedIdentityPropagationEnabled - Indicates whether the Studio has Trusted identity propagation enabled. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-trustedidentitypropagationenabled

userRole

@Stability(Stable)
public CfnStudio.Builder userRole(String userRole)

The Amazon Resource Name (ARN) of the IAM user role that will be assumed by users and groups logged in to a Studio.

The permissions attached to this IAM role can be scoped down for each user or group using session policies. You only need to specify UserRole when you set AuthMode to SSO .

Parameters:

userRole - The Amazon Resource Name (ARN) of the IAM user role that will be assumed by users and groups logged in to a Studio. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-userrole

build

@Stability(Stable)
public CfnStudio build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnStudio>

Returns:

a newly built instance of CfnStudio.