AWS::Proton::ServiceTemplate - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Proton::ServiceTemplate

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 Amazon Proton. If the selected service template includes a service pipeline definition, they provide a link to their source code repository. Amazon Proton then deploys and manages the infrastructure defined by the selected service template. For more information, see Amazon Proton templates in the Amazon Proton User Guide.

Syntax

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

JSON

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

YAML

Type: AWS::Proton::ServiceTemplate
Properties:
  Description: String
  DisplayName: String
  EncryptionKey: String
  Name: String
  PipelineProvisioning: String
  Tags: 
    - Tag

Properties

Description

A description of the service template.

Required: No

Type: String

Minimum: 0

Maximum: 500

Update requires: No interruption

DisplayName

The service template name as displayed in the developer interface.

Required: No

Type: String

Minimum: 1

Maximum: 100

Update requires: No interruption

EncryptionKey

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

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 service template.

Required: No

Type: String

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

Minimum: 1

Maximum: 100

Update requires: Replacement

PipelineProvisioning

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

Required: No

Type: String

Allowed values: CUSTOMER_MANAGED

Update requires: Replacement

Tags

An object that includes the template bundle S3 bucket path and name for the new version of a service template.

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 service 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 service template ARN.