test_grid_projects

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

Overview

Name	test_grid_projects
Type	Resource
Id	aws.devicefarm.test_grid_projects

Fields

The following fields are returned by SELECT queries:

get_test_grid_project

Name	Datatype	Description
name	string	A human-readable name for the project.
arn	string	The ARN for the project. (pattern: <code>^arn:aws:devicefarm:.+</code>)
created	string (date-time)	When the project was created.
description	string	A human-readable description for the project.
vpc_config	object	The VPC security groups and subnets that are attached to a project.

list_test_grid_projects

Name	Datatype	Description
next_token	string	Used for pagination. Pass into ListTestGridProjects to get more results in a paginated request.
test_grid_projects	array	The list of TestGridProjects, based on a ListTestGridProjectsRequest.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_test_grid_project	select	region		Retrieves information about a Selenium testing project.
list_test_grid_projects	select	region		Gets a list of all Selenium testing projects in your account.
create_test_grid_project	insert	region, name		Creates a Selenium testing project. Projects are used to track TestGridSession instances.
update_test_grid_project	update	region, projectArn		Change details of a project.
delete_test_grid_project	delete	region		Deletes a Selenium testing project and all content generated under it. You cannot delete a project if it has active sessions. You cannot undo this operation.

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

get_test_grid_project

Retrieves information about a Selenium testing project.

SELECT
name,
arn,
created,
description,
vpc_config
FROM aws.devicefarm.test_grid_projects
WHERE region = '{{ region }}' -- required
;

list_test_grid_projects

Gets a list of all Selenium testing projects in your account.

SELECT
next_token,
test_grid_projects
FROM aws.devicefarm.test_grid_projects
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_test_grid_project

Creates a Selenium testing project. Projects are used to track TestGridSession instances.

INSERT INTO aws.devicefarm.test_grid_projects (
name,
description,
vpcConfig,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ vpcConfig }}',
'{{ region }}'
RETURNING
test_grid_project
;

Manifest

# Description fields are for documentation purposes
- name: test_grid_projects
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the test_grid_projects resource.
  - name: name
    value: "{{ name }}"
    description: |
      Human-readable name of the Selenium testing project.
  - name: description
    value: "{{ description }}"
    description: |
      Human-readable description of the project.
  - name: vpcConfig
    description: |
      The VPC security groups and subnets that are attached to a project.
    value:
      securityGroupIds:
        - "{{ securityGroupIds }}"
      subnetIds:
        - "{{ subnetIds }}"
      vpcId: "{{ vpcId }}"

UPDATE examples

update_test_grid_project

Change details of a project.

UPDATE aws.devicefarm.test_grid_projects
SET 
projectArn = '{{ projectArn }}',
name = '{{ name }}',
description = '{{ description }}',
vpcConfig = '{{ vpcConfig }}'
WHERE 
region = '{{ region }}' --required
AND projectArn = '{{ projectArn }}' --required
RETURNING
test_grid_project;

DELETE examples

delete_test_grid_project

Deletes a Selenium testing project and all content generated under it. You cannot delete a project if it has active sessions. You cannot undo this operation.

DELETE FROM aws.devicefarm.test_grid_projects
WHERE region = '{{ region }}' --required
;