This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::EMR::Studio
<a name="aws-resource-emr-studio"></a>

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 [https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-studio.html](https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-studio.html).

## Syntax
<a name="aws-resource-emr-studio-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-emr-studio-syntax.json"></a>

```
{
  "Type" : "AWS::EMR::Studio",
  "Properties" : {
      "[AuthMode](#cfn-emr-studio-authmode)" : String,
      "[DefaultS3Location](#cfn-emr-studio-defaults3location)" : String,
      "[Description](#cfn-emr-studio-description)" : String,
      "[EncryptionKeyArn](#cfn-emr-studio-encryptionkeyarn)" : String,
      "[EngineSecurityGroupId](#cfn-emr-studio-enginesecuritygroupid)" : String,
      "[IdcInstanceArn](#cfn-emr-studio-idcinstancearn)" : String,
      "[IdcUserAssignment](#cfn-emr-studio-idcuserassignment)" : String,
      "[IdpAuthUrl](#cfn-emr-studio-idpauthurl)" : String,
      "[IdpRelayStateParameterName](#cfn-emr-studio-idprelaystateparametername)" : String,
      "[Name](#cfn-emr-studio-name)" : String,
      "[ServiceRole](#cfn-emr-studio-servicerole)" : String,
      "[SubnetIds](#cfn-emr-studio-subnetids)" : [ String, ... ],
      "[Tags](#cfn-emr-studio-tags)" : [ Tag, ... ],
      "[TrustedIdentityPropagationEnabled](#cfn-emr-studio-trustedidentitypropagationenabled)" : Boolean,
      "[UserRole](#cfn-emr-studio-userrole)" : String,
      "[VpcId](#cfn-emr-studio-vpcid)" : String,
      "[WorkspaceSecurityGroupId](#cfn-emr-studio-workspacesecuritygroupid)" : String
    }
}
```

### YAML
<a name="aws-resource-emr-studio-syntax.yaml"></a>

```
Type: AWS::EMR::Studio
Properties:
  [AuthMode](#cfn-emr-studio-authmode): String
  [DefaultS3Location](#cfn-emr-studio-defaults3location): String
  [Description](#cfn-emr-studio-description): String
  [EncryptionKeyArn](#cfn-emr-studio-encryptionkeyarn): String
  [EngineSecurityGroupId](#cfn-emr-studio-enginesecuritygroupid): String
  [IdcInstanceArn](#cfn-emr-studio-idcinstancearn): String
  [IdcUserAssignment](#cfn-emr-studio-idcuserassignment): String
  [IdpAuthUrl](#cfn-emr-studio-idpauthurl): String
  [IdpRelayStateParameterName](#cfn-emr-studio-idprelaystateparametername): String
  [Name](#cfn-emr-studio-name): String
  [ServiceRole](#cfn-emr-studio-servicerole): String
  [SubnetIds](#cfn-emr-studio-subnetids): 
    - String
  [Tags](#cfn-emr-studio-tags): 
    - Tag
  [TrustedIdentityPropagationEnabled](#cfn-emr-studio-trustedidentitypropagationenabled): Boolean
  [UserRole](#cfn-emr-studio-userrole): String
  [VpcId](#cfn-emr-studio-vpcid): String
  [WorkspaceSecurityGroupId](#cfn-emr-studio-workspacesecuritygroupid): String
```

## Properties
<a name="aws-resource-emr-studio-properties"></a>

`AuthMode`  <a name="cfn-emr-studio-authmode"></a>
Specifies whether the Studio authenticates users using IAM Identity Center or IAM.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `SSO | IAM`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DefaultS3Location`  <a name="cfn-emr-studio-defaults3location"></a>
The Amazon S3 location to back up EMR Studio Workspaces and notebook files.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^s3://.*`  
*Minimum*: `6`  
*Maximum*: `10280`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-emr-studio-description"></a>
A detailed description of the Amazon EMR Studio.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EncryptionKeyArn`  <a name="cfn-emr-studio-encryptionkeyarn"></a>
The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws(-(cn|us-gov|iso-f|iso-e))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`EngineSecurityGroupId`  <a name="cfn-emr-studio-enginesecuritygroupid"></a>
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  
*Pattern*: `^sg-[a-zA-Z0-9\-._]+$`  
*Minimum*: `4`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`IdcInstanceArn`  <a name="cfn-emr-studio-idcinstancearn"></a>
 The ARN of the IAM Identity Center instance the Studio application belongs to.   
*Required*: No  
*Type*: String  
*Minimum*: `20`  
*Maximum*: `2048`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`IdcUserAssignment`  <a name="cfn-emr-studio-idcuserassignment"></a>
 Indicates whether the Studio has `REQUIRED` or `OPTIONAL` IAM Identity Center user assignment. If the value is set to `REQUIRED`, users must be explicitly assigned to the Studio application to access the Studio.   
*Required*: No  
*Type*: String  
*Allowed values*: `REQUIRED | OPTIONAL`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`IdpAuthUrl`  <a name="cfn-emr-studio-idpauthurl"></a>
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  
*Pattern*: `^https://[0-9a-zA-Z]([-.\w]*[0-9a-zA-Z])(:[0-9]*)*([?/#].*)?$`  
*Maximum*: `4096`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IdpRelayStateParameterName`  <a name="cfn-emr-studio-idprelaystateparametername"></a>
The name of your identity provider's `RelayState` parameter.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-emr-studio-name"></a>
A descriptive name for the Amazon EMR Studio.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[a-zA-Z0-9_-]+`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ServiceRole`  <a name="cfn-emr-studio-servicerole"></a>
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  
*Pattern*: `^arn:aws(-(cn|us-gov|iso-f|iso-e))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SubnetIds`  <a name="cfn-emr-studio-subnetids"></a>
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*: Array of String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-emr-studio-tags"></a>
An array of key-value pairs to apply to this resource.  
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).  
*Required*: No  
*Type*: Array of [Tag](aws-properties-emr-studio-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TrustedIdentityPropagationEnabled`  <a name="cfn-emr-studio-trustedidentitypropagationenabled"></a>
 Indicates whether the Studio has Trusted identity propagation enabled. The default value is `false`.   
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`UserRole`  <a name="cfn-emr-studio-userrole"></a>
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`.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws(-(cn|us-gov|iso-f|iso-e))?:[a-z-]+:(([a-z]+-)+[0-9])?:([0-9]{12})?:[^.]+$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`VpcId`  <a name="cfn-emr-studio-vpcid"></a>
The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(vpc-[0-9a-f]{8}|vpc-[0-9a-f]{17})$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`WorkspaceSecurityGroupId`  <a name="cfn-emr-studio-workspacesecuritygroupid"></a>
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  
*Pattern*: `^sg-[a-zA-Z0-9\-._]+$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-emr-studio-return-values"></a>

### Ref
<a name="aws-resource-emr-studio-return-values-ref"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-emr-studio-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-emr-studio-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the Amazon EMR Studio. For example: `arn:aws:elasticmapreduce:us-east-1:653XXXXXXXXX:studio/es-EXAMPLE12345678XXXXXXXXXXX`.

`StudioId`  <a name="StudioId-fn::getatt"></a>
The ID of the Amazon EMR Studio. For example: `es-EXAMPLE12345678XXXXXXXXXXX`.

`Url`  <a name="Url-fn::getatt"></a>
The unique access URL of the Amazon EMR Studio. For example: `https://es-EXAMPLE12345678XXXXXXXXXXX.emrstudio-prod.us-east-1.amazonaws.com`.

# AWS::EMR::Studio Tag
<a name="aws-properties-emr-studio-tag"></a>

A key-value pair containing user-defined metadata that you can associate with an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see [Tag Clusters](https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html). 

## Syntax
<a name="aws-properties-emr-studio-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-emr-studio-tag-syntax.json"></a>

```
{
  "[Key](#cfn-emr-studio-tag-key)" : String,
  "[Value](#cfn-emr-studio-tag-value)" : String
}
```

### YAML
<a name="aws-properties-emr-studio-tag-syntax.yaml"></a>

```
  [Key](#cfn-emr-studio-tag-key): String
  [Value](#cfn-emr-studio-tag-value): String
```

## Properties
<a name="aws-properties-emr-studio-tag-properties"></a>

`Key`  <a name="cfn-emr-studio-tag-key"></a>
A user-defined key, which is the minimum required information for a valid tag. For more information, see [Tag](https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html).   
*Required*: Yes  
*Type*: String  
*Pattern*: `^(?!aws:)[a-zA-Z+-=._:/]+$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-emr-studio-tag-value"></a>
A user-defined value, which is optional in a tag. For more information, see [Tag Clusters](https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html).   
*Required*: Yes  
*Type*: String  
*Pattern*: `[a-zA-Z+-=._:/]+$`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)