Proton / Client / create_service_template

create_service_template#

Proton.Client.create_service_template(**kwargs)#

Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CI/CD service pipeline. Developers, in turn, select the service template from Proton. If the selected service template includes a service pipeline definition, they provide a link to their source code repository. Proton then deploys and manages the infrastructure defined by the selected service template. For more information, see Proton templates in the Proton User Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_service_template(
    description='string',
    displayName='string',
    encryptionKey='string',
    name='string',
    pipelineProvisioning='CUSTOMER_MANAGED',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)
Parameters:

  • description (string) – A description of the service template.

  • displayName (string) – The name of the service template as displayed in the developer interface.

  • encryptionKey (string) – A customer provided encryption key that’s used to encrypt data.

  • name (string) –

    [REQUIRED]

    The name of the service template.

  • pipelineProvisioning (string) – By default, Proton provides a service pipeline for your service. When this parameter is included, it indicates that an Proton service pipeline isn’t provided for your service. After it’s included, it can’t be changed. For more information, see Template bundles in the Proton User Guide.

  • tags (list) –

    An optional list of metadata items that you can associate with the Proton service template. A tag is a key-value pair.

    For more information, see Proton resources and tagging in the Proton User Guide.

    • (dict) –

      A description of a resource tag.

      • key (string) – [REQUIRED]

        The key of the resource tag.

      • value (string) – [REQUIRED]

        The value of the resource tag.

Return type:

dict

Returns:

Response Syntax

{
    'serviceTemplate': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'displayName': 'string',
        'encryptionKey': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'name': 'string',
        'pipelineProvisioning': 'CUSTOMER_MANAGED',
        'recommendedVersion': 'string'
    }
}

Response Structure

  • (dict) –

    • serviceTemplate (dict) –

      The service template detail data that’s returned by Proton.

      • arn (string) –

        The Amazon Resource Name (ARN) of the service template.

      • createdAt (datetime) –

        The time when the service template was created.

      • description (string) –

        A description of the service template.

      • displayName (string) –

        The service template name as displayed in the developer interface.

      • encryptionKey (string) –

        The customer provided service template encryption key that’s used to encrypt data.

      • lastModifiedAt (datetime) –

        The time when the service template was last modified.

      • name (string) –

        The name of the service template.

      • pipelineProvisioning (string) –

        If pipelineProvisioning is true, a service pipeline is included in the service template. Otherwise, a service pipeline isn’t included in the service template.

      • recommendedVersion (string) –

        The recommended version of the service template.

Exceptions