El tipo de región se puede agregar a la interfaz Options
de su esquema personalizado para generar un componente; en el asistente de esquema puede especificar una o más regiones de AWS. El tipo de región se puede importar desde el esquema base al archivo blueprint.ts
. Para obtener más información, consulte Regiones de AWS
Importación del tipo de región de los esquemas de Amazon CodeCatalyst
Añada lo siguiente al archivo blueprint.ts
:
import { Region } from '@amazon-codecatalyst/blueprints.blueprint'
El parámetro de tipo de región es una matriz de códigos de región de AWS entre los que puede elegir, o puede utilizar *
para incluir todas las regiones de AWS compatibles.
Anotaciones
Se pueden agregar etiquetas JSDoc a cada campo de la interfaz Options
para personalizar el aspecto y el comportamiento de un campo en el asistente. Para el tipo de región, se admiten las siguientes etiquetas:
-
La anotación
@displayName
se puede utilizar para cambiar la etiqueta del campo en el asistente.Ejemplo:
@displayName AWS Region
-
La anotación
@placeholder
se puede utilizar para cambiar el marcador de posición del componente de selección o selección múltiple.Ejemplo:
@placeholder Choose AWS Region
Ejemplos de componentes de regiones
Selección de una región de una lista especificada
export interface Options extends ParentOptions { ... /** * @displayName Region */ region: Region<['us-east-1', 'us-east-2', 'us-west-1', 'us-west-2']>; }
Selección de una o más regiones de una lista especificada
export interface Options extends ParentOptions { ... /** * @displayName Regions */ multiRegion: Region<['us-east-1', 'us-east-2', 'us-west-1', 'us-west-2']>[]; }
Selección de una región de AWS
export interface Options extends ParentOptions { ... /** * @displayName Region */ region: Region<['*']>; }
Selección de una o más regiones de una lista especificada
export interface Options extends ParentOptions { ... /** * @displayName Regions */ multiRegion: Region<['us-east-1', 'us-east-2', 'us-west-1', 'us-west-2']>[]; }