launch_profiles

Creates, updates, deletes or gets a launch_profile resource or lists launch_profiles in a region

Overview

Name	launch_profiles
Type	Resource
Description	Represents a launch profile which delegates access to a collection of studio components to studio users
Id	aws.nimblestudio.launch_profiles

Fields

Name	Datatype	Description
description	string	The description.
ec2_subnet_ids	array	Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from. These subnets must support the specified instance types.
launch_profile_id	string
launch_profile_protocol_versions	array	The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
name	string	The name for the launch profile.
stream_configuration	object	A configuration for a streaming session.
studio_component_ids	array	Unique identifiers for a collection of studio components that can be used with this launch profile.
studio_id	string	The studio ID.
tags	object
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	StudioId, Name, StudioComponentIds, Ec2SubnetIds, StreamConfiguration, LaunchProfileProtocolVersions, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all launch_profiles in a region.

SELECT
region,
description,
ec2_subnet_ids,
launch_profile_id,
launch_profile_protocol_versions,
name,
stream_configuration,
studio_component_ids,
studio_id,
tags
FROM aws.nimblestudio.launch_profiles
WHERE region = 'us-east-1';

Gets all properties from an individual launch_profile.

SELECT
region,
description,
ec2_subnet_ids,
launch_profile_id,
launch_profile_protocol_versions,
name,
stream_configuration,
studio_component_ids,
studio_id,
tags
FROM aws.nimblestudio.launch_profiles
WHERE region = 'us-east-1' AND data__Identifier = '<LaunchProfileId>|<StudioId>';

INSERT example

Use the following StackQL query and manifest file to create a new launch_profile resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.nimblestudio.launch_profiles (
 Ec2SubnetIds,
 LaunchProfileProtocolVersions,
 Name,
 StreamConfiguration,
 StudioComponentIds,
 StudioId,
 region
)
SELECT 
'{{ Ec2SubnetIds }}',
 '{{ LaunchProfileProtocolVersions }}',
 '{{ Name }}',
 '{{ StreamConfiguration }}',
 '{{ StudioComponentIds }}',
 '{{ StudioId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.nimblestudio.launch_profiles (
 Description,
 Ec2SubnetIds,
 LaunchProfileProtocolVersions,
 Name,
 StreamConfiguration,
 StudioComponentIds,
 StudioId,
 Tags,
 region
)
SELECT 
 '{{ Description }}',
 '{{ Ec2SubnetIds }}',
 '{{ LaunchProfileProtocolVersions }}',
 '{{ Name }}',
 '{{ StreamConfiguration }}',
 '{{ StudioComponentIds }}',
 '{{ StudioId }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: launch_profile
    props:
      - name: Description
        value: '{{ Description }}'
      - name: Ec2SubnetIds
        value:
          - '{{ Ec2SubnetIds[0] }}'
      - name: LaunchProfileProtocolVersions
        value:
          - '{{ LaunchProfileProtocolVersions[0] }}'
      - name: Name
        value: '{{ Name }}'
      - name: StreamConfiguration
        value:
          ClipboardMode: '{{ ClipboardMode }}'
          Ec2InstanceTypes:
            - '{{ Ec2InstanceTypes[0] }}'
          MaxSessionLengthInMinutes: null
          StreamingImageIds:
            - '{{ StreamingImageIds[0] }}'
          MaxStoppedSessionLengthInMinutes: null
          SessionStorage:
            Root:
              Linux: '{{ Linux }}'
              Windows: '{{ Windows }}'
            Mode:
              - '{{ Mode[0] }}'
          SessionBackup:
            Mode: '{{ Mode }}'
            MaxBackupsToRetain: null
          SessionPersistenceMode: '{{ SessionPersistenceMode }}'
          VolumeConfiguration:
            Size: null
            Throughput: null
            Iops: null
          AutomaticTerminationMode: '{{ AutomaticTerminationMode }}'
      - name: StudioComponentIds
        value:
          - '{{ StudioComponentIds[0] }}'
      - name: StudioId
        value: '{{ StudioId }}'
      - name: Tags
        value: {}

DELETE example

/*+ delete */
DELETE FROM aws.nimblestudio.launch_profiles
WHERE data__Identifier = '<LaunchProfileId|StudioId>'
AND region = 'us-east-1';

Permissions

To operate on the launch_profiles resource, the following permissions are required:

Create

nimble:CreateLaunchProfile,
nimble:GetLaunchProfile,
nimble:TagResource,
ec2:CreateNetworkInterface,
ec2:CreateNetworkInterfacePermission,
ec2:RunInstances,
ec2:DescribeSubnets

Read

nimble:GetLaunchProfile

Update

nimble:UpdateLaunchProfile,
nimble:GetLaunchProfile,
ec2:CreateNetworkInterface,
ec2:CreateNetworkInterfacePermission,
ec2:DescribeSubnets,
ec2:RunInstances

Delete

nimble:DeleteLaunchProfile,
nimble:GetLaunchProfile,
nimble:UntagResource

List

nimble:ListLaunchProfiles