Amazon Proton · Schema

CreateServiceTemplateVersionInput

CreateServiceTemplateVersionInput schema from Amazon Proton API

DevOpsInfrastructure as CodePlatform EngineeringServerlessTemplatesSelf-ServiceCI/CD

Properties

Name Type Description
clientToken object
compatibleEnvironmentTemplates object
description object
majorVersion object
source object
supportedComponentSources object
tags object
templateName object
View JSON Schema on GitHub

JSON Schema

amazon-proton-create-service-template-version-input-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-proton/refs/heads/main/json-schema/amazon-proton-create-service-template-version-input-schema.json",
  "title": "CreateServiceTemplateVersionInput",
  "description": "CreateServiceTemplateVersionInput schema from Amazon Proton API",
  "type": "object",
  "properties": {
    "clientToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientToken"
        },
        {
          "description": "When included, if two identical requests are made with the same client token, Proton returns the service template version that the first request created."
        }
      ]
    },
    "compatibleEnvironmentTemplates": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CompatibleEnvironmentTemplateInputList"
        },
        {
          "description": "An array of environment template objects that are compatible with the new service template version. A service instance based on this service template version can run in environments based on compatible templates."
        }
      ]
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Description"
        },
        {
          "description": "A description of the new version of a service template."
        }
      ]
    },
    "majorVersion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TemplateVersionPart"
        },
        {
          "description": "<p>To create a new minor version of the service template, include a <code>major Version</code>.</p> <p>To create a new major and minor version of the service template, <i>exclude</i> <code>major Version</code>.</p>"
        }
      ]
    },
    "source": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TemplateVersionSourceInput"
        },
        {
          "description": "An object that includes the template bundle S3 bucket path and name for the new version of a service template."
        }
      ]
    },
    "supportedComponentSources": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ServiceTemplateSupportedComponentSourceInputList"
        },
        {
          "description": "<p>An array of supported component sources. Components with supported sources can be attached to service instances based on this service template version.</p> <p>For more information about components, see <a href=\"https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html\">Proton components</a> in the <i>Proton User Guide</i>.</p>"
        }
      ]
    },
    "tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagList"
        },
        {
          "description": "<p>An optional list of metadata items that you can associate with the Proton service template version. A tag is a key-value pair.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/proton/latest/userguide/resources.html\">Proton resources and tagging</a> in the <i>Proton User Guide</i>.</p>"
        }
      ]
    },
    "templateName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceName"
        },
        {
          "description": "The name of the service template."
        }
      ]
    }
  },
  "required": [
    "compatibleEnvironmentTemplates",
    "source",
    "templateName"
  ]
}