GS2-Idle Deploy/CDK Reference

The template format used when creating stacks with GS2-Deploy, and implementation examples of template output in various languages using CDK
Tags:

Entities

Resources targeted by the Deploy operation

Namespace

Namespace

A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the Namespace differs, the data is treated as a completely independent data space.

Therefore, you must create a Namespace before you can start using each service.

Request

Resource creation and update requests

TypeConditionRequiredDefaultValue LimitsDescription
namestring
✓
~ 128 charsNamespace name
Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
descriptionstring~ 1024 charsDescription
transactionSettingTransactionSetting
✓
Transaction Setting
Configuration for controlling how transactions are processed when granting idle rewards.
receiveScriptScriptSettingScript setting executed when rewards are received
Script Trigger Reference - receive
overrideAcquireActionsScriptIdstring~ 1024 charsScript GRN for dynamically determining idle reward Acquire Actions
logSettingLogSettingLog Output Setting
Specifies the GS2-Log namespace for outputting API request and response logs related to idle reward operations. Useful for tracking idle status creation, reward claims, and debugging timing issues.

GetAttr

Resource creation results that can be retrieved using the !GetAttr tag

TypeDescription
ItemNamespaceNamespace created

Implementation Example

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

Transaction Setting

Transaction Setting controls how transactions are executed, including their consistency, asynchronous processing, and conflict avoidance mechanisms. Combining features like AutoRun, AtomicCommit, asynchronous execution using GS2-Distributor, batch application of script results, and asynchronous Acquire Actions via GS2-JobQueue enables robust transaction management tailored to game logic.

TypeConditionRequiredDefaultValue LimitsDescription
enableAutoRunboolfalseWhether to automatically execute issued transactions on the server side
enableAtomicCommitbool{enableAutoRun} == truefalseWhether to commit the execution of transactions atomically
* Applicable only if enableAutoRun is true
transactionUseDistributorbool{enableAtomicCommit} == truefalseWhether to execute transactions asynchronously
* Applicable only if enableAtomicCommit is true
commitScriptResultInUseDistributorbool{transactionUseDistributor} == truefalseWhether to execute the commit processing of the script result asynchronously
* Applicable only if transactionUseDistributor is true
acquireActionUseJobQueuebool{enableAtomicCommit} == truefalseWhether to use GS2-JobQueue to execute the acquire action
* Applicable only if enableAtomicCommit is true
distributorNamespaceIdstring“grn:gs2:{region}:{ownerId}:distributor:default”~ 1024 charsGS2-Distributor Namespace GRN used to execute transactions
queueNamespaceIdstring“grn:gs2:{region}:{ownerId}:queue:default”~ 1024 charsGS2-JobQueue Namespace GRN used to execute transactions

ScriptSetting

Script Setting

In GS2, you can associate custom scripts with microservice events and execute them. This model holds the settings for triggering script execution.

There are two main ways to execute a script: synchronous execution and asynchronous execution. Synchronous execution blocks processing until the script has finished executing. Instead, you can use the script’s execution results to halt API execution or control the API’s response content.

In contrast, asynchronous execution does not block processing until the script has finished executing. However, because the script result cannot be used to stop the API execution or modify the API response, asynchronous execution does not affect the API response flow and is generally recommended.

There are two types of asynchronous execution methods: GS2-Script and Amazon EventBridge. By using Amazon EventBridge, you can write processing in languages other than Lua.

TypeConditionRequiredDefaultValue LimitsDescription
triggerScriptIdstring~ 1024 charsGS2-Script script GRN executed synchronously when the API is executed
Must be specified in GRN format starting with “grn:gs2:”.
doneTriggerTargetTypeString Enum
enum {
  “none”,
  “gs2_script”,
  “aws”
}
“none”How to execute asynchronous scripts
Specifies the type of script to use for asynchronous execution.
You can choose from “Do not use asynchronous execution (none)”, “Use GS2-Script (gs2_script)”, and “Use Amazon EventBridge (aws)”.
DefinitionDescription
“none”None
“gs2_script”GS2-Script
“aws”Amazon EventBridge
doneTriggerScriptIdstring{doneTriggerTargetType} == “gs2_script”~ 1024 charsGS2-Script script GRN for asynchronous execution
Must be specified in GRN format starting with “grn:gs2:”.
* Applicable only if doneTriggerTargetType is “gs2_script”
doneTriggerQueueNamespaceIdstring{doneTriggerTargetType} == “gs2_script”~ 1024 charsGS2-JobQueue Namespace GRN to execute asynchronous execution scripts
If you want to execute asynchronous execution scripts via GS2-JobQueue instead of executing them directly, specify the GS2-JobQueue Namespace GRN.
There are not many cases where GS2-JobQueue is required, so you generally do not need to specify it unless you have a specific reason.
* Applicable only if doneTriggerTargetType is “gs2_script”

LogSetting

Log Output Setting

Log Output Setting defines how log data is exported. This type holds the GS2-Log Namespace identifier (Namespace ID) used to export log data. Specify the GS2-Log Namespace where log data is collected and stored in the GRN format for the Log Namespace ID (loggingNamespaceId). Configuring this setting ensures that log data for API requests and responses occurring within the specified Namespace is output to the target GS2-Log namespace. GS2-Log provides real-time logs that can be used for system monitoring, analysis, debugging, and other operational purposes.

TypeConditionRequiredDefaultValue LimitsDescription
loggingNamespaceIdstring
✓
~ 1024 charsGS2-Log Namespace GRN to output logs
Must be specified in GRN format starting with “grn:gs2:”.

CurrentCategoryMaster

Currently active Category Model master data

This master data describes the definitions of Category Models currently active within the namespace. GS2 uses JSON format files for managing master data. By uploading these files, the master data settings are updated on the server.

To create JSON files, GS2 provides a master data editor within the management console. Additionally, you can create tools better suited for game operations and export JSON files in the appropriate format.

Request

Resource creation and update requests

TypeConditionRequiredDefaultValue LimitsDescription
namespaceNamestring
✓
~ 128 charsNamespace name
Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
modeString Enum
enum {
  “direct”,
  “preUpload”
}
“direct”Update mode
DefinitionDescription
“direct”Directly update master data
“preUpload”Upload master data and then update
settingsstring{mode} == “direct”
✓*
~ 5242880 charsMaster Data
* Required if mode is “direct”
uploadTokenstring{mode} == “preUpload”
✓*
~ 1024 charsToken obtained by pre-upload
Used to apply the uploaded master data.
* Required if mode is “preUpload”

GetAttr

Resource creation results that can be retrieved using the !GetAttr tag

TypeDescription
ItemCurrentCategoryMasterUpdated master data of the currently active Category Models

Implementation Example

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

Category Model

A Category Model is an entity that defines a waiting category in which idle rewards can be earned over time. The settings include information such as the reward for each waiting time and the maximum idle time.

TypeConditionRequiredDefaultValue LimitsDescription
categoryModelIdstring
*
~ 1024 charsCategory Model GRN
* Set automatically by the server
namestring
✓
~ 128 charsCategory Model name
Category Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
metadatastring~ 2048 charsMetadata
Arbitrary values can be set in the metadata.
Since they do not affect GS2’s behavior, they can be used to store information used in the game.
rewardIntervalMinutesint
✓
0 ~ 2147483646Reward Interval (Minutes)
The time interval in minutes between each idle reward. For example, if set to 60, the user earns one reward unit for every 60 minutes of idle time. The total number of rewards is calculated as (elapsed idle minutes) / rewardIntervalMinutes, cycling through the acquireActions array.
defaultMaximumIdleMinutesint
✓
0 ~ 2147483646Default Maximum Idle Time (Minutes)
The default maximum idle time in minutes for new statuses in this category. Idle time beyond this limit does not accumulate additional rewards. This value is copied to each status’s maximumIdleMinutes when the status is created, and can be extended per-user via transactions.
rewardResetModeString Enum
enum {
  “Reset”,
  “CarryOver”
}
“Reset”Reward Reset Mode
Determines how idle time is handled after the user receives rewards. “Reset” sets the idle time back to zero, meaning any partial interval time is lost. “CarryOver” preserves the remaining time that was not enough to earn an additional reward, so it counts toward the next reward cycle.
DefinitionDescription
“Reset”Reset waiting time to 0
“CarryOver”Carry over the remaining time that was insufficient to receive a reward
acquireActionsList<AcquireActionList>[]1 ~ 100 itemsList of acquire actions for each waiting time
Assuming that the waiting time is “X minutes”,
“X / rewardIntervalMinutes” will be the number of rewards that can be received, but by looping the elements specified in this array, different rewards can be given for each waiting time.
idlePeriodScheduleIdstring~ 1024 charsIdle Period Schedule ID
The GRN of a GS2-Schedule event that defines the time period during which idle time accumulates. When set, idle time only counts while the event is active. If the event repeats, the status tracks the repetition count and resets idle time when a new cycle begins, ensuring rewards are calculated per event period.
receivePeriodScheduleIdstring~ 1024 charsReceive Period Schedule ID
The GRN of a GS2-Schedule event that defines the time window during which users can claim accumulated idle rewards. When set, reward claims are only accepted while the event is active. This allows time-limited reward collection periods separate from the idle accumulation period.

AcquireActionList

Acquire Action List

A wrapper that groups multiple acquire actions to be granted together for a single reward interval. Each AcquireActionList corresponds to one reward cycle in the category model’s acquireActions array, enabling different reward combinations at each interval.

TypeConditionRequiredDefaultValue LimitsDescription
acquireActionsList<AcquireAction>[]0 ~ 100 itemsList of Acquire Actions
The collection of acquire actions that are executed together when this reward interval is triggered. Multiple actions can be combined to grant different types of rewards simultaneously for a single idle reward cycle. Up to 100 actions per list.

AcquireAction

Acquire Action

Represents a single acquire action used as an idle reward. Consists of an action type (e.g., add items, increase currency) and its request parameters. When idle rewards are claimed, these actions are assembled into transactions and executed to deliver the rewards to the user.

TypeConditionRequiredDefaultValue LimitsDescription
actionString Enum
enum {
"Gs2AdReward:AcquirePointByUserId",
"Gs2Dictionary:AddEntriesByUserId",
"Gs2Enchant:ReDrawBalanceParameterStatusByUserId",
"Gs2Enchant:SetBalanceParameterStatusByUserId",
"Gs2Enchant:ReDrawRarityParameterStatusByUserId",
"Gs2Enchant:AddRarityParameterStatusByUserId",
"Gs2Enchant:SetRarityParameterStatusByUserId",
"Gs2Enhance:DirectEnhanceByUserId",
"Gs2Enhance:UnleashByUserId",
"Gs2Enhance:CreateProgressByUserId",
"Gs2Exchange:ExchangeByUserId",
"Gs2Exchange:IncrementalExchangeByUserId",
"Gs2Exchange:CreateAwaitByUserId",
"Gs2Exchange:AcquireForceByUserId",
"Gs2Exchange:SkipByUserId",
"Gs2Experience:AddExperienceByUserId",
"Gs2Experience:SetExperienceByUserId",
"Gs2Experience:AddRankCapByUserId",
"Gs2Experience:SetRankCapByUserId",
"Gs2Experience:MultiplyAcquireActionsByUserId",
"Gs2Formation:AddMoldCapacityByUserId",
"Gs2Formation:SetMoldCapacityByUserId",
"Gs2Formation:AcquireActionsToFormProperties",
"Gs2Formation:SetFormByUserId",
"Gs2Formation:AcquireActionsToPropertyFormProperties",
"Gs2Friend:UpdateProfileByUserId",
"Gs2Grade:AddGradeByUserId",
"Gs2Grade:ApplyRankCapByUserId",
"Gs2Grade:MultiplyAcquireActionsByUserId",
"Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Idle:IncreaseMaximumIdleMinutesByUserId",
"Gs2Idle:SetMaximumIdleMinutesByUserId",
"Gs2Idle:ReceiveByUserId",
"Gs2Inbox:SendMessageByUserId",
"Gs2Inventory:AddCapacityByUserId",
"Gs2Inventory:SetCapacityByUserId",
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetWithGradeByUserId",
"Gs2Inventory:AddReferenceOfByUserId",
"Gs2Inventory:DeleteReferenceOfByUserId",
"Gs2Inventory:AcquireSimpleItemsByUserId",
"Gs2Inventory:SetSimpleItemsByUserId",
"Gs2Inventory:AcquireBigItemByUserId",
"Gs2Inventory:SetBigItemByUserId",
"Gs2JobQueue:PushByUserId",
"Gs2Limit:CountDownByUserId",
"Gs2Limit:DeleteCounterByUserId",
"Gs2LoginReward:DeleteReceiveStatusByUserId",
"Gs2LoginReward:UnmarkReceivedByUserId",
"Gs2Lottery:DrawByUserId",
"Gs2Lottery:ResetBoxByUserId",
"Gs2Mission:RevertReceiveByUserId",
"Gs2Mission:IncreaseCounterByUserId",
"Gs2Mission:SetCounterByUserId",
"Gs2Money:DepositByUserId",
"Gs2Money:RevertRecordReceipt",
"Gs2Money2:DepositByUserId",
"Gs2Quest:CreateProgressByUserId",
"Gs2Schedule:TriggerByUserId",
"Gs2Schedule:ExtendTriggerByUserId",
"Gs2Script:InvokeScript",
"Gs2SerialKey:RevertUseByUserId",
"Gs2SerialKey:IssueOnce",
"Gs2Showcase:DecrementPurchaseCountByUserId",
"Gs2Showcase:ForceReDrawByUserId",
"Gs2SkillTree:MarkReleaseByUserId",
"Gs2Stamina:RecoverStaminaByUserId",
"Gs2Stamina:RaiseMaxValueByUserId",
"Gs2Stamina:SetMaxValueByUserId",
"Gs2Stamina:SetRecoverIntervalByUserId",
"Gs2Stamina:SetRecoverValueByUserId",
"Gs2StateMachine:StartStateMachineByUserId",
}
✓
Type of action to be executed in the Acquire Action
requeststring
✓
~ 524288 charsJSON string of the request used when executing the action