AWS::AppStream::AppBlockBuilder - 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).

AWS::AppStream::AppBlockBuilder

Creates an app block builder.

Syntax

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

JSON

{
  "Type" : "AWS::AppStream::AppBlockBuilder",
  "Properties" : {
      "AccessEndpoints" : [ AccessEndpoint, ... ],
      "AppBlockArns" : [ String, ... ],
      "Description" : String,
      "DisplayName" : String,
      "EnableDefaultInternetAccess" : Boolean,
      "IamRoleArn" : String,
      "InstanceType" : String,
      "Name" : String,
      "Platform" : String,
      "Tags" : [ Tag, ... ],
      "VpcConfig" : VpcConfig
    }
}

YAML

Type: AWS::AppStream::AppBlockBuilder
Properties:
  AccessEndpoints: 
    - AccessEndpoint
  AppBlockArns: 
    - String
  Description: String
  DisplayName: String
  EnableDefaultInternetAccess: Boolean
  IamRoleArn: String
  InstanceType: String
  Name: String
  Platform: String
  Tags: 
    - Tag
  VpcConfig: 
    VpcConfig

Properties

AccessEndpoints

The access endpoints of the app block builder.

Required: No

Type: Array of AccessEndpoint

Minimum: 1

Maximum: 4

Update requires: No interruption

AppBlockArns

The ARN of the app block.

Maximum: 1

Required: No

Type: Array of String

Update requires: No interruption

Description

The description of the app block builder.

Required: No

Type: String

Minimum: 1

Update requires: No interruption

DisplayName

The display name of the app block builder.

Required: No

Type: String

Minimum: 1

Update requires: No interruption

EnableDefaultInternetAccess

Indicates whether default internet access is enabled for the app block builder.

Required: No

Type: Boolean

Update requires: No interruption

IamRoleArn

The ARN of the IAM role that is applied to the app block builder.

Required: No

Type: String

Pattern: ^arn:aws(?:\-cn|\-iso\-b|\-iso|\-us\-gov)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\-]{0,1023}$

Update requires: No interruption

InstanceType

The instance type of the app block builder.

Required: Yes

Type: String

Minimum: 1

Update requires: No interruption

Name

The name of the app block builder.

Required: Yes

Type: String

Minimum: 1

Update requires: Replacement

Platform

The platform of the app block builder.

Allowed values: WINDOWS_SERVER_2019

Required: Yes

Type: String

Update requires: No interruption

Tags

The tags of the app block builder.

Required: No

Type: Array of Tag

Update requires: No interruption

VpcConfig

The VPC configuration for the app block builder.

Required: Yes

Type: VpcConfig

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Name of the app block builder, such as abcdefAppBlockBuilder.

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 builder.

CreatedTime

The time when the app block builder was created.