GS2-Deploy/CDK Reference of GS2-Chat

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

Entities

Namespace

Namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project. Each GS2 service is managed per namespace. Services within different namespaces are treated as completely independent data spaces, even if they are the same service.

Therefore, it is necessary to create a namespace before starting to use each service.

	Type	Required	Default	Value Limits	Description
name	string	✓		~ 128 chars	Namespace name This name is used to identify the namespace and is specified in alphanumeric characters.
description	string			~ 1024 chars	Description
transactionSetting	TransactionSetting				Transaction settings
allowCreateRoom	bool	✓	true		Allow game players to create rooms If the game operator creates the rooms in advance and the game player joins the rooms, specify “false”. On the other hand, if the game player creates the rooms freely and invites other players to play, specify “true”.
messageLifeTimeDays	int	✓	1	1 ~ 30	Message retention period(days) The number of days to keep messages in the room.
postMessageScript	ScriptSetting				Script to run when you post a message
createRoomScript	ScriptSetting				Script to run when a room is created
deleteRoomScript	ScriptSetting				Script to run when a room is deleted
subscribeRoomScript	ScriptSetting				Script to run when a room is subscribed
unsubscribeRoomScript	ScriptSetting				Script to run when a room is unsubscribed
postNotification	NotificationSetting	✓			Push notifications when new posts come to the rooms to which you are subscribed
logSetting	LogSetting				Log output settings Manages log output settings. This type holds the GS2-Log namespace information used to output log data.

GetAttr

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

	Type	Description
Item	Namespace	Namespace created

Implementation Example

Type: GS2::Chat::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSetting: null
  AllowCreateRoom: null
  MessageLifeTimeDays: null
  PostMessageScript: null
  CreateRoomScript: null
  DeleteRoomScript: null
  SubscribeRoomScript: null
  UnsubscribeRoomScript: null
  PostNotification: 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/chat"
    "github.com/openlyinc/pointy"
)

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

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

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        chat.Namespace(
            stack=self,
            name='namespace-0001',
            options=chat.NamespaceOptions(
                log_setting=core.LogSetting(
                    logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
                ),
            ),
        )

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

CurrentModelMaster

Currently available master data

GS2 uses JSON format files for master data management. By uploading the file, you can actually reflect the settings on the server.

To create JSON files, we provide a master data editor within the management console. Additionally, you can utilize the service by creating tools more suited to game operations and exporting JSON files in the appropriate format.

Note

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

Type

Condition

Required

Default

Value Limits

Description

namespaceName

string

✓

~ 128 chars

Namespace name

This name is used to identify the namespace and is specified in alphanumeric characters.

mode

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

✓

“direct”

~ 128 chars

Update mode

Enumerator String Definition	Description
“direct”	Directly update the settings
“preUpload”	Upload the settings and then update

settings

string

{mode} == “direct”

✓

~ 5242880 chars

Master data

If mode is “direct”, then required

uploadToken

string

{mode} == “preUpload”

✓

~ 1024 chars

Token used to reflect results after upload

If mode is “preUpload”, then required

GetAttr

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

	Type	Description
Item	CurrentModelMaster	Updated and currently available category settings

Implementation Example

Type: GS2::Chat::CurrentModelMaster
Properties:
  NamespaceName: namespace-0001
  Mode: null
  Settings: {
    "version": "2020-04-30",
    "categoryModels": [
      {
        "category": 0,
        "rejectAccessTokenPost": "Disabled"
      },
      {
        "category": 1,
        "rejectAccessTokenPost": "Disabled"
      }
    ]
  }
  UploadToken: null

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

SampleStack := core.NewStack()
chat.NewNamespace(
    &SampleStack,
    "namespace-0001",
    chat.NamespaceOptions{},
).MasterData(
    []chat.CategoryModel{
        chat.NewCategoryModel(
            0,
            chat.CategoryModelOptions{
                RejectAccessTokenPost: chat.CategoryModelRejectAccessTokenPostDisabled.Pointer(),
            },
        ),
        chat.NewCategoryModel(
            1,
            chat.CategoryModelOptions{
                RejectAccessTokenPost: chat.CategoryModelRejectAccessTokenPostDisabled.Pointer(),
            },
        ),
    },
)

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

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Chat\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
                new \Gs2Cdk\Chat\Model\CategoryModel(
                    category:0,
                    options: new \Gs2Cdk\Chat\Model\Options\CategoryModelOptions(
                        rejectAccessTokenPost:Gs2Cdk\Chat\Model\Enums\CategoryModelRejectAccessTokenPost::DISABLED
                    )
                ),
                new \Gs2Cdk\Chat\Model\CategoryModel(
                    category:1,
                    options: new \Gs2Cdk\Chat\Model\Options\CategoryModelOptions(
                        rejectAccessTokenPost:Gs2Cdk\Chat\Model\Enums\CategoryModelRejectAccessTokenPost::DISABLED
                    )
                )
            ]
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.chat.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.chat.model.CategoryModel(
                    0,
                    new io.gs2.cdk.chat.model.options.CategoryModelOptions()
                        .withRejectAccessTokenPost(io.gs2.cdk.chat.model.enums.CategoryModelRejectAccessTokenPost.DISABLED)
                ),
                new io.gs2.cdk.chat.model.CategoryModel(
                    1,
                    new io.gs2.cdk.chat.model.options.CategoryModelOptions()
                        .withRejectAccessTokenPost(io.gs2.cdk.chat.model.enums.CategoryModelRejectAccessTokenPost.DISABLED)
                )
            )
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Chat.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2Chat.Model.CategoryModel[] {
                new Gs2Cdk.Gs2Chat.Model.CategoryModel(
                    category: 0,
                    options: new Gs2Cdk.Gs2Chat.Model.Options.CategoryModelOptions
                    {
                        rejectAccessTokenPost = Gs2Cdk.Gs2Chat.Model.Enums.CategoryModelRejectAccessTokenPost.Disabled
                    }
                ),
                new Gs2Cdk.Gs2Chat.Model.CategoryModel(
                    category: 1,
                    options: new Gs2Cdk.Gs2Chat.Model.Options.CategoryModelOptions
                    {
                        rejectAccessTokenPost = Gs2Cdk.Gs2Chat.Model.Enums.CategoryModelRejectAccessTokenPost.Disabled
                    }
                )
            }
        );
    }
}

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

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new chat.model.Namespace(
            this,
            "namespace-0001",
        ).masterData(
            [
                new chat.model.CategoryModel(
                    0,
                    {
                        rejectAccessTokenPost: chat.model.CategoryModelRejectAccessTokenPost.DISABLED
                    }
                ),
                new chat.model.CategoryModel(
                    1,
                    {
                        rejectAccessTokenPost: chat.model.CategoryModelRejectAccessTokenPost.DISABLED
                    }
                )
            ]
        );
    }
}

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

from gs2_cdk import Stack, core, chat

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        chat.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            category_models=[
                chat.CategoryModel(
                    category=0,
                    options=chat.CategoryModelOptions(
                        reject_access_token_post = chat.CategoryModelRejectAccessTokenPost.DISABLED
                    ),
                ),
                chat.CategoryModel(
                    category=1,
                    options=chat.CategoryModelOptions(
                        reject_access_token_post = chat.CategoryModelRejectAccessTokenPost.DISABLED
                    ),
                ),
            ],
        )

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

NotificationType

Notification Type

Setting categories for receiving new message notifications

	Type	Condition	Required	Default	Value Limits	Description
category	int		✓	0	0 ~ 2147483646	Categories for which you receive new message notifications
enableTransferMobilePushNotification	bool		✓	false		Transfer to mobile push notifications when you were offline?

ScriptSetting

Script settings

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 execution result to stop the execution of the API or to tamper with the result of the API.

In contrast, asynchronous execution does not block processing until the script has finished executing. Since the script result cannot be used to stop the API execution or modify the API response, asynchronous execution does not affect the API’s response flow. For this reason, asynchronous execution 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

Script GRN of synchronous execution script

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

doneTriggerTargetType

String Enum
enum {
  “none”,
  “gs2_script”,
  “aws”
}

✓

“none”

~ 128 chars

How to execute asynchronous scripts

Specifies the type of script to use for asynchronous execution.
You can choose from “Do not use asynchronous execution scripts (none)”, “Use GS2-Script (gs2_script)”, and “Use Amazon EventBridge (aws)”.

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

doneTriggerScriptId

string

{doneTriggerTargetType} == “gs2_script”

~ 1024 chars

Script GRN of asynchronous execution script

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

If doneTriggerTargetType is “gs2_script”, then enabled

doneTriggerQueueNamespaceId

string

{doneTriggerTargetType} == “gs2_script”

~ 1024 chars

GS2-JobQueue namespace 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 is little reason to use GS2-JobQueue, so you don’t need to specify it unless you have a specific reason.

If doneTriggerTargetType is “gs2_script”, then enabled

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

GitHubCheckoutSetting

Setup to check out master data from GitHub

Type

Condition

Required

Default

Value Limits

Description

apiKeyId

string

✓

~ 1024 chars

GitHub API key GRN

repositoryName

string

✓

~ 1024 chars

Repository Name

sourcePath

string

✓

~ 1024 chars

Master data (JSON) file path

referenceType

String Enum
enum {
  “commit_hash”,
  “branch”,
  “tag”
}

✓

~ 128 chars

Source of code

Enumerator String Definition	Description
“commit_hash”	Commit hash
“branch”	Branch
“tag”	Tag

commitHash

string

{referenceType} == “commit_hash”

✓

~ 1024 chars

Commit hash

If referenceType is “commit_hash”, then required

branchName

string

{referenceType} == “branch”

✓

~ 1024 chars

Branch Name

If referenceType is “branch”, then required

tagName

string

{referenceType} == “tag”

✓

~ 1024 chars

Tag Name

If referenceType is “tag”, then required