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

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

|  | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| name | string |  | ✓|  |  ~ 128 chars | Namespace name<br>Unique Namespace name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
| description | string |  | |  |  ~ 1024 chars | Description |
| transactionSetting | [TransactionSetting](#transactionsetting) |  | |  |  | Transaction Setting<br>Configuration for controlling how transactions are processed when executing limit operations such as counting up and resetting counters. |
| countUpScript | [ScriptSetting](#scriptsetting) |  | |  |  | Script setting to execute when counting up<br>Script Trigger Reference - [`countUp`](../script/#countup) |
| logSetting | [LogSetting](#logsetting) |  | |  |  | Log Output Setting<br>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](/articles/tech/deploy/#getattr) tag

| | Type | Description |
| --- | --- | --- |
| Item | [Namespace](../sdk#namespace) | Namespace created

#### Implementation Example




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

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

```

**Go**
```go

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

```

**PHP**
```php

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

```

**Java**
```java

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

```

**C#**
```csharp

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

```

**TypeScript**
```typescript

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

```

**Python**
```python

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 execution methods, consistency, asynchronous processing, and conflict avoidance mechanisms of transactions.
Combining features like AutoRun, AtomicCommit, asynchronous execution using GS2-Distributor, batch application of script results, and asynchronous processing of Acquire Actions via GS2-JobQueue enables robust transaction management tailored to game logic.

|  | Type | Condition | Required | 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 transactions atomically<br>* Enabled only if enableAutoRun is true |
| transactionUseDistributor | bool | {enableAtomicCommit} == true |  | false |  | Whether to execute transactions asynchronously<br>* Enabled only if enableAtomicCommit is true |
| commitScriptResultInUseDistributor | bool | {transactionUseDistributor} == true |  | false |  | Whether to execute the commit processing of the script result asynchronously<br>* Enabled only if transactionUseDistributor is true |
| acquireActionUseJobQueue | bool | {enableAtomicCommit} == true |  | false |  | Whether to use GS2-JobQueue to execute the acquire action<br>* Enabled 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.
Because synchronous execution blocks processing until the script finishes executing,
you can use the script result to stop the API execution or control the API response.

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<br>Must be specified in GRN format starting with "grn:gs2:". |
| doneTriggerTargetType | string (enum)<br>enum {<br>"none",<br>"gs2_script",<br>"aws"<br>}<br> |  |  | "none" |  | Asynchronous script execution method<br>Specifies the type of script to use for asynchronous execution.<br>You can choose from "Do not use an asynchronous execution script (none)", "Use GS2-Script (gs2_script)", and "Use Amazon EventBridge (aws)"."none": None / "gs2_script": GS2-Script / "aws": Amazon EventBridge /  |
| doneTriggerScriptId | string | {doneTriggerTargetType} == "gs2_script" |  |  |  ~ 1024 chars | GS2-Script script GRN for asynchronous execution<br>Must be specified in GRN format starting with "grn:gs2:".<br>* Enabled only if doneTriggerTargetType is "gs2_script" |
| doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == "gs2_script" |  |  |  ~ 1024 chars | GS2-JobQueue Namespace GRN used to execute asynchronous scripts<br>If you want to execute asynchronous execution scripts via GS2-JobQueue instead of executing them directly, specify the GS2-JobQueue Namespace GRN.<br>GS2-JobQueue is generally not required unless you have a specific reason to use it.<br>* Enabled 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), which is 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<br>Must be specified in GRN format starting with "grn:gs2:". |

---

### CurrentLimitMaster

Currently active Usage Limit Model master data

This master data defines the Usage Limit Models currently active within the Namespace.
GS2 uses JSON format files for managing master data.
By uploading these files, you can apply the master data to 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 [GS2-Limit Master Data Reference](api_reference/limit/master_data/) for the JSON file format.

#### Request

Resource creation and update requests

|  | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128 chars | Namespace name<br>Unique Namespace name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
| mode | string (enum)<br>enum {<br>"direct",<br>"preUpload"<br>}<br> |  | | "direct" |  | Update mode"direct": Directly update master data / "preUpload": Upload master data and then update /  |
| settings | string | {mode} == "direct" | ✓*|  |  ~ 5242880 bytes (5MB) | Master Data<br>* Required if mode is "direct" |
| uploadToken | string | {mode} == "preUpload" | ✓*|  |  ~ 1024 chars | Token obtained by pre-upload<br>Used to apply the uploaded master data.<br>* Required if mode is "preUpload" |

#### GetAttr

Resource creation results that can be retrieved using the [!GetAttr](/articles/tech/deploy/#getattr) tag

| | Type | Description |
| --- | --- | --- |
| Item | [CurrentLimitMaster](../sdk#currentlimitmaster) | Updated master data of the currently active Usage Limit Models

#### Implementation Example




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

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

```

**Go**
```go

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

```

**PHP**
```php

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

```

**Java**
```java

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

```

**C#**
```csharp

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

```

**TypeScript**
```typescript

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

```

**Python**
```python

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<br>* Set automatically by the server |
| name | string |  | ✓ |  |  ~ 128 chars | Usage Limit Model name<br>Unique Usage Limit Model name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
| metadata | string |  |  |  |  ~ 2048 chars | Metadata<br>Arbitrary values can be set in the metadata.<br>Since they do not affect GS2’s behavior, they can be used to store information used in the game. |
| resetType | string (enum)<br>enum {<br>"notReset",<br>"daily",<br>"weekly",<br>"monthly",<br>"days"<br>}<br> |  | ✓ |  |  | Reset Timing<br>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."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<br>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.<br>* Required if resetType is "monthly" |
| resetDayOfWeek | string (enum)<br>enum {<br>"sunday",<br>"monday",<br>"tuesday",<br>"wednesday",<br>"thursday",<br>"friday",<br>"saturday"<br>}<br> | {resetType} == "weekly" | ✓* |  |  | Reset Day of Week<br>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."sunday": Sunday / "monday": Monday / "tuesday": Tuesday / "wednesday": Wednesday / "thursday": Thursday / "friday": Friday / "saturday": Saturday / <br>* Required if resetType is "weekly" |
| resetHour | int | {resetType} in ["monthly", "weekly", "daily"] | ✓* |  | 0 ~ 23 | Reset Hour<br>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.<br>* Required if resetType is "monthly","weekly","daily" |
| anchorTimestamp | long | {resetType} == "days" | ✓* |  |  | Base date and time for counting elapsed days<br>Unix time, milliseconds<br>* Required if resetType is "days" |
| days | int | {resetType} == "days" | ✓* |  | 1 ~ 2147483646 | Number of Days to Reset<br>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.<br>* Required if resetType is "days" |

---