AWS::NimbleStudio::StreamingImage - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::NimbleStudio::StreamingImage

The AWS::NimbleStudio::StreamingImage resource creates a streaming image in a studio. A streaming image defines the operating system and software to be used in an Amazon Nimble Studio streaming session.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::NimbleStudio::StreamingImage",
  "Properties" : {
      "Description" : String,
      "Ec2ImageId" : String,
      "Name" : String,
      "StudioId" : String,
      "Tags" : {Key: Value, ...}
    }
}

YAML

Type: AWS::NimbleStudio::StreamingImage
Properties:
  Description: String
  Ec2ImageId: String
  Name: String
  StudioId: String
  Tags: 
    Key: Value

Properties

Description

A human-readable description of the streaming image.

Required: No

Type: String

Minimum: 0

Maximum: 256

Update requires: No interruption

Ec2ImageId

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

Required: Yes

Type: String

Pattern: ^ami-[0-9A-z]+$

Update requires: Replacement

Name

A friendly name for a streaming image resource.

Required: Yes

Type: String

Minimum: 0

Maximum: 64

Update requires: No interruption

StudioId

The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.

Required: Yes

Type: String

Update requires: Replacement

Tags

An array of key-value pairs to apply to this resource.

For more information, see Tag.

Required: No

Type: Object of String

Pattern: .+

Update requires: Replacement

Return values

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

EulaIds

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

Owner

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

The platform of the streaming image, either WINDOWS or LINUX.

StreamingImageId

The unique identifier for the streaming image resource.