CreateEnvironmentTemplate - AWS Proton

CreateEnvironmentTemplate

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

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

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

  • Register and publish a customer managed environment template that connects AWS Proton to your existing provisioned infrastructure that you manage. AWS 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 AWS Proton Administrator Guide.

Request Syntax

{ "description": "string", "displayName": "string", "encryptionKey": "string", "name": "string", "provisioning": "string", "tags": [ { "key": "string", "value": "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.

description

A description of the environment template.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Required: No

displayName

The environment template name as displayed in the developer interface.

Type: String

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

Required: No

encryptionKey

A customer provided encryption key that AWS Proton uses to encrypt data.

Type: String

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

Required: No

name

The name of the environment template.

Type: String

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

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

Required: Yes

provisioning

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

Type: String

Valid Values: CUSTOMER_MANAGED

Required: No

tags

Create tags for your environment template. For more information, see AWS Proton resources and tagging in the AWS Proton Administrator Guide or AWS Proton User Guide.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

Response Syntax

{ "environmentTemplate": { "arn": "string", "createdAt": number, "description": "string", "displayName": "string", "encryptionKey": "string", "lastModifiedAt": number, "name": "string", "provisioning": "string", "recommendedVersion": "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.

environmentTemplate

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

Type: EnvironmentTemplate 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: