Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StudioComponent

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.

Hierarchy

  • StudioComponent

Index

Properties

Optional arn

arn: undefined | string

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

Optional configuration

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

Optional createdAt

createdAt: Date

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

Optional createdBy

createdBy: undefined | string

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

Optional description

description: undefined | string

A human-readable description for the studio component resource.

Optional ec2SecurityGroupIds

ec2SecurityGroupIds: string[]

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

Optional initializationScripts

initializationScripts: StudioComponentInitializationScript[]

Initialization scripts for studio components.

Optional name

name: undefined | string

A friendly name for the studio component resource.

Optional runtimeRoleArn

runtimeRoleArn: undefined | 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.

Optional scriptParameters

scriptParameters: ScriptParameterKeyValue[]

Parameters for the studio component scripts.

Optional secureInitializationRoleArn

secureInitializationRoleArn: undefined | 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.

Optional state

state: StudioComponentState | string

The current state.

Optional statusCode

statusCode: StudioComponentStatusCode | string

The status code.

Optional statusMessage

statusMessage: undefined | string

The status message for the studio component.

Optional studioComponentId

studioComponentId: undefined | string

The unique identifier for a studio component resource.

Optional subtype

subtype: StudioComponentSubtype | string

The specific subtype of a studio component.

Optional tags

tags: Record<string, string>

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

Optional type

type: StudioComponentType | string

The type of the studio component.

Optional updatedAt

updatedAt: Date

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

Optional updatedBy

updatedBy: undefined | string

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