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, idp_auth_url=None, idp_relay_state_parameter_name=None, tags=None, user_role=None)

Bases: object

Properties for defining a CfnStudio.

Parameters
  • auth_mode (str) – Specifies whether the Studio authenticates users using AWS SSO 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.

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

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

Link

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.
import aws_cdk.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",
    idp_auth_url="idpAuthUrl",
    idp_relay_state_parameter_name="idpRelayStateParameterName",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    user_role="userRole"
)

Attributes

auth_mode

Specifies whether the Studio authenticates users using AWS SSO or IAM.

Link

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

Return type

str

default_s3_location

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

Link

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

Return type

str

description

A detailed description of the Amazon EMR Studio.

Link

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

Return type

Optional[str]

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 .

Link

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

Return type

str

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.

Link

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

Return type

Optional[str]

idp_relay_state_parameter_name

The name of your identity provider’s RelayState parameter.

Link

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

Return type

Optional[str]

name

A descriptive name for the Amazon EMR Studio.

Link

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

Return type

str

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.

Link

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

Return type

str

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.

Link

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

Return type

List[str]

tags

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

For more information, see Tag .

Link

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

Return type

Optional[List[CfnTag]]

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 .

Link

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

Return type

Optional[str]

vpc_id

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

Link

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

Return type

str

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.

Link

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

Return type

str