可以将区域类型添加到自定义蓝图的 Options
界面,以便在蓝图向导中生成可输入一个或多个 AWS 区域的组件。可以从 blueprint.ts
文件中的基础蓝图导入区域类型。有关更多信息,请参阅 AWS 区域
导入 Amazon CodeCatalyst 蓝图区域类型
在您的 blueprint.ts
文件中,添加以下内容:
import { Region } from '@amazon-codecatalyst/blueprints.blueprint'
区域类型参数是一组可供选择的 AWS 区域代码,您也可以使用 *
包含所有受支持的 AWS 区域。
注释
可以向 Options
界面中的每个字段添加 JSDoc 标签,以自定义字段在向导中的显示和行为方式。对于区域类型,支持以下标签:
-
@displayName
注释可用于在向导中更改字段的标签。例如:
@displayName AWS Region
-
@placeholder
注释可用于更改选择/多选组件的占位符。例如:
@placeholder Choose AWS Region
区域组件示例
从指定列表中选择区域
export interface Options extends ParentOptions { ... /** * @displayName Region */ region: Region<['us-east-1', 'us-east-2', 'us-west-1', 'us-west-2']>; }
从指定列表中选择一个或多个区域
export interface Options extends ParentOptions { ... /** * @displayName Regions */ multiRegion: Region<['us-east-1', 'us-east-2', 'us-west-1', 'us-west-2']>[]; }
选择一个 AWS 区域
export interface Options extends ParentOptions { ... /** * @displayName Region */ region: Region<['*']>; }
从指定列表中选择一个或多个区域
export interface Options extends ParentOptions { ... /** * @displayName Regions */ multiRegion: Region<['us-east-1', 'us-east-2', 'us-west-1', 'us-west-2']>[]; }