app_block_builders

Creates, updates, deletes or gets an app_block_builder resource or lists app_block_builders in a region

Overview

Name	app_block_builders
Type	Resource
Description	Resource Type definition for AWS::AppStream::AppBlockBuilder.
Id	aws.appstream.app_block_builders

Fields

Name	Datatype	Description
name	string
arn	string
description	string
display_name	string
platform	string
access_endpoints	array
tags	array
vpc_config	object
enable_default_internet_access	boolean
iam_role_arn	string
created_time	string
instance_type	string
app_block_arns	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, Platform, InstanceType, VpcConfig, 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 app_block_builders in a region.

SELECT
region,
name,
arn,
description,
display_name,
platform,
access_endpoints,
tags,
vpc_config,
enable_default_internet_access,
iam_role_arn,
created_time,
instance_type,
app_block_arns
FROM aws.appstream.app_block_builders
WHERE region = 'us-east-1';

Gets all properties from an individual app_block_builder.

SELECT
region,
name,
arn,
description,
display_name,
platform,
access_endpoints,
tags,
vpc_config,
enable_default_internet_access,
iam_role_arn,
created_time,
instance_type,
app_block_arns
FROM aws.appstream.app_block_builders
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.appstream.app_block_builders (
 Name,
 Platform,
 VpcConfig,
 InstanceType,
 region
)
SELECT 
'{{ Name }}',
 '{{ Platform }}',
 '{{ VpcConfig }}',
 '{{ InstanceType }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.appstream.app_block_builders (
 Name,
 Description,
 DisplayName,
 Platform,
 AccessEndpoints,
 Tags,
 VpcConfig,
 EnableDefaultInternetAccess,
 IamRoleArn,
 InstanceType,
 AppBlockArns,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Description }}',
 '{{ DisplayName }}',
 '{{ Platform }}',
 '{{ AccessEndpoints }}',
 '{{ Tags }}',
 '{{ VpcConfig }}',
 '{{ EnableDefaultInternetAccess }}',
 '{{ IamRoleArn }}',
 '{{ InstanceType }}',
 '{{ AppBlockArns }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: app_block_builder
    props:
      - name: Name
        value: '{{ Name }}'
      - name: Description
        value: '{{ Description }}'
      - name: DisplayName
        value: '{{ DisplayName }}'
      - name: Platform
        value: '{{ Platform }}'
      - name: AccessEndpoints
        value:
          - EndpointType: '{{ EndpointType }}'
            VpceId: '{{ VpceId }}'
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'
      - name: VpcConfig
        value:
          SecurityGroupIds:
            - '{{ SecurityGroupIds[0] }}'
          SubnetIds:
            - '{{ SubnetIds[0] }}'
      - name: EnableDefaultInternetAccess
        value: '{{ EnableDefaultInternetAccess }}'
      - name: IamRoleArn
        value: '{{ IamRoleArn }}'
      - name: InstanceType
        value: '{{ InstanceType }}'
      - name: AppBlockArns
        value:
          - '{{ AppBlockArns[0] }}'

DELETE example

/*+ delete */
DELETE FROM aws.appstream.app_block_builders
WHERE data__Identifier = '<Name>'
AND region = 'us-east-1';

Permissions

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

Create

appstream:CreateAppBlockBuilder,
appstream:DescribeAppBlockBuilders,
appstream:StartAppBlockBuilder,
appstream:AssociateAppBlockBuilderAppBlock,
appstream:DescribeAppBlockBuilderAppBlockAssociations,
appstream:TagResource,
iam:PassRole

Read

appstream:DescribeAppBlockBuilders

Update

appstream:UpdateAppBlockBuilder,
appstream:DescribeAppBlockBuilders,
appstream:StartAppBlockBuilder,
appstream:StopAppBlockBuilder,
appstream:AssociateAppBlockBuilderAppBlock,
appstream:DisassociateAppBlockBuilderAppBlock,
appstream:DescribeAppBlockBuilderAppBlockAssociations,
appstream:ListTagsForResource,
appstream:TagResource,
appstream:UntagResource,
iam:PassRole

Delete

appstream:DescribeAppBlockBuilders,
appstream:DeleteAppBlockBuilder,
appstream:DisassociateAppBlockBuilderAppBlock,
appstream:DescribeAppBlockBuilderAppBlockAssociations

List

appstream:DescribeAppBlockBuilders