streaming_images

Creates, updates, deletes or gets a streaming_image resource or lists streaming_images in a region

Overview

Name	streaming_images
Type	Resource
Description	Represents a streaming session machine image that can be used to launch a streaming session
Id	aws.nimblestudio.streaming_images

Fields

Name	Datatype	Description
description	string	A human-readable description of the streaming image.
ec2_image_id	string	The ID of an EC2 machine image with which to create this streaming image.
encryption_configuration	object	TODO
eula_ids	array	The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.
name	string	A friendly name for a streaming image resource.
owner	string	The owner of the streaming image, either the studioId that contains the streaming image, or 'amazon' for images that are provided by Amazon Nimble Studio.
platform	string	The platform of the streaming image, either WINDOWS or LINUX.
streaming_image_id	string
studio_id	string	The studioId.
tags	object
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	StudioId, Ec2ImageId, Name, 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 streaming_images in a region.

SELECT
region,
description,
ec2_image_id,
encryption_configuration,
eula_ids,
name,
owner,
platform,
streaming_image_id,
studio_id,
tags
FROM aws.nimblestudio.streaming_images
WHERE region = 'us-east-1';

Gets all properties from an individual streaming_image.

SELECT
region,
description,
ec2_image_id,
encryption_configuration,
eula_ids,
name,
owner,
platform,
streaming_image_id,
studio_id,
tags
FROM aws.nimblestudio.streaming_images
WHERE region = 'us-east-1' AND data__Identifier = '<StudioId>|<StreamingImageId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.nimblestudio.streaming_images (
 Ec2ImageId,
 Name,
 StudioId,
 region
)
SELECT 
'{{ Ec2ImageId }}',
 '{{ Name }}',
 '{{ StudioId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.nimblestudio.streaming_images (
 Description,
 Ec2ImageId,
 Name,
 StudioId,
 Tags,
 region
)
SELECT 
 '{{ Description }}',
 '{{ Ec2ImageId }}',
 '{{ Name }}',
 '{{ StudioId }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: streaming_image
    props:
      - name: Description
        value: '{{ Description }}'
      - name: Ec2ImageId
        value: '{{ Ec2ImageId }}'
      - name: Name
        value: '{{ Name }}'
      - name: StudioId
        value: '{{ StudioId }}'
      - name: Tags
        value: {}

DELETE example

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

Permissions

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

Create

nimble:CreateStreamingImage,
nimble:GetStreamingImage,
nimble:TagResource,
ec2:DescribeImages,
ec2:DescribeSnapshots,
ec2:ModifyInstanceAttribute,
ec2:ModifySnapshotAttribute,
ec2:ModifyImageAttribute,
ec2:RegisterImage,
kms:Encrypt,
kms:Decrypt,
kms:CreateGrant,
kms:ListGrants,
kms:GenerateDataKey

Read

nimble:GetStreamingImage

Update

nimble:UpdateStreamingImage,
nimble:GetStreamingImage,
kms:Encrypt,
kms:Decrypt,
kms:CreateGrant,
kms:ListGrants,
kms:GenerateDataKey

Delete

nimble:DeleteStreamingImage,
nimble:GetStreamingImage,
nimble:UntagResource,
ec2:ModifyInstanceAttribute,
ec2:ModifySnapshotAttribute,
ec2:DeregisterImage,
ec2:DeleteSnapshot,
kms:ListGrants,
kms:RetireGrant

List

nimble:ListStreamingImages