Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StreamingImage

Represents a streaming image resource.

Streaming images are used by studio users to select which operating system and software they want to use in a Nimble Studio streaming session.

Amazon provides a number of streaming images that include popular 3rd-party software.

You can create your own streaming images using an Amazon EC2 machine image that you create for this purpose. You can also include software that your users require.

Hierarchy

  • StreamingImage

Index

Properties

Optional arn

arn: undefined | string

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

Optional description

description: undefined | string

A human-readable description of the streaming image.

Optional ec2ImageId

ec2ImageId: undefined | string

The ID of an EC2 machine image with which to create the streaming image.

Optional encryptionConfiguration

encryptionConfiguration: StreamingImageEncryptionConfiguration

The encryption configuration.

Optional eulaIds

eulaIds: string[]

The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.

Optional name

name: undefined | string

A friendly name for a streaming image resource.

Optional owner

owner: undefined | 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.

Optional platform

platform: undefined | string

The platform of the streaming image, either Windows or Linux.

Optional state

state: StreamingImageState | string

The current state.

Optional statusCode

statusCode: StreamingImageStatusCode | string

The status code.

Optional statusMessage

statusMessage: undefined | string

The status message for the streaming image.

Optional streamingImageId

streamingImageId: undefined | string

The ID of the streaming image.

Optional tags

tags: Record<string, string>

A collection of labels, in the form of key-value pairs, that apply to this resource.