Package 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, IStudioRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:05.862Z") @Stability(Stable) public class CfnStudio extends CfnResource implements IInspectable, IStudioRef, ITaggable
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")
         .encryptionKeyArn("encryptionKeyArn")
         .idcInstanceArn("idcInstanceArn")
         .idcUserAssignment("idcUserAssignment")
         .idpAuthUrl("idpAuthUrl")
         .idpRelayStateParameterName("idpRelayStateParameterName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .trustedIdentityPropagationEnabled(false)
         .userRole("userRole")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnStudio

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

    • CfnStudio

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

    • CfnStudio

      @Stability(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 - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromStudioArn

      @Stability(Stable) @NotNull public static IStudioRef fromStudioArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IStudioRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromStudioId

      @Stability(Stable) @NotNull public static IStudioRef fromStudioId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String studioId)
      Creates a new IStudioRef from a studioId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      studioId - This parameter is required.

    • inspect

      @Stability(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(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(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(Stable) @NotNull public String getAttrStudioId()
      The ID of the Amazon EMR Studio.

      For example: es-EXAMPLE12345678XXXXXXXXXXX .

    • getAttrUrl

      @Stability(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(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getStudioRef

      @Stability(Stable) @NotNull public StudioReference getStudioRef()
      A reference to a Studio resource.
      Specified by:
      getStudioRef in interface IStudioRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAuthMode

      @Stability(Stable) @NotNull public String getAuthMode()
      Specifies whether the Studio authenticates users using IAM Identity Center or IAM.

    • setAuthMode

      @Stability(Stable) public void setAuthMode(@NotNull String value)
      Specifies whether the Studio authenticates users using IAM Identity Center or IAM.

    • getDefaultS3Location

      @Stability(Stable) @NotNull public String getDefaultS3Location()
      The Amazon S3 location to back up EMR Studio Workspaces and notebook files.

    • setDefaultS3Location

      @Stability(Stable) public void setDefaultS3Location(@NotNull String value)
      The Amazon S3 location to back up EMR Studio Workspaces and notebook files.

    • getEngineSecurityGroupId

      @Stability(Stable) @NotNull public String getEngineSecurityGroupId()
      The ID of the Amazon EMR Studio Engine security group.

    • setEngineSecurityGroupId

      @Stability(Stable) public void setEngineSecurityGroupId(@NotNull String value)
      The ID of the Amazon EMR Studio Engine security group.

    • getName

      @Stability(Stable) @NotNull public String getName()
      A descriptive name for the Amazon EMR Studio.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      A descriptive name for the Amazon EMR Studio.

    • getServiceRole

      @Stability(Stable) @NotNull public String getServiceRole()
      The Amazon Resource Name (ARN) of the IAM role that will be assumed by the Amazon EMR Studio.

    • setServiceRole

      @Stability(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.

    • getSubnetIds

      @Stability(Stable) @NotNull public List<String> getSubnetIds()
      A list of subnet IDs to associate with the Amazon EMR Studio.

    • setSubnetIds

      @Stability(Stable) public void setSubnetIds(@NotNull List<String> value)
      A list of subnet IDs to associate with the Amazon EMR Studio.

    • getVpcId

      @Stability(Stable) @NotNull public String getVpcId()
      The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.

    • setVpcId

      @Stability(Stable) public void setVpcId(@NotNull String value)
      The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.

    • getWorkspaceSecurityGroupId

      @Stability(Stable) @NotNull public String getWorkspaceSecurityGroupId()
      The ID of the Workspace security group associated with the Amazon EMR Studio.

    • setWorkspaceSecurityGroupId

      @Stability(Stable) public void setWorkspaceSecurityGroupId(@NotNull String value)
      The ID of the Workspace security group associated with the Amazon EMR Studio.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A detailed description of the Amazon EMR Studio.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A detailed description of the Amazon EMR Studio.

    • getEncryptionKeyArn

      @Stability(Stable) @Nullable public String getEncryptionKeyArn()
      The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.

    • setEncryptionKeyArn

      @Stability(Stable) public void setEncryptionKeyArn(@Nullable String value)
      The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.

    • getIdcInstanceArn

      @Stability(Stable) @Nullable public String getIdcInstanceArn()
      The ARN of the IAM Identity Center instance the Studio application belongs to.

    • setIdcInstanceArn

      @Stability(Stable) public void setIdcInstanceArn(@Nullable String value)
      The ARN of the IAM Identity Center instance the Studio application belongs to.

    • getIdcUserAssignment

      @Stability(Stable) @Nullable public String getIdcUserAssignment()
      Indicates whether the Studio has REQUIRED or OPTIONAL IAM Identity Center user assignment.

    • setIdcUserAssignment

      @Stability(Stable) public void setIdcUserAssignment(@Nullable String value)
      Indicates whether the Studio has REQUIRED or OPTIONAL IAM Identity Center user assignment.

    • getIdpAuthUrl

      @Stability(Stable) @Nullable public String getIdpAuthUrl()
      Your identity provider's authentication endpoint.

    • setIdpAuthUrl

      @Stability(Stable) public void setIdpAuthUrl(@Nullable String value)
      Your identity provider's authentication endpoint.

    • getIdpRelayStateParameterName

      @Stability(Stable) @Nullable public String getIdpRelayStateParameterName()
      The name of your identity provider's RelayState parameter.

    • setIdpRelayStateParameterName

      @Stability(Stable) public void setIdpRelayStateParameterName(@Nullable String value)
      The name of your identity provider's RelayState parameter.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.

    • getTrustedIdentityPropagationEnabled

      @Stability(Stable) @Nullable public Object getTrustedIdentityPropagationEnabled()
      Indicates whether the Studio has Trusted identity propagation enabled.

      Returns union: either Boolean or IResolvable

    • setTrustedIdentityPropagationEnabled

      @Stability(Stable) public void setTrustedIdentityPropagationEnabled(@Nullable Boolean value)
      Indicates whether the Studio has Trusted identity propagation enabled.

    • setTrustedIdentityPropagationEnabled

      @Stability(Stable) public void setTrustedIdentityPropagationEnabled(@Nullable IResolvable value)
      Indicates whether the Studio has Trusted identity propagation enabled.

    • getUserRole

      @Stability(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.

    • setUserRole

      @Stability(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.