Proton / Client / create_environment_template

create_environment_template#

Proton.Client.create_environment_template(**kwargs)#

Create an environment template for Proton. For more information, see Environment Templates in the Proton User Guide.

You can create an environment template in one of the two following ways:

  • Register and publish a standard environment template that instructs Proton to deploy and manage environment infrastructure.

  • Register and publish a customer managed environment template that connects Proton to your existing provisioned infrastructure that you manage. Proton doesn’t manage your existing provisioned infrastructure. To create an environment template for customer provisioned and managed infrastructure, include the provisioning parameter and set the value to CUSTOMER_MANAGED. For more information, see Register and publish an environment template in the Proton User Guide.

See also: AWS API Documentation

Request Syntax

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

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

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

  • encryptionKey (string) – A customer provided encryption key that Proton uses to encrypt data.

  • name (string) –

    [REQUIRED]

    The name of the environment template.

  • provisioning (string) – When included, indicates that the environment template is for customer provisioned and managed infrastructure.

  • tags (list) –

    An optional list of metadata items that you can associate with the Proton environment 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

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

Response Structure

  • (dict) –

    • environmentTemplate (dict) –

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

      • arn (string) –

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

      • createdAt (datetime) –

        The time when the environment template was created.

      • description (string) –

        A description of the environment template.

      • displayName (string) –

        The name of the environment template as displayed in the developer interface.

      • encryptionKey (string) –

        The customer provided encryption key for the environment template.

      • lastModifiedAt (datetime) –

        The time when the environment template was last modified.

      • name (string) –

        The name of the environment template.

      • provisioning (string) –

        When included, indicates that the environment template is for customer provisioned and managed infrastructure.

      • recommendedVersion (string) –

        The ID of the recommended version of the environment template.

Exceptions