Create Launch Profile
nimblestudio_create_launch_profile | R Documentation |
Create a launch profile¶
Description¶
Create a launch profile.
Usage¶
nimblestudio_create_launch_profile(clientToken, description,
ec2SubnetIds, launchProfileProtocolVersions, name, streamConfiguration,
studioComponentIds, studioId, tags)
Arguments¶
clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
description
The description.
ec2SubnetIds
[required] Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from. These subnets must support the specified instance types.
launchProfileProtocolVersions
[required] The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
name
[required] The name for the launch profile.
streamConfiguration
[required] A configuration for a streaming session.
studioComponentIds
[required] Unique identifiers for a collection of studio components that can be used with this launch profile.
studioId
[required] The studio ID.
tags
A collection of labels, in the form of key-value pairs, that apply to this resource.
Value¶
A list with the following syntax:
list(
launchProfile = list(
arn = "string",
createdAt = as.POSIXct(
"2015-01-01"
),
createdBy = "string",
description = "string",
ec2SubnetIds = list(
"string"
),
launchProfileId = "string",
launchProfileProtocolVersions = list(
"string"
),
name = "string",
state = "CREATE_IN_PROGRESS"|"READY"|"UPDATE_IN_PROGRESS"|"DELETE_IN_PROGRESS"|"DELETED"|"DELETE_FAILED"|"CREATE_FAILED"|"UPDATE_FAILED",
statusCode = "LAUNCH_PROFILE_CREATED"|"LAUNCH_PROFILE_UPDATED"|"LAUNCH_PROFILE_DELETED"|"LAUNCH_PROFILE_CREATE_IN_PROGRESS"|"LAUNCH_PROFILE_UPDATE_IN_PROGRESS"|"LAUNCH_PROFILE_DELETE_IN_PROGRESS"|"INTERNAL_ERROR"|"STREAMING_IMAGE_NOT_FOUND"|"STREAMING_IMAGE_NOT_READY"|"LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED"|"ENCRYPTION_KEY_ACCESS_DENIED"|"ENCRYPTION_KEY_NOT_FOUND"|"INVALID_SUBNETS_PROVIDED"|"INVALID_INSTANCE_TYPES_PROVIDED"|"INVALID_SUBNETS_COMBINATION",
statusMessage = "string",
streamConfiguration = list(
automaticTerminationMode = "DEACTIVATED"|"ACTIVATED",
clipboardMode = "ENABLED"|"DISABLED",
ec2InstanceTypes = list(
"g4dn.xlarge"|"g4dn.2xlarge"|"g4dn.4xlarge"|"g4dn.8xlarge"|"g4dn.12xlarge"|"g4dn.16xlarge"|"g3.4xlarge"|"g3s.xlarge"|"g5.xlarge"|"g5.2xlarge"|"g5.4xlarge"|"g5.8xlarge"|"g5.16xlarge"
),
maxSessionLengthInMinutes = 123,
maxStoppedSessionLengthInMinutes = 123,
sessionBackup = list(
maxBackupsToRetain = 123,
mode = "AUTOMATIC"|"DEACTIVATED"
),
sessionPersistenceMode = "DEACTIVATED"|"ACTIVATED",
sessionStorage = list(
mode = list(
"UPLOAD"
),
root = list(
linux = "string",
windows = "string"
)
),
streamingImageIds = list(
"string"
),
volumeConfiguration = list(
iops = 123,
size = 123,
throughput = 123
)
),
studioComponentIds = list(
"string"
),
tags = list(
"string"
),
updatedAt = as.POSIXct(
"2015-01-01"
),
updatedBy = "string",
validationResults = list(
list(
state = "VALIDATION_NOT_STARTED"|"VALIDATION_IN_PROGRESS"|"VALIDATION_SUCCESS"|"VALIDATION_FAILED"|"VALIDATION_FAILED_INTERNAL_SERVER_ERROR",
statusCode = "VALIDATION_NOT_STARTED"|"VALIDATION_IN_PROGRESS"|"VALIDATION_SUCCESS"|"VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION"|"VALIDATION_FAILED_SUBNET_NOT_FOUND"|"VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION"|"VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY"|"VALIDATION_FAILED_UNAUTHORIZED"|"VALIDATION_FAILED_INTERNAL_SERVER_ERROR",
statusMessage = "string",
type = "VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT"|"VALIDATE_SUBNET_ASSOCIATION"|"VALIDATE_NETWORK_ACL_ASSOCIATION"|"VALIDATE_SECURITY_GROUP_ASSOCIATION"
)
)
)
)
Request syntax¶
svc$create_launch_profile(
clientToken = "string",
description = "string",
ec2SubnetIds = list(
"string"
),
launchProfileProtocolVersions = list(
"string"
),
name = "string",
streamConfiguration = list(
automaticTerminationMode = "DEACTIVATED"|"ACTIVATED",
clipboardMode = "ENABLED"|"DISABLED",
ec2InstanceTypes = list(
"g4dn.xlarge"|"g4dn.2xlarge"|"g4dn.4xlarge"|"g4dn.8xlarge"|"g4dn.12xlarge"|"g4dn.16xlarge"|"g3.4xlarge"|"g3s.xlarge"|"g5.xlarge"|"g5.2xlarge"|"g5.4xlarge"|"g5.8xlarge"|"g5.16xlarge"
),
maxSessionLengthInMinutes = 123,
maxStoppedSessionLengthInMinutes = 123,
sessionBackup = list(
maxBackupsToRetain = 123,
mode = "AUTOMATIC"|"DEACTIVATED"
),
sessionPersistenceMode = "DEACTIVATED"|"ACTIVATED",
sessionStorage = list(
mode = list(
"UPLOAD"
),
root = list(
linux = "string",
windows = "string"
)
),
streamingImageIds = list(
"string"
),
volumeConfiguration = list(
iops = 123,
size = 123,
throughput = 123
)
),
studioComponentIds = list(
"string"
),
studioId = "string",
tags = list(
"string"
)
)