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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-nimblestudio/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 Amazon Web Services SSO 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.

Constant Summary collapse

SENSITIVE =
[:display_name]

Instance Attribute Summary collapse

Instance Attribute Details

#admin_role_arnString

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

Returns:

  • (String)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3462

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

#arnString

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

Returns:

  • (String)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3462

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_atTime

The Unix epoch timestamp in seconds for when the resource was created.

Returns:

  • (Time)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3462

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_nameString

A friendly name for the studio.

Returns:

  • (String)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3462

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_regionString

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

Returns:

  • (String)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3462

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_idString

The Amazon Web Services SSO application client ID used to integrate with Amazon Web Services SSO to enable Amazon Web Services SSO users to log in to Nimble Studio portal.

Returns:

  • (String)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3462

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

#stateString

The current state of the studio resource.

Returns:

  • (String)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3462

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_codeString

Status codes that provide additional detail on the studio state.

Returns:

  • (String)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3462

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_messageString

Additional detail on the studio state.

Returns:

  • (String)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3462

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_configurationTypes::StudioEncryptionConfiguration

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



3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3462

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_idString

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

Returns:

  • (String)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3462

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_nameString

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

Returns:

  • (String)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3462

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_urlString

The address of the web page for the studio.

Returns:

  • (String)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3462

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

#tagsHash<String,String>

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

Returns:

  • (Hash<String,String>)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3462

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_atTime

The Unix epoch timestamp in seconds for when the resource was updated.

Returns:

  • (Time)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3462

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_arnString

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

Returns:

  • (String)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3462

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