GS2-Deploy/CDK Reference of GS2-Realtime

Template format used to create GS2-Deploy stacks and examples of template output implementation in various languages using CDK

Entities

Namespace

A namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project. 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.

Type

Condition

Required

Default

Value Limits

Description

name

string

✓

~ 128 chars

Namespace name

description

string

~ 1024 chars

Description

transactionSetting

TransactionSetting

Transaction settings

serverType

String Enum
enum {
“relay”
}

✓

~ 128 chars

Server Type

Enumerator String Definition	Description
“relay”	Packet relay

serverSpec

String Enum
enum {
“realtime1.nano”
}

✓

~ 128 chars

Server Spec

Enumerator String Definition	Description
“realtime1.nano”	realtime1.nano

createNotification

NotificationSetting

Push notification when room creation is finished

logSetting

LogSetting

Log output settings

GetAttr

Generation results of resources that can be obtained with the !GetAttr tag

	Type	Description
Item	Namespace	Namespace created

Implementation Example

Type: GS2::Realtime::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSetting: null
  ServerType: relay
  ServerSpec: realtime1.nano
  CreateNotification: 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/realtime"
    "github.com/openlyinc/pointy"
)

SampleStack := core.NewStack()
realtime.NewNamespace(
    &SampleStack,
    "namespace-0001",
    realtime.NamespaceServerTypeRelay,
    realtime.NamespaceServerSpecRealtime1Nano,
    realtime.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\Realtime\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            serverType: \Gs2Cdk\Realtime\Model\Enums\NamespaceServerType::RELAY,
            serverSpec: \Gs2Cdk\Realtime\Model\Enums\NamespaceServerSpec::REALTIME1_NANO,
            options: new \Gs2Cdk\Realtime\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.realtime.model.Namespace(
                this,
                "namespace-0001",
                io.gs2.cdk.realtime.model.enums.NamespaceServerType.RELAY,
                io.gs2.cdk.realtime.model.enums.NamespaceServerSpec.REALTIME1_NANO,
                new io.gs2.cdk.realtime.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.Gs2Realtime.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            serverType: Gs2Cdk.Gs2Realtime.Model.Enums.NamespaceServerType.Relay,
            serverSpec: Gs2Cdk.Gs2Realtime.Model.Enums.NamespaceServerSpec.Realtime1Nano,
            options: new Gs2Cdk.Gs2Realtime.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 realtime from "@/gs2cdk/realtime";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new realtime.model.Namespace(
            this,
            "namespace-0001",
            realtime.model.NamespaceServerType.RELAY,
            realtime.model.NamespaceServerSpec.REALTIME1_NANO,
            {
                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, realtime

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        realtime.Namespace(
            stack=self,
            name='namespace-0001',
            server_type=realtime.NamespaceServerType.RELAY,
            server_spec=realtime.NamespaceServerSpec.REALTIME1_NANO,
            options=realtime.NamespaceOptions(
                log_setting=core.LogSetting(
                    logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
                ),
            ),
        )

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

NotificationSetting

Push notification settings

This is a setting for sending push notifications when an event occurs in a GS2 microservice. The push notification here refers to the processing via the WebSocket interface provided by GS2-Gateway, and is different from the push notification of a smartphone. For example, when a matchmaking is completed or a friend request is received, the GS2-Gateway can send a push notification via the WebSocket interface, and the game client can detect the change of the state.

GS2-Gateway’s push notifications can be used to send additional processing to mobile push notifications when the destination device is offline. If you use mobile push notifications well, you may be able to realize a flow in which you can notify the player by using mobile push notifications even if you end the game during matchmaking and return to the game.

Type

Condition

Required

Default

Value Limits

Description

gatewayNamespaceId

string

✓

“grn:gs2:{region}:{ownerId}:gateway:default”

~ 1024 chars

GS2-Gateway namespace to use for push notifications

Specify the GS2-Gateway namespace ID in GRN format starting with “grn:gs2:”.

enableTransferMobileNotification

bool?

false

Forwarding to mobile push notification

When this notification is sent, if the destination device is offline, specify whether to forward it to mobile push notification.

sound

string

{enableTransferMobileNotification} == true

~ 1024 chars

Sound file name to be used for mobile push notifications

The sound file name specified here is used when sending mobile push notifications, and you can send notifications with a special sound.

If enableTransferMobileNotification is true, then enabled

enable

String Enum
enum {
“Enabled”,
“Disabled”
}

✓

“Enabled”

~ 128 chars

Whether to enable push notifications

Enumerator String Definition	Description
“Enabled”	Enabled
“Disabled”	Disabled

LogSetting

Log Export Settings

Manages log data export settings. 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, and debugging.

	Type	Condition	Required	Default	Value Limits	Description
loggingNamespaceId	string		✓		~ 1024 chars	GS2-Log namespace GRN to output logs

TransactionSetting

Transaction settings

Transaction settings control how transactions are executed, their consistency, asynchronous processing, and conflict avoidance mechanisms. Combining features like AutoRun, AtomicCommit, Distributor, batch application of script results, and asynchronous acquisition actions via 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 the execution of transactions atomically If enableAutoRun is true, then required
transactionUseDistributor	bool	{enableAtomicCommit} == true	✓	false		Whether to execute transactions asynchronously If enableAtomicCommit is true, then required
commitScriptResultInUseDistributor	bool	{transactionUseDistributor} == true	✓	false		Whether to execute the commit processing of the script result asynchronously If transactionUseDistributor is true, then required
acquireActionUseJobQueue	bool	{enableAtomicCommit} == true	✓	false		Whether to use GS2-JobQueue to execute the acquire action If enableAtomicCommit is true, then required
distributorNamespaceId	string		✓	“grn:gs2:{region}:{ownerId}:distributor:default”	~ 1024 chars	GS2-Distributor namespace used for transaction execution
queueNamespaceId	string		✓	“grn:gs2:{region}:{ownerId}:queue:default”	~ 1024 chars	Namespace in GS2-JobQueue used to run the transaction