本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

架构文件

作为管理员，当您使用 Open API 数据模型（架构）部分为模板包定义参数架构 YAML 文件时， AWS Proton 可以根据您在架构中定义的要求验证参数值输入。

有关格式和可用关键字的更多信息，请参阅 OpenAPI 的 Schema object 部分。

环境模板捆绑包的架构要求

您的架构必须遵循 OpenAPI 的 Data Models (schemas) 部分并采用 YAML 格式。它还必须是您的环境模板捆绑包的一部分。

对于您的环境架构，您必须包含设置了格式的标头，以确认您使用了 Open API 的 Data Models (schemas) 部分。在以下环境架构示例中，这些标头出现在前三行中。

必须包含 environment_input_type 并使用您提供的名称进行定义。在以下示例中，这是在第 5 行中定义的。通过定义此参数，可以将其与 AWS Proton 环境资源相关联。

要遵循 Open API 架构模型，您必须包含 types。在以下示例中，它位于第 6 行。

在 types 后面，您必须定义一个 environment_input_type 类型。您将环境的输入参数定义为 environment_input_type 的属性。您必须包含至少一个属性，其名称至少与架构的关联环境基础设施即代码 (IaC) 文件中列出的一个参数匹配。

创建环境并提供自定义参数值时，会 AWS Proton 使用架构文件进行匹配、验证并将其注入关联的 CloudFormation IaC 文件中的花括号参数中。对于每个属性（参数），提供 name 和 type。（可选）还提供 description、default 和 pattern。

为以下示例标准 环境模板架构定义的参数包括 vpc_cidr、subnet_one_cidr 和 subnet_two_cidr，它们使用 default 关键字和默认值。在您使用该环境模板捆绑包架构创建环境时，您可以接受默认值或提供您自己的值。如果参数没有 默认值并且作为 required 属性（参数）列出，您在创建环境时必须为其提供值。

第二个示例标准 环境模板架构列出了 required 参数 my_other_sample_input。

您可以为两种类型的环境模板创建一个架构。有关更多信息，请参阅注册并发布模板。

服务模板捆绑包的架构要求

您的架构必须遵循 OpenAPI 的 Data Models (schemas) 部分并采用 YAML 格式，如以下示例中所示。您必须在服务模板捆绑包中提供架构文件。

在以下服务架构示例中，您必须包含设置了格式的标头。在以下示例中，它位于前三行。这是为了确认您使用了 Open API 的 Data Models (schemas) 部分。

必须包含 service_input_type 并使用您提供的名称进行定义。在以下示例中，它位于第 5 行。这会将参数与 AWS Proton 服务资源相关联。

当您使用控制台或 CLI 创建 AWS Proton 服务时，默认情况下会包含服务管道。在您为服务包含服务管道时，您必须包含 pipeline_input_type 并具有您提供的名称。在以下示例中，它位于第 7 行。如果您@@ 不包括 AWS Proton 服务管道，请不要包含此参数。有关更多信息，请参阅注册并发布模板。

要遵循 Open API 架构模型，您必须在以下示例中包含 types，它位于第 9 行。

在 types 后面，您必须定义一个 service_input_type 类型。您将服务的输入参数定义为 service_input_type 的属性。您必须包含至少一个属性，其名称至少与架构的关联服务基础设施即代码 (IaC) 文件中列出的一个参数匹配。

要定义服务管道，您必须在 service_input_type 定义下面定义一个 pipeline_input_type。如上所述，您必须包含至少一个属性，其名称至少与架构的关联管道 IaC 文件中列出的一个参数匹配。如果您@@ 不包括 AWS Proton 服务管道，请不要包含此定义。

作为管理员或开发人员，当您创建服务并提供自定义参数值时，会 AWS Proton 使用架构文件来匹配、验证这些值，并将其注入关联的 CloudFormation IaC 文件的花括号参数中。对于每个属性（参数），提供 name 和 type。（可选）还提供 description、default 和 pattern。

为示例模式定义的参数包括 port、desired_count、task_size 和 image，它们使用 default 关键字和默认值。在您使用该服务模板捆绑包架构创建服务时，您可以接受默认值或提供您自己的值。unique_name 参数也包含在该示例中，并且没有 默认值。它作为 required 属性（参数）列出。作为管理员或开发人员，您在创建服务时必须提供 required 参数的值。

如果要创建具有服务管道的服务模板，请将 pipeline_input_type 包含在架构中。

包含服务管道的服务的示例 AWS Proton 服务架构文件。

此架构示例可以与示例 4 和示例 5 中所示的 AWS Proton IaC 文件一起使用。包含一个服务管道。

schema:                            # required
  format:                          # required
    openapi: "3.0.0"               # required
  # required           defined by administrator
  service_input_type: "LoadBalancedServiceInput"
  # only include if including AWS Proton service pipeline, defined by administrator
  pipeline_input_type: "PipelineInputs"

  types:                           # required
    # defined by administrator
    LoadBalancedServiceInput:
      type: object
      description: "Input properties for a loadbalanced Fargate service"
      properties:
        port:                      # parameter
          type: number
          description: "The port to route traffic to"
          default: 80
          minimum: 0
          maximum: 65535
        desired_count:             # parameter
          type: number
          description: "The default number of Fargate tasks you want running"
          default: 1
          minimum: 1
        task_size:                 # parameter
          type: string
          description: "The size of the task you want to run"
          enum: ["x-small", "small", "medium", "large", "x-large"]
          default: "x-small"
        image:                     # parameter
          type: string
          description: "The name/url of the container image"
          default: "public.ecr.aws/z9d2n7e1/nginx:1.19.5"
          minLength: 1
          maxLength: 200
        unique_name:               # parameter
          type: string
          description: "The unique name of your service identifier. This will be used to name your log group, task definition and ECS service"
          minLength: 1
          maxLength: 100
      required:
        - unique_name
    # defined by administrator
    PipelineInputs:
      type: object
      description: "Pipeline input properties"
      properties:
        dockerfile:                # parameter
          type: string
          description: "The location of the Dockerfile to build"
          default: "Dockerfile"
          minLength: 1
          maxLength: 100
        unit_test_command:         # parameter
          type: string
          description: "The command to run to unit test the application code"
          default: "echo 'add your unit test command here'"
          minLength: 1
          maxLength: 200

如果要创建没有服务管道的服务模板，请不要 将 pipeline_input_type 包含在架构中，如以下示例中所示。

不包含服务管道的服务的示例 AWS Proton 服务架构文件

schema:                            # required
  format:                          # required
    openapi: "3.0.0"               # required
  # required            defined by administrator  
  service_input_type: "MyServiceInstanceInputType"

  types:                           # required
    # defined by administrator
    MyServiceInstanceInputType:
      type: object
      description: "Service instance input properties"
      required:
        - my_sample_service_instance_required_input
      properties:
        my_sample_service_instance_optional_input:   # parameter
          type: string
          description: "This is a sample input"
          default: "hello world"
        my_sample_service_instance_required_input:   # parameter
          type: string
          description: "Another sample input"