使用旧版 Amazon CloudFormation Designer 创建模板

Designer 具备以下优势：可以图形化的方式表示模板中的资源、简化模板撰写工作、简化模板编辑工作。

可视化模板资源

分析 JSON 或 YAML 格式的文本文件以了解模板中的资源及其之间的关系是项艰难的任务。在 Designer 中，您可以查看模板中包含的资源的图形化表示，了解它们之间的关系。

Designer 在模板元数据中定义有关您的资源的信息，如资源的大小、相对位置等。在您打开模板时，Designer 会自动添加此元数据，以便在您保存模板时保留当前布局。当您在 Designer 中重新打开模板时，它会显示与上次保存模板时完全相同的图表。

所有布局信息均在 AWS::CloudFormation::Designer 元数据键中定义，后者仅供 Designer 使用，不会干扰 Amazon CloudFormation 堆栈的创建。下面的模板元数据示例显示了 Designer 以元数据形式添加到模板中的布局信息：

JSON

"Metadata": {
  "AWS::CloudFormation::Designer": {
    "6b56eaae-0bb6-4215-aad6-12345EXAMPLE": {
      "size": {
        "width": 60,
        "height": 60
      },
      "position": {
        "x": 340,
        "y": 430
      },
      "z": 2,
      "parent": "21ccc9b0-29e9-4a86-9cf2-12345EXAMPLE",
      "embeds": [],
      "ismemberof": [
        "c3eead73-6a76-4532-9268-12345EXAMPLE"
      ]
    },
...

YAML

Metadata:
  'AWS::CloudFormation::Designer':
    6b56eaae-0bb6-4215-aad6-12345EXAMPLE:
      size:
        width: 60
        height: 60
      position:
        x: 340
        'y': 430
      z: 2
      parent: 21ccc9b0-29e9-4a86-9cf2-12345EXAMPLE
      embeds: []
      ismemberof:
        - c3eead73-6a76-4532-9268-12345EXAMPLE
...

简化模板撰写工作

在文本编辑器中撰写模板资源时，您必须手动编辑 JSON 或 YAML，这一过程繁琐又容易出错。通过使用 Designer，您可以将更多的时间花在设计 Amazon 基础设施而不是手动编写模板代码上。在 Designer 中，您可以拖放新资源以将其添加到模板中，然后在资源之间拖动连接线以建立关系。Designer 会自动修改 JSON 或 YAML。

创建模板时，Designer 会在资源间强制建立一些基本的关系，以帮助您创建有效的模板。例如，您无法直接在 VPC 中添加 EC2 实例；您必须将此实例添加到 VPC 中的子网内。

您还可以直接在 Designer 中验证模板。它提供与 ValidateTemplate API 调用相同级别的验证：检查 JSON 或 YAML 语法是否有效、所有引用参数是否都已声明、是否不存在循环依赖关系。

借助 集成的 JSON 和 YAML 编辑器 简化编辑工作

通过使用集成编辑器，您可以在 Amazon CloudFormation 控制台中进行所有模板修改。您无需使用单独的文本编辑器来修改和保存您的模板。集成编辑器 还提供了自动补全功能，它可列出资源的所有属性名称，因此，您无需查找或记住它们。此外，您还可以使用集成编辑器将 JSON 模板转换为 YAML，或进行反向转换。

Designer 有四个窗格。canvas 窗格显示模板资源的图表，以便您迅速查看资源及资源间的关系。为向模板添加资源，可从 Resources types 窗格拖放资源到 canvas 窗格上。使用 Integrated JSON and YAML editor 窗格可指定模板详细信息，如资源属性或模板参数。修改模板后，您可以将其保存到本地文件或 Amazon S3 存储桶。当您将有效的模板从 JSON 转换为 YAML 或进行反向转换时，Messages 窗格会显示成功或失败消息。当您打开或验证无效的模板时，Messages 窗格会显示验证错误。

下图介绍 Designer 窗格及其主要组件。

Designer 窗格和组

Canvas (画布) 窗格

Designer 在 canvas 窗格中以图表形式显示模板资源。您可以在此窗格中修改图表的布局、添加或删除资源、添加或删除资源间的连接。例如，可以从 Resource types 窗格将自动扩缩组和启动配置添加到 canvas 窗格。要连接这些相关资源，在它们之间拖出一条连接线。

Designer 如何对资源建模？

当您将资源从 Resource types 窗格拖放到 canvas 窗格时，Designer 会将其建模为容器或方形对象。

连接资源

您通过连接资源来在相关资源之间创建关联。例如，当您向 canvas 窗格添加 Internet 网关和 VPC 时，它们之间没有联系。要将此网关连接到 VPC，您必须连接它们。连接资源的方法取决于资源类型和 Designer 对于此资源的建模方式。下面的描述和图表介绍了各种方法。

使用资源菜单访问常见资源操作

Resource 菜单提供对常见资源操作的便捷访问：编辑资源属性、复制资源、删除资源或查看资源文档。要查看 Resource 菜单，可以右键单击 canvas 窗格中的资源。文档链接指向模板参考，其中描述了该资源的属性和语法。

资源菜单

定义明确的依赖关系

要指定 Amazon CloudFormation 创建和删除资源的顺序，您可以创建明确的依赖关系。要覆盖并行资源创建和删除，明确的依赖关系是非常有用的。Amazon CloudFormation 自动确定可以并行处理模板中的哪些资源，而无法处理哪些资源。当您指定的属性引用相同模板中另一来源的属性（使用 Ref 内部函数）或获取另一资源的属性（使用 Fn::GetAtt 内部函数）时，即暗示着存在依赖关系，Amazon CloudFormation 会以正确的顺序构建它们。

但是，在某些情况下，您必须明确定义依赖关系。例如，在网关连接到 VPC 之前，路由规则无法使用互联网网关。通常，Amazon CloudFormation 在创建 Internet 网关后会因为隐式依赖关系立即创建路由规则。但是，Amazon CloudFormation 可能在将 Internet 网关连接到 VPC 之前即创建规则，从而导致出错。因此，您必须明确定义网关-VPC 连接的依赖关系。

要创建明确的依赖关系，可以从路由上的 DependsOn (*) 点拖一条线到网关-VPC 连接。

有关何时可能需要创建明确依赖关系的更多信息，请参阅DependsOn 属性。

JSON

在 JSON 中，这些明确的依赖关系以资源上的 DependsOn 属性表示，如以下示例所示：

"PublicRoute": {
  "Type": "AWS::EC2::Route",
  "DependsOn": "VPCGatewayAttachment",
  "Properties": {
      "DestinationCidrBlock": "0.0.0.0/0",
      "RouteTableId": {
          "Ref": "PublicRouteTable"
      },
      "GatewayId": {
          "Ref": "InternetGateway"
      }
  }

YAML

在 YAML 中，这些明确的依赖关系以资源上的 DependsOn 属性表示，如以下示例所示：

PublicRoute:
  Type: 'AWS::EC2::Route'
  DependsOn:
    - VPCGatewayAttachment
  Properties:
    DestinationCidrBlock: 0.0.0.0/0
    RouteTableId: !Ref PublicRouteTable
    GatewayId: !Ref InternetGateway

集成的 JSON 和 YAML 编辑器

可以使用 Designer 的集成的 JSON 和 YAML 编辑器查看和编辑模板详细信息。例如，可以使用 集成编辑器 定义资源的属性或更改模板参数。集成编辑器具有两个视图：Components (组件) 视图和 Template (模板) 视图。

要对模板的特定部分进行次要变更，可以使用 Components 视图。在 Components 视图中，可编辑的组件划分到了各个选项卡中。这些选项卡根据您是否选择了资源而变化。

例如，如果您选择了某个资源，则 Designer 提供编辑此资源属性的选项卡，如更新策略或创建策略。如果尚未选择任何元素，则 Designer 提供编辑模板参数、映射、条件、元数据和输出的选项卡。在 Components 视图中所做的任意更改都必须是有效的 JSON 或 YAML 标记。如果引入无效的 JSON 或 YAML，在退出 Components (组件) 视图时，Designer 将无效的标记恢复为有效的标记。

要对模板执行广泛的变更，可以使用 Template 视图。在 Template (模板) 视图中，集成的 JSON 和 YAML 编辑器显示整个模板的原始 JSON 或 YAML。如果要更改资源，请在画布窗格中选择该资源。Designer 在集成的 JSON 和 YAML 编辑器中自动突出显示该资源。

Amazon CloudFormation Designer 集成的 JSON 和 YAML 编辑器

将模板转换为 YAML 或 JSON

通过在 Choose template language（选择模板语言）中选择相应的单选按钮可将有效的模板在 JSON 和 YAML 之间来回转换。Designer 只能转换有效的 YAML 或有效的 JSON 模板。如果转换成功，Messages（消息）窗格会显示类似下面的消息：Successfully converted the template to YAML（成功将模板转换为 YAML）。

选择模板语言后，拖动到画布上的任何新资源都将以所选语言创建。要切换成另一种语言，请确保模板有效，然后在提示 Choose template language 时选择 YAML 或 JSON。

自动完成

集成的 JSON 和 YAML 编辑器 包含自动补全功能，可帮助您指定资源属性，因此，您不必记住属性名称。要查看 JSON 模板中的有效属性列表，请在 Properties 大括号 ({}) 中按 Ctrl+Space，如以下示例所示：

对于 YAML 模板，您可以先删除左/右大括号，然后按 Enter 以转到新行。要查看有效的属性列表，请在 Properties 后面的新行上按 Ctrl+Space，如以下示例所示：

键盘快捷键

Designer 的集成的 JSON 和 YAML 编辑器提供以下键盘快捷键：