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

# GS2-Version Deploy/CDK 레퍼런스

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




## 엔티티

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

### Namespace

네임스페이스<br>

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

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

#### Request

리소스 생성・갱신 요청

|  | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| name | string |  | ✓|  |  ~ 128자 | 네임스페이스 이름<br>네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다. |
| description | string |  | |  |  ~ 1024자 | 설명문 |
| transactionSetting | [TransactionSetting](#transactionsetting) |  | |  |  | 트랜잭션 설정<br>버전 체크 작업 시 트랜잭션 처리 방법을 제어하는 설정입니다. |
| assumeUserId | string |  | ✓|  |  ~ 1024자 | 버전 체크를 통과한 경우 승격되는 GS2-Identifier 사용자 GRN<br>버전 체크가 통과했을 때 권한을 이어받는 GS2-Identifier 사용자입니다. 버전 검증이 성공한 후, 시스템이 사용자를 대신하여 인가된 작업(액세스 부여 등)을 수행할 수 있도록 합니다. |
| acceptVersionScript | [ScriptSetting](#scriptsetting) |  | |  |  | 버전을 승인했을 때 실행할 스크립트 설정<br>Script 트리거 레퍼런스 - [`acceptVersion`](../script/#acceptversion) |
| checkVersionTriggerScriptId | string |  | |  |  ~ 1024자 | 버전 체크 처리를 실행하는 GS2-Script 스크립트 GRN<br>Script 트리거 레퍼런스 - [`checkVersion`](../script/#checkversion) |
| logSetting | [LogSetting](#logsetting) |  | |  |  | 로그 출력 설정<br>버전 체크 및 버전 승인 작업에 관한 API 요청·응답 로그를 출력할 GS2-Log 네임스페이스를 지정합니다. |

#### GetAttr

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

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

#### 구현 예제




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

Type: GS2::Version::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSetting: null
  AssumeUserId: grn:gs2::YourOwnerId:identifier:user:user-0001
  AcceptVersionScript: null
  CheckVersionTriggerScriptId: 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/version"
)


SampleStack := core.NewStack()
version.NewNamespace(
    &SampleStack,
    "namespace-0001",
    "grn:gs2::YourOwnerId:identifier:user:user-0001",
    version.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\Version\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            assumeUserId: "grn:gs2::YourOwnerId:identifier:user:user-0001",
            options: new \Gs2Cdk\Version\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.version.model.Namespace(
                this,
                "namespace-0001",
                "grn:gs2::YourOwnerId:identifier:user:user-0001",
                new io.gs2.cdk.version.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.Gs2Version.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            assumeUserId: "grn:gs2::YourOwnerId:identifier:user:user-0001",
            options: new Gs2Cdk.Gs2Version.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 version from "@/gs2cdk/version";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new version.model.Namespace(
            this,
            "namespace-0001",
            "grn:gs2::YourOwnerId:identifier:user:user-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, version

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        version.Namespace(
            stack=self,
            name='namespace-0001',
            assume_user_id='grn:gs2::YourOwnerId:identifier:user:user-0001',
            options=version.NamespaceOptions(
                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로 지정해야 합니다. |

---

### CurrentVersionMaster

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

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

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

JSON 파일 형식에 대해서는 [GS2-Version 마스터 데이터 레퍼런스](api_reference/version/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 | [CurrentVersionMaster](../sdk#currentversionmaster) | 갱신된 현재 활성화된 버전 모델의 마스터 데이터

#### 구현 예제




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

Type: GS2::Version::CurrentVersionMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  Settings: {
    "version": "2019-10-09",
    "versionModels": [
      {
        "name": "app",
        "scope": "passive",
        "type": "simple",
        "metadata": "APP",
        "warningVersion":
          {
            "major": 2,
            "minor": 2,
            "micro": 2
          },
        "errorVersion":
          {
            "major": 1,
            "minor": 1,
            "micro": 1
          }
      },
      {
        "name": "asset",
        "scope": "passive",
        "type": "simple",
        "metadata": "ASSET",
        "warningVersion":
          {
            "major": 3,
            "minor": 3,
            "micro": 3
          },
        "errorVersion":
          {
            "major": 2,
            "minor": 2,
            "micro": 2
          },
        "needSignature": true,
        "signatureKeyId": "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
      },
      {
        "name": "eula",
        "scope": "active",
        "type": "simple",
        "metadata": "EULA",
        "currentVersion":
          {
            "major": 2,
            "minor": 2,
            "micro": 2
          },
        "warningVersion":
          {
            "major": 4,
            "minor": 4,
            "micro": 4
          },
        "errorVersion":
          {
            "major": 3,
            "minor": 3,
            "micro": 3
          }
      }
    ]
  }
  UploadToken: null

```

**Go**
```go

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


SampleStack := core.NewStack()
version.NewNamespace(
    &SampleStack,
    "namespace-0001",
    "user-0001",
    version.NamespaceOptions{},
).MasterData(
    []version.VersionModel{
        version.NewVersionModel(
            "app",
            version.VersionModelScopePassive,
            version.VersionModelTypeSimple,
            version.VersionModelOptions{
                Metadata: pointy.String("APP"),
                WarningVersion: &version.Version{
                    Major: 2,
                    Minor: 2,
                    Micro: 2,
                },
                ErrorVersion: &version.Version{
                    Major: 1,
                    Minor: 1,
                    Micro: 1,
                },
            },
        ),
        version.NewVersionModel(
            "asset",
            version.VersionModelScopePassive,
            version.VersionModelTypeSimple,
            version.VersionModelOptions{
                Metadata: pointy.String("ASSET"),
                WarningVersion: &version.Version{
                    Major: 3,
                    Minor: 3,
                    Micro: 3,
                },
                ErrorVersion: &version.Version{
                    Major: 2,
                    Minor: 2,
                    Micro: 2,
                },
                NeedSignature: pointy.Bool(true),
                SignatureKeyId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"),
            },
        ),
        version.NewVersionModel(
            "eula",
            version.VersionModelScopeActive,
            version.VersionModelTypeSimple,
            version.VersionModelOptions{
                Metadata: pointy.String("EULA"),
                CurrentVersion: &version.Version{
                    Major: 2,
                    Minor: 2,
                    Micro: 2,
                },
                WarningVersion: &version.Version{
                    Major: 4,
                    Minor: 4,
                    Micro: 4,
                },
                ErrorVersion: &version.Version{
                    Major: 3,
                    Minor: 3,
                    Micro: 3,
                },
            },
        ),
    },
)

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

```

**PHP**
```php

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Version\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            assumeUserId: "user-0001"
        ))->masterData(
            [
                new \Gs2Cdk\Version\Model\VersionModel(
                    name:"app",
                    scope: \Gs2Cdk\Version\Model\Enums\VersionModelScope::PASSIVE,
                    type: \Gs2Cdk\Version\Model\Enums\VersionModelType::SIMPLE,
                    options: new \Gs2Cdk\Version\Model\Options\VersionModelOptions(
                        metadata:"APP",
                        warningVersion:new \Gs2Cdk\Version\Model\Version(
                            major: 2,
                            minor: 2,
                            micro: 2,
                        ),
                        errorVersion:new \Gs2Cdk\Version\Model\Version(
                            major: 1,
                            minor: 1,
                            micro: 1,
                        )
                    )
                ),
                new \Gs2Cdk\Version\Model\VersionModel(
                    name:"asset",
                    scope: \Gs2Cdk\Version\Model\Enums\VersionModelScope::PASSIVE,
                    type: \Gs2Cdk\Version\Model\Enums\VersionModelType::SIMPLE,
                    options: new \Gs2Cdk\Version\Model\Options\VersionModelOptions(
                        metadata:"ASSET",
                        warningVersion:new \Gs2Cdk\Version\Model\Version(
                            major: 3,
                            minor: 3,
                            micro: 3,
                        ),
                        errorVersion:new \Gs2Cdk\Version\Model\Version(
                            major: 2,
                            minor: 2,
                            micro: 2,
                        ),
                        needSignature:true,
                        signatureKeyId:"grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
                    )
                ),
                new \Gs2Cdk\Version\Model\VersionModel(
                    name:"eula",
                    scope: \Gs2Cdk\Version\Model\Enums\VersionModelScope::ACTIVE,
                    type: \Gs2Cdk\Version\Model\Enums\VersionModelType::SIMPLE,
                    options: new \Gs2Cdk\Version\Model\Options\VersionModelOptions(
                        metadata:"EULA",
                        currentVersion:new \Gs2Cdk\Version\Model\Version(
                            major: 2,
                            minor: 2,
                            micro: 2,
                        ),
                        warningVersion:new \Gs2Cdk\Version\Model\Version(
                            major: 4,
                            minor: 4,
                            micro: 4,
                        ),
                        errorVersion:new \Gs2Cdk\Version\Model\Version(
                            major: 3,
                            minor: 3,
                            micro: 3,
                        )
                    )
                )
            ]
        );
    }
}

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

```

**Java**
```java

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.version.model.Namespace(
            this,
            "namespace-0001",
            "user-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.version.model.VersionModel(
                    "app",
                    io.gs2.cdk.version.model.enums.VersionModelScope.PASSIVE,
                    io.gs2.cdk.version.model.enums.VersionModelType.SIMPLE,
                    new io.gs2.cdk.version.model.options.VersionModelOptions()
                        .withMetadata("APP")
                        .withWarningVersion(new io.gs2.cdk.version.model.Version(
                            2,
                            2,
                            2
                        ))
                        .withErrorVersion(new io.gs2.cdk.version.model.Version(
                            1,
                            1,
                            1
                        ))
                ),
                new io.gs2.cdk.version.model.VersionModel(
                    "asset",
                    io.gs2.cdk.version.model.enums.VersionModelScope.PASSIVE,
                    io.gs2.cdk.version.model.enums.VersionModelType.SIMPLE,
                    new io.gs2.cdk.version.model.options.VersionModelOptions()
                        .withMetadata("ASSET")
                        .withWarningVersion(new io.gs2.cdk.version.model.Version(
                            3,
                            3,
                            3
                        ))
                        .withErrorVersion(new io.gs2.cdk.version.model.Version(
                            2,
                            2,
                            2
                        ))
                        .withNeedSignature(true)
                        .withSignatureKeyId("grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001")
                ),
                new io.gs2.cdk.version.model.VersionModel(
                    "eula",
                    io.gs2.cdk.version.model.enums.VersionModelScope.ACTIVE,
                    io.gs2.cdk.version.model.enums.VersionModelType.SIMPLE,
                    new io.gs2.cdk.version.model.options.VersionModelOptions()
                        .withMetadata("EULA")
                        .withCurrentVersion(new io.gs2.cdk.version.model.Version(
                            2,
                            2,
                            2
                        ))
                        .withWarningVersion(new io.gs2.cdk.version.model.Version(
                            4,
                            4,
                            4
                        ))
                        .withErrorVersion(new io.gs2.cdk.version.model.Version(
                            3,
                            3,
                            3
                        ))
                )
            )
        );
    }
}

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

```

**C#**
```csharp

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Version.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            assumeUserId: "user-0001"
        ).MasterData(
            new Gs2Cdk.Gs2Version.Model.VersionModel[] {
                new Gs2Cdk.Gs2Version.Model.VersionModel(
                    name: "app",
                    scope: Gs2Cdk.Gs2Version.Model.Enums.VersionModelScope.Passive,
                    type: Gs2Cdk.Gs2Version.Model.Enums.VersionModelType.Simple,
                    options: new Gs2Cdk.Gs2Version.Model.Options.VersionModelOptions
                    {
                        metadata = "APP",
                        warningVersion = new Gs2Cdk.Gs2Version.Model.Version_(
                            major: 2,
                            minor: 2,
                            micro: 2
                        ),
                        errorVersion = new Gs2Cdk.Gs2Version.Model.Version_(
                            major: 1,
                            minor: 1,
                            micro: 1
                        )
                    }
                ),
                new Gs2Cdk.Gs2Version.Model.VersionModel(
                    name: "asset",
                    scope: Gs2Cdk.Gs2Version.Model.Enums.VersionModelScope.Passive,
                    type: Gs2Cdk.Gs2Version.Model.Enums.VersionModelType.Simple,
                    options: new Gs2Cdk.Gs2Version.Model.Options.VersionModelOptions
                    {
                        metadata = "ASSET",
                        warningVersion = new Gs2Cdk.Gs2Version.Model.Version_(
                            major: 3,
                            minor: 3,
                            micro: 3
                        ),
                        errorVersion = new Gs2Cdk.Gs2Version.Model.Version_(
                            major: 2,
                            minor: 2,
                            micro: 2
                        ),
                        needSignature = true,
                        signatureKeyId = "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
                    }
                ),
                new Gs2Cdk.Gs2Version.Model.VersionModel(
                    name: "eula",
                    scope: Gs2Cdk.Gs2Version.Model.Enums.VersionModelScope.Active,
                    type: Gs2Cdk.Gs2Version.Model.Enums.VersionModelType.Simple,
                    options: new Gs2Cdk.Gs2Version.Model.Options.VersionModelOptions
                    {
                        metadata = "EULA",
                        currentVersion = new Gs2Cdk.Gs2Version.Model.Version_(
                            major: 2,
                            minor: 2,
                            micro: 2
                        ),
                        warningVersion = new Gs2Cdk.Gs2Version.Model.Version_(
                            major: 4,
                            minor: 4,
                            micro: 4
                        ),
                        errorVersion = new Gs2Cdk.Gs2Version.Model.Version_(
                            major: 3,
                            minor: 3,
                            micro: 3
                        )
                    }
                )
            }
        );
    }
}

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

```

**TypeScript**
```typescript

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new version.model.Namespace(
            this,
            "namespace-0001",
            "user-0001",
        ).masterData(
            [
                new version.model.VersionModel(
                    "app",
                    version.model.VersionModelScope.PASSIVE,
                    version.model.VersionModelType.SIMPLE,
                    {
                        metadata: "APP",
                        warningVersion: new version.model.Version(
                            2,
                            2,
                            2
                        ),
                        errorVersion: new version.model.Version(
                            1,
                            1,
                            1
                        )
                    }
                ),
                new version.model.VersionModel(
                    "asset",
                    version.model.VersionModelScope.PASSIVE,
                    version.model.VersionModelType.SIMPLE,
                    {
                        metadata: "ASSET",
                        warningVersion: new version.model.Version(
                            3,
                            3,
                            3
                        ),
                        errorVersion: new version.model.Version(
                            2,
                            2,
                            2
                        ),
                        needSignature: true,
                        signatureKeyId: "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
                    }
                ),
                new version.model.VersionModel(
                    "eula",
                    version.model.VersionModelScope.ACTIVE,
                    version.model.VersionModelType.SIMPLE,
                    {
                        metadata: "EULA",
                        currentVersion: new version.model.Version(
                            2,
                            2,
                            2
                        ),
                        warningVersion: new version.model.Version(
                            4,
                            4,
                            4
                        ),
                        errorVersion: new version.model.Version(
                            3,
                            3,
                            3
                        )
                    }
                )
            ]
        );
    }
}

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

```

**Python**
```python

from gs2_cdk import Stack, core, version

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        version.Namespace(
            stack=self,
            name="namespace-0001",
            assume_user_id="user-0001"
        ).master_data(
            version_models=[
                version.VersionModel(
                    name='app',
                    scope=version.VersionModelScope.PASSIVE,
                    type=version.VersionModelType.SIMPLE,
                    options=version.VersionModelOptions(
                        metadata = 'APP',
                        warning_version = version.Version(
                            major=2,
                            minor=2,
                            micro=2,        
                        ),
                        error_version = version.Version(
                            major=1,
                            minor=1,
                            micro=1,        
                        )
                    ),
                ),
                version.VersionModel(
                    name='asset',
                    scope=version.VersionModelScope.PASSIVE,
                    type=version.VersionModelType.SIMPLE,
                    options=version.VersionModelOptions(
                        metadata = 'ASSET',
                        warning_version = version.Version(
                            major=3,
                            minor=3,
                            micro=3,        
                        ),
                        error_version = version.Version(
                            major=2,
                            minor=2,
                            micro=2,        
                        ),
                        need_signature = True,
                        signature_key_id = 'grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001'
                    ),
                ),
                version.VersionModel(
                    name='eula',
                    scope=version.VersionModelScope.ACTIVE,
                    type=version.VersionModelType.SIMPLE,
                    options=version.VersionModelOptions(
                        metadata = 'EULA',
                        current_version = version.Version(
                            major=2,
                            minor=2,
                            micro=2,        
                        ),
                        warning_version = version.Version(
                            major=4,
                            minor=4,
                            micro=4,        
                        ),
                        error_version = version.Version(
                            major=3,
                            minor=3,
                            micro=3,        
                        )
                    ),
                ),
            ],
        )

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

```


#### VersionModel

버전 모델<br>

버전 모델에는 로그인은 허용하지만 버전 업그레이드가 가능함을 알리는 경고 버전과, 로그인을 허용하지 않는 에러 버전을 설정할 수 있습니다.<br>

현재 버전을 클라이언트에 신고하도록 할 때, 서명 유무를 지정할 수 있습니다.<br>
서명 있음을 선택한 경우, 클라이언트는 허위 버전을 신고할 수 없게 됩니다.

|  | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| versionModelId | string |  | ※ |  |  ~ 1024자 | 버전 모델 GRN<br>※ 서버가 자동으로 설정 |
| name | string |  | ✓ |  |  ~ 128자 | 버전 모델 이름<br>버전 모델 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다. |
| metadata | string |  |  |  |  ~ 2048자 | 메타데이터<br>메타데이터에는 임의의 값을 설정할 수 있습니다.<br>이 값들은 GS2의 동작에는 영향을 주지 않으므로, 게임 내에서 사용하는 정보를 저장하는 용도로 사용할 수 있습니다. |
| scope | 문자열 열거형<br>enum {<br>"passive",<br>"active"<br>}<br> |  | ✓ |  |  | 판정에 사용할 버전 값의 종류<br>버전 체크에 사용할 버전 값을 얻는 방법을 결정합니다. "passive"는 체크 시점에 클라이언트가 현재 버전을 신고하는 방식이며, "active"는 사용자가 과거에 명시적으로 승인한 버전(이용약관 동의 등)을 사용하는 방식입니다.passive: 클라이언트에서 전송 / active: 과거 명시적으로 승인한 버전 /  |
| type | 문자열 열거형<br>enum {<br>"simple",<br>"schedule"<br>}<br> |  |  | "simple" |  | 버전 체크 모드<br>버전 체크 방식을 선택합니다. "simple"은 고정된 경고·에러 버전 임계값을 사용하며, "schedule"은 GS2-Schedule의 이벤트를 이용하여 시기에 따라 다른 버전 임계값을 적용합니다.simple: 심플 / schedule: 시계열 전환 /  |
| currentVersion | [Version](#version) | {type} == "simple" and {scope} == "active" | ✓※ |  |  | 현재 버전<br>이 버전 모델의 최신 버전입니다. "simple" 모드의 "active" 스코프에서만 사용되며, 사용자가 버전 업데이트를 승인·확인할 때 현재 버전을 알립니다.<br>※ type이(가) "simple"이고 scope이(가) "active" 이면 필수 |
| warningVersion | [Version](#version) | {type} == "simple" | ✓※ |  |  | 버전 업그레이드를 촉구하는 버전<br>업그레이드 알림을 표시하는 최소 버전 임계값입니다. 클라이언트의 버전이 이 값보다 낮은 경우에도 로그인은 허용되지만 사용자에게 업그레이드가 권장됩니다. 비교는 메이저, 마이너, 마이크로 순으로 계층적으로 수행됩니다.<br>※ type이(가) "simple" 이면 필수 |
| errorVersion | [Version](#version) | {type} == "simple" | ✓※ |  |  | 버전 체크에서 에러로 판정되는 버전<br>로그인을 허용하는 최소 버전 임계값입니다. 클라이언트의 버전이 이 값보다 낮으면 버전 체크가 에러로 판정되어 로그인이 차단됩니다. 비교는 메이저, 마이너, 마이크로 순으로 계층적으로 수행됩니다.<br>※ type이(가) "simple" 이면 필수 |
| scheduleVersions | [List&lt;ScheduleVersion&gt;](#scheduleversion) | {type} == "schedule" |  |  | 0 ~ 10 items | 시계열로 전환되는 버전 체크 내용 목록<br>GS2-Schedule의 이벤트를 기준으로 서로 다른 시점에 유효해지는 버전 체크 설정 목록입니다. 업데이트를 필수로 만들기 전에 경고를 표시하는 등 단계적인 버전 강제가 가능해집니다.<br>※ type이(가) "schedule" 이면 활성화 |
| needSignature | bool | {scope} == "passive" | ✓※ |  |  | 판정할 버전 값에 서명 검증이 필요한지 여부<br>활성화하면 클라이언트는 버전 신고와 함께 암호 서명을 제공해야 합니다. 이를 통해 클라이언트가 버전 체크를 회피하기 위해 허위 버전을 신고하는 것을 방지합니다. 스코프가 "passive"인 경우에만 적용됩니다.<br>※ scope이(가) "passive" 이면 필수 |
| signatureKeyId | string | {needSignature} | ✓※ |  |  ~ 1024자 | 암호화 키 GRN<br>※ needSignature이(가) "true" 이면 필수 |
| approveRequirement | 문자열 열거형<br>enum {<br>"required",<br>"optional"<br>}<br> | {scope} == "active" |  | "required" |  | 승인 필요 여부<br>이 버전 모델에 대한 사용자 승인이 필수인지 임의인지를 제어합니다. "required"인 경우, 사용자가 현재 버전을 승인하지 않으면 버전 체크가 실패합니다. "optional"인 경우, 승인 상태와 관계없이 버전 체크가 통과합니다. 스코프가 "active"인 경우에만 적용됩니다.required: 승인 필요 / optional: 임의 승인 / <br>※ scope이(가) "active" 이면 활성화 |

#### Version

버전<br>

3단계 계층(메이저, 마이너, 마이크로)으로 구성된 버전 번호를 나타냅니다. 버전 비교는 메이저, 마이너, 마이크로 순으로 계층적으로 수행됩니다. 버전 체크의 경고·에러 임계값 정의에 사용됩니다.

|  | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| major | int |  | ✓ |  | 0 ~ 2147483646 | 메이저 버전<br>버전 비교에서 가장 우선순위가 높은 구성 요소입니다. 메이저 버전의 차이는 마이너 버전 및 마이크로 버전보다 우선합니다. |
| minor | int |  | ✓ |  | 0 ~ 2147483646 | 마이너 버전<br>버전 비교에서 두 번째로 우선순위가 높은 구성 요소입니다. 메이저 버전이 동일한 경우에만 비교됩니다. |
| micro | int |  | ✓ |  | 0 ~ 2147483646 | 마이크로 버전<br>버전 비교에서 가장 우선순위가 낮은 구성 요소입니다. 메이저 버전과 마이너 버전이 모두 동일한 경우에만 비교됩니다. |

#### ScheduleVersion

시계열로 전환되는 버전<br>

GS2-Schedule의 이벤트로 제어되는 특정 기간 동안 유효해지는 버전 임계값(현재, 경고, 에러) 세트를 정의합니다. 여러 개의 스케줄 버전을 설정함으로써, 오래된 클라이언트를 차단하기 전에 사용자에게 경고하는 등 단계적인 버전 강제를 구현할 수 있습니다.

|  | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| currentVersion | [Version](#version) |  | ✓ |  |  | 현재 버전<br>이 스케줄 기간 동안 사용 가능한 최신 버전입니다. "active" 스코프에서 사용자가 업데이트를 승인할 때 현재 버전을 알리는 데 사용됩니다. |
| warningVersion | [Version](#version) |  | ✓ |  |  | 버전 업그레이드를 촉구하는 버전<br>이 스케줄 기간 동안 업그레이드 알림을 표시하는 최소 버전 임계값입니다. 로그인은 허용되지만 사용자에게 업그레이드가 권장됩니다. |
| errorVersion | [Version](#version) |  | ✓ |  |  | 버전 체크에서 에러로 판정되는 버전<br>이 스케줄 기간 동안 로그인을 허용하는 최소 버전 임계값입니다. 클라이언트의 버전이 이 값보다 낮으면 버전 체크가 에러로 판정되어 로그인이 차단됩니다. |
| scheduleEventId | string |  |  |  |  ~ 1024자 | 버전 체크를 활성화하는 GS2-Schedule 이벤트 GRN<br>이 버전 임계값 세트가 유효해지는 기간을 제어하는 GS2-Schedule의 이벤트를 지정합니다. 여기서 정의된 버전 체크 설정은 지정한 이벤트가 활성화되어 있는 기간에만 적용됩니다. |

---