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	awscc.appstream.app_block_builders

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
name	string
region	string	AWS region.

For more information, see AWS::AppStream::AppBlockBuilder.

Methods

Name	Resource	Accessible by	Required Params
create_resource	app_block_builders	INSERT	Name, Platform, InstanceType, VpcConfig, region
delete_resource	app_block_builders	DELETE	Identifier, region
update_resource	app_block_builders	UPDATE	Identifier, PatchDocument, region
list_resources	app_block_builders_list_only	SELECT	region
get_resource	app_block_builders	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.appstream.app_block_builders
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all app_block_builders in a region.

SELECT
  region,
  name
FROM awscc.appstream.app_block_builders_list_only
WHERE
  region = 'us-east-1';

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 awscc.appstream.app_block_builders (
  Name,
  Platform,
  VpcConfig,
  InstanceType,
  region
)
SELECT
  '{{ name }}',
  '{{ platform }}',
  '{{ vpc_config }}',
  '{{ instance_type }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.appstream.app_block_builders (
  Name,
  Description,
  DisplayName,
  Platform,
  AccessEndpoints,
  Tags,
  VpcConfig,
  EnableDefaultInternetAccess,
  IamRoleArn,
  InstanceType,
  AppBlockArns,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ display_name }}',
  '{{ platform }}',
  '{{ access_endpoints }}',
  '{{ tags }}',
  '{{ vpc_config }}',
  '{{ enable_default_internet_access }}',
  '{{ iam_role_arn }}',
  '{{ instance_type }}',
  '{{ app_block_arns }}',
  '{{ 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: display_name
        value: '{{ display_name }}'
      - name: platform
        value: '{{ platform }}'
      - name: access_endpoints
        value:
          - endpoint_type: '{{ endpoint_type }}'
            vpce_id: '{{ vpce_id }}'
      - name: tags
        value:
          - value: '{{ value }}'
            key: '{{ key }}'
      - name: vpc_config
        value:
          security_group_ids:
            - '{{ security_group_ids[0] }}'
          subnet_ids:
            - '{{ subnet_ids[0] }}'
      - name: enable_default_internet_access
        value: '{{ enable_default_internet_access }}'
      - name: iam_role_arn
        value: '{{ iam_role_arn }}'
      - name: instance_type
        value: '{{ instance_type }}'
      - name: app_block_arns
        value:
          - '{{ app_block_arns[0] }}'

UPDATE example

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

/*+ update */
UPDATE awscc.appstream.app_block_builders
SET PatchDocument = string('{{ {
    "Description": description,
    "DisplayName": display_name,
    "Platform": platform,
    "AccessEndpoints": access_endpoints,
    "Tags": tags,
    "VpcConfig": vpc_config,
    "EnableDefaultInternetAccess": enable_default_internet_access,
    "IamRoleArn": iam_role_arn,
    "InstanceType": instance_type,
    "AppBlockArns": app_block_arns
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.appstream.app_block_builders
WHERE
  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,
appstream:ListTagsForResource,
iam:PassRole

Read

appstream:DescribeAppBlockBuilders,
appstream:ListTagsForResource

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