

Amazon CodeCatalyst は新規のお客様には提供されなくなりました。既存のお客様は、通常どおりサービスを引き続き使用できます。詳細については、「[CodeCatalyst から移行する方法](migration.md)」を参照してください。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# リージョンコンポーネントをブループリントに追加する
<a name="region-comp-bp"></a>

リージョンタイプをカスタムブループリントの `Options` インターフェイスに追加してコンポーネントを生成できます。ブループリントウィザードでは 1 つまたは複数の AWS リージョンを入力できます。リージョンタイプは、`blueprint.ts` ファイルのベースブループリントからインポートできます。詳細については、「[AWS リージョン](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/)」を参照してください。

**Amazon CodeCatalyst ブループリントリージョンタイプをインポートするには**

`blueprint.ts` ファイルで次を追加します。

```
import { Region } from '@amazon-codecatalyst/blueprints.blueprint'
```

リージョンタイプパラメータは、選択できる AWS リージョンコードの配列です。または、`*` を使用して、サポートされるすべての AWS リージョンを含めることもできます。

**Topics**
+ [‏注釈](#region-annotations-bp)
+ [リージョンコンポーネントの例](#region-components-examples)

## ‏注釈
<a name="region-annotations-bp"></a>

JSDoc タグを `Options` インターフェイスの各フィールドに追加すると、ウィザードでのフィールドの表示方法と動作をカスタマイズできます。リージョンタイプでは、次のタグがサポートされます。
+ `@displayName` 注釈を使用して、ウィザードのフィールドのラベルを変更できます。

  例: `@displayName AWS Region`
+ `@placeholder` 注釈を使用して、選択コンポーネントと複数選択コンポーネントのプレースホルダーを変更できます。

  例: `@placeholder Choose AWS Region`

## リージョンコンポーネントの例
<a name="region-components-examples"></a>

### 指定したリストからリージョンを選択する
<a name="region-specified-list-bp"></a>

```
export interface Options extends ParentOptions {
    ...
  /**
   * @displayName Region
   */
  region: Region<['us-east-1', 'us-east-2', 'us-west-1', 'us-west-2']>;
}
```

### 指定したリストから 1 つまたは複数のリージョンを選択する
<a name="region-specified-list-bp"></a>

```
export interface Options extends ParentOptions {
    ...
  /**
   * @displayName Regions
   */
  multiRegion: Region<['us-east-1', 'us-east-2', 'us-west-1', 'us-west-2']>[];
}
```

### AWS リージョンを 1 つ選択する
<a name="region-one-bp"></a>

```
export interface Options extends ParentOptions {
    ...
  /**
   * @displayName Region
   */
  region: Region<['*']>;
}
```

### 指定したリストから 1 つまたは複数のリージョンを選択する
<a name="region-specified-list-bp"></a>

```
export interface Options extends ParentOptions {
    ...
  /**
   * @displayName Regions
   */
  multiRegion: Region<['us-east-1', 'us-east-2', 'us-west-1', 'us-west-2']>[];
}
```