Skip to content

CreateStudioInput

Source code in docs_src/capo_emr/types/create_studio_input.py
class CreateStudioInput(TypedDict, closed=True):
    name: NotRequired["capo_emr.types.xml_string_max_len256.XmlStringMaxLen256"]
    """<p>A descriptive name for the Amazon EMR Studio.</p>"""
    description: NotRequired["capo_emr.types.xml_string_max_len256.XmlStringMaxLen256"]
    """<p>A detailed description of the Amazon EMR Studio.</p>"""
    auth_mode: NotRequired["capo_emr.types.auth_mode.AuthMode"]
    """<p>Specifies whether the Studio authenticates users using IAM or IAM Identity Center.</p>"""
    vpc_id: NotRequired["capo_emr.types.xml_string_max_len256.XmlStringMaxLen256"]
    """<p>The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.</p>"""
    subnet_ids: NotRequired["capo_emr.types.subnet_id_list.SubnetIdList"]
    """<p>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 <code>VpcId</code>. Studio users can create a Workspace in any of the specified subnets.</p>"""
    service_role: NotRequired["capo_emr.types.xml_string.XmlString"]
    """<p>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.</p>"""
    user_role: NotRequired["capo_emr.types.xml_string.XmlString"]
    """<p>The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a <code>UserRole</code> when you use IAM Identity Center authentication. The permissions attached to the <code>UserRole</code> can be scoped down for each user or group using session policies.</p>"""
    workspace_security_group_id: NotRequired[
        "capo_emr.types.xml_string_max_len256.XmlStringMaxLen256"
    ]
    """<p>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 <code>VpcId</code>.</p>"""
    engine_security_group_id: NotRequired[
        "capo_emr.types.xml_string_max_len256.XmlStringMaxLen256"
    ]
    """<p>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 <code>VpcId</code>.</p>"""
    default_s3_location: NotRequired["capo_emr.types.xml_string.XmlString"]
    """<p>The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.</p>"""
    idp_auth_url: NotRequired["capo_emr.types.xml_string.XmlString"]
    """<p>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.</p>"""
    idp_relay_state_parameter_name: NotRequired[
        "capo_emr.types.xml_string_max_len256.XmlStringMaxLen256"
    ]
    """<p>The name that your identity provider (IdP) uses for its <code>RelayState</code> parameter. For example, <code>RelayState</code> or <code>TargetSource</code>. Specify this value when you use IAM authentication and want to let federated users log in to a Studio using the Studio URL. The <code>RelayState</code> parameter differs by IdP.</p>"""
    tags: NotRequired["capo_emr.types.tag_list.TagList"]
    """<p>A list of tags to associate with the Amazon EMR Studio. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.</p>"""
    trusted_identity_propagation_enabled: NotRequired[
        "capo_emr.types.boolean_object.BooleanObject"
    ]
    """<p> A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is <code>false</code>. </p>"""
    idc_user_assignment: NotRequired[
        "capo_emr.types.idc_user_assignment.IdcUserAssignment"
    ]
    """<p> Specifies whether IAM Identity Center user assignment is <code>REQUIRED</code> or <code>OPTIONAL</code>. If the value is set to <code>REQUIRED</code>, users must be explicitly assigned to the Studio application to access the Studio. </p>"""
    idc_instance_arn: NotRequired["capo_emr.types.arn_type.ArnType"]
    """<p> The ARN of the IAM Identity Center instance to create the Studio application. </p>"""
    encryption_key_arn: NotRequired["capo_emr.types.xml_string.XmlString"]
    """<p>The KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.</p>"""

auth_mode instance-attribute

auth_mode: NotRequired[AuthMode]

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

default_s3_location instance-attribute

default_s3_location: NotRequired[XmlString]

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

description instance-attribute

description: NotRequired[XmlStringMaxLen256]

A detailed description of the Amazon EMR Studio.

encryption_key_arn instance-attribute

encryption_key_arn: NotRequired[XmlString]

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

engine_security_group_id instance-attribute

engine_security_group_id: NotRequired[XmlStringMaxLen256]

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.

idc_instance_arn instance-attribute

idc_instance_arn: NotRequired[ArnType]

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

idc_user_assignment instance-attribute

idc_user_assignment: NotRequired[IdcUserAssignment]

Specifies whether IAM Identity Center user assignment is REQUIRED or OPTIONAL. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio.

idp_auth_url instance-attribute

idp_auth_url: NotRequired[XmlString]

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 instance-attribute

idp_relay_state_parameter_name: NotRequired[XmlStringMaxLen256]

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 instance-attribute

name: NotRequired[XmlStringMaxLen256]

A descriptive name for the Amazon EMR Studio.

service_role instance-attribute

service_role: NotRequired[XmlString]

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 instance-attribute

subnet_ids: NotRequired[SubnetIdList]

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.

tags instance-attribute

tags: NotRequired[TagList]

A list of tags to associate with the Amazon EMR Studio. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.

trusted_identity_propagation_enabled instance-attribute

trusted_identity_propagation_enabled: NotRequired[BooleanObject]

A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.

user_role instance-attribute

user_role: NotRequired[XmlString]

The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a UserRole when you use IAM Identity Center authentication. The permissions attached to the UserRole can be scoped down for each user or group using session policies.

vpc_id instance-attribute

vpc_id: NotRequired[XmlStringMaxLen256]

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

workspace_security_group_id instance-attribute

workspace_security_group_id: NotRequired[XmlStringMaxLen256]

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.