projects

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

Overview

Name	projects
Type	Resource
Id	aws.codecatalyst.projects

Fields

The following fields are returned by SELECT queries:

get_project

Name	Datatype	Description
name	string	The name of the project in the space.
description	string	The description of the project.
display_name	string	The friendly name of the project displayed to users in Amazon CodeCatalyst.
space_name	string	The name of the space. (pattern: <code>[a-zA-Z0-9]+(?:[-_.][a-zA-Z0-9]+)*</code>)

list_projects

Name	Datatype	Description
name	string	The name of the project in the space.
description	string	The description of the project.
display_name	string	The friendly name displayed to users of the project in Amazon CodeCatalyst.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_project	select	space_name, name, region		Returns information about a project.
list_projects	select	space_name, region		Retrieves a list of projects.
create_project	insert	space_name, region, displayName		Creates a project in a specified space.
update_project	update	space_name, name, region		Changes one or more values for a project.
delete_project	delete	space_name, name, region		Deletes a project in a space.
start_dev_environment	exec	space_name, project_name, id, region		Starts a specified Dev Environment and puts it into an active state.
stop_dev_environment	exec	space_name, project_name, id, region		Pauses a specified Dev Environment and places it in a non-running state. Stopped Dev Environments do not consume compute minutes.

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
id	string	The system-generated unique ID of the Dev Environment.
name	string	The name of the project in the space. To retrieve a list of project names, use ListProjects.
project_name	string	The name of the project in the space.
region	string	AWS region (default: us-east-1)
space_name	string	The name of the space.

SELECT examples

get_project

Returns information about a project.

SELECT
name,
description,
display_name,
space_name
FROM aws.codecatalyst.projects
WHERE space_name = '{{ space_name }}' -- required
AND name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
;

list_projects

Retrieves a list of projects.

SELECT
name,
description,
display_name
FROM aws.codecatalyst.projects
WHERE space_name = '{{ space_name }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_project

Creates a project in a specified space.

INSERT INTO aws.codecatalyst.projects (
displayName,
description,
space_name,
region
)
SELECT 
'{{ displayName }}' /* required */,
'{{ description }}',
'{{ space_name }}',
'{{ region }}'
RETURNING
name,
description,
display_name,
space_name
;

Manifest

# Description fields are for documentation purposes
- name: projects
props:
  - name: space_name
    value: "{{ space_name }}"
    description: Required parameter for the projects resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the projects resource.
  - name: displayName
    value: "{{ displayName }}"
  - name: description
    value: "{{ description }}"

UPDATE examples

update_project

Changes one or more values for a project.

UPDATE aws.codecatalyst.projects
SET 
description = '{{ description }}'
WHERE 
space_name = '{{ space_name }}' --required
AND name = '{{ name }}' --required
AND region = '{{ region }}' --required
RETURNING
name,
description,
display_name,
space_name;

DELETE examples

delete_project

Deletes a project in a space.

DELETE FROM aws.codecatalyst.projects
WHERE space_name = '{{ space_name }}' --required
AND name = '{{ name }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

start_dev_environment

Starts a specified Dev Environment and puts it into an active state.

EXEC aws.codecatalyst.projects.start_dev_environment 
@space_name='{{ space_name }}' --required, 
@project_name='{{ project_name }}' --required, 
@id='{{ id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"ides": "{{ ides }}", 
"instanceType": "{{ instanceType }}", 
"inactivityTimeoutMinutes": {{ inactivityTimeoutMinutes }}
}'
;

stop_dev_environment

Pauses a specified Dev Environment and places it in a non-running state. Stopped Dev Environments do not consume compute minutes.

EXEC aws.codecatalyst.projects.stop_dev_environment 
@space_name='{{ space_name }}' --required, 
@project_name='{{ project_name }}' --required, 
@id='{{ id }}' --required, 
@region='{{ region }}' --required
;