app_blocks

Creates, updates, deletes, gets or lists an app_blocks resource.

Overview

Name	app_blocks
Type	Resource
Id	aws.appstream.app_blocks

Fields

The following fields are returned by SELECT queries:

describe_app_blocks

Name	Datatype	Description
app_blocks	array	The app blocks in the list.
next_token	string	The pagination token used to retrieve the next page of results for this operation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_app_blocks	select	region		Retrieves a list that describes one or more app blocks.
create_app_block	insert	region, Name, SourceS3Location		Creates an app block. App blocks are a WorkSpaces Applications resource that stores the details about the virtual hard disk in an S3 bucket. It also stores the setup script with details about how to mount the virtual hard disk. The virtual hard disk includes the application binaries and other files necessary to launch your applications. Multiple applications can be assigned to a single app block. This is only supported for Elastic fleets.
associate_app_block_builder_app_block	update	region, AppBlockArn, AppBlockBuilderName		Associates the specified app block builder with the specified app block.
delete_app_block	delete	region		Deletes an app block.
disassociate_app_block_builder_app_block	exec	region, AppBlockArn, AppBlockBuilderName		Disassociates a specified app block builder from a specified app block.
start_app_block_builder	exec	region, Name		Starts an app block builder. An app block builder can only be started when it's associated with an app block. Starting an app block builder starts a new instance, which is equivalent to an elastic fleet instance with application builder assistance functionality.
stop_app_block_builder	exec	region, Name		Stops an app block builder. Stopping an app block builder terminates the instance, and the instance state is not persisted.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_app_blocks

Retrieves a list that describes one or more app blocks.

SELECT
app_blocks,
next_token
FROM aws.appstream.app_blocks
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_app_block

Creates an app block. App blocks are a WorkSpaces Applications resource that stores the details about the virtual hard disk in an S3 bucket. It also stores the setup script with details about how to mount the virtual hard disk. The virtual hard disk includes the application binaries and other files necessary to launch your applications. Multiple applications can be assigned to a single app block. This is only supported for Elastic fleets.

INSERT INTO aws.appstream.app_blocks (
Name,
Description,
DisplayName,
SourceS3Location,
SetupScriptDetails,
Tags,
PostSetupScriptDetails,
PackagingType,
region
)
SELECT 
'{{ Name }}' /* required */,
'{{ Description }}',
'{{ DisplayName }}',
'{{ SourceS3Location }}' /* required */,
'{{ SetupScriptDetails }}',
'{{ Tags }}',
'{{ PostSetupScriptDetails }}',
'{{ PackagingType }}',
'{{ region }}'
RETURNING
app_block
;

Manifest

# Description fields are for documentation purposes
- name: app_blocks
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the app_blocks resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      The name of the app block.
  - name: Description
    value: "{{ Description }}"
    description: |
      The description of the app block.
  - name: DisplayName
    value: "{{ DisplayName }}"
    description: |
      The display name of the app block. This is not displayed to the user.
  - name: SourceS3Location
    description: |
      The source S3 location of the app block.
    value:
      S3Bucket: "{{ S3Bucket }}"
      S3Key: "{{ S3Key }}"
  - name: SetupScriptDetails
    description: |
      The setup script details of the app block. This must be provided for the CUSTOM PackagingType.
    value:
      ScriptS3Location:
        S3Bucket: "{{ S3Bucket }}"
        S3Key: "{{ S3Key }}"
      ExecutablePath: "{{ ExecutablePath }}"
      ExecutableParameters: "{{ ExecutableParameters }}"
      TimeoutInSeconds: {{ TimeoutInSeconds }}
  - name: Tags
    value: "{{ Tags }}"
    description: |
      The tags assigned to the app block.
  - name: PostSetupScriptDetails
    description: |
      The post setup script details of the app block. This can only be provided for the APPSTREAM2 PackagingType.
    value:
      ScriptS3Location:
        S3Bucket: "{{ S3Bucket }}"
        S3Key: "{{ S3Key }}"
      ExecutablePath: "{{ ExecutablePath }}"
      ExecutableParameters: "{{ ExecutableParameters }}"
      TimeoutInSeconds: {{ TimeoutInSeconds }}
  - name: PackagingType
    value: "{{ PackagingType }}"
    description: |
      The packaging type of the app block.
    valid_values: ['CUSTOM', 'APPSTREAM2']

UPDATE examples

associate_app_block_builder_app_block

Associates the specified app block builder with the specified app block.

UPDATE aws.appstream.app_blocks
SET 
AppBlockArn = '{{ AppBlockArn }}',
AppBlockBuilderName = '{{ AppBlockBuilderName }}'
WHERE 
region = '{{ region }}' --required
AND AppBlockArn = '{{ AppBlockArn }}' --required
AND AppBlockBuilderName = '{{ AppBlockBuilderName }}' --required
RETURNING
app_block_builder_app_block_association;

DELETE examples

delete_app_block

Deletes an app block.

DELETE FROM aws.appstream.app_blocks
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

disassociate_app_block_builder_app_block

Disassociates a specified app block builder from a specified app block.

EXEC aws.appstream.app_blocks.disassociate_app_block_builder_app_block 
@region='{{ region }}' --required 
@@json=
'{
"AppBlockArn": "{{ AppBlockArn }}", 
"AppBlockBuilderName": "{{ AppBlockBuilderName }}"
}'
;

start_app_block_builder

Starts an app block builder. An app block builder can only be started when it's associated with an app block. Starting an app block builder starts a new instance, which is equivalent to an elastic fleet instance with application builder assistance functionality.

EXEC aws.appstream.app_blocks.start_app_block_builder 
@region='{{ region }}' --required 
@@json=
'{
"Name": "{{ Name }}"
}'
;

stop_app_block_builder

Stops an app block builder. Stopping an app block builder terminates the instance, and the instance state is not persisted.

EXEC aws.appstream.app_blocks.stop_app_block_builder 
@region='{{ region }}' --required 
@@json=
'{
"Name": "{{ Name }}"
}'
;