workspace_bundles

Creates, updates, deletes, gets or lists a workspace_bundles resource.

Overview

Name	workspace_bundles
Type	Resource
Id	aws.workspaces.workspace_bundles

Fields

The following fields are returned by SELECT queries:

describe_workspace_bundles

Name	Datatype	Description
bundle_id	string	The identifier of the bundle. (pattern: <code>^wsb-[0-9a-z]{8,63}$</code>)
bundle_type	string	The type of WorkSpace bundle. (REGULAR, STANDBY)
compute_type	object	Describes the compute type of the bundle.
creation_time	string (date-time)	The time when the bundle was created.
description	string	The description of the bundle.
image_id	string	The identifier of the image that was used to create the bundle. (pattern: <code>wsi-[0-9a-z]{9,63}$</code>)
last_updated_time	string (date-time)	The last time that the bundle was updated.
name	string	The name of the bundle.
owner	string	The owner of the bundle. This is the account identifier of the owner, or AMAZON if the bundle is provided by Amazon Web Services.
root_storage	object	Describes the root volume for a WorkSpace bundle.
state	string	The state of the WorkSpace bundle. (AVAILABLE, PENDING, ERROR)
user_storage	object	Describes the user volume for a WorkSpace bundle.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_workspace_bundles	select	region		Retrieves a list that describes the available WorkSpace bundles. You can filter the results using either bundle ID or owner, but not both.
create_workspace_bundle	insert	region, BundleName, BundleDescription, ImageId, ComputeType, UserStorage		Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle.
update_workspace_bundle	update	region		Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom WorkSpaces Bundle. Existing WorkSpaces aren't automatically updated when you update the bundle that they're based on. To update existing WorkSpaces that are based on a bundle that you've updated, you must either rebuild the WorkSpaces or delete and recreate them.
delete_workspace_bundle	delete	region		Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image.

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_workspace_bundles

Retrieves a list that describes the available WorkSpace bundles. You can filter the results using either bundle ID or owner, but not both.

SELECT
bundle_id,
bundle_type,
compute_type,
creation_time,
description,
image_id,
last_updated_time,
name,
owner,
root_storage,
state,
user_storage
FROM aws.workspaces.workspace_bundles
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_workspace_bundle

Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle.

INSERT INTO aws.workspaces.workspace_bundles (
BundleName,
BundleDescription,
ImageId,
ComputeType,
UserStorage,
RootStorage,
Tags,
region
)
SELECT 
'{{ BundleName }}' /* required */,
'{{ BundleDescription }}' /* required */,
'{{ ImageId }}' /* required */,
'{{ ComputeType }}' /* required */,
'{{ UserStorage }}' /* required */,
'{{ RootStorage }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
workspace_bundle
;

Manifest

# Description fields are for documentation purposes
- name: workspace_bundles
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the workspace_bundles resource.
  - name: BundleName
    value: "{{ BundleName }}"
    description: |
      The name of the bundle.
  - name: BundleDescription
    value: "{{ BundleDescription }}"
    description: |
      The description of the bundle.
  - name: ImageId
    value: "{{ ImageId }}"
    description: |
      The identifier of the image that is used to create the bundle.
  - name: ComputeType
    description: |
      Describes the compute type of the bundle.
    value:
      Name: "{{ Name }}"
  - name: UserStorage
    description: |
      Describes the user volume for a WorkSpace bundle.
    value:
      Capacity: "{{ Capacity }}"
  - name: RootStorage
    description: |
      Describes the root volume for a WorkSpace bundle.
    value:
      Capacity: "{{ Capacity }}"
  - name: Tags
    description: |
      The tags associated with the bundle. To add tags at the same time when you're creating the bundle, you must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_workspace_bundle

Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom WorkSpaces Bundle. Existing WorkSpaces aren't automatically updated when you update the bundle that they're based on. To update existing WorkSpaces that are based on a bundle that you've updated, you must either rebuild the WorkSpaces or delete and recreate them.

UPDATE aws.workspaces.workspace_bundles
SET 
BundleId = '{{ BundleId }}',
ImageId = '{{ ImageId }}'
WHERE 
region = '{{ region }}' --required;

DELETE examples

delete_workspace_bundle

Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image.

DELETE FROM aws.workspaces.workspace_bundles
WHERE region = '{{ region }}' --required
;