studios_list_only
Lists studios
in a region or regions, for all properties use studios
Overview
Name | studios_list_only |
Type | Resource |
Description | Resource schema for AWS::EMR::Studio |
Id | aws.emr.studios_list_only |
Fields
Name | Datatype | Description |
---|---|---|
arn | string | The Amazon Resource Name (ARN) of the EMR Studio. |
auth_mode | string | Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication. |
default_s3_location | string | The default Amazon S3 location to back up EMR Studio Workspaces and notebook files. A Studio user can select an alternative Amazon S3 location when creating a Workspace. |
description | string | A detailed description of the Studio. |
engine_security_group_id | string | 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 | string | A descriptive name for the Amazon EMR Studio. |
service_role | string | 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. |
studio_id | string | The ID of the EMR Studio. |
subnet_ids | array | A list of up to 5 subnet IDs to associate with the Studio. The subnets must belong to the VPC specified by VpcId. Studio users can create a Workspace in any of the specified subnets. |
tags | array | A list of tags to associate with the 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. |
url | string | The unique Studio access URL. |
user_role | string | 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. |
vpc_id | string | The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio. |
workspace_security_group_id | string | 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. |
idp_auth_url | string | 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 | string | The name of relay state parameter for external Identity Provider. |
trusted_identity_propagation_enabled | boolean | A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false. |
idc_user_assignment | string | 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. |
idc_instance_arn | string | The ARN of the IAM Identity Center instance to create the Studio application. |
encryption_key_arn | string | The AWS KMS key identifier (ARN) used to encrypt AWS EMR Studio workspace and notebook files when backed up to AWS S3. |
region | string | AWS region. |
Methods
Name | Accessible by | Required Params |
---|---|---|
list_resources | SELECT | region |
SELECT
examples
Lists all studios
in a region.
SELECT
region,
studio_id
FROM aws.emr.studios_list_only
WHERE region = 'us-east-1';
Permissions
For permissions required to operate on the studios_list_only
resource, see studios