Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-nimblestudio-launchprofile.json
Parent schema serverless-framework-configuration
Type: object

Represents a launch profile which delegates access to a collection of studio components to studio users. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-nimblestudio

Properties

Ec2SubnetIds string[] required

Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from. These subnets must support the specified instance types.

minItems=0maxItems=6
LaunchProfileProtocolVersions string[] required

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

Name string | Aws_CF_FunctionString required

The name for the launch profile.

StreamConfiguration object required

A configuration for a streaming session.

10 nested properties
ClipboardMode string | Aws_CF_FunctionString required
Ec2InstanceTypes StreamingInstanceType[] required

The EC2 instance types that users can select from when launching a streaming session with this launch profile.

minItems=1maxItems=30
StreamingImageIds string[] required

The streaming images that users can select from when launching a streaming session with this launch profile.

minItems=1maxItems=20
MaxSessionLengthInMinutes number

The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.

Default: 690
min=1max=43200
MaxStoppedSessionLengthInMinutes number

Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.

This field is allowed only when sessionPersistenceMode is ACTIVATED and automaticTerminationMode is ACTIVATED.

If the value is set to 0, your sessions can’t be STOPPED. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated (instead of STOPPED).

If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped (instead of terminated).

Default: 0
min=0max=5760
SessionStorage object

The configuration for a streaming session’s upload storage.

2 nested properties

Allows artists to upload files to their workstations. The only valid option is UPLOAD.

minItems=1
Root object

The upload storage root location (folder) on streaming workstations where files are uploaded.

2 nested properties
Linux string | Aws_CF_FunctionString

The folder path in Linux workstations where files are uploaded.

Windows string | Aws_CF_FunctionString

The folder path in Windows workstations where files are uploaded.

SessionBackup object

Configures how streaming sessions are backed up when launched from this launch profile.

2 nested properties
Mode string | Aws_CF_FunctionString
MaxBackupsToRetain number

The maximum number of backups that each streaming session created from this launch profile can have.

Default: 0
min=0max=10
SessionPersistenceMode string | Aws_CF_FunctionString
VolumeConfiguration object

Custom volume configuration for the root volumes that are attached to streaming sessions.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

3 nested properties
Size number

The size of the root volume that is attached to the streaming session. The root volume size is measured in GiBs.

Default: 500
min=100max=16000
Throughput number

The throughput to provision for the root volume that is attached to the streaming session. The throughput is measured in MiB/s.

Default: 125
min=125max=1000
Iops number

The number of I/O operations per second for the root volume that is attached to streaming session.

Default: 3000
min=3000max=16000
AutomaticTerminationMode string | Aws_CF_FunctionString
StudioComponentIds string[] required

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

minItems=1maxItems=100
StudioId string | Aws_CF_FunctionString required

The studio ID.

Description string | Aws_CF_FunctionString

The description.

Tags object

Definitions

AutomaticTerminationMode string | Aws_CF_FunctionString
SessionBackupMode string | Aws_CF_FunctionString
SessionPersistenceMode string | Aws_CF_FunctionString
StreamConfiguration object

A configuration for a streaming session.

ClipboardMode string | Aws_CF_FunctionString required
Ec2InstanceTypes StreamingInstanceType[] required

The EC2 instance types that users can select from when launching a streaming session with this launch profile.

minItems=1maxItems=30
StreamingImageIds string[] required

The streaming images that users can select from when launching a streaming session with this launch profile.

minItems=1maxItems=20
MaxSessionLengthInMinutes number

The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.

Default: 690
min=1max=43200
MaxStoppedSessionLengthInMinutes number

Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.

This field is allowed only when sessionPersistenceMode is ACTIVATED and automaticTerminationMode is ACTIVATED.

If the value is set to 0, your sessions can’t be STOPPED. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated (instead of STOPPED).

If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped (instead of terminated).

Default: 0
min=0max=5760
SessionStorage object

The configuration for a streaming session’s upload storage.

2 nested properties

Allows artists to upload files to their workstations. The only valid option is UPLOAD.

minItems=1
Root object

The upload storage root location (folder) on streaming workstations where files are uploaded.

2 nested properties
Linux string | Aws_CF_FunctionString

The folder path in Linux workstations where files are uploaded.

Windows string | Aws_CF_FunctionString

The folder path in Windows workstations where files are uploaded.

SessionBackup object

Configures how streaming sessions are backed up when launched from this launch profile.

2 nested properties
Mode string | Aws_CF_FunctionString
MaxBackupsToRetain number

The maximum number of backups that each streaming session created from this launch profile can have.

Default: 0
min=0max=10
SessionPersistenceMode string | Aws_CF_FunctionString
VolumeConfiguration object

Custom volume configuration for the root volumes that are attached to streaming sessions.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

3 nested properties
Size number

The size of the root volume that is attached to the streaming session. The root volume size is measured in GiBs.

Default: 500
min=100max=16000
Throughput number

The throughput to provision for the root volume that is attached to the streaming session. The throughput is measured in MiB/s.

Default: 125
min=125max=1000
Iops number

The number of I/O operations per second for the root volume that is attached to streaming session.

Default: 3000
min=3000max=16000
AutomaticTerminationMode string | Aws_CF_FunctionString
StreamConfigurationSessionBackup object

Configures how streaming sessions are backed up when launched from this launch profile.

Mode string | Aws_CF_FunctionString
MaxBackupsToRetain number

The maximum number of backups that each streaming session created from this launch profile can have.

Default: 0
min=0max=10
StreamConfigurationSessionStorage object

The configuration for a streaming session’s upload storage.

Allows artists to upload files to their workstations. The only valid option is UPLOAD.

minItems=1
Root object

The upload storage root location (folder) on streaming workstations where files are uploaded.

2 nested properties
Linux string | Aws_CF_FunctionString

The folder path in Linux workstations where files are uploaded.

Windows string | Aws_CF_FunctionString

The folder path in Windows workstations where files are uploaded.

StreamingClipboardMode string | Aws_CF_FunctionString
StreamingInstanceType string | Aws_CF_FunctionString
StreamingSessionStorageMode string | Aws_CF_FunctionString
StreamingSessionStorageRoot object

The upload storage root location (folder) on streaming workstations where files are uploaded.

Linux string | Aws_CF_FunctionString

The folder path in Linux workstations where files are uploaded.

Windows string | Aws_CF_FunctionString

The folder path in Windows workstations where files are uploaded.

Tags object
VolumeConfiguration object

Custom volume configuration for the root volumes that are attached to streaming sessions.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

Size number

The size of the root volume that is attached to the streaming session. The root volume size is measured in GiBs.

Default: 500
min=100max=16000
Throughput number

The throughput to provision for the root volume that is attached to the streaming session. The throughput is measured in MiB/s.

Default: 125
min=125max=1000
Iops number

The number of I/O operations per second for the root volume that is attached to streaming session.

Default: 3000
min=3000max=16000