AWS::AppStream::AppBlock - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::AppStream::AppBlock

This resource creates an app block. App blocks store details about the virtual hard disk that contains the files for the application in an S3 bucket. It also stores the setup script with details about how to mount the virtual hard disk. App blocks are only supported for Elastic fleets.

Syntax

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

JSON

{
  "Type" : "AWS::AppStream::AppBlock",
  "Properties" : {
      "Description" : String,
      "DisplayName" : String,
      "Name" : String,
      "PackagingType" : String,
      "PostSetupScriptDetails" : ScriptDetails,
      "SetupScriptDetails" : ScriptDetails,
      "SourceS3Location" : S3Location,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::AppStream::AppBlock
Properties:
  Description: String
  DisplayName: String
  Name: String
  PackagingType: String
  PostSetupScriptDetails: 
    ScriptDetails
  SetupScriptDetails: 
    ScriptDetails
  SourceS3Location: 
    S3Location
  Tags: 
    - Tag

Properties

Description

The description of the app block.

Required: No

Type: String

Minimum: 1

Update requires: Replacement

DisplayName

The display name of the app block.

Required: No

Type: String

Minimum: 1

Update requires: Replacement

Name

The name of the app block.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$

Required: Yes

Type: String

Minimum: 1

Update requires: Replacement

PackagingType

The packaging type of the app block.

Required: No

Type: String

Allowed values: CUSTOM | APPSTREAM2

Update requires: Replacement

PostSetupScriptDetails

The post setup script details of the app block.

Required: No

Type: ScriptDetails

Update requires: Replacement

SetupScriptDetails

The setup script details of the app block.

Required: No

Type: ScriptDetails

Update requires: Replacement

SourceS3Location

The source S3 location of the app block.

Required: Yes

Type: S3Location

Update requires: Replacement

Tags

The tags of the app block.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Arn of the app block, such as arn:aws:appstream:us-west-2:123456789123:app-block/abcdefg.

For more information about using the Ref function, see Ref.

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.

Arn

The ARN of the app block.

CreatedTime

The time when the app block was created.