Class: Aws::NimbleStudio::Types::Studio

Inherits:

Struct

• Object
• Struct
• Aws::NimbleStudio::Types::Studio

Includes:

Structure

Defined in:

lib/aws-sdk-nimblestudio/types.rb

Overview

Represents a studio resource.

A studio is the core resource used with Nimble Studio. You must create a studio first, before any other resource type can be created. All other resources you create and manage in Nimble Studio are contained within a studio.

When creating a studio, you must provides two IAM roles for use with the Nimble Studio portal. These roles are assumed by your users when they log in to the Nimble Studio portal via IAM Identity Center and your identity source.

The user role must have the ‘AmazonNimbleStudio-StudioUser` managed policy attached for the portal to function properly.

The admin role must have the ‘AmazonNimbleStudio-StudioAdmin` managed policy attached for the portal to function properly.

Your studio roles must trust the ‘identity.nimble.amazonaws.com` service principal to function properly.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:display_name]

Instance Attribute Summary

• #admin_role_arn ⇒ String

  The IAM role that studio admins assume when logging in to the Nimble Studio portal.

• #arn ⇒ String

  The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it.

• #created_at ⇒ Time

  The ISO timestamp in seconds for when the resource was created.

• #display_name ⇒ String

  A friendly name for the studio.

• #home_region ⇒ String

  The Amazon Web Services Region where the studio resource is located.

• #sso_client_id ⇒ String

  The IAM Identity Center application client ID used to integrate with IAM Identity Center.

• #state ⇒ String

  The current state of the studio resource.

• #status_code ⇒ String

  Status codes that provide additional detail on the studio state.

• #status_message ⇒ String

  Additional detail on the studio state.

• #studio_encryption_configuration ⇒ Types::StudioEncryptionConfiguration

  Configuration of the encryption method that is used for the studio.

• #studio_id ⇒ String

  The unique identifier for a studio resource.

• #studio_name ⇒ String

  The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.

• #studio_url ⇒ String

  The address of the web page for the studio.

• #tags ⇒ Hash<String,String>

  A collection of labels, in the form of key-value pairs, that apply to this resource.

• #updated_at ⇒ Time

  The ISO timestamp in seconds for when the resource was updated.

• #user_role_arn ⇒ String

  The IAM role that studio users assume when logging in to the Nimble Studio portal.

Instance Attribute Details

#admin_role_arn ⇒ String

The IAM role that studio admins assume when logging in to the Nimble Studio portal.

Returns:

• (String)

# File 'lib/aws-sdk-nimblestudio/types.rb', line 3219

class Studio < Struct.new(
  :admin_role_arn,
  :arn,
  :created_at,
  :display_name,
  :home_region,
  :sso_client_id,
  :state,
  :status_code,
  :status_message,
  :studio_encryption_configuration,
  :studio_id,
  :studio_name,
  :studio_url,
  :tags,
  :updated_at,
  :user_role_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#arn ⇒ String

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

Returns:

• (String)

# File 'lib/aws-sdk-nimblestudio/types.rb', line 3219

class Studio < Struct.new(
  :admin_role_arn,
  :arn,
  :created_at,
  :display_name,
  :home_region,
  :sso_client_id,
  :state,
  :status_code,
  :status_message,
  :studio_encryption_configuration,
  :studio_id,
  :studio_name,
  :studio_url,
  :tags,
  :updated_at,
  :user_role_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#created_at ⇒ Time

The ISO timestamp in seconds for when the resource was created.

Returns:

• (Time)

# File 'lib/aws-sdk-nimblestudio/types.rb', line 3219

class Studio < Struct.new(
  :admin_role_arn,
  :arn,
  :created_at,
  :display_name,
  :home_region,
  :sso_client_id,
  :state,
  :status_code,
  :status_message,
  :studio_encryption_configuration,
  :studio_id,
  :studio_name,
  :studio_url,
  :tags,
  :updated_at,
  :user_role_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#display_name ⇒ String

A friendly name for the studio.

Returns:

• (String)

# File 'lib/aws-sdk-nimblestudio/types.rb', line 3219

class Studio < Struct.new(
  :admin_role_arn,
  :arn,
  :created_at,
  :display_name,
  :home_region,
  :sso_client_id,
  :state,
  :status_code,
  :status_message,
  :studio_encryption_configuration,
  :studio_id,
  :studio_name,
  :studio_url,
  :tags,
  :updated_at,
  :user_role_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#home_region ⇒ String

The Amazon Web Services Region where the studio resource is located.

Returns:

• (String)

# File 'lib/aws-sdk-nimblestudio/types.rb', line 3219

class Studio < Struct.new(
  :admin_role_arn,
  :arn,
  :created_at,
  :display_name,
  :home_region,
  :sso_client_id,
  :state,
  :status_code,
  :status_message,
  :studio_encryption_configuration,
  :studio_id,
  :studio_name,
  :studio_url,
  :tags,
  :updated_at,
  :user_role_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#sso_client_id ⇒ String

The IAM Identity Center application client ID used to integrate with IAM Identity Center. This ID allows IAM Identity Center users to log in to Nimble Studio portal.

Returns:

• (String)

# File 'lib/aws-sdk-nimblestudio/types.rb', line 3219

class Studio < Struct.new(
  :admin_role_arn,
  :arn,
  :created_at,
  :display_name,
  :home_region,
  :sso_client_id,
  :state,
  :status_code,
  :status_message,
  :studio_encryption_configuration,
  :studio_id,
  :studio_name,
  :studio_url,
  :tags,
  :updated_at,
  :user_role_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#state ⇒ String

The current state of the studio resource.

Returns:

• (String)

# File 'lib/aws-sdk-nimblestudio/types.rb', line 3219

class Studio < Struct.new(
  :admin_role_arn,
  :arn,
  :created_at,
  :display_name,
  :home_region,
  :sso_client_id,
  :state,
  :status_code,
  :status_message,
  :studio_encryption_configuration,
  :studio_id,
  :studio_name,
  :studio_url,
  :tags,
  :updated_at,
  :user_role_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#status_code ⇒ String

Status codes that provide additional detail on the studio state.

Returns:

• (String)

# File 'lib/aws-sdk-nimblestudio/types.rb', line 3219

class Studio < Struct.new(
  :admin_role_arn,
  :arn,
  :created_at,
  :display_name,
  :home_region,
  :sso_client_id,
  :state,
  :status_code,
  :status_message,
  :studio_encryption_configuration,
  :studio_id,
  :studio_name,
  :studio_url,
  :tags,
  :updated_at,
  :user_role_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#status_message ⇒ String

Additional detail on the studio state.

Returns:

• (String)

# File 'lib/aws-sdk-nimblestudio/types.rb', line 3219

class Studio < Struct.new(
  :admin_role_arn,
  :arn,
  :created_at,
  :display_name,
  :home_region,
  :sso_client_id,
  :state,
  :status_code,
  :status_message,
  :studio_encryption_configuration,
  :studio_id,
  :studio_name,
  :studio_url,
  :tags,
  :updated_at,
  :user_role_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#studio_encryption_configuration ⇒ Types::StudioEncryptionConfiguration

Configuration of the encryption method that is used for the studio.

Returns:

• (Types::StudioEncryptionConfiguration)

# File 'lib/aws-sdk-nimblestudio/types.rb', line 3219

class Studio < Struct.new(
  :admin_role_arn,
  :arn,
  :created_at,
  :display_name,
  :home_region,
  :sso_client_id,
  :state,
  :status_code,
  :status_message,
  :studio_encryption_configuration,
  :studio_id,
  :studio_name,
  :studio_url,
  :tags,
  :updated_at,
  :user_role_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#studio_id ⇒ String

The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.

Returns:

• (String)

# File 'lib/aws-sdk-nimblestudio/types.rb', line 3219

class Studio < Struct.new(
  :admin_role_arn,
  :arn,
  :created_at,
  :display_name,
  :home_region,
  :sso_client_id,
  :state,
  :status_code,
  :status_message,
  :studio_encryption_configuration,
  :studio_id,
  :studio_name,
  :studio_url,
  :tags,
  :updated_at,
  :user_role_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#studio_name ⇒ String

The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.

Returns:

• (String)

# File 'lib/aws-sdk-nimblestudio/types.rb', line 3219

class Studio < Struct.new(
  :admin_role_arn,
  :arn,
  :created_at,
  :display_name,
  :home_region,
  :sso_client_id,
  :state,
  :status_code,
  :status_message,
  :studio_encryption_configuration,
  :studio_id,
  :studio_name,
  :studio_url,
  :tags,
  :updated_at,
  :user_role_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#studio_url ⇒ String

The address of the web page for the studio.

Returns:

• (String)

# File 'lib/aws-sdk-nimblestudio/types.rb', line 3219

class Studio < Struct.new(
  :admin_role_arn,
  :arn,
  :created_at,
  :display_name,
  :home_region,
  :sso_client_id,
  :state,
  :status_code,
  :status_message,
  :studio_encryption_configuration,
  :studio_id,
  :studio_name,
  :studio_url,
  :tags,
  :updated_at,
  :user_role_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A collection of labels, in the form of key-value pairs, that apply to this resource.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-nimblestudio/types.rb', line 3219

class Studio < Struct.new(
  :admin_role_arn,
  :arn,
  :created_at,
  :display_name,
  :home_region,
  :sso_client_id,
  :state,
  :status_code,
  :status_message,
  :studio_encryption_configuration,
  :studio_id,
  :studio_name,
  :studio_url,
  :tags,
  :updated_at,
  :user_role_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#updated_at ⇒ Time

The ISO timestamp in seconds for when the resource was updated.

Returns:

• (Time)

# File 'lib/aws-sdk-nimblestudio/types.rb', line 3219

class Studio < Struct.new(
  :admin_role_arn,
  :arn,
  :created_at,
  :display_name,
  :home_region,
  :sso_client_id,
  :state,
  :status_code,
  :status_message,
  :studio_encryption_configuration,
  :studio_id,
  :studio_name,
  :studio_url,
  :tags,
  :updated_at,
  :user_role_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#user_role_arn ⇒ String

The IAM role that studio users assume when logging in to the Nimble Studio portal.

Returns:

• (String)

# File 'lib/aws-sdk-nimblestudio/types.rb', line 3219

class Studio < Struct.new(
  :admin_role_arn,
  :arn,
  :created_at,
  :display_name,
  :home_region,
  :sso_client_id,
  :state,
  :status_code,
  :status_message,
  :studio_encryption_configuration,
  :studio_id,
  :studio_name,
  :studio_url,
  :tags,
  :updated_at,
  :user_role_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end