Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

使用模块封装及重复使用资源配置

模块是一种供您以透明、易管理和可重复的方式打包资源配置以便跨堆栈模板实现包含的方法。模块可以将常见服务配置和最佳实践封装为模块化、可自定义的构建基块，供您包含在堆栈模板中。模块使您能够将包含最佳实践、专家领域知识和可接受的指南（例如安全性、合规性、治理和行业法规）在内的资源配置纳入模板中，而无需深入了解资源实施的复杂性。

例如，网络领域专家可以创建一个包含遵守安全准则的内置安全组和入口/出口规则的模块。然后，您可以将该模块纳入到模板中，以便在堆栈中预配置安全的网络基础架构，而无需花费时间弄清楚 VPC、子网、安全组和网关的工作方式。此外，由于模块具有版本控制，因此如果安全指南随时间而发生变化，模块作者可以创建包含这些更改的新版本模块。

在模板中使用模块的特点包括：

模块可以包含：

有关开发模块类型的信息，请参阅《CloudFormation 命令行界面用户指南》中的开发模块类型。

在模板中使用模块

要使用模块，请确保该模块已在要在其中使用它的账户和区域中注册。有关更多信息，请参阅公有和私有扩展。您在 CloudFormation 注册表中将模块注册为私有扩展。然后，将其作为单个资源进行处理：

当您启动堆栈操作时，CloudFormation 会生成一个已处理的模板，该模板将所有包含的模块解析为适当的资源。在实际执行堆栈操作之前，使用更改集预览要添加或更新的资源。有关更多信息，请参阅使用更改集更新堆栈。

参阅以下示例：您有一个包含资源和模块的模板。模板包含一个单独的资源 ResourceA 和一个模块 ModuleParent。而模块包含两个资源（ResourceB 和 ResourceC），以及一个嵌套模块 ModuleChild。ModuleChild 包含一个资源，即 ResourceD。如果您使用此模板创建堆栈，CloudFormation 会处理模板并将模块解析为适当的资源。最终创建的堆栈具有四个资源：ResourceA、ResourceB、ResourceC 和 ResourceD。

CloudFormation 会跟踪堆栈中的哪些资源是从模块创建而成的。您可以在给定堆栈的 Events（事件）、Resources（资源）和 Drifts（偏差）选项卡上查看此信息，更改集预览中也包含此信息。

模块与模板中的资源可以区别开来，因为它们遵循以下四部分命名约定，而不是资源所用的典型的三部分命名约定：

organization::service::use-case::MODULE

使用参数指定模块值

模块可以包含模块参数。与模板参数非常相似，模块参数使您能够将自定义值从包含自定义值的模板（或模块）输入到模块中。然后，模块可以使用这些值来设置其所包含的资源的属性。

您还可以定义模板参数，这些参数反过来会设置模块属性，以便用户可以输入在堆栈操作时传递给模块的值。有关定义模板参数的更多信息，请参阅 参数。

同样，如果模块含有包含模块参数的嵌套模块，则您可以：

使用模板参数指定模块参数值

以下示例展示了如何定义将值传递给模块的模板参数。

此处，包含 My::S3::SampleBucket::MODULE 的模板定义了模板参数 BucketName，该参数使用户能够在堆栈操作期间指定 S3 存储桶名称。

// Template containing My::S3::SampleBucket::MODULE
{
  "Parameters": {
    "BucketName": {
      "Description": "Name for your sample bucket",
      "Type": "String"
    }
  },
  "Resources": {
    "MyBucket": {
      "Type": "My::S3::SampleBucket::MODULE",
      "Properties": {
        "BucketName": {
          "Ref": "BucketName"
        }
      }
    }
  }
}

在父模块中指定子模块中资源的属性

以下示例展示了如何在嵌套在另一个模块中的模块中指定参数值。

第一个模块 My::S3::SampleBucketPrivate::MODULE 将是子模块。该模块定义了两个参数：BucketName 和 AccessControl。为这些参数指定的值用于指定模块所包含的 AWS::S3::Bucket 资源的 BucketName 和 AccessControl 属性。以下为 My::S3::SampleBucketPrivate::MODULE 的模板片段。

// My::S3::SampleBucketPrivate::MODULE
{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Description": "A sample S3 Bucket with Versioning and DeletionPolicy.",
    "Parameters": {
        "BucketName": {
            "Description": "Name for the bucket",
            "Type": "String"
        },
        "AccessControl": {
            "Description": "AccessControl for the bucket",
            "Type": "String"
        }
    },
    "Resources": {
        "S3Bucket": {
            "Type": "AWS::S3::Bucket",
            "Properties": {
                "BucketName": {
                    "Ref": "BucketName"
                },
                "AccessControl": {
                    "Ref": "AccessControl"
                },
                "DeletionPolicy": "Retain",
                "VersioningConfiguration": {
                    "Status": "Enabled"
                }
            }
        }
    }
}

接下来，上一个模块嵌套在父模块 My::S3::SampleBucket::MODULE 中。父模块 My::S3::SampleBucket::MODULE 通过以下方式设置子模块参数：

// My::S3::SampleBucket::MODULE
{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Description": "A sample S3 Bucket. With Private AccessControl.",
  "Parameters": {
    "BucketName": {
      "Description": "Name for your sample bucket",
      "Type": "String"
    }
  },
  "Resources": {
    "MyBucket": {
      "Type": "My::S3::SampleBucketPrivate::MODULE",
      "Properties": {
        "BucketName": {
          "Ref": "BucketName"
        },
        "AccessControl" : "Private"
      }
    }
  }
}

为模块参数指定约束

模块参数不支持约束强制执行。有关更多信息，请参阅属性。要对模块参数执行约束检查，请创建具有所需约束的模板参数，然后在模块参数中引用该模板参数。

引用模块中的资源

模块中的资源可以通过逻辑名称进行引用。模块中包含的资源的完全限定逻辑名称可以通过将以下名称相结合来构成：

可以使用或不使用句点作为分隔符来指定资源的完全限定逻辑名称。例如，以下两个逻辑名称都是有效的，且功能等同：

通过这种方式，您可以使用 GetAtt 和 Ref 内部函数来访问模块资源上的属性值。

在以下示例中，模板引用模块中的属性来为模板本身的资源设置相应属性。

假设 My::S3::SampleBucket::MODULE 模块包含逻辑名称为 S3Bucket 的资源 AWS::S3::Bucket。要使用 Ref 内部函数引用此资源的存储桶名称，将模板中给定模块的逻辑名称 MyBucket 与模块中资源的逻辑名称 S3Bucket 相结合，从而获得资源的完全限定逻辑名称：MyBucket.S3Bucket 或 MyBucketS3Bucket。

模块中包含的资源的逻辑名称在模块的架构中指定。您可以通过以下方式访问该架构：

// Template that uses My::S3::SampleBucket::MODULE
{
  "Parameters": {
    "BucketName": {
      "Description": "Name for your sample bucket",
      "Type": "String"
   }
 },
  "Resources": {
    "MyBucket": {
      "Type": "My::S3::SampleBucket::MODULE",
      "Properties": {
          "BucketName": {
            "Ref": "BucketName"
         }
      }
    },
    "exampleQueue": {
      "Type": "AWS::SQS::Queue",
      "Properties": {
          "QueueName": {
            "Ref": "MyBucket.S3Bucket"
          }
      }
    }
},
"Outputs": {
  "BucketArn": {
      "Value": {
          "Fn::GetAtt": [
             "MyBucket",
             "S3Bucket.Arn"
          ]
      }
    }
  }
}

Parameters:
  BucketName:
    Description: Name for your sample bucket
    Type: String
Resources:
  MyBucket:
    Type: My::S3::SampleBucket::MODULE
    Properties:
      BucketName: !Ref BucketName
  exampleQueue:
    Type: AWS::SQS::Queue
    Properties:
      QueueName: !Ref MyBucket.S3Bucket
Outputs:
  BucketArn:
    Value: !GetAtt MyBucket.S3Bucket.Arn

使用模块时的注意事项

模块注册和版本控制

您可以使用 CloudFormation 注册表注册及管理账户和区域中的模块。有关更多信息，请参阅使用 Amazon CloudFormation 注册表。

您可以在给定账户和区域注册同一模块的多个版本。请注意以下事项：

有关注册新版本模块或更改模块的默认版本的更多信息，请参阅 使用 Amazon CloudFormation 注册表。

激活公共模块以在您的账户中使用

为了在您的账户和区域中成功激活公共模块，模块中包含的每个第三方公共扩展（资源或模块）必须满足以下条件：

如果您没有激活正确的第三方公有扩展和扩展版本，CloudFormation 将使操作失败，并显示一条错误消息，其中列出在成功激活该模块之前需要激活的扩展和/或版本。