Interface ICfnStudioProps

Properties for defining a CfnStudio.

Namespace: Amazon.CDK.AWS.EMR

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnStudioProps

Syntax (vb)

Public Interface ICfnStudioProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.EMR;

             var cfnStudioProps = new CfnStudioProps {
                 AuthMode = "authMode",
                 DefaultS3Location = "defaultS3Location",
                 EngineSecurityGroupId = "engineSecurityGroupId",
                 Name = "name",
                 ServiceRole = "serviceRole",
                 SubnetIds = new [] { "subnetIds" },
                 VpcId = "vpcId",
                 WorkspaceSecurityGroupId = "workspaceSecurityGroupId",

                 // the properties below are optional
                 Description = "description",
                 EncryptionKeyArn = "encryptionKeyArn",
                 IdcInstanceArn = "idcInstanceArn",
                 IdcUserAssignment = "idcUserAssignment",
                 IdpAuthUrl = "idpAuthUrl",
                 IdpRelayStateParameterName = "idpRelayStateParameterName",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TrustedIdentityPropagationEnabled = false,
                 UserRole = "userRole"
             };

Synopsis

Properties

AuthMode	Specifies whether the Studio authenticates users using SSO or IAM.
DefaultS3Location	The Amazon S3 location to back up EMR Studio Workspaces and notebook files.
Description	A detailed description of the Amazon EMR Studio.
EncryptionKeyArn	The AWS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
EngineSecurityGroupId	The ID of the Amazon EMR Studio Engine security group.
IdcInstanceArn	The ARN of the IAM Identity Center instance the Studio application belongs to.
IdcUserAssignment	Indicates whether the Studio has `REQUIRED` or `OPTIONAL` IAM Identity Center user assignment.
IdpAuthUrl	Your identity provider's authentication endpoint.
IdpRelayStateParameterName	The name of your identity provider's `RelayState` parameter.
Name	A descriptive name for the Amazon EMR Studio.
ServiceRole	The Amazon Resource Name (ARN) of the IAM role that will be assumed by the Amazon EMR Studio.
SubnetIds	A list of subnet IDs to associate with the Amazon EMR Studio.
Tags	An array of key-value pairs to apply to this resource.
TrustedIdentityPropagationEnabled	Indicates whether the Studio has Trusted identity propagation enabled.
UserRole	The Amazon Resource Name (ARN) of the IAM user role that will be assumed by users and groups logged in to a Studio.
VpcId	The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
WorkspaceSecurityGroupId	The ID of the Workspace security group associated with the Amazon EMR Studio.

Properties

AuthMode

Specifies whether the Studio authenticates users using SSO or IAM.

string AuthMode { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-authmode

DefaultS3Location

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

object DefaultS3Location { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-defaults3location

Type union: either string or IBucketRef

Description

A detailed description of the Amazon EMR Studio.

string? Description { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-description

EncryptionKeyArn

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

object? EncryptionKeyArn { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-encryptionkeyarn

Type union: either string or IKeyRef

EngineSecurityGroupId

The ID of the Amazon EMR Studio Engine security group.

object EngineSecurityGroupId { get; }

Property Value

object

Remarks

The Engine security group allows inbound network traffic from the Workspace security group, and it must be in the same VPC specified by VpcId .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-enginesecuritygroupid

Type union: either string or ISecurityGroupRef

IdcInstanceArn

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

string? IdcInstanceArn { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-idcinstancearn

IdcUserAssignment

Indicates whether the Studio has REQUIRED or OPTIONAL IAM Identity Center user assignment.

string? IdcUserAssignment { get; }

Property Value

string

Remarks

If the value is set to REQUIRED , users must be explicitly assigned to the Studio application to access the Studio.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-idcuserassignment

IdpAuthUrl

Your identity provider's authentication endpoint.

string? IdpAuthUrl { get; }

Property Value

string

Remarks

Amazon EMR Studio redirects federated users to this endpoint for authentication when logging in to a Studio with the Studio URL.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-idpauthurl

IdpRelayStateParameterName

The name of your identity provider's RelayState parameter.

string? IdpRelayStateParameterName { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-idprelaystateparametername

Name

A descriptive name for the Amazon EMR Studio.

string Name { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-name

ServiceRole

The Amazon Resource Name (ARN) of the IAM role that will be assumed by the Amazon EMR Studio.

object ServiceRole { get; }

Property Value

object

Remarks

The service role provides a way for Amazon EMR Studio to interoperate with other AWS services.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-servicerole

Type union: either string or IRoleRef

SubnetIds

A list of subnet IDs to associate with the Amazon EMR Studio.

object[] SubnetIds { get; }

Property Value

object[]

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-subnetids

Type union: (either string or ISubnetRef)[]

TrustedIdentityPropagationEnabled

Indicates whether the Studio has Trusted identity propagation enabled.

object? TrustedIdentityPropagationEnabled { get; }

Property Value

object

Remarks

The default value is false .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-trustedidentitypropagationenabled

Type union: either bool or IResolvable

UserRole

The Amazon Resource Name (ARN) of the IAM user role that will be assumed by users and groups logged in to a Studio.

object? UserRole { get; }

Property Value

object

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-userrole

Type union: either string or IRoleRef

VpcId

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

object VpcId { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-vpcid

Type union: either string or IVPCRef

WorkspaceSecurityGroupId

The ID of the Workspace security group associated with the Amazon EMR Studio.

object WorkspaceSecurityGroupId { get; }

Property Value

object

Remarks

The Workspace security group allows outbound network traffic to resources in the Engine security group and to the internet.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html#cfn-emr-studio-workspacesecuritygroupid

Type union: either string or ISecurityGroupRef