Documentation

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: newStudioComponent smart constructor.

Create a value of StudioComponent with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arn:StudioComponent', studioComponent_arn - The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

$sel:configuration:StudioComponent', studioComponent_configuration - The configuration of the studio component, based on component type.

$sel:createdAt:StudioComponent', studioComponent_createdAt - The ISO timestamp in seconds for when the resource was created.

$sel:createdBy:StudioComponent', studioComponent_createdBy - The user ID of the user that created the studio component.

$sel:description:StudioComponent', studioComponent_description - A human-readable description for the studio component resource.

$sel:ec2SecurityGroupIds:StudioComponent', studioComponent_ec2SecurityGroupIds - The EC2 security groups that control access to the studio component.

$sel:initializationScripts:StudioComponent', studioComponent_initializationScripts - Initialization scripts for studio components.

$sel:name:StudioComponent', studioComponent_name - A friendly name for the studio component resource.

$sel:runtimeRoleArn:StudioComponent', studioComponent_runtimeRoleArn - 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.

$sel:scriptParameters:StudioComponent', studioComponent_scriptParameters - Parameters for the studio component scripts.

$sel:secureInitializationRoleArn:StudioComponent', studioComponent_secureInitializationRoleArn - 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.

$sel:state:StudioComponent', studioComponent_state - The current state.

$sel:statusCode:StudioComponent', studioComponent_statusCode - The status code.

$sel:statusMessage:StudioComponent', studioComponent_statusMessage - The status message for the studio component.

$sel:studioComponentId:StudioComponent', studioComponent_studioComponentId - The unique identifier for a studio component resource.

$sel:subtype:StudioComponent', studioComponent_subtype - The specific subtype of a studio component.

$sel:tags:StudioComponent', studioComponent_tags - A collection of labels, in the form of key-value pairs, that apply to this resource.

$sel:type':StudioComponent', studioComponent_type - The type of the studio component.

$sel:updatedAt:StudioComponent', studioComponent_updatedAt - The ISO timestamp in seconds for when the resource was updated.

$sel:updatedBy:StudioComponent', studioComponent_updatedBy - The user ID of the user that most recently updated the resource.

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

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

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

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

A human-readable description for the studio component resource.

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

Initialization scripts for studio components.

A friendly name for the studio component resource.

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.

Parameters for the studio component scripts.

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.

The current state.

The status code.

The status message for the studio component.

The unique identifier for a studio component resource.

The specific subtype of a studio component.

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

The type of the studio component.

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

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