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.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::EMR::Studio", "Properties" : { "AuthMode" :
String
, "DefaultS3Location" :String
, "Description" :String
, "EngineSecurityGroupId" :String
, "IdpAuthUrl" :String
, "IdpRelayStateParameterName" :String
, "Name" :String
, "ServiceRole" :String
, "SubnetIds" :[ String, ... ]
, "Tags" :[ Tag, ... ]
, "UserRole" :String
, "VpcId" :String
, "WorkspaceSecurityGroupId" :String
} }
YAML
Type: AWS::EMR::Studio Properties: AuthMode:
String
DefaultS3Location:String
Description:String
EngineSecurityGroupId:String
IdpAuthUrl:String
IdpRelayStateParameterName:String
Name:String
ServiceRole:String
SubnetIds:- String
Tags:- Tag
UserRole:String
VpcId:String
WorkspaceSecurityGroupId:String
Properties
AuthMode
-
Specifies whether the Studio authenticates users using IAM Identity Center or IAM.
Required: Yes
Type: String
Allowed values:
IAM | SSO
Update requires: Replacement
DefaultS3Location
-
The Amazon S3 location to back up EMR Studio Workspaces and notebook files.
Required: Yes
Type: String
Minimum:
0
Maximum:
10280
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Update requires: No interruption
Description
-
A detailed description of the Amazon EMR Studio.
Required: No
Type: String
Minimum:
0
Maximum:
256
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Update requires: No interruption
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
.Required: Yes
Type: String
Minimum:
0
Maximum:
256
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Update requires: Replacement
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.
Required: No
Type: String
Minimum:
0
Maximum:
10280
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Update requires: No interruption
IdpRelayStateParameterName
-
The name of your identity provider's
RelayState
parameter.Required: No
Type: String
Minimum:
0
Maximum:
256
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Update requires: No interruption
Name
-
A descriptive name for the Amazon EMR Studio.
Required: Yes
Type: String
Minimum:
0
Maximum:
256
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Update requires: No interruption
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.
Required: Yes
Type: String
Minimum:
0
Maximum:
10280
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Update requires: Replacement
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.Required: Yes
Type: List of String
Update requires: No interruption
Tags
-
An array of key-value pairs to apply to this resource.
For more information, see Tag.
Required: No
Type: List of Tag
Update requires: No interruption
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 setAuthMode
toSSO
.Required: No
Type: String
Minimum:
0
Maximum:
10280
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Update requires: Replacement
VpcId
-
The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
Required: Yes
Type: String
Minimum:
0
Maximum:
256
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Update requires: Replacement
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.
Required: Yes
Type: String
Minimum:
0
Maximum:
256
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Update requires: Replacement
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the resource ID. For example:
{ "Ref": "es-EXAMPLE12345678XXXXXXXXXXX" }
Ref returns the ID of the Amazon EMR Studio.
For more information about using the Ref
function, see Ref.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt.
Arn
-
The Amazon Resource Name (ARN) of the Amazon EMR Studio. For example:
arn:aws:elasticmapreduce:us-east-1:653XXXXXXXXX:studio/es-EXAMPLE12345678XXXXXXXXXXX
. StudioId
-
The ID of the Amazon EMR Studio. For example:
es-EXAMPLE12345678XXXXXXXXXXX
. Url
-
The unique access URL of the Amazon EMR Studio. For example:
https://es-EXAMPLE12345678XXXXXXXXXXX.emrstudio-prod.us-east-1.amazonaws.com
.