run_groups

Creates, updates, deletes or gets a run_group resource or lists run_groups in a region

Overview

Name	run_groups
Type	Resource
Description	Definition of AWS::Omics::RunGroup Resource Type
Id	awscc.omics.run_groups

Fields

get (all properties)

Name	Datatype	Description
arn	string
creation_time	string
id	string
max_cpus	number
max_gpus	number
max_duration	number
max_runs	number
name	string
tags	object	A map of resource tags
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string
region	string	AWS region.

For more information, see AWS::Omics::RunGroup.

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual run_group.

SELECT
  region,
  arn,
  creation_time,
  id,
  max_cpus,
  max_gpus,
  max_duration,
  max_runs,
  name,
  tags
FROM awscc.omics.run_groups
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all run_groups in a region.

SELECT
  region,
  id
FROM awscc.omics.run_groups_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.omics.run_groups (
  MaxCpus,
  MaxGpus,
  MaxDuration,
  MaxRuns,
  Name,
  Tags,
  region
)
SELECT
  '{{ max_cpus }}',
  '{{ max_gpus }}',
  '{{ max_duration }}',
  '{{ max_runs }}',
  '{{ name }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.omics.run_groups (
  MaxCpus,
  MaxGpus,
  MaxDuration,
  MaxRuns,
  Name,
  Tags,
  region
)
SELECT
  '{{ max_cpus }}',
  '{{ max_gpus }}',
  '{{ max_duration }}',
  '{{ max_runs }}',
  '{{ 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: run_group
  props:
    - name: max_cpus
      value: null
    - name: max_gpus
      value: null
    - name: max_duration
      value: null
    - name: max_runs
      value: null
    - name: name
      value: '{{ name }}'
    - name: tags
      value: {}

UPDATE example

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

/*+ update */
UPDATE awscc.omics.run_groups
SET PatchDocument = string('{{ {
    "MaxCpus": max_cpus,
    "MaxGpus": max_gpus,
    "MaxDuration": max_duration,
    "MaxRuns": max_runs,
    "Name": name,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

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

Create

omics:CreateRunGroup,
omics:TagResource

Read

omics:GetRunGroup

Update

omics:UpdateRunGroup,
omics:TagResource,
omics:GetRunGroup,
omics:ListTagsForResource,
omics:UntagResource

Delete

omics:DeleteRunGroup,
omics:GetRunGroup

List

omics:ListRunGroups