AWS::Proton::EnvironmentTemplate - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Proton::EnvironmentTemplate

Create an environment template for AWS Proton. For more information, see Environment Templates in the AWS 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 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 Protondoesn'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 User Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Proton::EnvironmentTemplate",
  "Properties" : {
      "Description" : String,
      "DisplayName" : String,
      "EncryptionKey" : String,
      "Name" : String,
      "Provisioning" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Proton::EnvironmentTemplate
Properties:
  Description: String
  DisplayName: String
  EncryptionKey: String
  Name: String
  Provisioning: String
  Tags: 
    - Tag

Properties

Description

A description of the environment template.

Required: No

Type: String

Minimum: 0

Maximum: 500

Update requires: No interruption

DisplayName

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

Required: No

Type: String

Minimum: 1

Maximum: 100

Update requires: No interruption

EncryptionKey

The customer provided encryption key for the environment template.

Required: No

Type: String

Pattern: ^arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\d{12}:([\w+=,.@-]+[/:])*[\w+=,.@-]+$

Minimum: 1

Maximum: 200

Update requires: Replacement

Name

The name of the environment template.

Required: No

Type: String

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

Minimum: 1

Maximum: 100

Update requires: Replacement

Provisioning

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

Required: No

Type: String

Allowed values: CUSTOMER_MANAGED

Update requires: Replacement

Tags

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

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

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 50

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the environment template.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

Returns the ARN of the environment template.