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

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
name	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	image_builders	INSERT	InstanceType, Name, region
delete_resource	image_builders	DELETE	Identifier, region
list_resources	image_builders_list_only	SELECT	region
get_resource	image_builders	SELECT	Identifier, region

SELECT examples

get (all properties)

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

list (identifiers only)

Lists all image_builders in a region.

SELECT
  region,
  name
FROM awscc.appstream.image_builders_list_only
WHERE
  region = '{{ region }}';

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 awscc.appstream.image_builders (
  Name,
  InstanceType,
  region
)
SELECT
  '{{ name }}',
  '{{ instance_type }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.appstream.image_builders (
  Description,
  VpcConfig,
  EnableDefaultInternetAccess,
  DomainJoinInfo,
  AppstreamAgentVersion,
  Name,
  ImageName,
  DisplayName,
  IamRoleArn,
  InstanceType,
  Tags,
  ImageArn,
  AccessEndpoints,
  region
)
SELECT
  '{{ description }}',
  '{{ vpc_config }}',
  '{{ enable_default_internet_access }}',
  '{{ domain_join_info }}',
  '{{ appstream_agent_version }}',
  '{{ name }}',
  '{{ image_name }}',
  '{{ display_name }}',
  '{{ iam_role_arn }}',
  '{{ instance_type }}',
  '{{ tags }}',
  '{{ image_arn }}',
  '{{ access_endpoints }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: 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: domain_join_info
      value:
        organizational_unit_distinguished_name: '{{ organizational_unit_distinguished_name }}'
        directory_name: '{{ directory_name }}'
    - name: appstream_agent_version
      value: '{{ appstream_agent_version }}'
    - name: name
      value: '{{ name }}'
    - name: image_name
      value: '{{ image_name }}'
    - name: display_name
      value: '{{ display_name }}'
    - name: iam_role_arn
      value: '{{ iam_role_arn }}'
    - name: instance_type
      value: '{{ instance_type }}'
    - name: tags
      value:
        - value: '{{ value }}'
          key: '{{ key }}'
    - name: image_arn
      value: '{{ image_arn }}'
    - name: access_endpoints
      value:
        - endpoint_type: '{{ endpoint_type }}'
          vpce_id: '{{ vpce_id }}'

DELETE example

/*+ delete */
DELETE FROM awscc.appstream.image_builders
WHERE
  Identifier = '{{ name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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