source_repositories

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

Overview

Name	source_repositories
Type	Resource
Id	aws.codecatalyst.source_repositories

Fields

The following fields are returned by SELECT queries:

get_source_repository

Name	Datatype	Description
name	string	The name of the source repository. (pattern: <code>(?!.[.]git$)[\w-.]</code>)
created_time	string (date-time)	The time the source repository was created, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
description	string	The description of the source repository.
last_updated_time	string (date-time)	The time the source repository was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
project_name	string	The name of the project in the space. (pattern: <code>[a-zA-Z0-9]+(?:[-_.][a-zA-Z0-9]+)*</code>)
space_name	string	The name of the space. (pattern: <code>[a-zA-Z0-9]+(?:[-_.][a-zA-Z0-9]+)*</code>)

list_source_repositories

Name	Datatype	Description
id	string	The system-generated unique ID of the source repository. (pattern: <code>[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}</code>)
name	string	The name of the source repository. (pattern: <code>(?!.[.]git$)[\w-.]</code>)
created_time	string (date-time)	The time the source repository was created, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.
description	string	The description of the repository, if any.
last_updated_time	string (date-time)	The time the source repository was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_source_repository	select	space_name, project_name, name, region		Returns information about a source repository.
list_source_repositories	select	space_name, project_name, region		Retrieves a list of source repositories in a project.
create_source_repository	insert	space_name, project_name, name, region		Creates an empty Git-based source repository in a specified project. The repository is created with an initial empty commit with a default branch named main.
delete_source_repository	delete	space_name, project_name, name, region		Deletes a source repository in Amazon CodeCatalyst. You cannot use this API to delete a linked repository. It can only be used to delete a Amazon CodeCatalyst source repository.

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
name	string	The name of the source repository.
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_source_repository

Returns information about a source repository.

SELECT
name,
created_time,
description,
last_updated_time,
project_name,
space_name
FROM aws.codecatalyst.source_repositories
WHERE space_name = '{{ space_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
;

list_source_repositories

Retrieves a list of source repositories in a project.

SELECT
id,
name,
created_time,
description,
last_updated_time
FROM aws.codecatalyst.source_repositories
WHERE space_name = '{{ space_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_source_repository

Creates an empty Git-based source repository in a specified project. The repository is created with an initial empty commit with a default branch named main.

INSERT INTO aws.codecatalyst.source_repositories (
description,
space_name,
project_name,
name,
region
)
SELECT 
'{{ description }}',
'{{ space_name }}',
'{{ project_name }}',
'{{ name }}',
'{{ region }}'
RETURNING
name,
description,
project_name,
space_name
;

Manifest

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

DELETE examples

delete_source_repository

Deletes a source repository in Amazon CodeCatalyst. You cannot use this API to delete a linked repository. It can only be used to delete a Amazon CodeCatalyst source repository.

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