Proton / Client / create_template_sync_config

create_template_sync_config#

Proton.Client.create_template_sync_config(**kwargs)#

Set up a template to create new template versions automatically by tracking a linked repository. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.

When a commit is pushed to your linked repository, 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 Proton User Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_template_sync_config(
    branch='string',
    repositoryName='string',
    repositoryProvider='GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
    subdirectory='string',
    templateName='string',
    templateType='ENVIRONMENT'|'SERVICE'
)
Parameters:

  • branch (string) –

    [REQUIRED]

    The repository branch for your template.

  • repositoryName (string) –

    [REQUIRED]

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

  • repositoryProvider (string) –

    [REQUIRED]

    The provider type for your repository.

  • subdirectory (string) – A repository subdirectory path to your template bundle directory. When included, Proton limits the template bundle search to this repository directory.

  • templateName (string) –

    [REQUIRED]

    The name of your registered template.

  • templateType (string) –

    [REQUIRED]

    The type of the registered template.

Return type:

dict

Returns:

Response Syntax

{
    'templateSyncConfig': {
        'branch': 'string',
        'repositoryName': 'string',
        'repositoryProvider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
        'subdirectory': 'string',
        'templateName': 'string',
        'templateType': 'ENVIRONMENT'|'SERVICE'
    }
}

Response Structure

  • (dict) –

    • templateSyncConfig (dict) –

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

      • branch (string) –

        The repository branch.

      • repositoryName (string) –

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

      • repositoryProvider (string) –

        The repository provider.

      • subdirectory (string) –

        A subdirectory path to your template bundle version.

      • templateName (string) –

        The template name.

      • templateType (string) –

        The template type.

Exceptions