> 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>

스크립트 실행 방식은 크게 두 가지로, 바로 "동기 실행"과 "비동기 실행"입니다.<br>
동기 실행은 스크립트 실행이 완료될 때까지 처리가 블록됩니다.<br>
대신 스크립트 실행 결과를 이용하여 API 실행을 중단시키거나 API 응답 내용을 제어할 수 있습니다.<br>

한편, 비동기 실행에서는 스크립트 완료를 기다리기 위해 처리가 블록되는 일이 없습니다.<br>
다만 스크립트 실행 결과를 이용하여 API 실행을 중단하거나 API 응답 내용을 변경할 수는 없습니다.<br>
비동기 실행은 API의 응답 흐름에 영향을 주지 않으므로 원칙적으로 비동기 실행을 권장합니다.<br>

비동기 실행에는 실행 방식이 두 가지 있으며, GS2-Script와 Amazon EventBridge가 있습니다.<br>
Amazon EventBridge를 사용함으로써 Lua 이외의 언어로 처리를 작성할 수 있습니다.

|  | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| triggerScriptId | string |  |  |  |  ~ 1024자 | API 실행 시 동기적으로 실행되는 GS2-Script의 스크립트GRN<br>"grn:gs2:"로 시작하는 GRN 형식의 ID로 지정해야 합니다. |
| doneTriggerTargetType | 문자열 열거형<br>enum {<br>"none",<br>"gs2_script",<br>"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 파일을 출력하는 방식으로도 서비스를 이용할 수 있습니다.
**ℹ️ Note**

JSON 파일 형식에 대해서는 [GS2-Formation 마스터 데이터 레퍼런스](api_reference/formation/master_data/)를 참조해 주세요.

#### Request

리소스 생성・갱신 요청

|  | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128자 | 네임스페이스 이름<br>네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다. |
| mode | 문자열 열거형<br>enum {<br>"direct",<br>"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>

폼 모델 내의 하나의 슬롯을 정의합니다. 슬롯은 게임 리소스(아이템, 캐릭터, 장비 등)를 배치할 수 있는 할당 가능한 포지션을 나타냅니다. 프로퍼티 정규 표현식에 의해 슬롯에 설정 가능한 값이 검증됩니다.

|  | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| 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로 식별되며 보유하는 리소스마다 존재할 수 있습니다. 슬롯 이름은 폼 내에서 고유해야 합니다. |

---