> For the complete documentation index, see [llms.txt](/llms.txt)

# GS2-Formation Deploy/CDK リファレンス

GS2-Deployのスタックを作成する際に使用するテンプレートのフォーマットと、CDKによる各種言語のテンプレート出力の実装例




## エンティティ

Deploy処理で操作の対象となるリソース

### Namespace

ネームスペース<br>

ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。<br>
GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。<br>

そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。

#### Request

リソースの生成・更新リクエスト

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| name | string |  | ✓|  |  ~ 128文字 | ネームスペース名<br>ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| description | string |  | |  |  ~ 1024文字 | 説明文 |
| transactionSetting | [TransactionSetting](#transactionsetting) |  | |  |  | トランザクション設定<br>編成操作時のトランザクションの処理方法を制御する設定です。 |
| updateMoldScript | [ScriptSetting](#scriptsetting) |  | |  |  | フォームの保存領域のキャパシティを更新するときに実行するスクリプトの設定<br>Script トリガーリファレンス - [`updateMold`](../script/#updatemold) |
| updateFormScript | [ScriptSetting](#scriptsetting) |  | |  |  | フォームを更新するときに実行するスクリプトの設定<br>Script トリガーリファレンス - [`updateForm`](../script/#updateform) |
| updatePropertyFormScript | [ScriptSetting](#scriptsetting) |  | |  |  | プロパティフォームを更新するときに実行するスクリプトの設定<br>Script トリガーリファレンス - [`updatePropertyForm`](../script/#updatepropertyform) |
| logSetting | [LogSetting](#logsetting) |  | |  |  | ログの出力設定<br>編成操作のログデータを GS2-Log に出力するための設定です。GS2-Log のネームスペースを指定することで、フォーム更新、保存領域キャパシティ変更、プロパティフォーム変更の API リクエスト・レスポンスログを収集できます。 |

#### GetAttr

[!GetAttr](/articles/tech/deploy/#getattr)タグで取得可能なリソースの生成結果

| | 型 | 説明 |
| --- | --- | --- |
| Item | [Namespace](../sdk#namespace) | 作成したネームスペース

#### 実装例




**GS2-Deploy(YAML)**
```yaml

Type: GS2::Formation::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSetting: 
    EnableAutoRun: true
    QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
  UpdateMoldScript: null
  UpdateFormScript: null
  UpdatePropertyFormScript: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001

```

**Go**
```go

import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/formation"
    "github.com/openlyinc/pointy"
)


SampleStack := core.NewStack()
formation.NewNamespace(
    &SampleStack,
    "namespace-0001",
    formation.NamespaceOptions{
        TransactionSetting: &core.TransactionSetting{
            QueueNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"),
        },
        LogSetting: &core.LogSetting{
            LoggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
        },
    },
)

println(SampleStack.Yaml())  // Generate Template

```

**PHP**
```php

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        new \Gs2Cdk\Formation\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\Formation\Model\Options\NamespaceOptions(
                transactionSetting: new \Gs2Cdk\Core\Model\TransactionSetting(
                    new \Gs2Cdk\Core\Model\TransactionSettingOptions(
                        queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
                    )
                ),
                logSetting: new \Gs2Cdk\Core\Model\LogSetting(
                    loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            )
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template

```

**Java**
```java

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.formation.model.Namespace(
                this,
                "namespace-0001",
                new io.gs2.cdk.formation.model.options.NamespaceOptions()
                        .withTransactionSetting(new io.gs2.cdk.core.model.TransactionSetting(
                            new io.gs2.cdk.core.model.options.TransactionSettingOptions()
                                .withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001")
                        ))
                        .withLogSetting(new io.gs2.cdk.core.model.LogSetting(
                            "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                        ))
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template

```

**C#**
```csharp

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Formation.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: new Gs2Cdk.Gs2Formation.Model.Options.NamespaceOptions
            {
                transactionSetting = new Gs2Cdk.Core.Model.TransactionSetting(
                    options: new Gs2Cdk.Core.Model.TransactionSettingOptions
                    {
                        queueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
                    }
                ),
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template

```

**TypeScript**
```typescript

import core from "@/gs2cdk/core";
import formation from "@/gs2cdk/formation";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new formation.model.Namespace(
            this,
            "namespace-0001",
            {
                transactionSetting: new core.TransactionSetting(
                    {
                        queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
                    }
                ),
                logSetting: new core.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template

```

**Python**
```python

from gs2_cdk import Stack, core, formation

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        formation.Namespace(
            stack=self,
            name='namespace-0001',
            options=formation.NamespaceOptions(
                transaction_setting=core.TransactionSetting(
                    options=core.TransactionSettingOptions(
                        queue_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001',
                    )
                ),
                log_setting=core.LogSetting(
                    logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
                ),
            ),
        )

print(SampleStack().yaml())  # Generate Template

```


#### TransactionSetting

トランザクション設定<br>

トランザクション設定は、トランザクションの実行方法・整合性・非同期処理・競合回避の仕組みを制御する設定です。<br>
自動実行（AutoRun）、アトミック実行（AtomicCommit）、GS2-Distributor を利用した非同期実行、スクリプト結果の一括適用、GS2-JobQueue による入手アクションの非同期化などを組み合わせ、ゲームロジックに応じた堅牢なトランザクション管理を可能にします。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| enableAutoRun | bool |  |  | false |  | 発行したトランザクションをサーバーサイドで自動的に実行するか |
| enableAtomicCommit | bool | {enableAutoRun} == true |  | false |  | トランザクションの実行をアトミックにコミットするか<br>※ enableAutoRun が true であれば 有効 |
| transactionUseDistributor | bool | {enableAtomicCommit} == true |  | false |  | トランザクションを非同期処理で実行する<br>※ enableAtomicCommit が true であれば 有効 |
| commitScriptResultInUseDistributor | bool | {transactionUseDistributor} == true |  | false |  | スクリプトの結果コミット処理を非同期処理で実行するか<br>※ transactionUseDistributor が true であれば 有効 |
| acquireActionUseJobQueue | bool | {enableAtomicCommit} == true |  | false |  | 入手アクションを実行する際に GS2-JobQueue を使用するか<br>※ enableAtomicCommit が true であれば 有効 |
| distributorNamespaceId | string |  |  | "grn:gs2:{region}:{ownerId}:distributor:default" |  ~ 1024文字 | トランザクションの実行に使用する GS2-Distributor ネームスペースGRN |
| queueNamespaceId | string |  |  | "grn:gs2:{region}:{ownerId}:queue:default" |  ~ 1024文字 | トランザクションの実行に使用する GS2-JobQueue のネームスペースGRN |

#### ScriptSetting

スクリプト設定<br>

GS2 ではマイクロサービスのイベントに関連づけて、カスタムスクリプトを実行することができます。<br>
このモデルは、スクリプトの実行をトリガーするための設定を保持します。<br>

スクリプトの実行方式は大きく2種類あり、それは「同期実行」と「非同期実行」です。<br>
同期実行は、スクリプトの実行が完了するまで処理がブロックされます。<br>
代わりに、スクリプトの実行結果を使って API の実行を止めたり、API のレスポンス内容を制御することができます。<br>

一方、非同期実行ではスクリプトの完了を待つために処理がブロックされることはありません。<br>
ただし、スクリプトの実行結果を利用して API の実行を停止したり、API の応答内容を変更することはできません。<br>
非同期実行は API の応答フローに影響を与えないため、原則として非同期実行を推奨します。<br>

非同期実行には実行方式が2種類あり、GS2-Script と Amazon EventBridge があります。<br>
Amazon EventBridge を使用することで、Lua 以外の言語で処理を記述することができます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| triggerScriptId | string |  |  |  |  ~ 1024文字 | API 実行時に同期的に実行される GS2-Script のスクリプトGRN<br>「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。 |
| doneTriggerTargetType | 文字列列挙型<br>enum {<br>&nbsp;&nbsp;"none",<br>&nbsp;&nbsp;"gs2_script",<br>&nbsp;&nbsp;"aws"<br>}<br> |  |  | "none" |  | 非同期スクリプトの実行方法<br>非同期実行で使用するスクリプトの種類を指定します。<br>「非同期実行のスクリプトを使用しない(none)」「GS2-Scriptを使用する(gs2_script)」「Amazon EventBridgeを使用する(aws)」が選択できます。"none": なし / "gs2_script": GS2-Script / "aws": Amazon EventBridge /  |
| doneTriggerScriptId | string | {doneTriggerTargetType} == "gs2_script" |  |  |  ~ 1024文字 | 非同期実行する GS2-Script スクリプトGRN<br>「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。<br>※ doneTriggerTargetType が "gs2_script" であれば 有効 |
| doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == "gs2_script" |  |  |  ~ 1024文字 | 非同期実行スクリプトを実行する GS2-JobQueue ネームスペースGRN<br>非同期実行スクリプトを直接実行するのではなく、GS2-JobQueue を経由する場合は GS2-JobQueue のネームスペースGRN を指定します。<br>GS2-JobQueue を利用する理由は多くはありませんので、特に理由がなければ指定する必要はありません。<br>※ doneTriggerTargetType が "gs2_script" であれば 有効 |

#### LogSetting

ログの出力設定<br>

ログデータの出力設定を管理します。この型は、ログデータを書き出すために使用される GS2-Log ネームスペースの識別子（Namespace ID）を保持します。<br>
ログネームスペースID(loggingNamespaceId)には、ログデータを収集し保存する GS2-Log のネームスペースを、GRNの形式で指定します。<br>
この設定をすることで、設定されたネームスペース内で発生したAPIリクエスト・レスポンスのログデータが、対象の GS2-Log ネームスペース側へ出力されるようになります。<br>
GS2-Log ではリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| loggingNamespaceId | string |  | ✓ |  |  ~ 1024文字 | ログを出力する GS2-Log のネームスペースGRN<br>「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。 |

---

### CurrentFormMaster

現在アクティブなフォームモデルのマスターデータ<br>

現在ネームスペース内で有効な、フォームモデルの定義を記述したマスターデータです。<br>
GS2ではマスターデータの管理にJSON形式のファイルを使用します。<br>
ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。<br>

JSONファイルを作成する方法として、マネージメントコンソール内にマスターデータエディタを提供しています。<br>
また、よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
{{% alert title="Note" color="info" %}}
JSONファイルの形式については [GS2-Formation マスターデータリファレンス](api_reference/formation/master_data/) をご参照ください。
{{% /alert %}}

#### Request

リソースの生成・更新リクエスト

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128文字 | ネームスペース名<br>ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| mode | 文字列列挙型<br>enum {<br>&nbsp;&nbsp;"direct",<br>&nbsp;&nbsp;"preUpload"<br>}<br> |  | | "direct" |  | 更新モード"direct": マスターデータを直接更新 / "preUpload": マスターデータをアップロードしてから更新 /  |
| settings | string | {mode} == "direct" | ✓※|  |  ~ 5242880 バイト (5MB) | マスターデータ<br>※ mode が "direct" であれば必須 |
| uploadToken | string | {mode} == "preUpload" | ✓※|  |  ~ 1024文字 | 事前アップロードで取得したトークン<br>アップロードしたマスターデータを適用するために使用されます。<br>※ mode が "preUpload" であれば必須 |

#### GetAttr

[!GetAttr](/articles/tech/deploy/#getattr)タグで取得可能なリソースの生成結果

| | 型 | 説明 |
| --- | --- | --- |
| Item | [CurrentFormMaster](../sdk#currentformmaster) | 更新された現在アクティブなフォームモデルのマスターデータ

#### 実装例




**GS2-Deploy(YAML)**
```yaml

Type: GS2::Formation::CurrentFormMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  Settings: {
    "version": "2019-09-09",
    "moldModels": [
      {
        "name": "party",
        "initialMaxCapacity": 10,
        "maxCapacity": 20,
        "formModel":
          {
            "name": "party",
            "metadata": "PARTY",
            "slots": [
              {
                "name": "tank",
                "metadata": "TANK",
                "propertyRegex": "grn:.*"
              },
              {
                "name": "healer",
                "metadata": "HEALER",
                "propertyRegex": "grn:.*"
              },
              {
                "name": "dps_1",
                "metadata": "DPS",
                "propertyRegex": "grn:.*"
              },
              {
                "name": "dps_2",
                "metadata": "DPS",
                "propertyRegex": "grn:.*"
              }
            ]
          },
        "metadata": "PARTY"
      },
      {
        "name": "equipment",
        "initialMaxCapacity": 20,
        "maxCapacity": 30,
        "formModel":
          {
            "name": "equipment",
            "metadata": "EQUIPMENT",
            "slots": [
              {
                "name": "head",
                "metadata": "HEAD",
                "propertyRegex": "grn:.*"
              },
              {
                "name": "body",
                "metadata": "BODY",
                "propertyRegex": "grn:.*"
              },
              {
                "name": "leg",
                "metadata": "LEG",
                "propertyRegex": "grn:.*"
              }
            ]
          },
        "metadata": "EQUIPMENT"
      }
    ],
    "propertyFormModels": []
    
  }
  UploadToken: null

```

**Go**
```go

import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/formation"
    "github.com/openlyinc/pointy"
)


SampleStack := core.NewStack()
formation.NewNamespace(
    &SampleStack,
    "namespace-0001",
    formation.NamespaceOptions{},
).MasterData(
    []formation.MoldModel{
        formation.NewMoldModel(
            "party",
            10,
            20,
            formation.NewFormModel(
                "party",
                []formation.SlotModel{
                    formation.NewSlotModel(
                        "tank",
                        "grn:.*",
                        formation.SlotModelOptions{
                            Metadata: pointy.String("TANK"),
                        },
                    ),
                    formation.NewSlotModel(
                        "healer",
                        "grn:.*",
                        formation.SlotModelOptions{
                            Metadata: pointy.String("HEALER"),
                        },
                    ),
                    formation.NewSlotModel(
                        "dps_1",
                        "grn:.*",
                        formation.SlotModelOptions{
                            Metadata: pointy.String("DPS"),
                        },
                    ),
                    formation.NewSlotModel(
                        "dps_2",
                        "grn:.*",
                        formation.SlotModelOptions{
                            Metadata: pointy.String("DPS"),
                        },
                    ),
                },
                formation.FormModelOptions{
                    Metadata: pointy.String("PARTY"),
                },
            ),
            formation.MoldModelOptions{
                Metadata: pointy.String("PARTY"),
            },
        ),
        formation.NewMoldModel(
            "equipment",
            20,
            30,
            formation.NewFormModel(
                "equipment",
                []formation.SlotModel{
                    formation.NewSlotModel(
                        "head",
                        "grn:.*",
                        formation.SlotModelOptions{
                            Metadata: pointy.String("HEAD"),
                        },
                    ),
                    formation.NewSlotModel(
                        "body",
                        "grn:.*",
                        formation.SlotModelOptions{
                            Metadata: pointy.String("BODY"),
                        },
                    ),
                    formation.NewSlotModel(
                        "leg",
                        "grn:.*",
                        formation.SlotModelOptions{
                            Metadata: pointy.String("LEG"),
                        },
                    ),
                },
                formation.FormModelOptions{
                    Metadata: pointy.String("EQUIPMENT"),
                },
            ),
            formation.MoldModelOptions{
                Metadata: pointy.String("EQUIPMENT"),
            },
        ),
    },
    []formation.PropertyFormModel{
    },
)

println(SampleStack.Yaml())  // Generate Template

```

**PHP**
```php

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Formation\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
                new \Gs2Cdk\Formation\Model\MoldModel(
                    name:"party",
                    initialMaxCapacity:10,
                    maxCapacity:20,
                    formModel:new \Gs2Cdk\Formation\Model\FormModel(
                        name: "party",
                        slots: [
                            new \Gs2Cdk\Formation\Model\SlotModel(
                                name: "tank",
                                propertyRegex: "grn:.*",
                                options: new \Gs2Cdk\Formation\Model\Options\SlotModelOptions(
                                    metadata: "TANK",
                                ),
                            ),
                            new \Gs2Cdk\Formation\Model\SlotModel(
                                name: "healer",
                                propertyRegex: "grn:.*",
                                options: new \Gs2Cdk\Formation\Model\Options\SlotModelOptions(
                                    metadata: "HEALER",
                                ),
                            ),
                            new \Gs2Cdk\Formation\Model\SlotModel(
                                name: "dps_1",
                                propertyRegex: "grn:.*",
                                options: new \Gs2Cdk\Formation\Model\Options\SlotModelOptions(
                                    metadata: "DPS",
                                ),
                            ),
                            new \Gs2Cdk\Formation\Model\SlotModel(
                                name: "dps_2",
                                propertyRegex: "grn:.*",
                                options: new \Gs2Cdk\Formation\Model\Options\SlotModelOptions(
                                    metadata: "DPS",
                                ),
                            ),
                        ],
                        options: new \Gs2Cdk\Formation\Model\Options\FormModelOptions(
                            metadata: "PARTY",
                        ),
                    ),
                    options: new \Gs2Cdk\Formation\Model\Options\MoldModelOptions(
                        metadata:"PARTY"
                    )
                ),
                new \Gs2Cdk\Formation\Model\MoldModel(
                    name:"equipment",
                    initialMaxCapacity:20,
                    maxCapacity:30,
                    formModel:new \Gs2Cdk\Formation\Model\FormModel(
                        name: "equipment",
                        slots: [
                            new \Gs2Cdk\Formation\Model\SlotModel(
                                name: "head",
                                propertyRegex: "grn:.*",
                                options: new \Gs2Cdk\Formation\Model\Options\SlotModelOptions(
                                    metadata: "HEAD",
                                ),
                            ),
                            new \Gs2Cdk\Formation\Model\SlotModel(
                                name: "body",
                                propertyRegex: "grn:.*",
                                options: new \Gs2Cdk\Formation\Model\Options\SlotModelOptions(
                                    metadata: "BODY",
                                ),
                            ),
                            new \Gs2Cdk\Formation\Model\SlotModel(
                                name: "leg",
                                propertyRegex: "grn:.*",
                                options: new \Gs2Cdk\Formation\Model\Options\SlotModelOptions(
                                    metadata: "LEG",
                                ),
                            ),
                        ],
                        options: new \Gs2Cdk\Formation\Model\Options\FormModelOptions(
                            metadata: "EQUIPMENT",
                        ),
                    ),
                    options: new \Gs2Cdk\Formation\Model\Options\MoldModelOptions(
                        metadata:"EQUIPMENT"
                    )
                )
            ],
            [
            ]
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template

```

**Java**
```java

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.formation.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.formation.model.MoldModel(
                    "party",
                    10,
                    20,
                    new io.gs2.cdk.formation.model.FormModel(
                        "party",
                        Arrays.asList(
                            new io.gs2.cdk.formation.model.SlotModel(
                                "tank",
                                "grn:.*",
                                new io.gs2.cdk.formation.model.options.SlotModelOptions()
                                    .withMetadata("TANK")
                            ),
                            new io.gs2.cdk.formation.model.SlotModel(
                                "healer",
                                "grn:.*",
                                new io.gs2.cdk.formation.model.options.SlotModelOptions()
                                    .withMetadata("HEALER")
                            ),
                            new io.gs2.cdk.formation.model.SlotModel(
                                "dps_1",
                                "grn:.*",
                                new io.gs2.cdk.formation.model.options.SlotModelOptions()
                                    .withMetadata("DPS")
                            ),
                            new io.gs2.cdk.formation.model.SlotModel(
                                "dps_2",
                                "grn:.*",
                                new io.gs2.cdk.formation.model.options.SlotModelOptions()
                                    .withMetadata("DPS")
                            )
                        ),
                        new io.gs2.cdk.formation.model.options.FormModelOptions()
                            .withMetadata("PARTY")
                    ),
                    new io.gs2.cdk.formation.model.options.MoldModelOptions()
                        .withMetadata("PARTY")
                ),
                new io.gs2.cdk.formation.model.MoldModel(
                    "equipment",
                    20,
                    30,
                    new io.gs2.cdk.formation.model.FormModel(
                        "equipment",
                        Arrays.asList(
                            new io.gs2.cdk.formation.model.SlotModel(
                                "head",
                                "grn:.*",
                                new io.gs2.cdk.formation.model.options.SlotModelOptions()
                                    .withMetadata("HEAD")
                            ),
                            new io.gs2.cdk.formation.model.SlotModel(
                                "body",
                                "grn:.*",
                                new io.gs2.cdk.formation.model.options.SlotModelOptions()
                                    .withMetadata("BODY")
                            ),
                            new io.gs2.cdk.formation.model.SlotModel(
                                "leg",
                                "grn:.*",
                                new io.gs2.cdk.formation.model.options.SlotModelOptions()
                                    .withMetadata("LEG")
                            )
                        ),
                        new io.gs2.cdk.formation.model.options.FormModelOptions()
                            .withMetadata("EQUIPMENT")
                    ),
                    new io.gs2.cdk.formation.model.options.MoldModelOptions()
                        .withMetadata("EQUIPMENT")
                )
            ),
            Arrays.asList(
            )
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template

```

**C#**
```csharp

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Formation.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2Formation.Model.MoldModel[] {
                new Gs2Cdk.Gs2Formation.Model.MoldModel(
                    name: "party",
                    initialMaxCapacity: 10,
                    maxCapacity: 20,
                    formModel: new Gs2Cdk.Gs2Formation.Model.FormModel(
                        name: "party",
                        slots: new Gs2Cdk.Gs2Formation.Model.SlotModel[]
                        {
                            new Gs2Cdk.Gs2Formation.Model.SlotModel(
                                name: "tank",
                                propertyRegex: "grn:.*",
                                options: new Gs2Cdk.Gs2Formation.Model.Options.SlotModelOptions
                                {
                                    metadata = "TANK"
                                }
                            ),
                            new Gs2Cdk.Gs2Formation.Model.SlotModel(
                                name: "healer",
                                propertyRegex: "grn:.*",
                                options: new Gs2Cdk.Gs2Formation.Model.Options.SlotModelOptions
                                {
                                    metadata = "HEALER"
                                }
                            ),
                            new Gs2Cdk.Gs2Formation.Model.SlotModel(
                                name: "dps_1",
                                propertyRegex: "grn:.*",
                                options: new Gs2Cdk.Gs2Formation.Model.Options.SlotModelOptions
                                {
                                    metadata = "DPS"
                                }
                            ),
                            new Gs2Cdk.Gs2Formation.Model.SlotModel(
                                name: "dps_2",
                                propertyRegex: "grn:.*",
                                options: new Gs2Cdk.Gs2Formation.Model.Options.SlotModelOptions
                                {
                                    metadata = "DPS"
                                }
                            )
                        },
                        options: new Gs2Cdk.Gs2Formation.Model.Options.FormModelOptions
                        {
                            metadata = "PARTY"
                        }
                    ),
                    options: new Gs2Cdk.Gs2Formation.Model.Options.MoldModelOptions
                    {
                        metadata = "PARTY"
                    }
                ),
                new Gs2Cdk.Gs2Formation.Model.MoldModel(
                    name: "equipment",
                    initialMaxCapacity: 20,
                    maxCapacity: 30,
                    formModel: new Gs2Cdk.Gs2Formation.Model.FormModel(
                        name: "equipment",
                        slots: new Gs2Cdk.Gs2Formation.Model.SlotModel[]
                        {
                            new Gs2Cdk.Gs2Formation.Model.SlotModel(
                                name: "head",
                                propertyRegex: "grn:.*",
                                options: new Gs2Cdk.Gs2Formation.Model.Options.SlotModelOptions
                                {
                                    metadata = "HEAD"
                                }
                            ),
                            new Gs2Cdk.Gs2Formation.Model.SlotModel(
                                name: "body",
                                propertyRegex: "grn:.*",
                                options: new Gs2Cdk.Gs2Formation.Model.Options.SlotModelOptions
                                {
                                    metadata = "BODY"
                                }
                            ),
                            new Gs2Cdk.Gs2Formation.Model.SlotModel(
                                name: "leg",
                                propertyRegex: "grn:.*",
                                options: new Gs2Cdk.Gs2Formation.Model.Options.SlotModelOptions
                                {
                                    metadata = "LEG"
                                }
                            )
                        },
                        options: new Gs2Cdk.Gs2Formation.Model.Options.FormModelOptions
                        {
                            metadata = "EQUIPMENT"
                        }
                    ),
                    options: new Gs2Cdk.Gs2Formation.Model.Options.MoldModelOptions
                    {
                        metadata = "EQUIPMENT"
                    }
                )
            },
            new Gs2Cdk.Gs2Formation.Model.PropertyFormModel[] {
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template

```

**TypeScript**
```typescript

import core from "@/gs2cdk/core";
import formation from "@/gs2cdk/formation";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new formation.model.Namespace(
            this,
            "namespace-0001",
        ).masterData(
            [
                new formation.model.MoldModel(
                    "party",
                    10,
                    20,
                    new formation.model.FormModel(
                        "party",
                        [
                            new formation.model.SlotModel(
                                "tank",
                                "grn:.*",
                                {
                                    metadata: "TANK"
                                }
                            ),
                            new formation.model.SlotModel(
                                "healer",
                                "grn:.*",
                                {
                                    metadata: "HEALER"
                                }
                            ),
                            new formation.model.SlotModel(
                                "dps_1",
                                "grn:.*",
                                {
                                    metadata: "DPS"
                                }
                            ),
                            new formation.model.SlotModel(
                                "dps_2",
                                "grn:.*",
                                {
                                    metadata: "DPS"
                                }
                            ),
                        ],
                        {
                            metadata: "PARTY"
                        }
                    ),
                    {
                        metadata: "PARTY"
                    }
                ),
                new formation.model.MoldModel(
                    "equipment",
                    20,
                    30,
                    new formation.model.FormModel(
                        "equipment",
                        [
                            new formation.model.SlotModel(
                                "head",
                                "grn:.*",
                                {
                                    metadata: "HEAD"
                                }
                            ),
                            new formation.model.SlotModel(
                                "body",
                                "grn:.*",
                                {
                                    metadata: "BODY"
                                }
                            ),
                            new formation.model.SlotModel(
                                "leg",
                                "grn:.*",
                                {
                                    metadata: "LEG"
                                }
                            ),
                        ],
                        {
                            metadata: "EQUIPMENT"
                        }
                    ),
                    {
                        metadata: "EQUIPMENT"
                    }
                )
            ],
            [
            ]
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template

```

**Python**
```python

from gs2_cdk import Stack, core, formation

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        formation.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            mold_models=[
                formation.MoldModel(
                    name='party',
                    initial_max_capacity=10,
                    max_capacity=20,
                    form_model=formation.FormModel(
                        name='party',
                        slots=[
                            formation.SlotModel(
                                name='tank',
                                property_regex='grn:.*',
                                options=formation.SlotModelOptions(
                                    metadata='TANK',
                                ),
                            ),
                            formation.SlotModel(
                                name='healer',
                                property_regex='grn:.*',
                                options=formation.SlotModelOptions(
                                    metadata='HEALER',
                                ),
                            ),
                            formation.SlotModel(
                                name='dps_1',
                                property_regex='grn:.*',
                                options=formation.SlotModelOptions(
                                    metadata='DPS',
                                ),
                            ),
                            formation.SlotModel(
                                name='dps_2',
                                property_regex='grn:.*',
                                options=formation.SlotModelOptions(
                                    metadata='DPS',
                                ),
                            ),
                        ],
                        options=formation.FormModelOptions(
                            metadata='PARTY',
                        ),
                    ),
                    options=formation.MoldModelOptions(
                        metadata = 'PARTY'
                    ),
                ),
                formation.MoldModel(
                    name='equipment',
                    initial_max_capacity=20,
                    max_capacity=30,
                    form_model=formation.FormModel(
                        name='equipment',
                        slots=[
                            formation.SlotModel(
                                name='head',
                                property_regex='grn:.*',
                                options=formation.SlotModelOptions(
                                    metadata='HEAD',
                                ),
                            ),
                            formation.SlotModel(
                                name='body',
                                property_regex='grn:.*',
                                options=formation.SlotModelOptions(
                                    metadata='BODY',
                                ),
                            ),
                            formation.SlotModel(
                                name='leg',
                                property_regex='grn:.*',
                                options=formation.SlotModelOptions(
                                    metadata='LEG',
                                ),
                            ),
                        ],
                        options=formation.FormModelOptions(
                            metadata='EQUIPMENT',
                        ),
                    ),
                    options=formation.MoldModelOptions(
                        metadata = 'EQUIPMENT'
                    ),
                ),
            ],
            property_form_models=[
            ],
        )

print(SampleStack().yaml())  # Generate Template

```


#### FormModel

フォームモデル<br>

フォームモデルは編成状況を表すエンティティです。<br>
編成できる領域として `スロット` を定義できます。<br>

武器・防具 であれば 「右手」「左手」「胴」「腕」のような部位をスロットとし、<br>
パーティであれば「前衛」「中衛」「後衛」のようなポジションをスロットとして表現できます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| formModelId | string |  | ※ |  |  ~ 1024文字 | フォームモデルGRN<br>※ サーバーが自動で設定 |
| name | string |  | ✓ |  |  ~ 128文字 | フォームモデル名<br>フォームモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| metadata | string |  |  |  |  ~ 2048文字 | メタデータ<br>メタデータには任意の値を設定できます。<br>これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| slots | [List&lt;SlotModel&gt;](#slotmodel) |  | ✓ |  | 1 ~ 10 items | スロットモデルリスト<br>このフォームを構成するスロット定義の順序付きリストです。各スロットは割り当て可能なポジションを表し、スロット名はフォーム内で一意である必要があります。装備では「weapon」「armor」「accessory」のようなスロット、パーティでは「position_1」「position_2」のようなスロットが考えられます。 |

#### SlotModel

スロットモデル<br>

フォームモデル内の1つのスロットを定義します。スロットはゲームリソース（アイテム、キャラクター、装備など）を配置できる割り当て可能なポジションを表します。プロパティの正規表現によってスロットに設定可能な値が検証されます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| name | string |  | ✓ |  |  ~ 128文字 | スロットモデル名<br>フォームモデル内でこのスロットを一意に識別する名前です。装備フォームでは「right_hand」「body」のような名前が、パーティフォームでは「vanguard」「rear_guard」のような名前が一般的です。 |
| propertyRegex | string |  |  | ".*" |  ~ 512文字 | プロパティとして設定可能な値の正規表現<br>このスロットに割り当て可能なプロパティ ID 値を検証する正規表現パターンです。例えば、特定の GS2-Inventory アイテム GRN や GS2-Dictionary エントリー GRN に制限することができます。デフォルトは ".*" で任意の値を許可します。 |
| metadata | string |  |  |  |  ~ 512文字 | メタデータ<br>メタデータには任意の値を設定できます。<br>これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |

#### MoldModel

フォームの保存領域モデル<br>

フォームの保存領域モデルは、パーティ編成であれば「火属性パーティ」「水属性パーティ」のような形で保存することを想定しています。<br>
保存できる領域の数は制限することができ、個別に拡張することもできます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| moldModelId | string |  | ※ |  |  ~ 1024文字 | フォームの保存領域GRN<br>※ サーバーが自動で設定 |
| name | string |  | ✓ |  |  ~ 128文字 | フォームの保存領域モデルの名前<br>フォームの保存領域モデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| metadata | string |  |  |  |  ~ 2048文字 | メタデータ<br>メタデータには任意の値を設定できます。<br>これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| initialMaxCapacity | int |  | ✓ |  | 1 ~ 2147483646 | フォームを保存できる初期キャパシティ<br>この保存領域で各プレイヤーが利用できるデフォルトのフォーム保存スロット数です。例えば 3 に設定すると、プレイヤーは初期状態で最大 3 つの異なる編成（例:「火属性パーティ」「水属性パーティ」「風属性パーティ」）を保存できます。プレイヤーごとに maxCapacity まで拡張可能です。 |
| maxCapacity | int |  | ✓ |  | 1 ~ 2147483646 | フォームを保存できる最大キャパシティ<br>この保存領域でプレイヤーごとのフォーム保存スロット数の絶対的な上限です。キャパシティ拡張操作を行っても、キャパシティはこの値を超えることはできません。initialMaxCapacity 以上の値である必要があります。 |
| formModel | [FormModel](#formmodel) |  | ✓ |  |  | フォームモデル |

#### PropertyFormModel

プロパティフォームモデル<br>

プロパティフォームモデルは編成状況を表すエンティティです。<br>
Mold / Form との違いは、スロット数を定義して、各スロットに編成を記録するのが Mold / Form で、<br>
所有している装備に対してスキルを設定するような、数を事前に決めるのが難しい編成を表現するのに利用するのがプロパティフォームモデルです。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| propertyFormModelId | string |  | ※ |  |  ~ 1024文字 | プロパティフォームモデルGRN<br>※ サーバーが自動で設定 |
| name | string |  | ✓ |  |  ~ 128文字 | プロパティフォームモデル名<br>プロパティフォームモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| metadata | string |  |  |  |  ~ 2048文字 | メタデータ<br>メタデータには任意の値を設定できます。<br>これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| slots | [List&lt;SlotModel&gt;](#slotmodel) |  | ✓ |  | 1 ~ 10 items | スロットモデルリスト<br>このプロパティフォームのスロット定義の順序付きリストです。キャパシティでフォーム数が制限される Mold/Form とは異なり、プロパティフォームはプロパティ ID で識別され、所有するリソースごとに存在できます。スロット名はフォーム内で一意である必要があります。 |

---