awscc.nimblestudio_launchprofile¶
Filters¶
event
reduce
value
Actions¶
delete¶
Parent base class for filters and actions.
properties:
type:
enum:
- delete
required:
- type
Permissions - nimble:DeleteLaunchProfile, nimble:UntagResource
update¶
Parent base class for filters and actions.
definitions:
StreamConfiguration:
additionalProperties: false
description: <p>A configuration for a streaming session.</p>
properties:
ClipboardMode:
enum:
- ENABLED
- DISABLED
type: string
Ec2InstanceTypes:
description: "<p>The EC2 instance types that users can select from when launching\
\ a streaming session\n with this launch profile.</p>"
items:
enum:
- g4dn.xlarge
- g4dn.2xlarge
- g4dn.4xlarge
- g4dn.8xlarge
- g4dn.12xlarge
- g4dn.16xlarge
type: string
maxItems: 30
minItems: 1
type: array
MaxSessionLengthInMinutes:
description: "<p>The length of time, in minutes, that a streaming session\
\ can be active before it is\n stopped or terminated. After this\
\ point, Nimble Studio automatically terminates or\n stops the\
\ session. The default length of time is 690 minutes, and the maximum length\
\ of\n time is 30 days.</p>"
maximum: 43200
minimum: 1
type: number
MaxStoppedSessionLengthInMinutes:
description: "<p>Integer that determines if you can start and stop your sessions\
\ and how long a session\n can stay in the STOPPED state. The\
\ default value is 0. The maximum value is 5760.</p>\n <p>If the\
\ value is missing or set to 0, your sessions can?t be stopped. If you then\
\ call\n StopStreamingSession, the session fails. If the time\
\ that a session stays in the READY\n state exceeds the maxSessionLengthInMinutes\
\ value, the session will automatically be\n terminated by AWS\
\ (instead of stopped).</p>\n <p>If the value is set to a positive\
\ number, the session can be stopped. You can call\n StopStreamingSession\
\ to stop sessions in the READY state. If the time that a session\n \
\ stays in the READY state exceeds the maxSessionLengthInMinutes\
\ value, the session will\n automatically be stopped by AWS (instead\
\ of terminated).</p>"
maximum: 5760
minimum: 0
type: number
SessionStorage:
additionalProperties: false
description: <p>The configuration for a streaming session?s upload storage.</p>
properties:
Mode:
description: "<p>Allows artists to upload files to their workstations.\
\ The only valid option is\n <code>UPLOAD</code>.</p>"
items:
enum:
- UPLOAD
type: string
minItems: 1
type: array
Root:
additionalProperties: false
description: "<p>The upload storage root location (folder) on streaming\
\ workstations where files are\n uploaded.</p>"
properties:
Linux:
description: <p>The folder path in Linux workstations where files
are uploaded.</p>
maxLength: 128
minLength: 1
pattern: ^(/?|(\$HOME)?(/[^\$/\n\s\\]+)*)$
type: string
Windows:
description: <p>The folder path in Windows workstations where files
are uploaded.</p>
maxLength: 128
minLength: 1
pattern: ^((\%HOMEPATH\%)|[a-zA-Z]:)[\\/](?:[a-zA-Z0-9_-]+[\\/])*[a-zA-Z0-9_-]+$
type: string
type: object
type: object
StreamingImageIds:
description: "<p>The streaming images that users can select from when launching\
\ a streaming session\n with this launch profile.</p>"
items:
maxLength: 22
minLength: 0
pattern: ^[a-zA-Z0-9-_]*$
type: string
maxItems: 20
minItems: 1
type: array
required:
- ClipboardMode
- Ec2InstanceTypes
- StreamingImageIds
type: object
StreamConfigurationSessionStorage:
additionalProperties: false
description: <p>The configuration for a streaming session?s upload storage.</p>
properties:
Mode:
description: "<p>Allows artists to upload files to their workstations. The\
\ only valid option is\n <code>UPLOAD</code>.</p>"
items:
enum:
- UPLOAD
type: string
minItems: 1
type: array
Root:
additionalProperties: false
description: "<p>The upload storage root location (folder) on streaming workstations\
\ where files are\n uploaded.</p>"
properties:
Linux:
description: <p>The folder path in Linux workstations where files are
uploaded.</p>
maxLength: 128
minLength: 1
pattern: ^(/?|(\$HOME)?(/[^\$/\n\s\\]+)*)$
type: string
Windows:
description: <p>The folder path in Windows workstations where files are
uploaded.</p>
maxLength: 128
minLength: 1
pattern: ^((\%HOMEPATH\%)|[a-zA-Z]:)[\\/](?:[a-zA-Z0-9_-]+[\\/])*[a-zA-Z0-9_-]+$
type: string
type: object
type: object
StreamingClipboardMode:
enum:
- ENABLED
- DISABLED
type: string
StreamingInstanceType:
enum:
- g4dn.xlarge
- g4dn.2xlarge
- g4dn.4xlarge
- g4dn.8xlarge
- g4dn.12xlarge
- g4dn.16xlarge
type: string
StreamingSessionStorageMode:
enum:
- UPLOAD
type: string
StreamingSessionStorageRoot:
additionalProperties: false
description: "<p>The upload storage root location (folder) on streaming workstations\
\ where files are\n uploaded.</p>"
properties:
Linux:
description: <p>The folder path in Linux workstations where files are uploaded.</p>
maxLength: 128
minLength: 1
pattern: ^(/?|(\$HOME)?(/[^\$/\n\s\\]+)*)$
type: string
Windows:
description: <p>The folder path in Windows workstations where files are uploaded.</p>
maxLength: 128
minLength: 1
pattern: ^((\%HOMEPATH\%)|[a-zA-Z]:)[\\/](?:[a-zA-Z0-9_-]+[\\/])*[a-zA-Z0-9_-]+$
type: string
type: object
Tags:
additionalProperties: false
patternProperties:
.+:
type: string
type: object
properties:
Description:
description: <p>The description.</p>
maxLength: 256
minLength: 0
type: string
LaunchProfileProtocolVersions:
description: "<p>The version number of the protocol that is used by the launch\
\ profile. The only valid\n version is \"2021-03-31\".</p>"
items:
description: "<p>The version number of the protocol that is used by the launch\
\ profile. The only valid\n version is \"2021-03-31\".</p>"
maxLength: 10
minLength: 0
pattern: ^2021\-03\-31$
type: string
type: array
Name:
description: <p>The name for the launch profile.</p>
maxLength: 64
minLength: 1
type: string
StreamConfiguration:
additionalProperties: false
description: <p>A configuration for a streaming session.</p>
properties:
ClipboardMode:
enum:
- ENABLED
- DISABLED
type: string
Ec2InstanceTypes:
description: "<p>The EC2 instance types that users can select from when launching\
\ a streaming session\n with this launch profile.</p>"
items:
enum:
- g4dn.xlarge
- g4dn.2xlarge
- g4dn.4xlarge
- g4dn.8xlarge
- g4dn.12xlarge
- g4dn.16xlarge
type: string
maxItems: 30
minItems: 1
type: array
MaxSessionLengthInMinutes:
description: "<p>The length of time, in minutes, that a streaming session\
\ can be active before it is\n stopped or terminated. After this\
\ point, Nimble Studio automatically terminates or\n stops the\
\ session. The default length of time is 690 minutes, and the maximum length\
\ of\n time is 30 days.</p>"
maximum: 43200
minimum: 1
type: number
MaxStoppedSessionLengthInMinutes:
description: "<p>Integer that determines if you can start and stop your sessions\
\ and how long a session\n can stay in the STOPPED state. The\
\ default value is 0. The maximum value is 5760.</p>\n <p>If the\
\ value is missing or set to 0, your sessions can?t be stopped. If you then\
\ call\n StopStreamingSession, the session fails. If the time\
\ that a session stays in the READY\n state exceeds the maxSessionLengthInMinutes\
\ value, the session will automatically be\n terminated by AWS\
\ (instead of stopped).</p>\n <p>If the value is set to a positive\
\ number, the session can be stopped. You can call\n StopStreamingSession\
\ to stop sessions in the READY state. If the time that a session\n \
\ stays in the READY state exceeds the maxSessionLengthInMinutes\
\ value, the session will\n automatically be stopped by AWS (instead\
\ of terminated).</p>"
maximum: 5760
minimum: 0
type: number
SessionStorage:
additionalProperties: false
description: <p>The configuration for a streaming session?s upload storage.</p>
properties:
Mode:
description: "<p>Allows artists to upload files to their workstations.\
\ The only valid option is\n <code>UPLOAD</code>.</p>"
items:
enum:
- UPLOAD
type: string
minItems: 1
type: array
Root:
additionalProperties: false
description: "<p>The upload storage root location (folder) on streaming\
\ workstations where files are\n uploaded.</p>"
properties:
Linux:
description: <p>The folder path in Linux workstations where files
are uploaded.</p>
maxLength: 128
minLength: 1
pattern: ^(/?|(\$HOME)?(/[^\$/\n\s\\]+)*)$
type: string
Windows:
description: <p>The folder path in Windows workstations where files
are uploaded.</p>
maxLength: 128
minLength: 1
pattern: ^((\%HOMEPATH\%)|[a-zA-Z]:)[\\/](?:[a-zA-Z0-9_-]+[\\/])*[a-zA-Z0-9_-]+$
type: string
type: object
type: object
StreamingImageIds:
description: "<p>The streaming images that users can select from when launching\
\ a streaming session\n with this launch profile.</p>"
items:
maxLength: 22
minLength: 0
pattern: ^[a-zA-Z0-9-_]*$
type: string
maxItems: 20
minItems: 1
type: array
required:
- ClipboardMode
- Ec2InstanceTypes
- StreamingImageIds
type: object
StudioComponentIds:
description: "<p>Unique identifiers for a collection of studio components that\
\ can be used with this\n launch profile.</p>"
items:
type: string
maxItems: 100
minItems: 1
type: array
type:
enum:
- update
Permissions - nimble:UpdateLaunchProfile