GS2-Limit Deploy/CDK Reference

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

Entities

Resources targeted by the Deploy operation

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

	Type	Required	Value Limits	Description
name	string	✓	~ 128 chars	Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
description	string		~ 1024 chars	Description
transactionSetting	TransactionSetting			Transaction Setting Configuration for controlling how transactions are processed when executing limit operations such as counting up and resetting counters.
countUpScript	ScriptSetting			Script to execute when counting up Script Trigger Reference - `countUp`
logSetting	LogSetting			Log Output Setting Specifies the GS2-Log namespace for outputting API request and response logs of limit operations. Useful for tracking counter increments, resets, and limit checks for debugging and analytics.

GetAttr

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

	Type	Description
Item	Namespace	Namespace created

Implementation Example

Type: GS2::Limit::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSetting: null
  CountUpScript: 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/limit"
)


SampleStack := core.NewStack()
limit.NewNamespace(
    &SampleStack,
    "namespace-0001",
    limit.NamespaceOptions{
        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\Limit\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\Limit\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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.limit.model.Namespace(
                this,
                "namespace-0001",
                new io.gs2.cdk.limit.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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Limit.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: new Gs2Cdk.Gs2Limit.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

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new limit.model.Namespace(
            this,
            "namespace-0001",
            {
                logSetting: new core.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

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

from gs2_cdk import Stack, core, limit

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        limit.Namespace(
            stack=self,
            name='namespace-0001',
            options=limit.NamespaceOptions(
                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.

	Type	Condition	Default	Value Limits	Description
enableAutoRun	bool		false		Whether to automatically execute issued transactions on the server side
enableAtomicCommit	bool	{enableAutoRun} == true	false		Whether to commit the execution of transactions atomically * Applicable only if enableAutoRun is true
transactionUseDistributor	bool	{enableAtomicCommit} == true	false		Whether to execute transactions asynchronously * Applicable only if enableAtomicCommit is true
commitScriptResultInUseDistributor	bool	{transactionUseDistributor} == true	false		Whether to execute the commit processing of the script result asynchronously * Applicable only if transactionUseDistributor is true
acquireActionUseJobQueue	bool	{enableAtomicCommit} == true	false		Whether to use GS2-JobQueue to execute the acquire action * Applicable only if enableAtomicCommit is true
distributorNamespaceId	string		“grn:gs2:{region}:{ownerId}:distributor:default”	~ 1024 chars	GS2-Distributor Namespace GRN used to execute transactions
queueNamespaceId	string		“grn:gs2:{region}:{ownerId}:queue:default”	~ 1024 chars	GS2-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.

Type

Condition

Required

Default

Value Limits

Description

triggerScriptId

string

~ 1024 chars

GS2-Script script GRN executed synchronously when the API is executed

Must be specified in GRN format starting with “grn:gs2:”.

doneTriggerTargetType

String 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)”.

Definition	Description
“none”	None
“gs2_script”	GS2-Script
“aws”	Amazon EventBridge

doneTriggerScriptId

string

{doneTriggerTargetType} == “gs2_script”

~ 1024 chars

GS2-Script script GRN for asynchronous execution

Must be specified in GRN format starting with “grn:gs2:”.

* Applicable only if doneTriggerTargetType is “gs2_script”

doneTriggerQueueNamespaceId

string

{doneTriggerTargetType} == “gs2_script”

~ 1024 chars

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

	Type	Condition	Required	Default	Value Limits	Description
loggingNamespaceId	string		✓		~ 1024 chars	GS2-Log namespace GRN to output logs Must be specified in GRN format starting with “grn:gs2:”.

CurrentLimitMaster

Currently active Usage Limit Model master data

This master data describes the definitions of Usage Limit 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.

Note

Please refer to Master Data Reference of GS2-Limit for the JSON file format.

Request

Resource creation and update requests

Type

Condition

Required

Default

Value Limits

Description

namespaceName

string

✓

~ 128 chars

Namespace name

Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).

mode

String Enum
enum {
“direct”,
“preUpload”
}

“direct”

Update mode

Definition	Description
“direct”	Directly update master data
“preUpload”	Upload master data and then update

settings

string

{mode} == “direct”

✓*

~ 5242880 chars

Master Data

* Required if mode is “direct”

uploadToken

string

{mode} == “preUpload”

✓*

~ 1024 chars

Token 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

	Type	Description
Item	CurrentLimitMaster	Updated master data of the currently active Usage Limit Models

Implementation Example

Type: GS2::Limit::CurrentLimitMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  Settings: {
    "version": "2019-04-05",
    "limitModels": [
      {
        "name": "daily",
        "resetType": "daily",
        "metadata": "DAILY",
        "resetHour": 9
      },
      {
        "name": "weekly",
        "resetType": "weekly",
        "metadata": "WEEKLY",
        "resetDayOfWeek": "sunday",
        "resetHour": 18
      }
    ]
  }
  UploadToken: null

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


SampleStack := core.NewStack()
limit.NewNamespace(
    &SampleStack,
    "namespace-0001",
    limit.NamespaceOptions{},
).MasterData(
    []limit.LimitModel{
        limit.NewLimitModel(
            "daily",
            limit.LimitModelResetTypeDaily,
            limit.LimitModelOptions{
                Metadata: pointy.String("DAILY"),
                ResetHour: pointy.Int32(9),
            },
        ),
        limit.NewLimitModel(
            "weekly",
            limit.LimitModelResetTypeWeekly,
            limit.LimitModelOptions{
                Metadata: pointy.String("WEEKLY"),
                ResetDayOfWeek: limit.LimitModelResetDayOfWeekSunday.Pointer(),
                ResetHour: pointy.Int32(18),
            },
        ),
    },
)

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

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Limit\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
                new \Gs2Cdk\Limit\Model\LimitModel(
                    name:"daily",
                    resetType: \Gs2Cdk\Limit\Model\Enums\LimitModelResetType::DAILY,
                    options: new \Gs2Cdk\Limit\Model\Options\LimitModelOptions(
                        metadata:"DAILY",
                        resetHour:9
                    )
                ),
                new \Gs2Cdk\Limit\Model\LimitModel(
                    name:"weekly",
                    resetType: \Gs2Cdk\Limit\Model\Enums\LimitModelResetType::WEEKLY,
                    options: new \Gs2Cdk\Limit\Model\Options\LimitModelOptions(
                        metadata:"WEEKLY",
                        resetDayOfWeek:Gs2Cdk\Limit\Model\Enums\LimitModelResetDayOfWeek::SUNDAY,
                        resetHour:18
                    )
                )
            ]
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.limit.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.limit.model.LimitModel(
                    "daily",
                    io.gs2.cdk.limit.model.enums.LimitModelResetType.DAILY,
                    new io.gs2.cdk.limit.model.options.LimitModelOptions()
                        .withMetadata("DAILY")
                        .withResetHour(9)
                ),
                new io.gs2.cdk.limit.model.LimitModel(
                    "weekly",
                    io.gs2.cdk.limit.model.enums.LimitModelResetType.WEEKLY,
                    new io.gs2.cdk.limit.model.options.LimitModelOptions()
                        .withMetadata("WEEKLY")
                        .withResetDayOfWeek(io.gs2.cdk.limit.model.enums.LimitModelResetDayOfWeek.SUNDAY)
                        .withResetHour(18)
                )
            )
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Limit.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2Limit.Model.LimitModel[] {
                new Gs2Cdk.Gs2Limit.Model.LimitModel(
                    name: "daily",
                    resetType: Gs2Cdk.Gs2Limit.Model.Enums.LimitModelResetType.Daily,
                    options: new Gs2Cdk.Gs2Limit.Model.Options.LimitModelOptions
                    {
                        metadata = "DAILY",
                        resetHour = 9
                    }
                ),
                new Gs2Cdk.Gs2Limit.Model.LimitModel(
                    name: "weekly",
                    resetType: Gs2Cdk.Gs2Limit.Model.Enums.LimitModelResetType.Weekly,
                    options: new Gs2Cdk.Gs2Limit.Model.Options.LimitModelOptions
                    {
                        metadata = "WEEKLY",
                        resetDayOfWeek = Gs2Cdk.Gs2Limit.Model.Enums.LimitModelResetDayOfWeek.Sunday,
                        resetHour = 18
                    }
                )
            }
        );
    }
}

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

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new limit.model.Namespace(
            this,
            "namespace-0001",
        ).masterData(
            [
                new limit.model.LimitModel(
                    "daily",
                    limit.model.LimitModelResetType.DAILY,
                    {
                        metadata: "DAILY",
                        resetHour: 9
                    }
                ),
                new limit.model.LimitModel(
                    "weekly",
                    limit.model.LimitModelResetType.WEEKLY,
                    {
                        metadata: "WEEKLY",
                        resetDayOfWeek: limit.model.LimitModelResetDayOfWeek.SUNDAY,
                        resetHour: 18
                    }
                )
            ]
        );
    }
}

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

from gs2_cdk import Stack, core, limit

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        limit.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            limit_models=[
                limit.LimitModel(
                    name='daily',
                    reset_type=limit.LimitModelResetType.DAILY,
                    options=limit.LimitModelOptions(
                        metadata = 'DAILY',
                        reset_hour = 9
                    ),
                ),
                limit.LimitModel(
                    name='weekly',
                    reset_type=limit.LimitModelResetType.WEEKLY,
                    options=limit.LimitModelOptions(
                        metadata = 'WEEKLY',
                        reset_day_of_week = limit.LimitModelResetDayOfWeek.SUNDAY,
                        reset_hour = 18
                    ),
                ),
            ],
        )

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

LimitModel

Usage Limit Model

Usage Limit Model allows you to set the timing for resetting the usage count. The reset interval can be selected from five options: “Daily”, “Weekly”, “Monthly”, “Every fixed number of days” or “Not Reset”.

Additionally, the maximum value for usage Limits is not fixed in the master data. This design allows the maximum allowed count to be changed dynamically depending on the game context. For example, in a step-up gacha:

Items purchasable when the purchase counter is under 3
When the above items are unavailable, another item purchasable if the purchase counter is under 5

The design assumes the ability to switch the “maximum count” based on the situation.

Type

Condition

Required

Default

Value Limits

Description

limitModelId

string

~ 1024 chars

Usage Limit Model GRN

* Set automatically by the server

name

string

✓

~ 128 chars

Usage Limit Model name

Usage Limit Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).

metadata

string

~ 2048 chars

Metadata

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.

resetType

String Enum
enum {
  “notReset”,
  “daily”,
  “weekly”,
  “monthly”,
  “days”
}

✓

Reset Timing

Determines when the counter values under this limit model are automatically reset to zero. Choose from: notReset (permanent, never resets), daily (resets at the specified hour each day), weekly (resets on the specified day of the week), monthly (resets on the specified day of the month), or days (resets every fixed number of days from an anchor timestamp). All times are in UTC.

Definition	Description
“notReset”	Not Reset
“daily”	Daily
“weekly”	Weekly
“monthly”	Monthly
“days”	Every fixed number of days

resetDayOfMonth

int

{resetType} == “monthly”

✓*

1 ~ 31

Reset Day of Month

The day of the month on which counters are reset when resetType is “monthly”. Valid values are 1-31. If the specified day exceeds the number of days in the current month (e.g., 31 for February), the counter resets on the last day of that month.

* Required if resetType is “monthly”

resetDayOfWeek

String Enum
enum {
  “sunday”,
  “monday”,
  “tuesday”,
  “wednesday”,
  “thursday”,
  “friday”,
  “saturday”
}

{resetType} == “weekly”

✓*

Reset Day of Week

The day of the week on which counters are reset when resetType is “weekly”. The reset occurs at the hour specified by resetHour (UTC) on this day.

Definition	Description
“sunday”	Sunday
“monday”	Monday
“tuesday”	Tuesday
“wednesday”	Wednesday
“thursday”	Thursday
“friday”	Friday
“saturday”	Saturday

* Required if resetType is “weekly”

resetHour

int

{resetType} in [“monthly”, “weekly”, “daily”]

✓*

0 ~ 23

Reset Hour

The hour (0-23) in UTC at which counters are reset for daily, weekly, or monthly reset types. For example, a value of 0 means counters reset at midnight UTC.

* Required if resetType is “monthly”,“weekly”,“daily”

anchorTimestamp

long

{resetType} == “days”

✓*

Base date and time for counting elapsed days

Unix time, milliseconds

* Required if resetType is “days”

days

int

{resetType} == “days”

✓*

1 ~ 2147483646

Number of Days to Reset

The interval in days between counter resets when resetType is “days”. The reset cycle is calculated from the anchorTimestamp. For example, if days is 7 and anchorTimestamp is Monday at noon, counters reset every Monday at noon.

* Required if resetType is “days”