AWS::NimbleStudio::StudioComponent

The AWS::NimbleStudio::StudioComponent resource represents a network resource that is used by a studio's users and workflows. A typical studio contains studio components for the following: a render farm, an Active Directory, a licensing service, and a shared 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, which are returned by GetLaunchProfileInitialization. These initialization scripts run on streaming sessions when they start. They provide users with flexibility in controlling how studio resources are configured on a streaming session.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::NimbleStudio::StudioComponent",
  "Properties" : {
      "Configuration" : StudioComponentConfiguration,
      "Description" : String,
      "Ec2SecurityGroupIds" : [ String, ... ],
      "InitializationScripts" : [ StudioComponentInitializationScript, ... ],
      "Name" : String,
      "RuntimeRoleArn" : String,
      "ScriptParameters" : [ ScriptParameterKeyValue, ... ],
      "SecureInitializationRoleArn" : String,
      "StudioId" : String,
      "Subtype" : String,
      "Tags" : {Key: Value, ...},
      "Type" : String
    }
}

YAML

Type: AWS::NimbleStudio::StudioComponent
Properties:
  Configuration: 
    StudioComponentConfiguration
  Description: String
  Ec2SecurityGroupIds: 
    - String
  InitializationScripts: 
    - StudioComponentInitializationScript
  Name: String
  RuntimeRoleArn: String
  ScriptParameters: 
    - ScriptParameterKeyValue
  SecureInitializationRoleArn: String
  StudioId: String
  Subtype: String
  Tags: 
    Key: Value
  Type: String

Properties

Configuration

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

Required: No

Type: StudioComponentConfiguration

Update requires: No interruption

Description

A human-readable description for the studio component resource.

Required: No

Type: String

Minimum: 0

Maximum: 256

Update requires: No interruption

Ec2SecurityGroupIds

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

Required: No

Type: Array of String

Minimum: 0

Maximum: 30

Update requires: No interruption

InitializationScripts

Initialization scripts for studio components.

Required: No

Type: Array of StudioComponentInitializationScript

Update requires: No interruption

Name

A friendly name for the studio component resource.

Required: Yes

Type: String

Minimum: 0

Maximum: 64

Update requires: No interruption

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.

Required: No

Type: String

Minimum: 0

Maximum: 2048

Update requires: No interruption

ScriptParameters

Parameters for the studio component scripts.

Required: No

Type: Array of ScriptParameterKeyValue

Minimum: 0

Maximum: 30

Update requires: No interruption

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.

Required: No

Type: String

Minimum: 0

Maximum: 2048

Update requires: No interruption

StudioId

The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.

Required: Yes

Type: String

Update requires: Replacement

Subtype

The specific subtype of a studio component.

Required: No

Type: String

Allowed values: AWS_MANAGED_MICROSOFT_AD | AMAZON_FSX_FOR_WINDOWS | AMAZON_FSX_FOR_LUSTRE | CUSTOM

Update requires: Replacement

Tags

An array of key-value pairs to apply to this resource.

For more information, see Tag.

Required: No

Type: Object of String

Pattern: .+

Update requires: Replacement

Type

The type of the studio component.

Required: Yes

Type: String

Allowed values: ACTIVE_DIRECTORY | SHARED_FILE_SYSTEM | COMPUTE_FARM | LICENSE_SERVICE | CUSTOM

Update requires: No interruption

Return values

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

StudioComponentId

The unique identifier for the studio component resource.