服务 Spec 导入器
将各种服务规格来源导入服务数据库.
使用量
程序化
declare const db: SpecDatabase;
new DatabaseBuilder(db, options)
// Import (modern) CloudFormation Registry Resources from a directory structure: <region>/<resource>.json
.importCloudFormationRegistryResources('data/CloudFormationSchema/')
// Import the (modern) JSON schema spec from SAM
.importSamJsonSchema('data/sam.schema.json')
// Import (legacy) CloudFormation Resource Specification from a directory structure containing a patch set: <region>/000_cloudformation/*.json
.importCloudFormationResourceSpec('data/CloudFormationResourceSpecification/')
// Import (legacy) SAM Resource Specification from a directory structure containing a patch set: *.json
.importSamResourceSpec('data/SAMResourceSpecification/')
// Import GetAtt'able attributes with the same name as properties
.importGetAttAllowList('data/GetAttAllowlist/GetAttAllowlist.json')
// Import various model enhancements
.importCloudFormationDocs('data/CloudFormationDocumentation.json')
.importStatefulResources('data/StatefulResources/StatefulResources.json')
.importCannedMetrics('data/CloudWatchConsoleServiceDirectory.json'),
// Apply the imports to the database
.build();
国 际
Usage: import-db [options] [database]
Import service specification sources into a service model database
Arguments:
database The database file (default: "db.json")
Options:
-s, --source <definition...> Import sources into the database. Use the format <source>:<path> to define sources.
-l, --load <database> Load an existing database as base, imported sources become additive
-c, --gzip Compress the database file using gzip
-f, --force Force overwriting an existing file (default: false)
-d, --debug Print additional debug output during import (default: false)
-r, --report <report-directory> Create a detailed build report in the specified directory
-v, --validate Validate imported sources and fail if any data is invalid (default: false)
-h, --help display help for command
来源
| CLI 源名称 | 数据库构建方法 | 路径参数 |
|---|---|---|
cfnSchemaDir | importCloudFormationRegistryResources | 结构目录 <region>/<resource>.json |
samSchema | importSamJsonSchema | SAM 注册 Schema 文件 |
cfnSpecDir | importCloudFormationResourceSpec | 包含补丁集的目录结构 <region>/000_cloudformation/*.json |
samSpec | importSamResourceSpec | SAM 资源规格文件 |
cfnDocs | importCloudFormationDocs | CloudFormation 文档文件 |
statefulResources | importStatefulResources | 国有资源文件 |
cannedMetrics | importCannedMetrics | CloudWatch Console 服务目录文件 |
云层排列记录Schema
CLI: 爱丽丝 cfnSchemaDir
代码 : importCloudFormationRegistryResources(schemaDir: string)
从目录结构中导入(现代) Cloud Formation Register Resources. 目录 MUST 包含每个区域的目录,每个区域包含每个资源的登记计划文件.
CloudFormationSchema/
├─ us-east-1/
│ ├─ aws-s3-bucket.json
├─ eu-west-1/
│ ├─ aws-s3-bucket.json
SAM 登记册Schema
CLI: 爱丽丝 samSchema
代码 : importSamJsonSchema(filePath: string)
从 SAM 导入 (现代) JSON Schema Spec. 包含 SAM Register Schema 的单一文件路径 .