Skip to content

/AWS1/CL_EMR=>CREATESTUDIO()

About CreateStudio

Creates a new Amazon EMR Studio.

Method Signature

IMPORTING

Required arguments:

iv_name TYPE /AWS1/EMRXMLSTRINGMAXLEN256 /AWS1/EMRXMLSTRINGMAXLEN256

A descriptive name for the Amazon EMR Studio.

iv_authmode TYPE /AWS1/EMRAUTHMODE /AWS1/EMRAUTHMODE

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

iv_vpcid TYPE /AWS1/EMRXMLSTRINGMAXLEN256 /AWS1/EMRXMLSTRINGMAXLEN256

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

it_subnetids TYPE /AWS1/CL_EMRSUBNETIDLIST_W=>TT_SUBNETIDLIST TT_SUBNETIDLIST

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.

iv_servicerole TYPE /AWS1/EMRXMLSTRING /AWS1/EMRXMLSTRING

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.

iv_workspacesecuritygroupid TYPE /AWS1/EMRXMLSTRINGMAXLEN256 /AWS1/EMRXMLSTRINGMAXLEN256

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.

iv_enginesecuritygroupid TYPE /AWS1/EMRXMLSTRINGMAXLEN256 /AWS1/EMRXMLSTRINGMAXLEN256

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.

iv_defaults3location TYPE /AWS1/EMRXMLSTRING /AWS1/EMRXMLSTRING

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

Optional arguments:

iv_description TYPE /AWS1/EMRXMLSTRINGMAXLEN256 /AWS1/EMRXMLSTRINGMAXLEN256

A detailed description of the Amazon EMR Studio.

iv_userrole TYPE /AWS1/EMRXMLSTRING /AWS1/EMRXMLSTRING

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.

iv_idpauthurl TYPE /AWS1/EMRXMLSTRING /AWS1/EMRXMLSTRING

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.

iv_idprelaystateparamname TYPE /AWS1/EMRXMLSTRINGMAXLEN256 /AWS1/EMRXMLSTRINGMAXLEN256

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.

it_tags TYPE /AWS1/CL_EMRTAG=>TT_TAGLIST TT_TAGLIST

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.

iv_trustedidpropagationenbd TYPE /AWS1/EMRBOOLEANOBJECT /AWS1/EMRBOOLEANOBJECT

A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.

iv_idcuserassignment TYPE /AWS1/EMRIDCUSERASSIGNMENT /AWS1/EMRIDCUSERASSIGNMENT

Specifies whether IAM Identity Center user assignment is REQUIRED or OPTIONAL. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio.

iv_idcinstancearn TYPE /AWS1/EMRARNTYPE /AWS1/EMRARNTYPE

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

iv_encryptionkeyarn TYPE /AWS1/EMRXMLSTRING /AWS1/EMRXMLSTRING

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

RETURNING

oo_output TYPE REF TO /aws1/cl_emrcreatestudiooutput /AWS1/CL_EMRCREATESTUDIOOUTPUT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->/aws1/if_emr~createstudio(
  it_subnetids = VALUE /aws1/cl_emrsubnetidlist_w=>tt_subnetidlist(
    ( new /aws1/cl_emrsubnetidlist_w( |string| ) )
  )
  it_tags = VALUE /aws1/cl_emrtag=>tt_taglist(
    (
      new /aws1/cl_emrtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_authmode = |string|
  iv_defaults3location = |string|
  iv_description = |string|
  iv_encryptionkeyarn = |string|
  iv_enginesecuritygroupid = |string|
  iv_idcinstancearn = |string|
  iv_idcuserassignment = |string|
  iv_idpauthurl = |string|
  iv_idprelaystateparamname = |string|
  iv_name = |string|
  iv_servicerole = |string|
  iv_trustedidpropagationenbd = ABAP_TRUE
  iv_userrole = |string|
  iv_vpcid = |string|
  iv_workspacesecuritygroupid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_xmlstringmaxlen256 = lo_result->get_studioid( ).
  lv_xmlstring = lo_result->get_url( ).
ENDIF.