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.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String?

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

A human-readable description for the studio component resource.

Link copied to clipboard

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

Link copied to clipboard

Initialization scripts for studio components.

Link copied to clipboard
val name: String?

A friendly name for the studio component resource.

Link copied to clipboard

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.

Link copied to clipboard

Parameters for the studio component scripts.

Link copied to clipboard

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.

Link copied to clipboard

The current state.

Link copied to clipboard
Link copied to clipboard

The status message for the studio component.

Link copied to clipboard

The unique identifier for a studio component resource.

Link copied to clipboard

The specific subtype of a studio component.

Link copied to clipboard

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

Link copied to clipboard

The type of the studio component.

Link copied to clipboard

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

Link copied to clipboard

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

Functions

Link copied to clipboard
inline fun copy(block: StudioComponent.Builder.() -> Unit = {}): StudioComponent
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String