app_block_builders

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

Overview

Name	app_block_builders
Type	Resource
Id	aws.appstream.app_block_builders

Fields

The following fields are returned by SELECT queries:

describe_app_block_builders

Name	Datatype	Description
app_block_builders	array	The list that describes one or more app block builders.
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_block_builders	select	region		Retrieves a list that describes one or more app block builders.
create_app_block_builder	insert	region, Name, Platform, InstanceType, VpcConfig		Creates an app block builder.
create_app_block_builder_streaming_url	insert	region, AppBlockBuilderName		Creates a URL to start a create app block builder streaming session.
update_app_block_builder	update	region, Name		Updates an app block builder. If the app block builder is in the STARTING or STOPPING state, you can't update it. If the app block builder is in the RUNNING state, you can only update the DisplayName and Description. If the app block builder is in the STOPPED state, you can update any attribute except the Name.
delete_app_block_builder	delete	region		Deletes an app block builder. An app block builder can only be deleted when it has no association with an app block.

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_block_builders

Retrieves a list that describes one or more app block builders.

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

INSERT examples

create_app_block_builder

Creates an app block builder.

INSERT INTO aws.appstream.app_block_builders (
Name,
Description,
DisplayName,
Tags,
Platform,
InstanceType,
VpcConfig,
EnableDefaultInternetAccess,
IamRoleArn,
AccessEndpoints,
DisableIMDSV1,
region
)
SELECT 
'{{ Name }}' /* required */,
'{{ Description }}',
'{{ DisplayName }}',
'{{ Tags }}',
'{{ Platform }}' /* required */,
'{{ InstanceType }}' /* required */,
'{{ VpcConfig }}' /* required */,
{{ EnableDefaultInternetAccess }},
'{{ IamRoleArn }}',
'{{ AccessEndpoints }}',
{{ DisableIMDSV1 }},
'{{ region }}'
RETURNING
app_block_builder
;

create_app_block_builder_streaming_url

Creates a URL to start a create app block builder streaming session.

INSERT INTO aws.appstream.app_block_builders (
AppBlockBuilderName,
Validity,
region
)
SELECT 
'{{ AppBlockBuilderName }}' /* required */,
{{ Validity }},
'{{ region }}'
RETURNING
expires,
streaming_url
;

Manifest

# Description fields are for documentation purposes
- name: app_block_builders
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the app_block_builders resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      The unique name for the app block builder.
  - name: Description
    value: "{{ Description }}"
    description: |
      The description of the app block builder.
  - name: DisplayName
    value: "{{ DisplayName }}"
    description: |
      The display name of the app block builder.
  - name: Tags
    value: "{{ Tags }}"
    description: |
      The tags to associate with the app block builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. If you do not specify a value, the value is set to an empty string. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: _ . : / = +  - @ For more information, see Tagging Your Resources in the Amazon WorkSpaces Applications Administration Guide.
  - name: Platform
    value: "{{ Platform }}"
    description: |
      The platform of the app block builder. WINDOWS_SERVER_2019 is the only valid value.
    valid_values: ['WINDOWS_SERVER_2019']
  - name: InstanceType
    value: "{{ InstanceType }}"
    description: |
      The instance type to use when launching the app block builder. The following instance types are available: stream.standard.small stream.standard.medium stream.standard.large stream.standard.xlarge stream.standard.2xlarge
  - name: VpcConfig
    description: |
      The VPC configuration for the app block builder. App block builders require that you specify at least two subnets in different availability zones.
    value:
      SubnetIds:
        - "{{ SubnetIds }}"
      SecurityGroupIds:
        - "{{ SecurityGroupIds }}"
  - name: EnableDefaultInternetAccess
    value: {{ EnableDefaultInternetAccess }}
    description: |
      Enables or disables default internet access for the app block builder.
  - name: IamRoleArn
    value: "{{ IamRoleArn }}"
    description: |
      The Amazon Resource Name (ARN) of the IAM role to apply to the app block builder. To assume a role, the app block builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. WorkSpaces Applications retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance. For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on WorkSpaces Applications Streaming Instances in the Amazon WorkSpaces Applications Administration Guide.
  - name: AccessEndpoints
    description: |
      The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block builder only through the specified endpoints.
    value:
      - EndpointType: "{{ EndpointType }}"
        VpceId: "{{ VpceId }}"
  - name: DisableIMDSV1
    value: {{ DisableIMDSV1 }}
    description: |
      Set to true to disable Instance Metadata Service Version 1 (IMDSv1) and enforce IMDSv2. Set to false to enable both IMDSv1 and IMDSv2.
  - name: AppBlockBuilderName
    value: "{{ AppBlockBuilderName }}"
    description: |
      The name of the app block builder.
  - name: Validity
    value: {{ Validity }}
    description: |
      The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 3600 seconds.

UPDATE examples

update_app_block_builder

Updates an app block builder. If the app block builder is in the STARTING or STOPPING state, you can't update it. If the app block builder is in the RUNNING state, you can only update the DisplayName and Description. If the app block builder is in the STOPPED state, you can update any attribute except the Name.

UPDATE aws.appstream.app_block_builders
SET 
Name = '{{ Name }}',
Description = '{{ Description }}',
DisplayName = '{{ DisplayName }}',
Platform = '{{ Platform }}',
InstanceType = '{{ InstanceType }}',
VpcConfig = '{{ VpcConfig }}',
EnableDefaultInternetAccess = {{ EnableDefaultInternetAccess }},
IamRoleArn = '{{ IamRoleArn }}',
AccessEndpoints = '{{ AccessEndpoints }}',
AttributesToDelete = '{{ AttributesToDelete }}',
DisableIMDSV1 = {{ DisableIMDSV1 }}
WHERE 
region = '{{ region }}' --required
AND Name = '{{ Name }}' --required
RETURNING
app_block_builder;

DELETE examples

delete_app_block_builder

Deletes an app block builder. An app block builder can only be deleted when it has no association with an app block.

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