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

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

Constant Summary collapse

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

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The ARN of the resource.

Returns:

  • (String)


3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3578

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

#configurationTypes::StudioComponentConfiguration

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



3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3578

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_atTime

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

Returns:

  • (Time)


3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3578

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_byString

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

Returns:

  • (String)


3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3578

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

#descriptionString

A human-readable description for the studio component resource.

Returns:

  • (String)


3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3578

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

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

Returns:

  • (Array<String>)


3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3578

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_scriptsArray<Types::StudioComponentInitializationScript>

Initialization scripts for studio components.



3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3578

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

#nameString

A friendly name for the studio component resource.

Returns:

  • (String)


3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3578

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_arnString

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

Returns:

  • (String)


3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3578

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_parametersArray<Types::ScriptParameterKeyValue>

Parameters for the studio component scripts.

Returns:



3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3578

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_arnString

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

Returns:

  • (String)


3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3578

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

#stateString

The current state.

Returns:

  • (String)


3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3578

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_codeString

The status code.

Returns:

  • (String)


3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3578

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_messageString

The status message for the studio component.

Returns:

  • (String)


3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3578

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_idString

The unique identifier for a studio component resource.

Returns:

  • (String)


3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3578

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

#subtypeString

The specific subtype of a studio component.

Returns:

  • (String)


3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3578

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

#tagsHash<String,String>

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

Returns:

  • (Hash<String,String>)


3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3578

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

#typeString

The type of the studio component.

Returns:

  • (String)


3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3578

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_atTime

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

Returns:

  • (Time)


3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3578

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_byString

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

Returns:

  • (String)


3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 3578

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