test_cases

Creates, updates, deletes or gets a test_case resource or lists test_cases in a region

Overview

Name	test_cases
Type	Resource
Description	Represents a Test Case that can be captured and executed
Id	awscc.apptest.test_cases

Fields

get (all properties)

Name	Datatype	Description
creation_time	string
description	string
last_update_time	string
▶latest_version	object
name	string
status	string
▶steps	array
tags	object
test_case_arn	string
test_case_id	string
test_case_version	number
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
test_case_id	string
region	string	AWS region.

For more information, see AWS::AppTest::TestCase.

Methods

Name	Resource	Accessible by	Required Params
create_resource	test_cases	INSERT	Name, Steps, region
delete_resource	test_cases	DELETE	Identifier, region
update_resource	test_cases	UPDATE	Identifier, PatchDocument, region
list_resources	test_cases_list_only	SELECT	region
get_resource	test_cases	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual test_case.

SELECT
  region,
  creation_time,
  description,
  last_update_time,
  latest_version,
  name,
  status,
  steps,
  tags,
  test_case_arn,
  test_case_id,
  test_case_version
FROM awscc.apptest.test_cases
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ test_case_id }}';

list (identifiers only)

Lists all test_cases in a region.

SELECT
  region,
  test_case_id
FROM awscc.apptest.test_cases_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.apptest.test_cases (
  Name,
  Steps,
  region
)
SELECT
  '{{ name }}',
  '{{ steps }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.apptest.test_cases (
  Description,
  Name,
  Steps,
  Tags,
  region
)
SELECT
  '{{ description }}',
  '{{ name }}',
  '{{ steps }}',
  '{{ 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: test_case
  props:
    - name: description
      value: '{{ description }}'
    - name: name
      value: '{{ name }}'
    - name: steps
      value:
        - name: '{{ name }}'
          description: '{{ description }}'
          action: null
    - name: tags
      value: {}

UPDATE example

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

/*+ update */
UPDATE awscc.apptest.test_cases
SET PatchDocument = string('{{ {
    "Description": description,
    "Steps": steps,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ test_case_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

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

Create

apptest:CreateTestCase,
apptest:GetTestCase,
apptest:ListTagsForResource

Read

apptest:GetTestCase,
apptest:ListTagsForResource

Update

apptest:UpdateTestCase,
apptest:GetTestCase,
apptest:TagResource,
apptest:UnTagResource,
apptest:ListTagsForResource

Delete

apptest:GetTestCase,
apptest:ListTagsForResource,
apptest:DeleteTestCase

List

apptest:ListTestCases