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

# GS2-MegaField Deploy/CDK 레퍼런스

GS2-Deploy의 스택을 생성할 때 사용하는 템플릿 포맷과, CDK를 이용한 각종 언어의 템플릿 출력 구현 예제




## 엔티티

Deploy 처리에서 조작 대상이 되는 리소스

### Namespace

네임스페이스<br>

네임스페이스는 하나의 프로젝트 내에서 동일한 서비스를 서로 다른 용도로 여러 개 이용하기 위한 엔티티입니다.<br>
GS2의 각 서비스는 네임스페이스 단위로 관리됩니다. 네임스페이스가 다르면 동일한 서비스라도 완전히 독립된 데이터 공간으로 취급됩니다.<br>

따라서 각 서비스의 이용을 시작하려면 먼저 네임스페이스를 생성해야 합니다.

#### Request

리소스 생성・갱신 요청

|  | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| name | string |  | ✓|  |  ~ 128자 | 네임스페이스 이름<br>네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다. |
| description | string |  | |  |  ~ 1024자 | 설명 |
| logSetting | [LogSetting](#logsetting) |  | |  |  | 로그 출력 설정 |

#### GetAttr

[!GetAttr](/articles/tech/deploy/#getattr) 태그로 취득 가능한 리소스 생성 결과

| | 타입 | 설명 |
| --- | --- | --- |
| Item | [Namespace](../sdk#namespace) | 생성한 네임스페이스

#### 구현 예제




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

Type: GS2::MegaField::Namespace
Properties:
  Name: namespace-0001
  Description: 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/megaField"
)


SampleStack := core.NewStack()
megaField.NewNamespace(
    &SampleStack,
    "namespace-0001",
    megaField.NamespaceOptions{
        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\MegaField\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\MegaField\Model\Options\NamespaceOptions(
                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.megaField.model.Namespace(
                this,
                "namespace-0001",
                new io.gs2.cdk.megaField.model.options.NamespaceOptions()
                        .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.Gs2MegaField.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: new Gs2Cdk.Gs2MegaField.Model.Options.NamespaceOptions
            {
                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 megaField from "@/gs2cdk/megaField";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new megaField.model.Namespace(
            this,
            "namespace-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, mega_field

class SampleStack(Stack):

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

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

```


#### LogSetting

로그 출력 설정<br>

로그 데이터의 출력 설정을 관리합니다. 이 타입은 로그 데이터를 기록하는 데 사용되는 로그 네임스페이스의 식별자(Namespace ID)를 보유합니다.<br>
로그 네임스페이스 ID는 로그 데이터를 집계하여 저장할 대상 GS2-Log의 네임스페이스를 지정합니다.<br>
이 설정을 통해 이 네임스페이스 이하의 API 요청/응답 로그 데이터가 대상 GS2-Log로 출력됩니다.<br>
GS2-Log에서는 실시간으로 로그가 제공되며, 시스템 모니터링, 분석, 디버깅 등에 활용할 수 있습니다.

|  | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| loggingNamespaceId | string |  | ✓ |  |  ~ 1024자 | 로그를 출력할 GS2-Log의 네임스페이스GRN<br>"grn:gs2:"로 시작하는 GRN 형식의 ID로 지정해야 합니다. |

---

### CurrentFieldMaster

현재 활성화된 필드 모델의 마스터 데이터<br>

현재 네임스페이스 내에서 유효한 필드 모델의 정의를 기술한 마스터 데이터입니다.<br>
GS2에서는 마스터 데이터의 관리에 JSON 형식 파일을 사용합니다.<br>
파일을 업로드함으로써 실제로 서버에 설정을 반영할 수 있습니다.<br>

JSON 파일을 작성하는 방법으로, 매니지먼트 콘솔 내에 마스터 데이터 에디터를 제공하고 있습니다.<br>
또한 게임 운영에 더 적합한 툴을 직접 제작하여 적절한 형식의 JSON 파일을 출력하는 방식으로도 서비스를 이용할 수 있습니다.
**ℹ️ Note**

JSON 파일 형식에 대해서는 [GS2-MegaField 마스터 데이터 레퍼런스](api_reference/mega_field/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 | [CurrentFieldMaster](../sdk#currentfieldmaster) | 업데이트된 현재 활성화된 필드 모델의 마스터 데이터

#### 구현 예제




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

Type: GS2::MegaField::CurrentFieldMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  Settings: {
    "version": "2022-08-28",
    "areaModels": [
      {
        "name": "area-0001",
        "metadata": "AREA_0001",
        "layerModels": [
          {
            "name": "layer-0001",
            "metadata": "LAYER_0001"
          }
        ]
      }
    ]
  }
  UploadToken: null

```

**Go**
```go

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


SampleStack := core.NewStack()
megaField.NewNamespace(
    &SampleStack,
    "namespace-0001",
    megaField.NamespaceOptions{},
).MasterData(
    []megaField.AreaModel{
        megaField.NewAreaModel(
            "area-0001",
            megaField.AreaModelOptions{
                Metadata: pointy.String("AREA_0001"),
                LayerModels: []megaField.LayerModel{
                    megaField.NewLayerModel(
                        "layer-0001",
                        megaField.LayerModelOptions{
                            Metadata: pointy.String("LAYER_0001"),
                        },
                    ),
                },
            },
        ),
    },
)

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

```

**PHP**
```php

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\MegaField\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
                new \Gs2Cdk\MegaField\Model\AreaModel(
                    name:"area-0001",
                    options: new \Gs2Cdk\MegaField\Model\Options\AreaModelOptions(
                        metadata:"AREA_0001",
                        layerModels:[
                            new \Gs2Cdk\MegaField\Model\LayerModel(
                                name: "layer-0001",
                                options: new \Gs2Cdk\MegaField\Model\Options\LayerModelOptions(
                                    metadata: "LAYER_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.megaField.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.megaField.model.AreaModel(
                    "area-0001",
                    new io.gs2.cdk.megaField.model.options.AreaModelOptions()
                        .withMetadata("AREA_0001")
                        .withLayerModels(Arrays.asList(
                            new io.gs2.cdk.megaField.model.LayerModel(
                                "layer-0001",
                                new io.gs2.cdk.megaField.model.options.LayerModelOptions()
                                    .withMetadata("LAYER_0001")
                            )
                        ))
                )
            )
        );
    }
}

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

```

**C#**
```csharp

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2MegaField.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2MegaField.Model.AreaModel[] {
                new Gs2Cdk.Gs2MegaField.Model.AreaModel(
                    name: "area-0001",
                    options: new Gs2Cdk.Gs2MegaField.Model.Options.AreaModelOptions
                    {
                        metadata = "AREA_0001",
                        layerModels = new Gs2Cdk.Gs2MegaField.Model.LayerModel[]
                        {
                            new Gs2Cdk.Gs2MegaField.Model.LayerModel(
                                name: "layer-0001",
                                options: new Gs2Cdk.Gs2MegaField.Model.Options.LayerModelOptions
                                {
                                    metadata = "LAYER_0001"
                                }
                            )
                        }
                    }
                )
            }
        );
    }
}

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

```

**TypeScript**
```typescript

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new megaField.model.Namespace(
            this,
            "namespace-0001",
        ).masterData(
            [
                new megaField.model.AreaModel(
                    "area-0001",
                    {
                        metadata: "AREA_0001",
                        layerModels: [
                            new megaField.model.LayerModel(
                                "layer-0001",
                                {
                                    metadata: "LAYER_0001"
                                }
                            ),
                        ]
                    }
                )
            ]
        );
    }
}

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

```

**Python**
```python

from gs2_cdk import Stack, core, mega_field

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        mega_field.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            area_models=[
                mega_field.AreaModel(
                    name='area-0001',
                    options=mega_field.AreaModelOptions(
                        metadata = 'AREA_0001',
                        layer_models = [
                            mega_field.LayerModel(
                                name='layer-0001',
                                options=mega_field.LayerModelOptions(
                                    metadata='LAYER_0001',
                                ),
                            ),
                        ]
                    ),
                ),
            ],
        )

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

```


#### AreaModel

에어리어는 공간을 분할하는 것으로, 같은 좌표라도 에어리어가 다르면 별도의 공간으로 취급할 수 있습니다.

|  | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| areaModelId | string |  | ※ |  |  ~ 1024자 | 에어리어 모델 GRN<br>※ 서버가 자동으로 설정 |
| name | string |  | ✓ |  |  ~ 128자 | 에어리어 모델 이름 |
| metadata | string |  |  |  |  ~ 2048자 | 메타데이터<br>메타데이터에는 임의의 값을 설정할 수 있습니다.<br>이 값들은 GS2의 동작에는 영향을 주지 않으므로, 게임 내에서 사용하는 정보를 저장하는 용도로 사용할 수 있습니다. |
| layerModels | [List&lt;LayerModel&gt;](#layermodel) |  |  | [] | 0 ~ 1000 items | 레이어 모델 목록 |

#### LayerModel

레이어는 하나의 공간 내에서 여러 개의 논리적 계층을 구현합니다.<br>
예를 들어, 캐릭터가 대량으로 존재하는 공간에서 에너미가 보이지 않게 되는 문제를 해결합니다.<br>
레이어 1에는 캐릭터를 배치합니다. 레이어 2에 에너미를 배치한 경우, 레이어마다 지정한 거리 내에서의 취득 수량을 지정할 수 있으므로 보이지 않게 될 걱정이 없습니다.

|  | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| layerModelId | string |  | ※ |  |  ~ 1024자 | 레이어 모델 GRN<br>※ 서버가 자동으로 설정 |
| name | string |  | ✓ |  |  ~ 128자 | 레이어 모델 이름 |
| metadata | string |  |  |  |  ~ 2048자 | 메타데이터<br>메타데이터에는 임의의 값을 설정할 수 있습니다.<br>이 값들은 GS2의 동작에는 영향을 주지 않으므로, 게임 내에서 사용하는 정보를 저장하는 용도로 사용할 수 있습니다. |

---