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.

arn

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

Type: String

Required: No

configuration

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

Type: StudioComponentConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

createdAt

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

Type: Timestamp

Required: No

createdBy

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

Type: String

Required: No

description

A human-readable description for the studio component resource.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

ec2SecurityGroupIds

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

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 30 items.

Required: No

initializationScripts

Initialization scripts for studio components.

Type: Array of StudioComponentInitializationScript objects

Required: No

name

A friendly name for the studio component resource.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Required: No

runtimeRoleArn

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Required: No

scriptParameters

Parameters for the studio component scripts.

Type: Array of ScriptParameterKeyValue objects

Array Members: Minimum number of 0 items. Maximum number of 30 items.

Required: No

secureInitializationRoleArn

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Required: No

state

The current state.

Type: String

Required: No

statusCode

The status code.

Type: String

Required: No

statusMessage

The status message for the studio component.

Type: String

Required: No

studioComponentId

The unique identifier for a studio component resource.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 22.

Pattern: ^[a-zA-Z0-9-_]*$

Required: No

subtype

The specific subtype of a studio component.

Type: String

Valid Values: AWS_MANAGED_MICROSOFT_AD | AMAZON_FSX_FOR_WINDOWS | AMAZON_FSX_FOR_LUSTRE | CUSTOM

Required: No

tags

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

Type: String to string map

Required: No

type

The type of the studio component.

Type: String

Valid Values: ACTIVE_DIRECTORY | SHARED_FILE_SYSTEM | COMPUTE_FARM | LICENSE_SERVICE | CUSTOM

Required: No

updatedAt

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

Type: Timestamp

Required: No

updatedBy

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

Type: String

Required: No

StudioComponent

Contents

See Also