AWS::NimbleStudio::LaunchProfile

The AWS::NimbleStudio::LaunchProfile resource represents access permissions for a set of studio components, including types of workstations, render farms, and shared file systems. Launch profiles are shared with studio users to give them access to the set of studio components.

Syntax

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

JSON

{
  "Type" : "AWS::NimbleStudio::LaunchProfile",
  "Properties" : {
      "Description" : String,
      "Ec2SubnetIds" : [ String, ... ],
      "LaunchProfileProtocolVersions" : [ String, ... ],
      "Name" : String,
      "StreamConfiguration" : StreamConfiguration,
      "StudioComponentIds" : [ String, ... ],
      "StudioId" : String,
      "Tags" : {Key: Value, ...}
    }
}

YAML

Type: AWS::NimbleStudio::LaunchProfile
Properties:
  Description: String
  Ec2SubnetIds: 
    - String
  LaunchProfileProtocolVersions: 
    - String
  Name: String
  StreamConfiguration: 
    StreamConfiguration
  StudioComponentIds: 
    - String
  StudioId: String
  Tags: 
    Key: Value

Properties

Description

A human-readable description of the launch profile.

Required: No

Type: String

Minimum: 0

Maximum: 256

Update requires: No interruption

Ec2SubnetIds

Unique identifiers for a collection of EC2 subnets.

Required: Yes

Type: Array of String

Minimum: 0

Maximum: 6

Update requires: Replacement

LaunchProfileProtocolVersions

The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".

Required: Yes

Type: Array of String

Minimum: 0

Maximum: 10

Update requires: No interruption

Name

A friendly name for the launch profile.

Required: Yes

Type: String

Minimum: 1

Maximum: 64

Update requires: No interruption

StreamConfiguration

A configuration for a streaming session.

Required: Yes

Type: StreamConfiguration

Update requires: No interruption

StudioComponentIds

Unique identifiers for a collection of studio components that can be used with this launch profile.

Required: Yes

Type: Array of String

Minimum: 1

Maximum: 100

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

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

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.

LaunchProfileId

The unique identifier for the launch profile resource.