Docs Home
AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi
aws.emr.Studio
Explore with Pulumi AI
Provides an Elastic MapReduce Studio.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.emr.Studio("example", {
authMode: "SSO",
defaultS3Location: `s3://${test.bucket}/test`,
engineSecurityGroupId: testAwsSecurityGroup.id,
name: "example",
serviceRole: testAwsIamRole.arn,
subnetIds: [testAwsSubnet.id],
userRole: testAwsIamRole.arn,
vpcId: testAwsVpc.id,
workspaceSecurityGroupId: testAwsSecurityGroup.id,
});
import pulumi
import pulumi_aws as aws
example = aws.emr.Studio("example",
auth_mode="SSO",
default_s3_location=f"s3://{test['bucket']}/test",
engine_security_group_id=test_aws_security_group["id"],
name="example",
service_role=test_aws_iam_role["arn"],
subnet_ids=[test_aws_subnet["id"]],
user_role=test_aws_iam_role["arn"],
vpc_id=test_aws_vpc["id"],
workspace_security_group_id=test_aws_security_group["id"])
package main
import (
"fmt"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/emr"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := emr.NewStudio(ctx, "example", &emr.StudioArgs{
AuthMode: pulumi.String("SSO"),
DefaultS3Location: pulumi.Sprintf("s3://%v/test", test.Bucket),
EngineSecurityGroupId: pulumi.Any(testAwsSecurityGroup.Id),
Name: pulumi.String("example"),
ServiceRole: pulumi.Any(testAwsIamRole.Arn),
SubnetIds: pulumi.StringArray{
testAwsSubnet.Id,
},
UserRole: pulumi.Any(testAwsIamRole.Arn),
VpcId: pulumi.Any(testAwsVpc.Id),
WorkspaceSecurityGroupId: pulumi.Any(testAwsSecurityGroup.Id),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Emr.Studio("example", new()
{
AuthMode = "SSO",
DefaultS3Location = $"s3://{test.Bucket}/test",
EngineSecurityGroupId = testAwsSecurityGroup.Id,
Name = "example",
ServiceRole = testAwsIamRole.Arn,
SubnetIds = new[]
{
testAwsSubnet.Id,
},
UserRole = testAwsIamRole.Arn,
VpcId = testAwsVpc.Id,
WorkspaceSecurityGroupId = testAwsSecurityGroup.Id,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.emr.Studio;
import com.pulumi.aws.emr.StudioArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Studio("example", StudioArgs.builder()
.authMode("SSO")
.defaultS3Location(String.format("s3://%s/test", test.bucket()))
.engineSecurityGroupId(testAwsSecurityGroup.id())
.name("example")
.serviceRole(testAwsIamRole.arn())
.subnetIds(testAwsSubnet.id())
.userRole(testAwsIamRole.arn())
.vpcId(testAwsVpc.id())
.workspaceSecurityGroupId(testAwsSecurityGroup.id())
.build());
}
}
resources:
example:
type: aws:emr:Studio
properties:
authMode: SSO
defaultS3Location: s3://${test.bucket}/test
engineSecurityGroupId: ${testAwsSecurityGroup.id}
name: example
serviceRole: ${testAwsIamRole.arn}
subnetIds:
- ${testAwsSubnet.id}
userRole: ${testAwsIamRole.arn}
vpcId: ${testAwsVpc.id}
workspaceSecurityGroupId: ${testAwsSecurityGroup.id}
Create Studio Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Studio(name: string, args: StudioArgs, opts?: CustomResourceOptions);@overload
def Studio(resource_name: str,
args: StudioArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Studio(resource_name: str,
opts: Optional[ResourceOptions] = None,
service_role: Optional[str] = None,
default_s3_location: Optional[str] = None,
workspace_security_group_id: Optional[str] = None,
auth_mode: Optional[str] = None,
engine_security_group_id: Optional[str] = None,
vpc_id: Optional[str] = None,
subnet_ids: Optional[Sequence[str]] = None,
encryption_key_arn: Optional[str] = None,
name: Optional[str] = None,
idp_relay_state_parameter_name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
user_role: Optional[str] = None,
idp_auth_url: Optional[str] = None,
description: Optional[str] = None)func NewStudio(ctx *Context, name string, args StudioArgs, opts ...ResourceOption) (*Studio, error)public Studio(string name, StudioArgs args, CustomResourceOptions? opts = null)public Studio(String name, StudioArgs args)
public Studio(String name, StudioArgs args, CustomResourceOptions options)
type: aws:emr:Studio
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. StudioArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. StudioArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. StudioArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. StudioArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. StudioArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var studioResource = new Aws.Emr.Studio("studioResource", new()
{
ServiceRole = "string",
DefaultS3Location = "string",
WorkspaceSecurityGroupId = "string",
AuthMode = "string",
EngineSecurityGroupId = "string",
VpcId = "string",
SubnetIds = new[]
{
"string",
},
EncryptionKeyArn = "string",
Name = "string",
IdpRelayStateParameterName = "string",
Tags =
{
{ "string", "string" },
},
UserRole = "string",
IdpAuthUrl = "string",
Description = "string",
});
example, err := emr.NewStudio(ctx, "studioResource", &emr.StudioArgs{
ServiceRole: pulumi.String("string"),
DefaultS3Location: pulumi.String("string"),
WorkspaceSecurityGroupId: pulumi.String("string"),
AuthMode: pulumi.String("string"),
EngineSecurityGroupId: pulumi.String("string"),
VpcId: pulumi.String("string"),
SubnetIds: pulumi.StringArray{
pulumi.String("string"),
},
EncryptionKeyArn: pulumi.String("string"),
Name: pulumi.String("string"),
IdpRelayStateParameterName: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
UserRole: pulumi.String("string"),
IdpAuthUrl: pulumi.String("string"),
Description: pulumi.String("string"),
})
var studioResource = new Studio("studioResource", StudioArgs.builder()
.serviceRole("string")
.defaultS3Location("string")
.workspaceSecurityGroupId("string")
.authMode("string")
.engineSecurityGroupId("string")
.vpcId("string")
.subnetIds("string")
.encryptionKeyArn("string")
.name("string")
.idpRelayStateParameterName("string")
.tags(Map.of("string", "string"))
.userRole("string")
.idpAuthUrl("string")
.description("string")
.build());
studio_resource = aws.emr.Studio("studioResource",
service_role="string",
default_s3_location="string",
workspace_security_group_id="string",
auth_mode="string",
engine_security_group_id="string",
vpc_id="string",
subnet_ids=["string"],
encryption_key_arn="string",
name="string",
idp_relay_state_parameter_name="string",
tags={
"string": "string",
},
user_role="string",
idp_auth_url="string",
description="string")
const studioResource = new aws.emr.Studio("studioResource", {
serviceRole: "string",
defaultS3Location: "string",
workspaceSecurityGroupId: "string",
authMode: "string",
engineSecurityGroupId: "string",
vpcId: "string",
subnetIds: ["string"],
encryptionKeyArn: "string",
name: "string",
idpRelayStateParameterName: "string",
tags: {
string: "string",
},
userRole: "string",
idpAuthUrl: "string",
description: "string",
});
type: aws:emr:Studio
properties:
authMode: string
defaultS3Location: string
description: string
encryptionKeyArn: string
engineSecurityGroupId: string
idpAuthUrl: string
idpRelayStateParameterName: string
name: string
serviceRole: string
subnetIds:
- string
tags:
string: string
userRole: string
vpcId: string
workspaceSecurityGroupId: string
Studio Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Studio resource accepts the following input properties:
- Auth
Mode stringThis property is required. 
Changes to this property will trigger replacement. - Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO. Valid values are
SSOorIAM. - Default
S3Location This property is required. string - The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
- Engine
Security Group Id stringThis property is required. Changes to this property will trigger replacement. - 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
vpc_id. - Service
Role stringThis property is required. Changes to this property will trigger replacement. - 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.
- Subnet
Ids This property is required. List<string> - 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
vpc_id. Studio users can create a Workspace in any of the specified subnets. - Vpc
Id stringThis property is required. Changes to this property will trigger replacement. - The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
- Workspace
Security Group Id stringThis property is required. Changes to this property will trigger replacement. 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
vpc_id.The following arguments are optional:
- Description string
- A detailed description of the Amazon EMR Studio.
- Encryption
Key stringArn - The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
- Idp
Auth Url - 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.
- Idp
Relay State Parameter Name - 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.
- Name string
- A descriptive name for the Amazon EMR Studio.
- Dictionary<string, string>
- list of tags to apply to the EMR Cluster. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - User
Role - The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a User Role when you use Amazon Web Services SSO authentication. The permissions attached to the User Role can be scoped down for each user or group using session policies.
- Auth
Mode stringThis property is required. Changes to this property will trigger replacement. - Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO. Valid values are
SSOorIAM. - Default
S3Location This property is required. string - The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
- Engine
Security Group Id stringThis property is required. Changes to this property will trigger replacement. - 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
vpc_id. - Service
Role stringThis property is required. Changes to this property will trigger replacement. - 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.
- Subnet
Ids This property is required. []string - 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
vpc_id. Studio users can create a Workspace in any of the specified subnets. - Vpc
Id stringThis property is required. Changes to this property will trigger replacement. - The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
- Workspace
Security Group Id stringThis property is required. Changes to this property will trigger replacement. 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
vpc_id.The following arguments are optional:
- Description string
- A detailed description of the Amazon EMR Studio.
- Encryption
Key stringArn - The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
- Idp
Auth Url - 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.
- Idp
Relay State Parameter Name - 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.
- Name string
- A descriptive name for the Amazon EMR Studio.
- map[string]string
- list of tags to apply to the EMR Cluster. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - User
Role - The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a User Role when you use Amazon Web Services SSO authentication. The permissions attached to the User Role can be scoped down for each user or group using session policies.
- auth
Mode StringThis property is required. Changes to this property will trigger replacement. - Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO. Valid values are
SSOorIAM. - default
S3Location This property is required. String - The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
- engine
Security Group Id StringThis property is required. Changes to this property will trigger replacement. - 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
vpc_id. - service
Role StringThis property is required. Changes to this property will trigger replacement. - 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.
- subnet
Ids This property is required. List<String> - 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
vpc_id. Studio users can create a Workspace in any of the specified subnets. - vpc
Id StringThis property is required. Changes to this property will trigger replacement. - The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
- workspace
Security Group Id StringThis property is required. Changes to this property will trigger replacement. 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
vpc_id.The following arguments are optional:
- description String
- A detailed description of the Amazon EMR Studio.
- encryption
Key StringArn - The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
- idp
Auth Url - 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.
- idp
Relay State Parameter Name - 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.
- name String
- A descriptive name for the Amazon EMR Studio.
- Map<String,String>
- list of tags to apply to the EMR Cluster. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - user
Role - The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a User Role when you use Amazon Web Services SSO authentication. The permissions attached to the User Role can be scoped down for each user or group using session policies.
- auth
Mode stringThis property is required. Changes to this property will trigger replacement. - Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO. Valid values are
SSOorIAM. - default
S3Location This property is required. string - The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
- engine
Security Group Id stringThis property is required. Changes to this property will trigger replacement. - 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
vpc_id. - service
Role stringThis property is required. Changes to this property will trigger replacement. - 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.
- subnet
Ids This property is required. string[] - 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
vpc_id. Studio users can create a Workspace in any of the specified subnets. - vpc
Id stringThis property is required. Changes to this property will trigger replacement. - The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
- workspace
Security Group Id stringThis property is required. Changes to this property will trigger replacement. 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
vpc_id.The following arguments are optional:
- description string
- A detailed description of the Amazon EMR Studio.
- encryption
Key stringArn - The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
- idp
Auth Url - 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.
- idp
Relay State Parameter Name - 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.
- name string
- A descriptive name for the Amazon EMR Studio.
- {[key: string]: string}
- list of tags to apply to the EMR Cluster. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - user
Role - The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a User Role when you use Amazon Web Services SSO authentication. The permissions attached to the User Role can be scoped down for each user or group using session policies.
- auth_
mode strThis property is required. Changes to this property will trigger replacement. - Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO. Valid values are
SSOorIAM. - default_
s3_ location This property is required. str - The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
- engine_
security_ group_ id strThis property is required. Changes to this property will trigger replacement. - 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
vpc_id. - service_
role strThis property is required. Changes to this property will trigger replacement. - 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.
- subnet_
ids This property is required. Sequence[str] - 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
vpc_id. Studio users can create a Workspace in any of the specified subnets. - vpc_
id strThis property is required. Changes to this property will trigger replacement. - The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
- workspace_
security_ group_ id strThis property is required. Changes to this property will trigger replacement. 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
vpc_id.The following arguments are optional:
- description str
- A detailed description of the Amazon EMR Studio.
- encryption_
key_ strarn - The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
- idp_
auth_ url - 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.
- idp_
relay_ state_ parameter_ name - 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.
- name str
- A descriptive name for the Amazon EMR Studio.
- Mapping[str, str]
- list of tags to apply to the EMR Cluster. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - user_
role - The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a User Role when you use Amazon Web Services SSO authentication. The permissions attached to the User Role can be scoped down for each user or group using session policies.
- auth
Mode StringThis property is required. Changes to this property will trigger replacement. - Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO. Valid values are
SSOorIAM. - default
S3Location This property is required. String - The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
- engine
Security Group Id StringThis property is required. Changes to this property will trigger replacement. - 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
vpc_id. - service
Role StringThis property is required. Changes to this property will trigger replacement. - 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.
- subnet
Ids This property is required. List<String> - 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
vpc_id. Studio users can create a Workspace in any of the specified subnets. - vpc
Id StringThis property is required. Changes to this property will trigger replacement. - The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
- workspace
Security Group Id StringThis property is required. Changes to this property will trigger replacement. 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
vpc_id.The following arguments are optional:
- description String
- A detailed description of the Amazon EMR Studio.
- encryption
Key StringArn - The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
- idp
Auth Url - 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.
- idp
Relay State Parameter Name - 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.
- name String
- A descriptive name for the Amazon EMR Studio.
- Map<String>
- list of tags to apply to the EMR Cluster. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - user
Role - The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a User Role when you use Amazon Web Services SSO authentication. The permissions attached to the User Role can be scoped down for each user or group using session policies.
Outputs
All input properties are implicitly available as output properties. Additionally, the Studio resource produces the following output properties:
Look up Existing Studio Resource
Get an existing Studio resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: StudioState, opts?: CustomResourceOptions): Studio@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
auth_mode: Optional[str] = None,
default_s3_location: Optional[str] = None,
description: Optional[str] = None,
encryption_key_arn: Optional[str] = None,
engine_security_group_id: Optional[str] = None,
idp_auth_url: Optional[str] = None,
idp_relay_state_parameter_name: Optional[str] = None,
name: Optional[str] = None,
service_role: Optional[str] = None,
subnet_ids: Optional[Sequence[str]] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
url: Optional[str] = None,
user_role: Optional[str] = None,
vpc_id: Optional[str] = None,
workspace_security_group_id: Optional[str] = None) -> Studiofunc GetStudio(ctx *Context, name string, id IDInput, state *StudioState, opts ...ResourceOption) (*Studio, error)public static Studio Get(string name, Input<string> id, StudioState? state, CustomResourceOptions? opts = null)public static Studio get(String name, Output<String> id, StudioState state, CustomResourceOptions options)resources: _: type: aws:emr:Studio get: id: ${id}- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
This property is required. - The unique name of the resulting resource.
- id
This property is required. - The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
The following state arguments are supported:
- Arn string
- ARN of the studio.
- Auth
Mode - Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO. Valid values are
SSOorIAM. - Default
S3Location string - The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
- Description string
- A detailed description of the Amazon EMR Studio.
- Encryption
Key stringArn - The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
- Engine
Security Group Id - 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
vpc_id. - Idp
Auth Url - 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.
- Idp
Relay State Parameter Name - 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.
- Name string
- A descriptive name for the Amazon EMR Studio.
- Service
Role - 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.
- Subnet
Ids List<string> - 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
vpc_id. Studio users can create a Workspace in any of the specified subnets. - Dictionary<string, string>
- list of tags to apply to the EMR Cluster. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Dictionary<string, string>
- Url string
- The unique access URL of the Amazon EMR Studio.
- User
Role - The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a User Role when you use Amazon Web Services SSO authentication. The permissions attached to the User Role can be scoped down for each user or group using session policies.
- Vpc
Id - The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
- Workspace
Security Group Id 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
vpc_id.The following arguments are optional:
- Arn string
- ARN of the studio.
- Auth
Mode - Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO. Valid values are
SSOorIAM. - Default
S3Location string - The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
- Description string
- A detailed description of the Amazon EMR Studio.
- Encryption
Key stringArn - The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
- Engine
Security Group Id - 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
vpc_id. - Idp
Auth Url - 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.
- Idp
Relay State Parameter Name - 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.
- Name string
- A descriptive name for the Amazon EMR Studio.
- Service
Role - 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.
- Subnet
Ids []string - 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
vpc_id. Studio users can create a Workspace in any of the specified subnets. - map[string]string
- list of tags to apply to the EMR Cluster. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - map[string]string
- Url string
- The unique access URL of the Amazon EMR Studio.
- User
Role - The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a User Role when you use Amazon Web Services SSO authentication. The permissions attached to the User Role can be scoped down for each user or group using session policies.
- Vpc
Id - The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
- Workspace
Security Group Id 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
vpc_id.The following arguments are optional:
- arn String
- ARN of the studio.
- auth
Mode - Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO. Valid values are
SSOorIAM. - default
S3Location String - The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
- description String
- A detailed description of the Amazon EMR Studio.
- encryption
Key StringArn - The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
- engine
Security Group Id - 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
vpc_id. - idp
Auth Url - 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.
- idp
Relay State Parameter Name - 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.
- name String
- A descriptive name for the Amazon EMR Studio.
- service
Role - 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.
- subnet
Ids List<String> - 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
vpc_id. Studio users can create a Workspace in any of the specified subnets. - Map<String,String>
- list of tags to apply to the EMR Cluster. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String,String>
- url String
- The unique access URL of the Amazon EMR Studio.
- user
Role - The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a User Role when you use Amazon Web Services SSO authentication. The permissions attached to the User Role can be scoped down for each user or group using session policies.
- vpc
Id - The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
- workspace
Security Group Id 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
vpc_id.The following arguments are optional:
- arn string
- ARN of the studio.
- auth
Mode - Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO. Valid values are
SSOorIAM. - default
S3Location string - The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
- description string
- A detailed description of the Amazon EMR Studio.
- encryption
Key stringArn - The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
- engine
Security Group Id - 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
vpc_id. - idp
Auth Url - 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.
- idp
Relay State Parameter Name - 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.
- name string
- A descriptive name for the Amazon EMR Studio.
- service
Role - 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.
- subnet
Ids string[] - 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
vpc_id. Studio users can create a Workspace in any of the specified subnets. - {[key: string]: string}
- list of tags to apply to the EMR Cluster. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - {[key: string]: string}
- url string
- The unique access URL of the Amazon EMR Studio.
- user
Role - The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a User Role when you use Amazon Web Services SSO authentication. The permissions attached to the User Role can be scoped down for each user or group using session policies.
- vpc
Id - The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
- workspace
Security Group Id 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
vpc_id.The following arguments are optional:
- arn str
- ARN of the studio.
- auth_
mode - Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO. Valid values are
SSOorIAM. - default_
s3_ strlocation - The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
- description str
- A detailed description of the Amazon EMR Studio.
- encryption_
key_ strarn - The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
- engine_
security_ group_ id - 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
vpc_id. - idp_
auth_ url - 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.
- idp_
relay_ state_ parameter_ name - 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.
- name str
- A descriptive name for the Amazon EMR Studio.
- service_
role - 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.
- subnet_
ids Sequence[str] - 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
vpc_id. Studio users can create a Workspace in any of the specified subnets. - Mapping[str, str]
- list of tags to apply to the EMR Cluster. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Mapping[str, str]
- url str
- The unique access URL of the Amazon EMR Studio.
- user_
role - The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a User Role when you use Amazon Web Services SSO authentication. The permissions attached to the User Role can be scoped down for each user or group using session policies.
- vpc_
id - The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
- workspace_
security_ group_ id 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
vpc_id.The following arguments are optional:
- arn String
- ARN of the studio.
- auth
Mode - Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO. Valid values are
SSOorIAM. - default
S3Location String - The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
- description String
- A detailed description of the Amazon EMR Studio.
- encryption
Key StringArn - The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
- engine
Security Group Id - 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
vpc_id. - idp
Auth Url - 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.
- idp
Relay State Parameter Name - 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.
- name String
- A descriptive name for the Amazon EMR Studio.
- service
Role - 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.
- subnet
Ids List<String> - 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
vpc_id. Studio users can create a Workspace in any of the specified subnets. - Map<String>
- list of tags to apply to the EMR Cluster. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String>
- url String
- The unique access URL of the Amazon EMR Studio.
- user
Role - The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a User Role when you use Amazon Web Services SSO authentication. The permissions attached to the User Role can be scoped down for each user or group using session policies.
- vpc
Id - The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
- workspace
Security Group Id 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
vpc_id.The following arguments are optional:
Import
Using pulumi import, import EMR studios using the id. For example:
$ pulumi import aws:emr/studio:Studio studio es-123456ABCDEF
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.