GS2-Gateway Deploy/CDK Reference

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

GetAttr

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

Implementation Example

• Language:
• GS2-Deploy(YAML)
• Go
• PHP
• Java
• C#
• TypeScript
• Python

Type: GS2::Gateway::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSettingV2: null
  FirebaseSecret: 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/gateway"
)


SampleStack := core.NewStack()
gateway.NewNamespace(
    &SampleStack,
    "namespace-0001",
    gateway.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\Gateway\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\Gateway\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.gateway.model.Namespace(
                this,
                "namespace-0001",
                new io.gs2.cdk.gateway.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.Gs2Gateway.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: new Gs2Cdk.Gs2Gateway.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 gateway from "@/gs2cdk/gateway";

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

class SampleStack(Stack):

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

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.

TransactionSettingV2

Transaction Setting (V2)

Transaction Setting (V2) is the setting that executes transactions with the recommended configuration. A transaction is always executed on the server side and committed atomically. The only value you have to specify is the GS2-Distributor Namespace used to execute the transaction.

By default (enableParallelExecution is false) the actions are executed sequentially so that multiple actions may update the same row. Actions also see the writes of earlier actions in List and Query results and across a nested transaction, and a later verify, consume or acquire action’s parameters may reference the result of an earlier verify or consume action using %{Gs2Xxx:ActionName.path[0].field}. See enableSequentialExecution under Transaction Setting for the details of this behaviour, the order the actions run in, its 20-action limit, and its trade-offs.

When enableParallelExecution is true, the actions are executed in parallel against a single snapshot of the data, which shortens the response time. Use it only when you can guarantee that no two actions in the same transaction write the same data: if two actions write the same row, the transaction fails with database:transaction:same.resource (400). In this mode there is no 20-action limit, and the writes of earlier actions are not visible to later actions. %{...} may reference only the results of an earlier phase (verify, then consume, then acquire); a reference to an action in the same phase is left unresolved. A phase that contains %{...} waits for the earlier phases to complete, which lengthens the response time by that amount.

Setting this fixes the other Transaction Setting fields: enableAutoRun and enableAtomicCommit are true, enableSequentialExecution is the inverse of enableParallelExecution, and transactionUseDistributor, commitScriptResultInUseDistributor, and acquireActionUseJobQueue are false. A Namespace that uses Transaction Setting (V2) therefore cannot execute a transaction as a client-run stamp sheet, cannot run AutoRun asynchronously via GS2-Distributor, and cannot fold acquire actions into GS2-JobQueue.