service_sync_configs

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

Overview

Name	service_sync_configs
Type	Resource
Id	aws.proton.service_sync_configs

Fields

The following fields are returned by SELECT queries:

get_service_sync_config

Name	Datatype	Description
branch	string	The name of the code repository branch that holds the service code Proton will sync with.
file_path	string	The file path to the service sync configuration file.
repository_name	string	The name of the code repository that holds the service code Proton will sync with. (pattern: <code>[A-Za-z0-9_.-]./[A-Za-z0-9_.-].</code>)
repository_provider	string	The name of the repository provider that holds the repository Proton will sync with. (GITHUB, GITHUB_ENTERPRISE, BITBUCKET)
service_name	string	The name of the service that the service instance is added to. (pattern: <code>^[0-9A-Za-z]+[0-9A-Za-z_-]*$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_service_sync_config	select	region		Get detailed information for the service sync configuration.
create_service_sync_config	insert	region, branch, filePath, repositoryName, repositoryProvider, serviceName		Create the Proton Ops configuration file.
update_service_sync_config	update	region, branch, filePath, repositoryName, repositoryProvider, serviceName		Update the Proton Ops config file.
delete_service_sync_config	delete	region		Delete the Proton Ops file.

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_service_sync_config

Get detailed information for the service sync configuration.

SELECT
branch,
file_path,
repository_name,
repository_provider,
service_name
FROM aws.proton.service_sync_configs
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_service_sync_config

Create the Proton Ops configuration file.

INSERT INTO aws.proton.service_sync_configs (
branch,
filePath,
repositoryName,
repositoryProvider,
serviceName,
region
)
SELECT 
'{{ branch }}' /* required */,
'{{ filePath }}' /* required */,
'{{ repositoryName }}' /* required */,
'{{ repositoryProvider }}' /* required */,
'{{ serviceName }}' /* required */,
'{{ region }}'
RETURNING
service_sync_config
;

Manifest

# Description fields are for documentation purposes
- name: service_sync_configs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the service_sync_configs resource.
  - name: branch
    value: "{{ branch }}"
    description: |
      The repository branch for your Proton Ops file.
  - name: filePath
    value: "{{ filePath }}"
    description: |
      The path to the Proton Ops file.
  - name: repositoryName
    value: "{{ repositoryName }}"
    description: |
      The repository name.
  - name: repositoryProvider
    value: "{{ repositoryProvider }}"
    description: |
      The provider type for your repository.
    valid_values: ['GITHUB', 'GITHUB_ENTERPRISE', 'BITBUCKET']
  - name: serviceName
    value: "{{ serviceName }}"
    description: |
      The name of the service the Proton Ops file is for.

UPDATE examples

update_service_sync_config

Update the Proton Ops config file.

UPDATE aws.proton.service_sync_configs
SET 
branch = '{{ branch }}',
filePath = '{{ filePath }}',
repositoryName = '{{ repositoryName }}',
repositoryProvider = '{{ repositoryProvider }}',
serviceName = '{{ serviceName }}'
WHERE 
region = '{{ region }}' --required
AND branch = '{{ branch }}' --required
AND filePath = '{{ filePath }}' --required
AND repositoryName = '{{ repositoryName }}' --required
AND repositoryProvider = '{{ repositoryProvider }}' --required
AND serviceName = '{{ serviceName }}' --required
RETURNING
service_sync_config;

DELETE examples

delete_service_sync_config

Delete the Proton Ops file.

DELETE FROM aws.proton.service_sync_configs
WHERE region = '{{ region }}' --required
;