CreateTemplateSyncConfig - AWS Proton

CreateTemplateSyncConfig

Set up a template to create new template versions automatically. When a commit is pushed to your registered repository, AWS Proton checks for changes to your repository template bundles. If it detects a template bundle change, a new major or minor version of its template is created, if the version doesn’t already exist. For more information, see Template sync configurations in the AWS Proton Administrator Guide.

Request Syntax

{ "branch": "string", "repositoryName": "string", "repositoryProvider": "string", "subdirectory": "string", "templateName": "string", "templateType": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

branch

The branch of the registered repository for your template.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Required: Yes

repositoryName

The name of your repository (for example, myrepos/myrepo).

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9_.-].*/[A-Za-z0-9_.-].*

Required: Yes

repositoryProvider

The provider type for your repository.

Type: String

Valid Values: GITHUB | GITHUB_ENTERPRISE | BITBUCKET

Required: Yes

subdirectory

A repository subdirectory path to your template bundle directory. When included, AWS Proton limits the template bundle search to this repository directory.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

Required: No

templateName

The name of your registered template.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$

Required: Yes

templateType

The type of the registered template.

Type: String

Valid Values: ENVIRONMENT | SERVICE

Required: Yes

Response Syntax

{ "templateSyncConfig": { "branch": "string", "repositoryName": "string", "repositoryProvider": "string", "subdirectory": "string", "templateName": "string", "templateType": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

templateSyncConfig

The template sync configuration detail data that's returned by AWS Proton.

Type: TemplateSyncConfig object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

There isn't sufficient access for performing this action.

HTTP Status Code: 400

ConflictException

The request couldn't be made due to a conflicting operation or resource.

HTTP Status Code: 400

InternalServerException

The request failed to register with the service.

HTTP Status Code: 500

ServiceQuotaExceededException

A quota was exceeded. For more information, see AWS Proton Quotas in the AWS Proton Administrator Guide.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input is invalid or an out-of-range value was supplied for the input parameter.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: