CfnStudioProps

class aws_cdk.aws_emr.CfnStudioProps(*, auth_mode, default_s3_location, engine_security_group_id, name, service_role, subnet_ids, vpc_id, workspace_security_group_id, description=None, encryption_key_arn=None, idc_instance_arn=None, idc_user_assignment=None, idp_auth_url=None, idp_relay_state_parameter_name=None, tags=None, trusted_identity_propagation_enabled=None, user_role=None)

Bases: object

Properties for defining a CfnStudio.

Parameters:

auth_mode (str) – Specifies whether the Studio authenticates users using IAM Identity Center or IAM.
default_s3_location (str) – The Amazon S3 location to back up EMR Studio Workspaces and notebook files.
engine_security_group_id (str) – 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 .
name (str) – A descriptive name for the Amazon EMR Studio.
service_role (str) – 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.
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 VpcId . Studio users can create a Workspace in any of the specified subnets.
vpc_id (str) – The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
workspace_security_group_id (str) – 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.
description (Optional[str]) – A detailed description of the Amazon EMR Studio.
encryption_key_arn (Optional[str]) – The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
idc_instance_arn (Optional[str]) – The ARN of the IAM Identity Center instance the Studio application belongs to.
idc_user_assignment (Optional[str]) – 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.
idp_auth_url (Optional[str]) – 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.
idp_relay_state_parameter_name (Optional[str]) – The name of your identity provider’s RelayState parameter.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .
trusted_identity_propagation_enabled (Union[bool, IResolvable, None]) – Indicates whether the Studio has Trusted identity propagation enabled. The default value is false .
user_role (Optional[str]) – 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 .

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_emr as emr

cfn_studio_props = emr.CfnStudioProps(
    auth_mode="authMode",
    default_s3_location="defaultS3Location",
    engine_security_group_id="engineSecurityGroupId",
    name="name",
    service_role="serviceRole",
    subnet_ids=["subnetIds"],
    vpc_id="vpcId",
    workspace_security_group_id="workspaceSecurityGroupId",

    # the properties below are optional
    description="description",
    encryption_key_arn="encryptionKeyArn",
    idc_instance_arn="idcInstanceArn",
    idc_user_assignment="idcUserAssignment",
    idp_auth_url="idpAuthUrl",
    idp_relay_state_parameter_name="idpRelayStateParameterName",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    trusted_identity_propagation_enabled=False,
    user_role="userRole"
)

Attributes

auth_mode

Specifies whether the Studio authenticates users using IAM Identity Center or IAM.

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

default_s3_location

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

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

description

A detailed description of the Amazon EMR Studio.

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

encryption_key_arn

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

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

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 VpcId .

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

idc_instance_arn

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

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

idc_user_assignment

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.

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

idp_auth_url

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.

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

idp_relay_state_parameter_name

The name of your identity provider’s RelayState parameter.

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.

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

service_role

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.

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

subnet_ids

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.

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

tags

An array of key-value pairs to apply to this resource.

For more information, see Tag .

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

trusted_identity_propagation_enabled

Indicates whether the Studio has Trusted identity propagation enabled.

The default value is false .

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

user_role

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 .

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

vpc_id

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

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

workspace_security_group_id

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.

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