向蓝图添加区域组件 - Amazon CodeCatalyst

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

向蓝图添加区域组件

可以将区域类型添加到自定义蓝图的Options界面中,以便在蓝图向导中生成组件,您可以输入一个或多个 AWS gion。gion 类型可以从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']>[]; }