模板结构
更新时间:2024-09-25
模板结构
下述模版结构即将下线,后续请使用最新版本的模板。
资源编排模板结构如下:
{
"COSTemplateFormatVersion" : "2019-08-07",
"Description" : "",
// 模板描述信息,可用于说明模板的适用场景、架构说明等。
"Metadata" : {
// 关于模板的元数据信息,比如存放用于可视化的布局信息。
},
"Parameters" : {
// 定义创建资源栈时模板用户可以定制化的参数。
},
"Mappings" : {
// 定义映射信息表,映射信息是一种多层的 Map 结构。
},
"Conditions": {
// 使用内部条件函数定义条件。这些条件确定何时创建关联的资源。
},
"Resources" : {
// 所需资源的详细定义,包括资源间的依赖关系、配置细节等。
},
"Outputs" : {
// 用于输出一些资源属性等有用信息,可以通过 API 或控制台获取输出的内容。
}
}
COSTemplateFormatVersion(可选)
云编排支持的模板版本号,当前版本号:2019-08-07。
Description(可选)
模板的描述信息,可用于说明模板的适用场景、架构说明等。通常情况下,对模板进行比较的描述有利于模板的用户理解模板的内容。
Metadata(可选)
模板编写者可以使用 Metadata 来存放与模板相关的元数据信息,内容可以是自由的 JSON 格式。
Parameters(可选)
定义创建资源栈时模板用户可以定制化的参数。比如很多情况下,模板的开发者会把资源得参数设计成一个参数,使用模板创建资源栈时,可以根据实际的评估结果来选择合适的参数,参数支持默认值。使用参数可以增强模板的灵活性,提高复用性。
Mappings(可选)
Mappings 定义了一个多层的映射表,可以通过 Fn::FindInMap 函数来选择 key 对应的值。可用于根据不同的输入参数值作为 Key 来查找映射表。
Conditions(可选)
Conditions 使用 Fn::And,Fn::Or,Fn::Not,Fn::Equals 定义条件,多个条件之间用“,”隔开。在创建或更新堆栈时,先计算模板中的所有条件,然后再创建资源。会创建与 true 条件关联的所有资源,忽略与 false 条件关联的所有资源。
Resources(必选)
用于详细定义使用该模板创建的资源栈所包含的资源,包括资源间的依赖关系、配置细节等。
Outputs(可选)
用于输出一些资源属性等有用信息,可以通过 API 或控制台获取输出的内容。