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

# GS2-Idle Deploy/CDK 레퍼런스

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




## 엔티티

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

### Namespace

네임스페이스<br>

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

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

#### Request

리소스 생성・갱신 요청

|  | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| name | string |  | ✓|  |  ~ 128자 | 네임스페이스 이름<br>네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다. |
| description | string |  | |  |  ~ 1024자 | 설명문 |
| transactionSetting | [TransactionSetting](#transactionsetting) |  | ✓|  |  | 트랜잭션 설정<br>방치 보상 부여 시 트랜잭션의 처리 방법을 제어하는 설정입니다. |
| receiveScript | [ScriptSetting](#scriptsetting) |  | |  |  | 보상을 받았을 때 실행할 스크립트 설정<br>Script 트리거 레퍼런스 - [`receive`](../script/#receive) |
| overrideAcquireActionsScriptId | string |  | |  |  ~ 1024자 | 방치 보상의 입수 액션을 동적으로 결정하는 스크립트GRN<br>Script 트리거 레퍼런스 - [`overrideAcquireActions`](../script/#overrideacquireactions) |
| logSetting | [LogSetting](#logsetting) |  | |  |  | 로그 출력 설정<br>방치 보상 조작과 관련된 API 요청 및 응답 로그를 출력하기 위한 GS2-Log 네임스페이스를 지정합니다. 방치 스테이터스 생성, 보상 수취, 타이밍 문제 디버깅에 유용합니다. |

#### GetAttr

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

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

#### 구현 예제




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

Type: GS2::Idle::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSetting: 
    EnableAutoRun: true
    QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
  ReceiveScript: null
  OverrideAcquireActionsScriptId: 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/idle"
    "github.com/openlyinc/pointy"
)


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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new idle.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, idle

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        idle.Namespace(
            stack=self,
            name='namespace-0001',
            options=idle.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로 지정해야 합니다. |

---

### CurrentCategoryMaster

현재 활성화된 카테고리 모델의 마스터 데이터<br>

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

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

JSON 파일 형식에 대해서는 [GS2-Idle 마스터 데이터 레퍼런스](api_reference/idle/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 | [CurrentCategoryMaster](../sdk#currentcategorymaster) | 업데이트된 현재 활성화된 카테고리 모델의 마스터 데이터

#### 구현 예제




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

Type: GS2::Idle::CurrentCategoryMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  Settings: {
    "version": "2023-06-06",
    "categoryModels": [
      {
        "name": "category-0001",
        "rewardIntervalMinutes": 5,
        "defaultMaximumIdleMinutes": 1440,
        "rewardResetMode": "Reset",
        "acquireActions": [
          {
            "acquireActions": [
              {
                "action": "Gs2Experience:AddExperienceByUserId",
                "request": {
                  "namespaceName": "namespace-0001",
                  "experienceName": "player",
                  "userId": "#{userId}",
                  "propertyId": "player",
                  "experienceValue": 10
                }
              }
            ]
          },
          {
            "acquireActions": [
              {
                "action": "Gs2Experience:AddExperienceByUserId",
                "request": {
                  "namespaceName": "namespace-0001",
                  "experienceName": "player",
                  "userId": "#{userId}",
                  "propertyId": "player",
                  "experienceValue": 5
                }
              }
            ]
          }
        ]
      },
      {
        "name": "category-0002",
        "rewardIntervalMinutes": 5,
        "defaultMaximumIdleMinutes": 1440,
        "acquireActions": [
          {
            "acquireActions": [
              {
                "action": "Gs2Experience:AddExperienceByUserId",
                "request": {
                  "namespaceName": "namespace-0001",
                  "experienceName": "player",
                  "userId": "#{userId}",
                  "propertyId": "player",
                  "experienceValue": 10
                }
              }
            ]
          },
          {
            "acquireActions": [
              {
                "action": "Gs2Experience:AddExperienceByUserId",
                "request": {
                  "namespaceName": "namespace-0001",
                  "experienceName": "player",
                  "userId": "#{userId}",
                  "propertyId": "player",
                  "experienceValue": 5
                }
              }
            ]
          }
        ],
        "idlePeriodScheduleId": "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001",
        "receivePeriodScheduleId": "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002"
      }
    ]
  }
  UploadToken: null

```

**Go**
```go

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


SampleStack := core.NewStack()
idle.NewNamespace(
    &SampleStack,
    "namespace-0001",
    idle.NamespaceOptions{},
).MasterData(
    []idle.CategoryModel{
        idle.NewCategoryModel(
            "category-0001",
            5,
            1440,
            idle.CategoryModelRewardResetModeReset,
            []idle.AcquireActionList{
                idle.NewAcquireActionList(
                    idle.AcquireActionListOptions{
                        AcquireActions: []core.AcquireAction{
                            experience.AddExperienceByUserId(
                                "namespace-0001",
                                "player",
                                "player",
                                pointy.Int64(30),
                                pointy.Bool(false),
                            ),
                        },
                    },
                ),
                idle.NewAcquireActionList(
                    idle.AcquireActionListOptions{
                        AcquireActions: []core.AcquireAction{
                            experience.AddExperienceByUserId(
                                "namespace-0001",
                                "player",
                                "player",
                                pointy.Int64(30),
                                pointy.Bool(false),
                            ),
                        },
                    },
                ),
            },
            idle.CategoryModelOptions{
            },
        ),
        idle.NewCategoryModel(
            "category-0002",
            5,
            1440,
            idle.CategoryModelRewardResetModeReset,
            []idle.AcquireActionList{
                idle.NewAcquireActionList(
                    idle.AcquireActionListOptions{
                        AcquireActions: []core.AcquireAction{
                            experience.AddExperienceByUserId(
                                "namespace-0001",
                                "player",
                                "player",
                                pointy.Int64(30),
                                pointy.Bool(false),
                            ),
                        },
                    },
                ),
                idle.NewAcquireActionList(
                    idle.AcquireActionListOptions{
                        AcquireActions: []core.AcquireAction{
                            experience.AddExperienceByUserId(
                                "namespace-0001",
                                "player",
                                "player",
                                pointy.Int64(30),
                                pointy.Bool(false),
                            ),
                        },
                    },
                ),
            },
            idle.CategoryModelOptions{
                IdlePeriodScheduleId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001"),
                ReceivePeriodScheduleId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002"),
            },
        ),
    },
)

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

```

**PHP**
```php

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Idle\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
                new \Gs2Cdk\Idle\Model\CategoryModel(
                    name:"category-0001",
                    rewardIntervalMinutes:5,
                    defaultMaximumIdleMinutes:1440,
                    rewardResetMode: \Gs2Cdk\Idle\Model\Enums\CategoryModelRewardResetMode::RESET,
                    acquireActions:[
                        new \Gs2Cdk\Idle\Model\AcquireActionList(
                            options: new \Gs2Cdk\Idle\Model\Options\AcquireActionListOptions(
                                acquireActions: [
                                    new \Gs2Cdk\Experience\StampSheet\AddExperienceByUserId(
                                        namespaceName: "namespace-0001",
                                        experienceName: "player",
                                        userId: "#{userId}",
                                        propertyId: "player",
                                        experienceValue: 10,
                                    ),
                                ],
                            ),
                        ),
                        new \Gs2Cdk\Idle\Model\AcquireActionList(
                            options: new \Gs2Cdk\Idle\Model\Options\AcquireActionListOptions(
                                acquireActions: [
                                    new \Gs2Cdk\Experience\StampSheet\AddExperienceByUserId(
                                        namespaceName: "namespace-0001",
                                        experienceName: "player",
                                        userId: "#{userId}",
                                        propertyId: "player",
                                        experienceValue: 5,
                                    ),
                                ],
                            ),
                        ),
                    ]
                ),
                new \Gs2Cdk\Idle\Model\CategoryModel(
                    name:"category-0002",
                    rewardIntervalMinutes:5,
                    defaultMaximumIdleMinutes:1440,
                    rewardResetMode: \Gs2Cdk\Idle\Model\Enums\CategoryModelRewardResetMode::RESET,
                    acquireActions:[
                        new \Gs2Cdk\Idle\Model\AcquireActionList(
                            options: new \Gs2Cdk\Idle\Model\Options\AcquireActionListOptions(
                                acquireActions: [
                                    new \Gs2Cdk\Experience\StampSheet\AddExperienceByUserId(
                                        namespaceName: "namespace-0001",
                                        experienceName: "player",
                                        userId: "#{userId}",
                                        propertyId: "player",
                                        experienceValue: 10,
                                    ),
                                ],
                            ),
                        ),
                        new \Gs2Cdk\Idle\Model\AcquireActionList(
                            options: new \Gs2Cdk\Idle\Model\Options\AcquireActionListOptions(
                                acquireActions: [
                                    new \Gs2Cdk\Experience\StampSheet\AddExperienceByUserId(
                                        namespaceName: "namespace-0001",
                                        experienceName: "player",
                                        userId: "#{userId}",
                                        propertyId: "player",
                                        experienceValue: 5,
                                    ),
                                ],
                            ),
                        ),
                    ],
                    options: new \Gs2Cdk\Idle\Model\Options\CategoryModelOptions(
                        idlePeriodScheduleId:"grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001",
                        receivePeriodScheduleId:"grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002"
                    )
                )
            ]
        );
    }
}

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

```

**Java**
```java

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.idle.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.idle.model.CategoryModel(
                    "category-0001",
                    5,
                    1440,
                    io.gs2.cdk.idle.model.enums.CategoryModelRewardResetMode.RESET,
                    Arrays.asList(
                        new io.gs2.cdk.idle.model.AcquireActionList(
                            new io.gs2.cdk.idle.model.options.AcquireActionListOptions()
                                .withAcquireActions(Arrays.asList(
                                    new io.gs2.cdk.experience.stampSheet.AddExperienceByUserId(
                                        "namespace-0001",
                                        "player",
                                        "player",
                                        30L,
                                        false,
                                        "#{userId}")
                                ))
                        ),
                        new io.gs2.cdk.idle.model.AcquireActionList(
                            new io.gs2.cdk.idle.model.options.AcquireActionListOptions()
                                .withAcquireActions(Arrays.asList(
                                    new io.gs2.cdk.experience.stampSheet.AddExperienceByUserId(
                                        "namespace-0001",
                                        "player",
                                        "player",
                                        30L,
                                        false,
                                        "#{userId}")
                                ))
                        )
                    )
                ),
                new io.gs2.cdk.idle.model.CategoryModel(
                    "category-0002",
                    5,
                    1440,
                    io.gs2.cdk.idle.model.enums.CategoryModelRewardResetMode.RESET,
                    Arrays.asList(
                        new io.gs2.cdk.idle.model.AcquireActionList(
                            new io.gs2.cdk.idle.model.options.AcquireActionListOptions()
                                .withAcquireActions(Arrays.asList(
                                    new io.gs2.cdk.experience.stampSheet.AddExperienceByUserId(
                                        "namespace-0001",
                                        "player",
                                        "player",
                                        30L,
                                        false,
                                        "#{userId}")
                                ))
                        ),
                        new io.gs2.cdk.idle.model.AcquireActionList(
                            new io.gs2.cdk.idle.model.options.AcquireActionListOptions()
                                .withAcquireActions(Arrays.asList(
                                    new io.gs2.cdk.experience.stampSheet.AddExperienceByUserId(
                                        "namespace-0001",
                                        "player",
                                        "player",
                                        30L,
                                        false,
                                        "#{userId}")
                                ))
                        )
                    ),
                    new io.gs2.cdk.idle.model.options.CategoryModelOptions()
                        .withIdlePeriodScheduleId("grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001")
                        .withReceivePeriodScheduleId("grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002")
                )
            )
        );
    }
}

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

```

**C#**
```csharp

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Idle.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2Idle.Model.CategoryModel[] {
                new Gs2Cdk.Gs2Idle.Model.CategoryModel(
                    name: "category-0001",
                    rewardIntervalMinutes: 5,
                    defaultMaximumIdleMinutes: 1440,
                    rewardResetMode: Gs2Cdk.Gs2Idle.Model.Enums.CategoryModelRewardResetMode.Reset,
                    acquireActions: new Gs2Cdk.Gs2Idle.Model.AcquireActionList[]
                    {
                        new Gs2Cdk.Gs2Idle.Model.AcquireActionList(
                            options: new Gs2Cdk.Gs2Idle.Model.Options.AcquireActionListOptions
                            {
                                acquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
                                {
                                    new Gs2Cdk.Gs2Experience.StampSheet.AddExperienceByUserId(
                                        namespaceName: "namespace-0001",
                                        experienceName: "player",
                                        userId: "#{userId}",
                                        propertyId: "player",
                                        experienceValue: 10
                                    )
                                }
                            }
                        ),
                        new Gs2Cdk.Gs2Idle.Model.AcquireActionList(
                            options: new Gs2Cdk.Gs2Idle.Model.Options.AcquireActionListOptions
                            {
                                acquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
                                {
                                    new Gs2Cdk.Gs2Experience.StampSheet.AddExperienceByUserId(
                                        namespaceName: "namespace-0001",
                                        experienceName: "player",
                                        userId: "#{userId}",
                                        propertyId: "player",
                                        experienceValue: 5
                                    )
                                }
                            }
                        )
                    }
                ),
                new Gs2Cdk.Gs2Idle.Model.CategoryModel(
                    name: "category-0002",
                    rewardIntervalMinutes: 5,
                    defaultMaximumIdleMinutes: 1440,
                    rewardResetMode: Gs2Cdk.Gs2Idle.Model.Enums.CategoryModelRewardResetMode.Reset,
                    acquireActions: new Gs2Cdk.Gs2Idle.Model.AcquireActionList[]
                    {
                        new Gs2Cdk.Gs2Idle.Model.AcquireActionList(
                            options: new Gs2Cdk.Gs2Idle.Model.Options.AcquireActionListOptions
                            {
                                acquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
                                {
                                    new Gs2Cdk.Gs2Experience.StampSheet.AddExperienceByUserId(
                                        namespaceName: "namespace-0001",
                                        experienceName: "player",
                                        userId: "#{userId}",
                                        propertyId: "player",
                                        experienceValue: 10
                                    )
                                }
                            }
                        ),
                        new Gs2Cdk.Gs2Idle.Model.AcquireActionList(
                            options: new Gs2Cdk.Gs2Idle.Model.Options.AcquireActionListOptions
                            {
                                acquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
                                {
                                    new Gs2Cdk.Gs2Experience.StampSheet.AddExperienceByUserId(
                                        namespaceName: "namespace-0001",
                                        experienceName: "player",
                                        userId: "#{userId}",
                                        propertyId: "player",
                                        experienceValue: 5
                                    )
                                }
                            }
                        )
                    },
                    options: new Gs2Cdk.Gs2Idle.Model.Options.CategoryModelOptions
                    {
                        idlePeriodScheduleId = "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001",
                        receivePeriodScheduleId = "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002"
                    }
                )
            }
        );
    }
}

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

```

**TypeScript**
```typescript

import core from "@/gs2cdk/core";
import idle from "@/gs2cdk/idle";
import experience from "@/gs2cdk/experience";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new idle.model.Namespace(
            this,
            "namespace-0001",
        ).masterData(
            [
                new idle.model.CategoryModel(
                    "category-0001",
                    5,
                    1440,
                    idle.model.CategoryModelRewardResetMode.RESET,
                    [
                        new idle.model.AcquireActionList(
                            {
                                acquireActions: [
                                    new experience.stampSheet.AddExperienceByUserId(
                                        "namespace-0001",
                                        "player",
                                        "player",
                                        30,
                                        null,
                                        null,
                                        "#{userId}"
                                    ),
                                ]
                            }
                        ),
                        new idle.model.AcquireActionList(
                            {
                                acquireActions: [
                                    new experience.stampSheet.AddExperienceByUserId(
                                        "namespace-0001",
                                        "player",
                                        "player",
                                        30,
                                        null,
                                        null,
                                        "#{userId}"
                                    ),
                                ]
                            }
                        ),
                    ]
                ),
                new idle.model.CategoryModel(
                    "category-0002",
                    5,
                    1440,
                    idle.model.CategoryModelRewardResetMode.RESET,
                    [
                        new idle.model.AcquireActionList(
                            {
                                acquireActions: [
                                    new experience.stampSheet.AddExperienceByUserId(
                                        "namespace-0001",
                                        "player",
                                        "player",
                                        30,
                                        null,
                                        null,
                                        "#{userId}"
                                    ),
                                ]
                            }
                        ),
                        new idle.model.AcquireActionList(
                            {
                                acquireActions: [
                                    new experience.stampSheet.AddExperienceByUserId(
                                        "namespace-0001",
                                        "player",
                                        "player",
                                        30,
                                        null,
                                        null,
                                        "#{userId}"
                                    ),
                                ]
                            }
                        ),
                    ],
                    {
                        idlePeriodScheduleId: "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001",
                        receivePeriodScheduleId: "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002"
                    }
                )
            ]
        );
    }
}

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

```

**Python**
```python

from gs2_cdk import Stack, core, idle, experience

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        idle.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            category_models=[
                idle.CategoryModel(
                    name='category-0001',
                    reward_interval_minutes=5,
                    default_maximum_idle_minutes=1440,
                    reward_reset_mode=idle.CategoryModelRewardResetMode.RESET,
                    acquire_actions=[
                        idle.AcquireActionList(
                            options=idle.AcquireActionListOptions(
                                acquire_actions=[
                                    experience.AddExperienceByUserId(
                                        namespace_name='namespace-0001',
                                        experience_name='player',
                                        user_id='#{userId}',
                                        property_id='player',
                                        experience_value=10
                                    ),
                                ],
                            ),
                        ),
                        idle.AcquireActionList(
                            options=idle.AcquireActionListOptions(
                                acquire_actions=[
                                    experience.AddExperienceByUserId(
                                        namespace_name='namespace-0001',
                                        experience_name='player',
                                        user_id='#{userId}',
                                        property_id='player',
                                        experience_value=5
                                    ),
                                ],
                            ),
                        ),
                    ]
                ),
                idle.CategoryModel(
                    name='category-0002',
                    reward_interval_minutes=5,
                    default_maximum_idle_minutes=1440,
                    reward_reset_mode=idle.CategoryModelRewardResetMode.RESET,
                    acquire_actions=[
                        idle.AcquireActionList(
                            options=idle.AcquireActionListOptions(
                                acquire_actions=[
                                    experience.AddExperienceByUserId(
                                        namespace_name='namespace-0001',
                                        experience_name='player',
                                        user_id='#{userId}',
                                        property_id='player',
                                        experience_value=10
                                    ),
                                ],
                            ),
                        ),
                        idle.AcquireActionList(
                            options=idle.AcquireActionListOptions(
                                acquire_actions=[
                                    experience.AddExperienceByUserId(
                                        namespace_name='namespace-0001',
                                        experience_name='player',
                                        user_id='#{userId}',
                                        property_id='player',
                                        experience_value=5
                                    ),
                                ],
                            ),
                        ),
                    ],
                    options=idle.CategoryModelOptions(
                        idle_period_schedule_id = 'grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001',
                        receive_period_schedule_id = 'grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002'
                    ),
                ),
            ],
        )

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

```


#### CategoryModel

카테고리 모델<br>

카테고리 모델이란, 방치 보상을 얻을 수 있는 대기 카테고리를 설정하는 엔티티입니다.<br>
설정에는 대기 시간별 보상이나 최대 대기 시간 등의 정보가 포함됩니다.

|  | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| categoryModelId | string |  | ※ |  |  ~ 1024자 | 카테고리 모델 GRN<br>※ 서버가 자동으로 설정 |
| name | string |  | ✓ |  |  ~ 128자 | 카테고리 모델 이름<br>카테고리 모델 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다. |
| metadata | string |  |  |  |  ~ 2048자 | 메타데이터<br>메타데이터에는 임의의 값을 설정할 수 있습니다.<br>이 값들은 GS2의 동작에는 영향을 주지 않으므로, 게임 내에서 사용하는 정보를 저장하는 용도로 사용할 수 있습니다. |
| rewardIntervalMinutes | int |  | ✓ |  | 0 ~ 2147483646 | 보상 간격(분)<br>각 방치 보상 사이의 시간 간격(분)입니다. 예를 들어 60으로 설정하면, 사용자는 방치 시간 60분마다 보상 1유닛을 획득합니다. 보상의 총 개수는 (경과 방치 분수) / rewardIntervalMinutes로 계산되며, acquireActions 배열을 순환합니다. |
| defaultMaximumIdleMinutes | int |  | ✓ |  | 0 ~ 2147483646 | 기본 최대 방치 시간(분)<br>이 카테고리의 새로운 스테이터스에 대한 기본 최대 방치 시간(분)입니다. 이 제한을 초과하는 방치 시간은 추가 보상을 축적하지 않습니다. 이 값은 스테이터스 생성 시 각 스테이터스의 maximumIdleMinutes 에 복사되며, 입수 액션을 통해 사용자별로 확장할 수 있습니다. |
| rewardResetMode | 문자열 열거형<br>enum {<br>"Reset",<br>"CarryOver"<br>}<br> |  |  | "Reset" |  | 보상 리셋 모드<br>사용자가 보상을 받은 후 방치 시간의 처리 방법을 결정합니다. "Reset"은 방치 시간을 0으로 되돌리며, 부분적인 간격 시간은 소실됩니다. "CarryOver"는 추가 보상을 얻기에 부족했던 나머지 시간을 유지하여 다음 보상 사이클에 반영됩니다.Reset: 대기 시간을 0으로 리셋 / CarryOver: 보상을 받기에 부족했던 나머지 시간을 이월 /  |
| acquireActions | [List&lt;AcquireActionList&gt;](#acquireactionlist) |  |  | [] | 1 ~ 100 items | 대기 시간마다 얻을 수 있는 입수 액션 리스트<br>대기 시간을 "X분"이라고 가정하면<br>"X / rewardIntervalMinutes"가 보상을 받을 수 있는 횟수가 되지만, 여기서 지정한 배열의 요소를 반복함으로써 대기 시간마다 다른 보상을 부여할 수 있습니다. |
| idlePeriodScheduleId | string |  |  |  |  ~ 1024자 | 방치 기간 스케줄ID<br>방치 시간이 축적되는 기간을 정의하는 GS2-Schedule 이벤트의 GRN입니다. 설정하면 이벤트가 활성 상태인 동안에만 방치 시간이 카운트됩니다. 이벤트가 반복되는 경우, 스테이터스는 반복 횟수를 추적하고 새로운 사이클이 시작될 때 방치 시간을 리셋하여 이벤트 기간마다 보상이 계산되도록 합니다. |
| receivePeriodScheduleId | string |  |  |  |  ~ 1024자 | 수취 기간 스케줄ID<br>사용자가 축적된 방치 보상을 받을 수 있는 시간대를 정의하는 GS2-Schedule 이벤트의 GRN입니다. 설정하면 이벤트가 활성 상태인 동안에만 보상 수취가 허용됩니다. 이를 통해 방치 축적 기간과는 별도의 기간 한정 보상 수취 기간을 설정할 수 있습니다. |

#### AcquireActionList

입수 액션 리스트<br>

하나의 보상 간격에서 함께 지급되는 여러 입수 액션을 그룹화하는 래퍼입니다. 각 AcquireActionList는 카테고리 모델의 acquireActions 배열 내 하나의 보상 주기에 대응하며, 각 간격마다 서로 다른 보상 조합을 설정할 수 있습니다.

|  | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| acquireActions | [List&lt;AcquireAction&gt;](#acquireaction) |  |  | [] | 0 ~ 100 items | 입수 액션 리스트<br>이 보상 간격이 트리거될 때 함께 실행되는 입수 액션의 집합입니다. 여러 액션을 조합하여 하나의 방치 보상 주기에서 서로 다른 종류의 보상을 동시에 지급할 수 있습니다. 리스트당 최대 100개의 액션입니다. |

#### AcquireAction

입수 액션<br>

방치 보상으로 사용되는 단일 입수 액션을 나타냅니다. 액션 타입(예: 아이템 추가, 통화 증가)과 그 요청 파라미터로 구성됩니다. 방치 보상을 수령하면 이러한 액션들이 트랜잭션으로 조합되어 실행되며, 사용자에게 보상이 지급됩니다.

|  | 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 |
| --- | --- | --- | --- | --- | --- | --- |
| action | 문자열 열거형<br>enum {<br>}<br> |  | ✓ |  |  | 입수 액션에서 실행할 액션의 종류 |
| request | string |  | ✓ |  |  ~ 524288자 | 액션 실행 시 사용되는 요청의 JSON 문자열 |

---