[ aws . proton ]

create-service-template

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-service-template
[--description <value>]
[--display-name <value>]
[--encryption-key <value>]
--name <value>
[--pipeline-provisioning <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--description (string)

A description of the service template.

--display-name (string)

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

--encryption-key (string)

A customer provided encryption key that’s used to encrypt data.

--name (string)

The name of the service template.

--pipeline-provisioning (string)

AWS Proton includes a service pipeline for your service by default. When included, this parameter indicates that an AWS Proton service pipeline won’t be included for your service. Once specified, this parameter can’t be changed. For more information, see Service template bundles in the AWS Proton Administrator Guide .

Possible values:

  • CUSTOMER_MANAGED

--tags (list)

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

(structure)

A description of a resource tag.

key -> (string)

The key of the resource tag.

value -> (string)

The value of the resource tag.

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

serviceTemplate -> (structure)

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

arn -> (string)

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

createdAt -> (timestamp)

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 -> (timestamp)

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 ID of the recommended version of the service template.