app_blocks

Creates, updates, deletes or gets an app_block resource or lists app_blocks in a region

Overview

Name	app_blocks
Type	Resource
Description	Resource Type definition for AWS::AppStream::AppBlock
Id	awscc.appstream.app_blocks

Fields

Name	Datatype	Description
name	string
arn	string
description	string
display_name	string
▶source_s3_location	object
▶setup_script_details	object
▶tags	array
created_time	string
packaging_type	string
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, SourceS3Location, region
delete_resource	DELETE	Identifier, region
update_resource	UPDATE	Identifier, PatchDocument, region
get_resource	SELECT	Identifier, region

SELECT examples

Gets all properties from an individual app_block.

SELECT
  region,
  name,
  arn,
  description,
  display_name,
  source_s3_location,
  setup_script_details,
  tags,
  created_time,
  packaging_type,
  post_setup_script_details
FROM awscc.appstream.app_blocks
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.appstream.app_blocks (
  Name,
  SourceS3Location,
  region
)
SELECT
  '{{ name }}',
  '{{ source_s3_location }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.appstream.app_blocks (
  Name,
  Description,
  DisplayName,
  SourceS3Location,
  SetupScriptDetails,
  Tags,
  PackagingType,
  PostSetupScriptDetails,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ display_name }}',
  '{{ source_s3_location }}',
  '{{ setup_script_details }}',
  '{{ tags }}',
  '{{ packaging_type }}',
  '{{ post_setup_script_details }}',
  '{{ 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: app_block
  props:
    - name: name
      value: '{{ name }}'
    - name: description
      value: '{{ description }}'
    - name: display_name
      value: '{{ display_name }}'
    - name: source_s3_location
      value:
        s3_bucket: '{{ s3_bucket }}'
        s3_key: '{{ s3_key }}'
    - name: setup_script_details
      value:
        script_s3_location: null
        executable_path: '{{ executable_path }}'
        executable_parameters: '{{ executable_parameters }}'
        timeout_in_seconds: '{{ timeout_in_seconds }}'
    - name: tags
      value:
        - value: '{{ value }}'
          key: '{{ key }}'
    - name: packaging_type
      value: '{{ packaging_type }}'
    - name: post_setup_script_details
      value: null

UPDATE example

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

/*+ update */
UPDATE awscc.appstream.app_blocks
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.appstream.app_blocks
WHERE
  Identifier = '{{ arn }}' 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 app_blocks resource, the following permissions are required:

Create

appstream:CreateAppBlock,
appstream:TagResource,
s3:GetObject,
s3:ListBucket,
s3:GetBucketOwnershipControls

Read

appstream:DescribeAppBlocks,
appstream:ListTagsForResource

Delete

appstream:DeleteAppBlock,
appstream:DescribeAppBlocks

Update

appstream:DescribeAppBlocks,
appstream:TagResource,
appstream:UntagResource