Getting started workflow - AWS Proton

Getting started workflow

Learn to create template bundles, create and register templates, and create environments and services by following the example steps and links.

Before starting, verify that you created an AWS Proton service role.

If your service template includes an AWS Proton service pipeline, verify that you created an AWS CodeStar connection and a AWS Proton pipeline service role.

For more information, see The AWS Proton service API Reference.

Example: Getting started workflow
  1. Refer to the diagram in How AWS Proton works for a high-level view of AWS Proton inputs and outputs.

  2. Create an environment bundle and a service template bundle.

    1. Identify input parameters.

    2. Create a schema file.

    3. Create infrastructure as code (IaC) files.

    4. To wrap up your template bundle, create a manifest file and organize your IaC files, manifest files, and schema file in directories.

    5. Make your template bundle accessible to AWS Proton.

  3. Create and register an environment template version with AWS Proton.

    When you use the console to create and register a template, a template version is automatically created.

    When you use the AWS CLI to create and register a template:

    1. Create an environment template.

    2. Create an environment template version.

    For more information, see CreateEnvironmentTemplate and CreateEnvironmentTemplateVersion in the AWS Proton API reference.

  4. Publish your environment template to make it available for use.

    For more information, see UpdateEnvironmentTemplateVersion in the AWS Proton API reference.

  5. To create an environment, select a published environment template version and provide values for required inputs.

    For more information, see CreateEnvironment in the AWS Proton API reference.

  6. Create and register a service template version with AWS Proton.

    When you use the console to create and register a template, a template version is automatically created.

    When you use the AWS CLI to create and register a template:

    1. Create a service template.

    2. Create a service template version.

    For more information, see CreateServiceTemplate and CreateServiceTemplateVersion in the AWS Proton API reference.

  7. Publish your service template to make it available for use.

    For more information, see UpdateServiceTemplateVersion in the AWS Proton API reference.

  8. To create a service, select a published service template version and provide values for required inputs.

    For more information, see CreateService in the AWS Proton API reference.