O tipo de região pode ser adicionado à interface de Options
do seu esquema personalizado para gerar um componente no assistente de esquema; é possível inserir uma ou mais regiões da AWS. O tipo de região pode ser importado do seu esquema base em seu arquivo blueprint.ts
. Para ter mais informações, consulte Regiões da AWS
Como importar o tipo de região de esquemas do Amazon CodeCatalyst
No arquivo blueprint.ts
, adicione:
import { Region } from '@amazon-codecatalyst/blueprints.blueprint'
O parâmetro de tipo de região é uma matriz de códigos de região da AWS para escolher, ou você pode usar *
para incluir todas as regiões da AWS compatíveis.
Anotações
As tags JSDoc podem ser adicionadas a cada campo na interface de Options
para personalizar como um campo aparece e se comporta no assistente. Para o tipo de região, as seguintes tags são compatíveis:
-
A anotação
@displayName
pode ser usada para alterar o rótulo do campo no assistente.Exemplo:
@displayName AWS Region
-
A anotação
@placeholder
pode ser usada para alterar o espaço reservado do componente de seleção/seleção múltipla.Exemplo:
@placeholder Choose AWS Region
Exemplos de componentes de região
Escolha de uma região de uma lista especificada
export interface Options extends ParentOptions { ... /** * @displayName Region */ region: Region<['us-east-1', 'us-east-2', 'us-west-1', 'us-west-2']>; }
Escolha de uma ou mais regiões de uma lista especificada
export interface Options extends ParentOptions { ... /** * @displayName Regions */ multiRegion: Region<['us-east-1', 'us-east-2', 'us-west-1', 'us-west-2']>[]; }
Escolha de uma região da AWS
export interface Options extends ParentOptions { ... /** * @displayName Region */ region: Region<['*']>; }
Escolha de uma ou mais regiões de uma lista especificada
export interface Options extends ParentOptions { ... /** * @displayName Regions */ multiRegion: Region<['us-east-1', 'us-east-2', 'us-west-1', 'us-west-2']>[]; }