Class: Aws::NimbleStudio::Types::Studio
- Inherits:
-
Struct
- Object
- Struct
- Aws::NimbleStudio::Types::Studio
- 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
-
#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 Unix epoch 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 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.
-
#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 Unix epoch 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.
3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3424 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.
3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3424 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 Unix epoch timestamp in seconds for when the resource was created.
3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3424 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.
3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3424 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.
3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3424 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 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.
3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3424 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.
3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3424 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.
3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3424 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.
3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3424 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.
3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3424 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.
3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3424 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.
3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3424 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.
3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3424 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.
3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3424 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 Unix epoch timestamp in seconds for when the resource was updated.
3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3424 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.
3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 |
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3424 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 |