リージョンタイプをカスタムブループリントの Options
インターフェイスに追加してコンポーネントを生成できます。ブループリントウィザードでは 1 つまたは複数の AWS リージョンを入力できます。リージョンタイプは、blueprint.ts
ファイルのベースブループリントからインポートできます。詳細については、「AWS リージョン
Amazon CodeCatalyst ブループリントリージョンタイプをインポートするには
blueprint.ts
ファイルで次を追加します。
import { Region } from '@amazon-codecatalyst/blueprints.blueprint'
リージョンタイプパラメータは、選択できる AWS リージョンコードの配列です。または、*
を使用して、サポートされるすべての AWS リージョンを含めることもできます。
注釈
JSDoc タグを Options
インターフェイスの各フィールドに追加すると、ウィザードでのフィールドの表示方法と動作をカスタマイズできます。リージョンタイプでは、次のタグがサポートされます。
-
@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']>; }
指定したリストから 1 つまたは複数のリージョンを選択する
export interface Options extends ParentOptions { ... /** * @displayName Regions */ multiRegion: Region<['us-east-1', 'us-east-2', 'us-west-1', 'us-west-2']>[]; }
AWS リージョンを 1 つ選択する
export interface Options extends ParentOptions { ... /** * @displayName Region */ region: Region<['*']>; }
指定したリストから 1 つまたは複数のリージョンを選択する
export interface Options extends ParentOptions { ... /** * @displayName Regions */ multiRegion: Region<['us-east-1', 'us-east-2', 'us-west-1', 'us-west-2']>[]; }