Class: Aws::EMR::Types::Studio

Inherits:

Struct

Object
Struct
Aws::EMR::Types::Studio

show all

Includes:: Structure

Defined in:: lib/aws-sdk-emr/types.rb

Overview

Details for an Amazon EMR Studio including ID, creation time, name, and so on.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#auth_mode ⇒ String

Specifies whether the Amazon EMR Studio authenticates users with IAM or IAM Identity Center.
#creation_time ⇒ Time

The time the Amazon EMR Studio was created.
#default_s3_location ⇒ String

The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
#description ⇒ String

The detailed description of the Amazon EMR Studio.
#encryption_key_arn ⇒ String

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 ⇒ String

The ID of the Engine security group associated with the Amazon EMR Studio.
#idc_instance_arn ⇒ String

The ARN of the IAM Identity Center instance the Studio application belongs to.
#idc_user_assignment ⇒ String

Indicates whether the Studio has REQUIRED or OPTIONAL IAM Identity Center user assignment.
#idp_auth_url ⇒ String

Your identity provider’s authentication endpoint.
#idp_relay_state_parameter_name ⇒ String

The name of your identity provider’s RelayState parameter.
#name ⇒ String

The name of the Amazon EMR Studio.
#service_role ⇒ String

The name of the IAM role assumed by the Amazon EMR Studio.
#studio_arn ⇒ String

The Amazon Resource Name (ARN) of the Amazon EMR Studio.
#studio_id ⇒ String

The ID of the Amazon EMR Studio.
#subnet_ids ⇒ Array<String>

The list of IDs of the subnets associated with the Amazon EMR Studio.
#tags ⇒ Array<Types::Tag>

A list of tags associated with the Amazon EMR Studio.
#trusted_identity_propagation_enabled ⇒ Boolean

Indicates whether the Studio has Trusted identity propagation enabled.
#url ⇒ String

The unique access URL of the Amazon EMR Studio.
#user_role ⇒ String

The name of the IAM role assumed by users logged in to the Amazon EMR Studio.
#vpc_id ⇒ String

The ID of the VPC associated with the Amazon EMR Studio.
#workspace_security_group_id ⇒ String

The ID of the Workspace security group associated with the Amazon EMR Studio.

Instance Attribute Details

#auth_mode ⇒ `String`

Specifies whether the Amazon EMR Studio authenticates users with IAM or IAM Identity Center.

# File 'lib/aws-sdk-emr/types.rb', line 7199

class Studio < Struct.new(
  :studio_id,
  :studio_arn,
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :url,
  :creation_time,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags,
  :idc_instance_arn,
  :trusted_identity_propagation_enabled,
  :idc_user_assignment,
  :encryption_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ `Time`

The time the Amazon EMR Studio was created.

# File 'lib/aws-sdk-emr/types.rb', line 7199

class Studio < Struct.new(
  :studio_id,
  :studio_arn,
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :url,
  :creation_time,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags,
  :idc_instance_arn,
  :trusted_identity_propagation_enabled,
  :idc_user_assignment,
  :encryption_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#default_s3_location ⇒ `String`

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

# File 'lib/aws-sdk-emr/types.rb', line 7199

class Studio < Struct.new(
  :studio_id,
  :studio_arn,
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :url,
  :creation_time,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags,
  :idc_instance_arn,
  :trusted_identity_propagation_enabled,
  :idc_user_assignment,
  :encryption_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

The detailed description of the Amazon EMR Studio.

# File 'lib/aws-sdk-emr/types.rb', line 7199

class Studio < Struct.new(
  :studio_id,
  :studio_arn,
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :url,
  :creation_time,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags,
  :idc_instance_arn,
  :trusted_identity_propagation_enabled,
  :idc_user_assignment,
  :encryption_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_key_arn ⇒ `String`

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

# File 'lib/aws-sdk-emr/types.rb', line 7199

class Studio < Struct.new(
  :studio_id,
  :studio_arn,
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :url,
  :creation_time,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags,
  :idc_instance_arn,
  :trusted_identity_propagation_enabled,
  :idc_user_assignment,
  :encryption_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#engine_security_group_id ⇒ `String`

The ID of the Engine security group associated with the Amazon EMR Studio. The Engine security group allows inbound network traffic from resources in the Workspace security group.

# File 'lib/aws-sdk-emr/types.rb', line 7199

class Studio < Struct.new(
  :studio_id,
  :studio_arn,
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :url,
  :creation_time,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags,
  :idc_instance_arn,
  :trusted_identity_propagation_enabled,
  :idc_user_assignment,
  :encryption_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#idc_instance_arn ⇒ `String`

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

# File 'lib/aws-sdk-emr/types.rb', line 7199

class Studio < Struct.new(
  :studio_id,
  :studio_arn,
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :url,
  :creation_time,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags,
  :idc_instance_arn,
  :trusted_identity_propagation_enabled,
  :idc_user_assignment,
  :encryption_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#idc_user_assignment ⇒ `String`

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.

# File 'lib/aws-sdk-emr/types.rb', line 7199

class Studio < Struct.new(
  :studio_id,
  :studio_arn,
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :url,
  :creation_time,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags,
  :idc_instance_arn,
  :trusted_identity_propagation_enabled,
  :idc_user_assignment,
  :encryption_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

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

# File 'lib/aws-sdk-emr/types.rb', line 7199

class Studio < Struct.new(
  :studio_id,
  :studio_arn,
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :url,
  :creation_time,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags,
  :idc_instance_arn,
  :trusted_identity_propagation_enabled,
  :idc_user_assignment,
  :encryption_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#idp_relay_state_parameter_name ⇒ `String`

The name of your identity provider’s RelayState parameter.

# File 'lib/aws-sdk-emr/types.rb', line 7199

class Studio < Struct.new(
  :studio_id,
  :studio_arn,
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :url,
  :creation_time,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags,
  :idc_instance_arn,
  :trusted_identity_propagation_enabled,
  :idc_user_assignment,
  :encryption_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

The name of the Amazon EMR Studio.

# File 'lib/aws-sdk-emr/types.rb', line 7199

class Studio < Struct.new(
  :studio_id,
  :studio_arn,
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :url,
  :creation_time,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags,
  :idc_instance_arn,
  :trusted_identity_propagation_enabled,
  :idc_user_assignment,
  :encryption_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#service_role ⇒ `String`

The name of the IAM role assumed by the Amazon EMR Studio.

# File 'lib/aws-sdk-emr/types.rb', line 7199

class Studio < Struct.new(
  :studio_id,
  :studio_arn,
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :url,
  :creation_time,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags,
  :idc_instance_arn,
  :trusted_identity_propagation_enabled,
  :idc_user_assignment,
  :encryption_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#studio_arn ⇒ `String`

The Amazon Resource Name (ARN) of the Amazon EMR Studio.

# File 'lib/aws-sdk-emr/types.rb', line 7199

class Studio < Struct.new(
  :studio_id,
  :studio_arn,
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :url,
  :creation_time,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags,
  :idc_instance_arn,
  :trusted_identity_propagation_enabled,
  :idc_user_assignment,
  :encryption_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#studio_id ⇒ `String`

The ID of the Amazon EMR Studio.

# File 'lib/aws-sdk-emr/types.rb', line 7199

class Studio < Struct.new(
  :studio_id,
  :studio_arn,
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :url,
  :creation_time,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags,
  :idc_instance_arn,
  :trusted_identity_propagation_enabled,
  :idc_user_assignment,
  :encryption_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_ids ⇒ `Array<String>`

The list of IDs of the subnets associated with the Amazon EMR Studio.

# File 'lib/aws-sdk-emr/types.rb', line 7199

class Studio < Struct.new(
  :studio_id,
  :studio_arn,
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :url,
  :creation_time,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags,
  :idc_instance_arn,
  :trusted_identity_propagation_enabled,
  :idc_user_assignment,
  :encryption_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

A list of tags associated with the Amazon EMR Studio.

# File 'lib/aws-sdk-emr/types.rb', line 7199

class Studio < Struct.new(
  :studio_id,
  :studio_arn,
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :url,
  :creation_time,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags,
  :idc_instance_arn,
  :trusted_identity_propagation_enabled,
  :idc_user_assignment,
  :encryption_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#trusted_identity_propagation_enabled ⇒ `Boolean`

Indicates whether the Studio has Trusted identity propagation enabled. The default value is false.

# File 'lib/aws-sdk-emr/types.rb', line 7199

class Studio < Struct.new(
  :studio_id,
  :studio_arn,
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :url,
  :creation_time,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags,
  :idc_instance_arn,
  :trusted_identity_propagation_enabled,
  :idc_user_assignment,
  :encryption_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#url ⇒ `String`

The unique access URL of the Amazon EMR Studio.

# File 'lib/aws-sdk-emr/types.rb', line 7199

class Studio < Struct.new(
  :studio_id,
  :studio_arn,
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :url,
  :creation_time,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags,
  :idc_instance_arn,
  :trusted_identity_propagation_enabled,
  :idc_user_assignment,
  :encryption_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#user_role ⇒ `String`

The name of the IAM role assumed by users logged in to the Amazon EMR Studio. A Studio only requires a UserRole when you use IAM authentication.

# File 'lib/aws-sdk-emr/types.rb', line 7199

class Studio < Struct.new(
  :studio_id,
  :studio_arn,
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :url,
  :creation_time,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags,
  :idc_instance_arn,
  :trusted_identity_propagation_enabled,
  :idc_user_assignment,
  :encryption_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ `String`

The ID of the VPC associated with the Amazon EMR Studio.

# File 'lib/aws-sdk-emr/types.rb', line 7199

class Studio < Struct.new(
  :studio_id,
  :studio_arn,
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :url,
  :creation_time,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags,
  :idc_instance_arn,
  :trusted_identity_propagation_enabled,
  :idc_user_assignment,
  :encryption_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_security_group_id ⇒ `String`

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.

# File 'lib/aws-sdk-emr/types.rb', line 7199

class Studio < Struct.new(
  :studio_id,
  :studio_arn,
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :url,
  :creation_time,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags,
  :idc_instance_arn,
  :trusted_identity_propagation_enabled,
  :idc_user_assignment,
  :encryption_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::EMR::Types::Studio

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#auth_mode ⇒ String

#creation_time ⇒ Time

#default_s3_location ⇒ String

#description ⇒ String

#encryption_key_arn ⇒ String

#engine_security_group_id ⇒ String

#idc_instance_arn ⇒ String

#idc_user_assignment ⇒ String

#idp_auth_url ⇒ String

#idp_relay_state_parameter_name ⇒ String

#name ⇒ String

#service_role ⇒ String

#studio_arn ⇒ String

#studio_id ⇒ String

#subnet_ids ⇒ Array<String>

#tags ⇒ Array<Types::Tag>

#trusted_identity_propagation_enabled ⇒ Boolean

#url ⇒ String

#user_role ⇒ String

#vpc_id ⇒ String

#workspace_security_group_id ⇒ String