aws_sdk_emr/client/

create_studio.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateStudio`](crate::operation::create_studio::builders::CreateStudioFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`name(impl Into<String>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::set_name):<br>required: **true**<br><p>A descriptive name for the Amazon EMR Studio.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::set_description):<br>required: **false**<br><p>A detailed description of the Amazon EMR Studio.</p><br>
    ///   - [`auth_mode(AuthMode)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::auth_mode) / [`set_auth_mode(Option<AuthMode>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::set_auth_mode):<br>required: **true**<br><p>Specifies whether the Studio authenticates users using IAM or IAM Identity Center.</p><br>
    ///   - [`vpc_id(impl Into<String>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::vpc_id) / [`set_vpc_id(Option<String>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::set_vpc_id):<br>required: **true**<br><p>The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.</p><br>
    ///   - [`subnet_ids(impl Into<String>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::subnet_ids) / [`set_subnet_ids(Option<Vec::<String>>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::set_subnet_ids):<br>required: **true**<br><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><br>
    ///   - [`service_role(impl Into<String>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::service_role) / [`set_service_role(Option<String>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::set_service_role):<br>required: **true**<br><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><br>
    ///   - [`user_role(impl Into<String>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::user_role) / [`set_user_role(Option<String>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::set_user_role):<br>required: **false**<br><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><br>
    ///   - [`workspace_security_group_id(impl Into<String>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::workspace_security_group_id) / [`set_workspace_security_group_id(Option<String>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::set_workspace_security_group_id):<br>required: **true**<br><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><br>
    ///   - [`engine_security_group_id(impl Into<String>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::engine_security_group_id) / [`set_engine_security_group_id(Option<String>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::set_engine_security_group_id):<br>required: **true**<br><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><br>
    ///   - [`default_s3_location(impl Into<String>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::default_s3_location) / [`set_default_s3_location(Option<String>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::set_default_s3_location):<br>required: **true**<br><p>The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.</p><br>
    ///   - [`idp_auth_url(impl Into<String>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::idp_auth_url) / [`set_idp_auth_url(Option<String>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::set_idp_auth_url):<br>required: **false**<br><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><br>
    ///   - [`idp_relay_state_parameter_name(impl Into<String>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::idp_relay_state_parameter_name) / [`set_idp_relay_state_parameter_name(Option<String>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::set_idp_relay_state_parameter_name):<br>required: **false**<br><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><br>
    ///   - [`tags(Tag)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::set_tags):<br>required: **false**<br><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><br>
    ///   - [`trusted_identity_propagation_enabled(bool)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::trusted_identity_propagation_enabled) / [`set_trusted_identity_propagation_enabled(Option<bool>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::set_trusted_identity_propagation_enabled):<br>required: **false**<br><p>A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is <code>false</code>.</p><br>
    ///   - [`idc_user_assignment(IdcUserAssignment)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::idc_user_assignment) / [`set_idc_user_assignment(Option<IdcUserAssignment>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::set_idc_user_assignment):<br>required: **false**<br><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><br>
    ///   - [`idc_instance_arn(impl Into<String>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::idc_instance_arn) / [`set_idc_instance_arn(Option<String>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::set_idc_instance_arn):<br>required: **false**<br><p>The ARN of the IAM Identity Center instance to create the Studio application.</p><br>
    ///   - [`encryption_key_arn(impl Into<String>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::encryption_key_arn) / [`set_encryption_key_arn(Option<String>)`](crate::operation::create_studio::builders::CreateStudioFluentBuilder::set_encryption_key_arn):<br>required: **false**<br><p>The KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.</p><br>
    /// - On success, responds with [`CreateStudioOutput`](crate::operation::create_studio::CreateStudioOutput) with field(s):
    ///   - [`studio_id(Option<String>)`](crate::operation::create_studio::CreateStudioOutput::studio_id): <p>The ID of the Amazon EMR Studio.</p>
    ///   - [`url(Option<String>)`](crate::operation::create_studio::CreateStudioOutput::url): <p>The unique Studio access URL.</p>
    /// - On failure, responds with [`SdkError<CreateStudioError>`](crate::operation::create_studio::CreateStudioError)
    pub fn create_studio(&self) -> crate::operation::create_studio::builders::CreateStudioFluentBuilder {
        crate::operation::create_studio::builders::CreateStudioFluentBuilder::new(self.handle.clone())
    }
}