Class: Aws::NimbleStudio::Types::StudioComponent

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-nimblestudio/types.rb

Overview

A studio component represents a network resource to be used by a studio’s users and workflows. A typical studio contains studio components for each of the following: render farm, Active Directory, licensing, and file system.

Access to a studio component is managed by specifying security groups for the resource, as well as its endpoint.

A studio component also has a set of initialization scripts that are returned by ‘GetLaunchProfileInitialization`. These initialization scripts run on streaming sessions when they start. They provide users with flexibility in controlling how the studio resources are configured on a streaming session.

See Also:

Constant Summary collapse

SENSITIVE = 
[:description, :name, :script_parameters]

Instance Attribute Summary collapse

Instance Attribute Details

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


3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
 
# File 'lib/aws-sdk-nimblestudio/types.rb', line 3343

class StudioComponent < Struct.new(
  :arn,
  :configuration,
  :created_at,
  :created_by,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :runtime_role_arn,
  :script_parameters,
  :secure_initialization_role_arn,
  :state,
  :status_code,
  :status_message,
  :studio_component_id,
  :subtype,
  :tags,
  :type,
  :updated_at,
  :updated_by)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end

#configuration ⇒ Types::StudioComponentConfiguration

The configuration of the studio component, based on component type.

Returns:



3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
 
# File 'lib/aws-sdk-nimblestudio/types.rb', line 3343

class StudioComponent < Struct.new(
  :arn,
  :configuration,
  :created_at,
  :created_by,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :runtime_role_arn,
  :script_parameters,
  :secure_initialization_role_arn,
  :state,
  :status_code,
  :status_message,
  :studio_component_id,
  :subtype,
  :tags,
  :type,
  :updated_at,
  :updated_by)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end

#created_at ⇒ Time

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

Returns:

  • (Time) 


3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
 
# File 'lib/aws-sdk-nimblestudio/types.rb', line 3343

class StudioComponent < Struct.new(
  :arn,
  :configuration,
  :created_at,
  :created_by,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :runtime_role_arn,
  :script_parameters,
  :secure_initialization_role_arn,
  :state,
  :status_code,
  :status_message,
  :studio_component_id,
  :subtype,
  :tags,
  :type,
  :updated_at,
  :updated_by)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end

#created_by ⇒ String

The user ID of the user that created the studio component.

Returns:

  • (String) 


3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
 
# File 'lib/aws-sdk-nimblestudio/types.rb', line 3343

class StudioComponent < Struct.new(
  :arn,
  :configuration,
  :created_at,
  :created_by,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :runtime_role_arn,
  :script_parameters,
  :secure_initialization_role_arn,
  :state,
  :status_code,
  :status_message,
  :studio_component_id,
  :subtype,
  :tags,
  :type,
  :updated_at,
  :updated_by)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end

#description ⇒ String

A human-readable description for the studio component resource.

Returns:

  • (String) 


3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
 
# File 'lib/aws-sdk-nimblestudio/types.rb', line 3343

class StudioComponent < Struct.new(
  :arn,
  :configuration,
  :created_at,
  :created_by,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :runtime_role_arn,
  :script_parameters,
  :secure_initialization_role_arn,
  :state,
  :status_code,
  :status_message,
  :studio_component_id,
  :subtype,
  :tags,
  :type,
  :updated_at,
  :updated_by)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end

#ec2_security_group_ids ⇒ Array<String>

The EC2 security groups that control access to the studio component.

Returns:

  • (Array<String>) 


3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
 
# File 'lib/aws-sdk-nimblestudio/types.rb', line 3343

class StudioComponent < Struct.new(
  :arn,
  :configuration,
  :created_at,
  :created_by,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :runtime_role_arn,
  :script_parameters,
  :secure_initialization_role_arn,
  :state,
  :status_code,
  :status_message,
  :studio_component_id,
  :subtype,
  :tags,
  :type,
  :updated_at,
  :updated_by)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end

#initialization_scripts ⇒ Array<Types::StudioComponentInitializationScript>

Initialization scripts for studio components.

Returns:



3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
 
# File 'lib/aws-sdk-nimblestudio/types.rb', line 3343

class StudioComponent < Struct.new(
  :arn,
  :configuration,
  :created_at,
  :created_by,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :runtime_role_arn,
  :script_parameters,
  :secure_initialization_role_arn,
  :state,
  :status_code,
  :status_message,
  :studio_component_id,
  :subtype,
  :tags,
  :type,
  :updated_at,
  :updated_by)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end

#name ⇒ String

A friendly name for the studio component resource.

Returns:

  • (String) 


3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
 
# File 'lib/aws-sdk-nimblestudio/types.rb', line 3343

class StudioComponent < Struct.new(
  :arn,
  :configuration,
  :created_at,
  :created_by,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :runtime_role_arn,
  :script_parameters,
  :secure_initialization_role_arn,
  :state,
  :status_code,
  :status_message,
  :studio_component_id,
  :subtype,
  :tags,
  :type,
  :updated_at,
  :updated_by)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end

#runtime_role_arn ⇒ String

An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

Returns:

  • (String) 


3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
 
# File 'lib/aws-sdk-nimblestudio/types.rb', line 3343

class StudioComponent < Struct.new(
  :arn,
  :configuration,
  :created_at,
  :created_by,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :runtime_role_arn,
  :script_parameters,
  :secure_initialization_role_arn,
  :state,
  :status_code,
  :status_message,
  :studio_component_id,
  :subtype,
  :tags,
  :type,
  :updated_at,
  :updated_by)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end

#script_parameters ⇒ Array<Types::ScriptParameterKeyValue>

Parameters for the studio component scripts.

Returns:



3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
 
# File 'lib/aws-sdk-nimblestudio/types.rb', line 3343

class StudioComponent < Struct.new(
  :arn,
  :configuration,
  :created_at,
  :created_by,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :runtime_role_arn,
  :script_parameters,
  :secure_initialization_role_arn,
  :state,
  :status_code,
  :status_message,
  :studio_component_id,
  :subtype,
  :tags,
  :type,
  :updated_at,
  :updated_by)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end

#secure_initialization_role_arn ⇒ String

An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

Returns:

  • (String) 


3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
 
# File 'lib/aws-sdk-nimblestudio/types.rb', line 3343

class StudioComponent < Struct.new(
  :arn,
  :configuration,
  :created_at,
  :created_by,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :runtime_role_arn,
  :script_parameters,
  :secure_initialization_role_arn,
  :state,
  :status_code,
  :status_message,
  :studio_component_id,
  :subtype,
  :tags,
  :type,
  :updated_at,
  :updated_by)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end

#state ⇒ String

The current state.

Returns:

  • (String) 


3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
 
# File 'lib/aws-sdk-nimblestudio/types.rb', line 3343

class StudioComponent < Struct.new(
  :arn,
  :configuration,
  :created_at,
  :created_by,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :runtime_role_arn,
  :script_parameters,
  :secure_initialization_role_arn,
  :state,
  :status_code,
  :status_message,
  :studio_component_id,
  :subtype,
  :tags,
  :type,
  :updated_at,
  :updated_by)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end

#status_code ⇒ String

The status code.

Returns:

  • (String) 


3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
 
# File 'lib/aws-sdk-nimblestudio/types.rb', line 3343

class StudioComponent < Struct.new(
  :arn,
  :configuration,
  :created_at,
  :created_by,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :runtime_role_arn,
  :script_parameters,
  :secure_initialization_role_arn,
  :state,
  :status_code,
  :status_message,
  :studio_component_id,
  :subtype,
  :tags,
  :type,
  :updated_at,
  :updated_by)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end

#status_message ⇒ String

The status message for the studio component.

Returns:

  • (String) 


3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
 
# File 'lib/aws-sdk-nimblestudio/types.rb', line 3343

class StudioComponent < Struct.new(
  :arn,
  :configuration,
  :created_at,
  :created_by,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :runtime_role_arn,
  :script_parameters,
  :secure_initialization_role_arn,
  :state,
  :status_code,
  :status_message,
  :studio_component_id,
  :subtype,
  :tags,
  :type,
  :updated_at,
  :updated_by)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end

#studio_component_id ⇒ String

The unique identifier for a studio component resource.

Returns:

  • (String) 


3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
 
# File 'lib/aws-sdk-nimblestudio/types.rb', line 3343

class StudioComponent < Struct.new(
  :arn,
  :configuration,
  :created_at,
  :created_by,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :runtime_role_arn,
  :script_parameters,
  :secure_initialization_role_arn,
  :state,
  :status_code,
  :status_message,
  :studio_component_id,
  :subtype,
  :tags,
  :type,
  :updated_at,
  :updated_by)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end

#subtype ⇒ String

The specific subtype of a studio component.

Returns:

  • (String) 


3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
 
# File 'lib/aws-sdk-nimblestudio/types.rb', line 3343

class StudioComponent < Struct.new(
  :arn,
  :configuration,
  :created_at,
  :created_by,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :runtime_role_arn,
  :script_parameters,
  :secure_initialization_role_arn,
  :state,
  :status_code,
  :status_message,
  :studio_component_id,
  :subtype,
  :tags,
  :type,
  :updated_at,
  :updated_by)
  SENSITIVE = [:description, :name, :script_parameters]
  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>) 


3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
 
# File 'lib/aws-sdk-nimblestudio/types.rb', line 3343

class StudioComponent < Struct.new(
  :arn,
  :configuration,
  :created_at,
  :created_by,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :runtime_role_arn,
  :script_parameters,
  :secure_initialization_role_arn,
  :state,
  :status_code,
  :status_message,
  :studio_component_id,
  :subtype,
  :tags,
  :type,
  :updated_at,
  :updated_by)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end

#type ⇒ String

The type of the studio component.

Returns:

  • (String) 


3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
 
# File 'lib/aws-sdk-nimblestudio/types.rb', line 3343

class StudioComponent < Struct.new(
  :arn,
  :configuration,
  :created_at,
  :created_by,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :runtime_role_arn,
  :script_parameters,
  :secure_initialization_role_arn,
  :state,
  :status_code,
  :status_message,
  :studio_component_id,
  :subtype,
  :tags,
  :type,
  :updated_at,
  :updated_by)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end

#updated_at ⇒ Time

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

Returns:

  • (Time) 


3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
 
# File 'lib/aws-sdk-nimblestudio/types.rb', line 3343

class StudioComponent < Struct.new(
  :arn,
  :configuration,
  :created_at,
  :created_by,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :runtime_role_arn,
  :script_parameters,
  :secure_initialization_role_arn,
  :state,
  :status_code,
  :status_message,
  :studio_component_id,
  :subtype,
  :tags,
  :type,
  :updated_at,
  :updated_by)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end

#updated_by ⇒ String

The user ID of the user that most recently updated the resource.

Returns:

  • (String) 


3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
 
# File 'lib/aws-sdk-nimblestudio/types.rb', line 3343

class StudioComponent < Struct.new(
  :arn,
  :configuration,
  :created_at,
  :created_by,
  :description,
  :ec2_security_group_ids,
  :initialization_scripts,
  :name,
  :runtime_role_arn,
  :script_parameters,
  :secure_initialization_role_arn,
  :state,
  :status_code,
  :status_message,
  :studio_component_id,
  :subtype,
  :tags,
  :type,
  :updated_at,
  :updated_by)
  SENSITIVE = [:description, :name, :script_parameters]
  include Aws::Structure
end