image_builders

Creates, updates, deletes or gets an image_builder resource or lists image_builders in a region

Overview

Name	image_builders
Type	Resource
Description	Resource Type definition for AWS::AppStream::ImageBuilder
Id	aws.appstream.image_builders

Fields

Name	Datatype	Description
description	string
vpc_config	object
enable_default_internet_access	boolean
domain_join_info	object
appstream_agent_version	string
name	string
image_name	string
display_name	string
iam_role_arn	string
instance_type	string
tags	array
streaming_url	string
image_arn	string
access_endpoints	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	InstanceType, Name, region
delete_resource	DELETE	data__Identifier, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all image_builders in a region.

SELECT
region,
description,
vpc_config,
enable_default_internet_access,
domain_join_info,
appstream_agent_version,
name,
image_name,
display_name,
iam_role_arn,
instance_type,
tags,
streaming_url,
image_arn,
access_endpoints
FROM aws.appstream.image_builders
WHERE region = 'us-east-1';

Gets all properties from an individual image_builder.

SELECT
region,
description,
vpc_config,
enable_default_internet_access,
domain_join_info,
appstream_agent_version,
name,
image_name,
display_name,
iam_role_arn,
instance_type,
tags,
streaming_url,
image_arn,
access_endpoints
FROM aws.appstream.image_builders
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO aws.appstream.image_builders (
 Description,
 VpcConfig,
 EnableDefaultInternetAccess,
 DomainJoinInfo,
 AppstreamAgentVersion,
 Name,
 ImageName,
 DisplayName,
 IamRoleArn,
 InstanceType,
 Tags,
 ImageArn,
 AccessEndpoints,
 region
)
SELECT 
 '{{ Description }}',
 '{{ VpcConfig }}',
 '{{ EnableDefaultInternetAccess }}',
 '{{ DomainJoinInfo }}',
 '{{ AppstreamAgentVersion }}',
 '{{ Name }}',
 '{{ ImageName }}',
 '{{ DisplayName }}',
 '{{ IamRoleArn }}',
 '{{ InstanceType }}',
 '{{ Tags }}',
 '{{ ImageArn }}',
 '{{ AccessEndpoints }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: image_builder
    props:
      - name: Description
        value: '{{ Description }}'
      - name: VpcConfig
        value:
          SecurityGroupIds:
            - '{{ SecurityGroupIds[0] }}'
          SubnetIds:
            - '{{ SubnetIds[0] }}'
      - name: EnableDefaultInternetAccess
        value: '{{ EnableDefaultInternetAccess }}'
      - name: DomainJoinInfo
        value:
          OrganizationalUnitDistinguishedName: '{{ OrganizationalUnitDistinguishedName }}'
          DirectoryName: '{{ DirectoryName }}'
      - name: AppstreamAgentVersion
        value: '{{ AppstreamAgentVersion }}'
      - name: Name
        value: '{{ Name }}'
      - name: ImageName
        value: '{{ ImageName }}'
      - name: DisplayName
        value: '{{ DisplayName }}'
      - name: IamRoleArn
        value: '{{ IamRoleArn }}'
      - name: InstanceType
        value: '{{ InstanceType }}'
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'
      - name: ImageArn
        value: '{{ ImageArn }}'
      - name: AccessEndpoints
        value:
          - EndpointType: '{{ EndpointType }}'
            VpceId: '{{ VpceId }}'

DELETE example

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

Permissions

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

Create

appstream:CreateImageBuilder,
appstream:CreateImageBuilderStreamingURL,
appstream:CreateStreamingURL,
appstream:DeleteImageBuilder,
appstream:DescribeImageBuilders,
appstream:StartImageBuilder,
appstream:StopImageBuilder,
iam:CreateServiceLinkedRole,
iam:DeleteServiceLinkedRole,
iam:GetServiceLinkedRoleDeletionStatus

Read

appstream:CreateImageBuilder,
appstream:CreateImageBuilderStreamingURL,
appstream:CreateStreamingURL,
appstream:DeleteImageBuilder,
appstream:DescribeImageBuilders,
appstream:StartImageBuilder,
appstream:StopImageBuilder,
iam:CreateServiceLinkedRole,
iam:DeleteServiceLinkedRole,
iam:GetServiceLinkedRoleDeletionStatus

Delete

appstream:CreateImageBuilder,
appstream:CreateImageBuilderStreamingURL,
appstream:CreateStreamingURL,
appstream:DeleteImageBuilder,
appstream:DescribeImageBuilders,
appstream:StartImageBuilder,
appstream:StopImageBuilder,
iam:CreateServiceLinkedRole,
iam:DeleteServiceLinkedRole,
iam:GetServiceLinkedRoleDeletionStatus

List

appstream:CreateImageBuilder,
appstream:CreateImageBuilderStreamingURL,
appstream:CreateStreamingURL,
appstream:DeleteImageBuilder,
appstream:DescribeImageBuilders,
appstream:StartImageBuilder,
appstream:StopImageBuilder,
iam:CreateServiceLinkedRole,
iam:DeleteServiceLinkedRole,
iam:GetServiceLinkedRoleDeletionStatus