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

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	Default	Value Limits	Description
name	string	✓		~ 128 chars	Namespace name Unique Namespace name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
description	string			~ 1024 chars	Description
transactionSettingV2	TransactionSettingV2				Transaction Setting (V2) Decides how the transactions this Namespace issues are executed. There are only two things to set: the GS2-Distributor Namespace that executes them, and whether the actions in a transaction run one at a time – so that a later action can build on what an earlier one wrote – or all at once for a shorter response time. Set this on a new Namespace. `transactionSetting`, the obsolete setting it replaces, is used only while this is unset.
allowCreateRoom	bool		true		Whether to allow game players to create rooms If the game operator pre-creates rooms and players subscribe to them, 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 setting to be executed when a message is posted Script Trigger Reference - `postMessage`
createRoomScript	ScriptSetting				Script setting to be executed when a room is created Script Trigger Reference - `createRoom`
deleteRoomScript	ScriptSetting				Script setting to be executed when a room is deleted Script Trigger Reference - `deleteRoom`
subscribeRoomScript	ScriptSetting				Script setting to be executed when subscribing to a room Script Trigger Reference - `subscribeRoom`
unsubscribeRoomScript	ScriptSetting				Script setting to be executed when unsubscribing from a room Script Trigger Reference - `unsubscribeRoom`
postNotification	NotificationSetting	✓			Push notifications when new posts are added to subscribed rooms Configuration for sending push notifications via GS2-Gateway when a new message is posted to a subscribed room. Without this setting, clients must poll rooms to detect new messages.
logSetting	LogSetting				Log Output Setting Manages log output settings. This type holds the GS2-Log Namespace information used to output log data.

GetAttr

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

	Type	Description
Item	Namespace	Namespace created

Implementation Example

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


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

TransactionSettingV2

Transaction Setting (V2)

Transaction Setting (V2) decides how the transactions issued by a Namespace are executed.

There are only two things to set:

distributorNamespaceId: the GS2-Distributor Namespace used to execute the transaction
enableParallelExecution: whether the actions in a transaction run one at a time or all at once

Whichever you choose, the transaction is executed by the server the moment it is issued, and it succeeds or fails as a whole: when an action fails, the actions that already ran are undone with it and nothing is left applied. Everything else about how a transaction runs is fixed to the recommended configuration, so there is nothing else to set.

Running the actions one at a time (the default, enableParallelExecution is false) lets each action work on top of what the actions before it wrote. The actions run in verify, consume, acquire order, and this is what lets you:

update the same row from more than one action in a single transaction, which fails when they run all at once
read what an earlier action wrote, including from List and Query and from inside a nested transaction
use %{Gs2Xxx:ActionName.path[0].field} to feed the result of an earlier verify or consume action into the parameters of a later verify, consume or acquire action

In exchange, the response time is the sum of the time taken by each action, and a transaction may contain at most 20 actions. The order within each phase is decided by the action name and then by the target resource, so you cannot choose the execution order by rearranging the actions in the request, and execution stops at the first action that fails.

Running the actions all at once (enableParallelExecution is true) executes them in parallel against a single snapshot of the data, so the response time is that of the slowest single action and there is no limit on the number of actions.

In exchange, an action cannot see what the other actions wrote, and two actions that write the same row fail the transaction with database:transaction:same.resource (400), so choose this only when you can guarantee that no two actions in the same transaction write the same data. %{...} 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, and a phase that contains %{...} waits for the earlier phases to complete, which lengthens the response time by that amount.

Transaction Setting is the obsolete setting that Transaction Setting (V2) replaces, kept for Namespaces created before Transaction Setting (V2) existed. It applies only while Transaction Setting (V2) is unset, and setting Transaction Setting (V2) supersedes it. Three behaviours it allowed are deliberately not offered here: executing a transaction as a client-run stamp sheet, running AutoRun asynchronously via GS2-Distributor, and folding acquire actions into GS2-JobQueue.

	Type	Condition	Required	Default	Value Limits	Description
distributorNamespaceId	string			“grn:gs2:{region}:{ownerId}:distributor:default”	~ 1024 chars	GS2-Distributor Namespace GRN used to execute transactions
enableParallelExecution	bool			false		Whether to execute the actions in parallel instead of sequentially

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

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

doneTriggerTargetType

string (enum)
enum {
  “none”,
  “gs2_script”,
  “aws”
}

“none”

Asynchronous script execution method

Specifies the type of script to use for asynchronous execution.
You can choose from “Do not use an asynchronous execution script (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:”.

* Enabled only if doneTriggerTargetType is “gs2_script”

doneTriggerQueueNamespaceId

string

{doneTriggerTargetType} == “gs2_script”

~ 1024 chars

GS2-JobQueue Namespace GRN used to execute asynchronous scripts

If you want to execute asynchronous execution scripts via GS2-JobQueue instead of executing them directly, specify the GS2-JobQueue Namespace GRN.
GS2-JobQueue is generally not required unless you have a specific reason to use it.

* Enabled only if doneTriggerTargetType is “gs2_script”

NotificationSetting

Push Notification Setting

Configuration for sending push notifications when events occur in GS2 microservices. 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 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 forward notifications to mobile push notification services when the destination device is offline. By properly utilizing mobile push notifications, you can implement a flow in which players are notified even if they exit the game during matchmaking and later return to it.

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

Whether to forward the notification as a mobile push notification

When an attempt is made to send this notification and the destination device is offline, specify whether it should be forwarded as a 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.

* Enabled only if enableTransferMobileNotification is true

mobileNotificationMessages

List<MobileNotificationMessage>

{enableTransferMobileNotification} == true

0 ~ 100 items

Localized title and body used when forwarding to mobile push notifications

The title and the body, per language, used when the notification is forwarded as a mobile push notification to an offline player.
The entry to be used is selected in the following order: the entry whose locale matches the locale registered with the device token, then the entry whose locale is default, and finally the first entry of the list.
If this is not set, the mobile array of the notification payload is used instead, and if that is not present either, the payload itself is used as the body.

* Enabled only if enableTransferMobileNotification is true

enable

string (enum)
enum {
“Enabled”,
“Disabled”
}

“Enabled”

Whether to enable push notifications

Definition	Description
Enabled	Enabled
Disabled	Disabled

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 Must be specified in GRN format starting with “grn:gs2:”.

TransactionSetting

Transaction Setting

Transaction Setting is obsolete: Transaction Setting (V2) replaces it. It is kept for Namespaces created before Transaction Setting (V2) existed, applies only while Transaction Setting (V2) is unset, and should not be chosen for a new Namespace.

It exposes each part of transaction execution as a separate field – AutoRun, AtomicCommit, asynchronous execution using GS2-Distributor, batch application of script results, asynchronous processing of acquire actions via GS2-JobQueue, and sequential execution – so combinations other than the recommended one can be built. Transaction Setting (V2) is that recommended combination expressed as a single setting. Keep using Transaction Setting only on a Namespace that already depends on a behaviour Transaction Setting (V2) does not offer: executing a transaction as a client-run stamp sheet, running AutoRun asynchronously via GS2-Distributor, or folding acquire actions into GS2-JobQueue.

	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 transactions atomically * Enabled only if enableAutoRun is true
transactionUseDistributor	bool	{enableAtomicCommit} == true	false		Whether to execute transactions asynchronously * Enabled only if enableAtomicCommit is true
commitScriptResultInUseDistributor	bool	{transactionUseDistributor} == true	false		Whether to execute the commit processing of the script result asynchronously * Enabled only if transactionUseDistributor is true
acquireActionUseJobQueue	bool	{enableAtomicCommit} == true	false		Whether to use GS2-JobQueue to execute the acquire action * Enabled only if enableAtomicCommit is true
enableSequentialExecution	bool	{enableAtomicCommit} == true	false		Whether to execute the actions of an atomic commit sequentially so that multiple actions may update the same row * 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

MobileNotificationMessage

Localized message for mobile push notification

One entry of the per-locale message list used when a notification is forwarded as a mobile push notification. Each entry holds the title and the body for one locale. The entry to be used is selected in the following order: the entry whose locale matches the locale registered with the Firebase device token, then the entry whose locale is default, and finally the first entry of the list.

	Type	Value Limits	Description
locale	string	~ 32 chars	Language of the message The language this entry is for, matched against the locale registered with the Firebase device token. The value is free-form, such as `ja` or `en`. The special value `default` marks the fallback entry used when no entry matches the device locale.
title	string	~ 256 chars	Title of the push notification The text displayed as the title of the mobile push notification when this entry is selected. If omitted, the subject of the notification is used.
message	string	~ 1024 chars	Body text of the push notification The text displayed as the body of the mobile push notification when this entry is selected.

CurrentModelMaster

Currently active Message Category Model master data

This master data defines the Message Category 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-Chat Master Data Reference for the JSON file format.

Request

Resource creation and update requests

Type

Condition

Required

Default

Value Limits

Description

namespaceName

string

✓

~ 128 chars

Namespace name

Unique Namespace 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 bytes (5MB)

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	CurrentModelMaster	Updated master data of the currently active Message Category Models

Implementation Example

Type: GS2::Chat::CurrentModelMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  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"
)


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

CategoryModel

Message Category Model

A Message Category Model defines the categories used to classify messages posted in chat rooms. Each category is identified by a numeric value, and you can configure whether posts using player access tokens are accepted or rejected per category. This enables use cases such as system-only announcement categories where only the server can post messages.

Type

Condition

Required

Default

Value Limits

Description

categoryModelId

string

~ 1024 chars

Message Category Model GRN

* Set automatically by the server