wal_workspaces

Creates, updates, deletes or gets a wal_workspace resource or lists wal_workspaces in a region

Overview

Name	wal_workspaces
Type	Resource
Description	Resource schema for AWS::EMR::WALWorkspace Type
Id	awscc.emr.wal_workspaces

Fields

get (all properties)

Name	Datatype	Description
wal_workspace_name	string	The name of the emrwal container
▶tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
wal_workspace_name	string	The name of the emrwal container
region	string	AWS region.

For more information, see AWS::EMR::WALWorkspace.

Methods

Name	Resource	Accessible by	Required Params
create_resource	wal_workspaces	INSERT	region
delete_resource	wal_workspaces	DELETE	Identifier, region
update_resource	wal_workspaces	UPDATE	Identifier, PatchDocument, region
list_resources	wal_workspaces_list_only	SELECT	region
get_resource	wal_workspaces	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual wal_workspace.

SELECT
  region,
  wal_workspace_name,
  tags
FROM awscc.emr.wal_workspaces
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ wal_workspace_name }}';

list (identifiers only)

Lists all wal_workspaces in a region.

SELECT
  region,
  wal_workspace_name
FROM awscc.emr.wal_workspaces_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.emr.wal_workspaces (
  WALWorkspaceName,
  Tags,
  region
)
SELECT
  '{{ wal_workspace_name }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.emr.wal_workspaces (
  WALWorkspaceName,
  Tags,
  region
)
SELECT
  '{{ wal_workspace_name }}',
  '{{ tags }}',
  '{{ 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: wal_workspace
  props:
    - name: wal_workspace_name
      value: '{{ wal_workspace_name }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

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

DELETE example

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

Create

emrwal:CreateWorkspace,
emrwal:TagResource,
iam:CreateServiceLinkedRole

Read

emrwal:ListTagsForResource

Delete

emrwal:DeleteWorkspace

List

emrwal:ListWorkspaces

Update

emrwal:TagResource,
emrwal:UntagResource,
emrwal:ListTagsForResource