Package software.amazon.awscdk.services.emr

Class CfnStudio

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.emr.CfnStudio
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.661Z") @Stability(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();

  • 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 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 Details

    • 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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • 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.

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

      The service role provides a way for Amazon EMR Studio to interoperate with other AWS services.

    • 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.

      The service role provides a way for Amazon EMR Studio to interoperate with other AWS services.

    • getSubnetIds

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

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

    • setWorkspaceSecurityGroupId

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

    • getIdpAuthUrl

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

    • 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.

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