software.amazon.awscdk.services.emr

Class CfnStudio

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.emr.CfnStudio

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.236Z")
 @Stability(value=Stable)
public class CfnStudio
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EMR::Studio`.

The AWS::EMR::Studio resource specifies an Amazon EMR Studio. An EMR Studio is a web-based, integrated development environment for fully managed Jupyter notebooks that run on Amazon EMR clusters. For more information, see the Amazon EMR Management Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.emr.*;
 CfnStudio cfnStudio = CfnStudio.Builder.create(this, "MyCfnStudio")
         .authMode("authMode")
         .defaultS3Location("defaultS3Location")
         .engineSecurityGroupId("engineSecurityGroupId")
         .name("name")
         .serviceRole("serviceRole")
         .subnetIds(List.of("subnetIds"))
         .vpcId("vpcId")
         .workspaceSecurityGroupId("workspaceSecurityGroupId")
         // the properties below are optional
         .description("description")
         .idpAuthUrl("idpAuthUrl")
         .idpRelayStateParameterName("idpRelayStateParameterName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .userRole("userRole")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnStudio.Builder A fluent builder for CfnStudio.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnStudio(software.constructs.Construct scope, String id, CfnStudioProps props) Create a new `AWS::EMR::Studio`.
protected	CfnStudio(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnStudio(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name (ARN) of the Amazon EMR Studio.
String	getAttrStudioId() The ID of the Amazon EMR Studio.
String	getAttrUrl() The unique access URL of the Amazon EMR Studio.
String	getAuthMode() Specifies whether the Studio authenticates users using AWS SSO or IAM.
protected Map<String,Object>	getCfnProperties()
String	getDefaultS3Location() The Amazon S3 location to back up 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	getIdpAuthUrl() Your identity provider's authentication endpoint.
String	getIdpRelayStateParameterName() The name of your identity provider's `RelayState` parameter.
String	getName() A descriptive name for the Amazon EMR Studio.
String	getServiceRole() The Amazon Resource Name (ARN) of 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.
TagManager	getTags() An array of key-value pairs to apply to this resource.
String	getUserRole() The Amazon Resource Name (ARN) of the IAM user role that will be assumed by users and groups logged in to a Studio.
String	getVpcId() The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
String	getWorkspaceSecurityGroupId() The ID of the Workspace security group associated with the Amazon EMR Studio.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAuthMode(String value) Specifies whether the Studio authenticates users using AWS SSO or IAM.
void	setDefaultS3Location(String value) The Amazon S3 location to back up EMR Studio Workspaces and notebook files.
void	setDescription(String value) A detailed description of the Amazon EMR Studio.
void	setEngineSecurityGroupId(String value) The ID of the Amazon EMR Studio Engine security group.
void	setIdpAuthUrl(String value) Your identity provider's authentication endpoint.
void	setIdpRelayStateParameterName(String value) The name of your identity provider's `RelayState` parameter.
void	setName(String value) A descriptive name for the Amazon EMR Studio.
void	setServiceRole(String value) The Amazon Resource Name (ARN) of the IAM role that will be assumed by the Amazon EMR Studio.
void	setSubnetIds(List<String> value) A list of subnet IDs to associate with the Amazon EMR Studio.
void	setUserRole(String value) The Amazon Resource Name (ARN) of the IAM user role that will be assumed by users and groups logged in to a Studio.
void	setVpcId(String value) The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
void	setWorkspaceSecurityGroupId(String value) The ID of the Workspace security group associated with the Amazon EMR Studio.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnStudio

protected CfnStudio(software.amazon.jsii.JsiiObjectRef objRef)

CfnStudio

protected CfnStudio(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnStudio

@Stability(value=Stable)
public CfnStudio(@NotNull
                                          software.constructs.Construct scope,
                                          @NotNull
                                          String id,
                                          @NotNull
                                          CfnStudioProps props)

Create a new `AWS::EMR::Studio`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the Amazon EMR Studio.

For example: arn:aws:elasticmapreduce:us-east-1:653XXXXXXXXX:studio/es-EXAMPLE12345678XXXXXXXXXXX .

getAttrStudioId

@Stability(value=Stable)
 @NotNull
public String getAttrStudioId()

The ID of the Amazon EMR Studio.

For example: es-EXAMPLE12345678XXXXXXXXXXX .

getAttrUrl

@Stability(value=Stable)
 @NotNull
public String getAttrUrl()

The unique access URL of the Amazon EMR Studio.

For example: https://es-EXAMPLE12345678XXXXXXXXXXX.emrstudio-prod.us-east-1.amazonaws.com .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

For more information, see Tag .

getAuthMode

@Stability(value=Stable)
 @NotNull
public String getAuthMode()

Specifies whether the Studio authenticates users using AWS SSO or IAM.

setAuthMode

@Stability(value=Stable)
public void setAuthMode(@NotNull
                                                 String value)

Specifies whether the Studio authenticates users using AWS SSO or IAM.

getDefaultS3Location

@Stability(value=Stable)
 @NotNull
public String getDefaultS3Location()

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

setDefaultS3Location

@Stability(value=Stable)
public void setDefaultS3Location(@NotNull
                                                          String value)

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

getEngineSecurityGroupId

@Stability(value=Stable)
 @NotNull
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 .

setEngineSecurityGroupId

@Stability(value=Stable)
public void setEngineSecurityGroupId(@NotNull
                                                              String value)

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 .

getName

@Stability(value=Stable)
 @NotNull
public String getName()

A descriptive name for the Amazon EMR Studio.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

A descriptive name for the Amazon EMR Studio.

getServiceRole

@Stability(value=Stable)
 @NotNull
public String getServiceRole()

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.

setServiceRole

@Stability(value=Stable)
public void setServiceRole(@NotNull
                                                    String value)

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.

getSubnetIds

@Stability(value=Stable)
 @NotNull
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.

setSubnetIds

@Stability(value=Stable)
public void setSubnetIds(@NotNull
                                                  List<String> value)

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.

getVpcId

@Stability(value=Stable)
 @NotNull
public String getVpcId()

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

setVpcId

@Stability(value=Stable)
public void setVpcId(@NotNull
                                              String value)

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

getWorkspaceSecurityGroupId

@Stability(value=Stable)
 @NotNull
public String getWorkspaceSecurityGroupId()

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.

setWorkspaceSecurityGroupId

@Stability(value=Stable)
public void setWorkspaceSecurityGroupId(@NotNull
                                                                 String value)

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.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A detailed description of the Amazon EMR Studio.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A detailed description of the Amazon EMR Studio.

getIdpAuthUrl

@Stability(value=Stable)
 @Nullable
public String getIdpAuthUrl()

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.

setIdpAuthUrl

@Stability(value=Stable)
public void setIdpAuthUrl(@Nullable
                                                   String value)

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.

getIdpRelayStateParameterName

@Stability(value=Stable)
 @Nullable
public String getIdpRelayStateParameterName()

The name of your identity provider's `RelayState` parameter.

setIdpRelayStateParameterName

@Stability(value=Stable)
public void setIdpRelayStateParameterName(@Nullable
                                                                   String value)

The name of your identity provider's `RelayState` parameter.

getUserRole

@Stability(value=Stable)
 @Nullable
public String getUserRole()

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 .

setUserRole

@Stability(value=Stable)
public void setUserRole(@Nullable
                                                 String value)

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 .