Studio class

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"])
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 main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_emr_studio" "example" {
  auth_mode                   = "SSO"
  default_s3_location         ="s3://${test.bucket}/test"
  engine_security_group_id    = testAwsSecurityGroup.id
  name                        = "example"
  service_role                = testAwsIamRole.arn
  subnet_ids                  = [testAwsSubnet.id]
  user_role                   = testAwsIamRole.arn
  vpc_id                      = testAwsVpc.id
  workspace_security_group_id = 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.ArrayList;
import java.util.Arrays;
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}

Import

Using pulumi import, import EMR studios using the id. For example:

$ pulumi import aws:emr/studio:Studio studio es-123456ABCDEF

Constructors

Studio(String name, {StudioArgs? args, CustomResourceOptions? options})
Creates a new Studio. name The Pulumi resource name. args Arguments used to configure this Studio. The set of arguments for Studio. options Resource options controlling this resource's behavior.
Studio.reference(String urn)
Creates a typed reference to an existing Studio resource.

Properties

arn ↔ Output<String>
ARN of the studio.
latefinal
authMode ↔ Output<String>
Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO. Valid values are SSO or IAM.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
defaultS3Location ↔ Output<String>
The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
latefinal
description ↔ Output<String?>
A detailed description of the Amazon EMR Studio.
latefinal
encryptionKeyArn ↔ Output<String?>
The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
latefinal
engineSecurityGroupId ↔ Output<String>
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.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
idpAuthUrl ↔ Output<String?>
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.
latefinal
idpRelayStateParameterName ↔ Output<String?>
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.
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>
A descriptive name for the Amazon EMR Studio.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serviceRole ↔ Output<String>
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.
latefinal
subnetIds ↔ Output<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 vpcId. Studio users can create a Workspace in any of the specified subnets.
latefinal
tags ↔ Output<Map<String, String>?>
list of tags to apply to the EMR Cluster. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
url ↔ Output<String>
The unique access URL of the Amazon EMR Studio.
latefinal
urn ↔ Output<String>
latefinalinherited
userRole ↔ Output<String?>
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.
latefinal
vpcId ↔ Output<String>
ID of the VPC to associate with the Studio.
latefinal
workspaceSecurityGroupId ↔ Output<String>
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.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {StudioState? state, CustomResourceOptions? options}) → Studio
Gets an existing Studio resource's state with the given name and id.