GS2-Deploy/CDK Reference of GS2-Inbox
Entity
Resources operated in Deploy process
Namespace
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 | |
|---|---|---|---|---|---|---|
| namespaceId | string | ✓ | ~ 1024 chars | Namespace GRN | ||
| name | string | ✓ | ~ 128 chars | Namespace name | ||
| description | string | ~ 1024 chars | Description | |||
| isAutomaticDeletingEnabled | bool | ✓ | false | Whether to automatically remove opened messages from the message list | ||
| transactionSetting | TransactionSetting | Transaction settings | ||||
| receiveMessageScript | ScriptSetting | Script to run when a message is received | ||||
| readMessageScript | ScriptSetting | Script to run when a message is opened | ||||
| deleteMessageScript | ScriptSetting | Script to run when a message is deleted | ||||
| receiveNotification | NotificationSetting | Push notifications when messages are received | ||||
| logSetting | LogSetting | Log output settings | ||||
| createdAt | long | ✓ | Now | Datetime of creation Unix time, milliseconds Automatically configured on the server | ||
| updatedAt | long | ✓ | Now | Datetime of last update Unix time, milliseconds Automatically configured on the server | ||
| revision | long | 0 | 0 ~ 9223372036854775805 | Revision |
GetAttr
Generation results of resources that can be obtained with the !GetAttr tag
| Type | Description | |
|---|---|---|
| Item | Namespace | Namespace created |
Implementation Example
Type: GS2::Inbox::Namespace
Properties:
Name: namespace-0001
Description: null
IsAutomaticDeletingEnabled: null
TransactionSetting:
EnableAutoRun: true
QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
ReceiveMessageScript: null
ReadMessageScript: null
DeleteMessageScript: null
ReceiveNotification: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001import (
"github.com/gs2io/gs2-golang-cdk/core"
"github.com/gs2io/gs2-golang-cdk/inbox"
"github.com/gs2io/gs2-golang-cdk/inventory"
"github.com/openlyinc/pointy"
)
SampleStack := core.NewStack()
inbox.NewNamespace(
&SampleStack,
"namespace-0001",
inbox.NamespaceOptions{
TransactionSetting: &core.TransactionSetting{
QueueNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"),
},
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\Inbox\Model\Namespace_(
stack: $this,
name: "namespace-0001",
options: new \Gs2Cdk\Inbox\Model\Options\NamespaceOptions(
transactionSetting: new \Gs2Cdk\Core\Model\TransactionSetting(
new \Gs2Cdk\Core\Model\TransactionSettingOptions(
queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
)
),
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.inbox.model.Namespace(
this,
"namespace-0001",
new io.gs2.cdk.inbox.model.options.NamespaceOptions()
.withTransactionSetting(new io.gs2.cdk.core.model.TransactionSetting(
new io.gs2.cdk.core.model.options.TransactionSettingOptions()
.withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001")
))
.withLogSetting(new io.gs2.cdk.core.model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
))
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Templatepublic class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Inbox.Model.Namespace(
stack: this,
name: "namespace-0001",
options: new Gs2Cdk.Gs2Inbox.Model.Options.NamespaceOptions
{
transactionSetting = new Gs2Cdk.Core.Model.TransactionSetting(
options: new Gs2Cdk.Core.Model.TransactionSettingOptions
{
queueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
}
),
logSetting = new Gs2Cdk.Core.Model.LogSetting(
loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Templateimport core from "@/gs2cdk/core";
import inbox from "@/gs2cdk/inbox";
class SampleStack extends core.Stack
{
public constructor() {
super();
new inbox.model.Namespace(
this,
"namespace-0001",
{
transactionSetting: new core.TransactionSetting(
{
queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-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, inbox
class SampleStack(Stack):
def __init__(self):
super().__init__()
inbox.Namespace(
stack=self,
name='namespace-0001',
options=inbox.NamespaceOptions(
transaction_setting=core.TransactionSetting(
options=core.TransactionSettingOptions(
queue_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001',
)
),
log_setting=core.LogSetting(
logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
),
),
)
print(SampleStack().yaml()) # Generate TemplateScriptSetting
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)”.
| |||||||||
| doneTriggerScriptId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024 chars | Script GRN
of asynchronous execution script Must be specified in GRN format starting with “grn:gs2:”. * Enabled if doneTriggerTargetType is “gs2_script” | ||||||||||
| doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024 chars | GS2-JobQueue namespace GRN
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. * Enabled if doneTriggerTargetType is “gs2_script” |
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. * Enabled if enableTransferMobileNotification is true | ||||||||
| enable | String Enum enum { “Enabled”, “Disabled” } | ✓ | “Enabled” | ~ 128 chars | Whether to enable push notifications
|
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 * Required if enableAutoRun is true | |
| transactionUseDistributor | bool | {enableAtomicCommit} == true | ✓* | false | Whether to execute transactions asynchronously * Required if enableAtomicCommit is true | |
| commitScriptResultInUseDistributor | bool | {transactionUseDistributor} == true | ✓* | false | Whether to execute the commit processing of the script result asynchronously * Required if transactionUseDistributor is true | |
| acquireActionUseJobQueue | bool | {enableAtomicCommit} == true | ✓* | false | Whether to use GS2-JobQueue to execute the acquire action * Required if enableAtomicCommit is true | |
| 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 |
CurrentMessageMaster
Currently Available Master Data
GS2 uses JSON format files for managing master data. By uploading these files, the settings are applied 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 operating your game and export JSON files in the appropriate format.
Note
Please refer to Master Data Reference of GS2-Inbox for the JSON file format.| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| namespaceId | string | ✓ | ~ 1024 chars | Namespace GRN | ||
| settings | string | ✓ | ~ 5242880 bytes (5MB) | Master Data |
GetAttr
Generation results of resources that can be obtained with the !GetAttr tag
| Type | Description | |
|---|---|---|
| Item | CurrentMessageMaster | Updated and currently available global message settings |
Implementation Example
Type: GS2::Inbox::CurrentMessageMaster
Properties:
NamespaceName: namespace-0001
Mode: direct
Settings: {
"version": "2020-03-12",
"globalMessages": [
{
"name": "message-0001",
"metadata": "hoge"
},
{
"name": "message-0002",
"metadata": "fuga",
"readAcquireActions": [
{
"action": "Gs2Inventory:AcquireItemSetByUserId",
"request": {
"namespaceName": "namespace-0001",
"inventoryName": "inventory-0001",
"itemName": "item-0001",
"acquireCount": 1,
"expireAt": null,
"createNewItemSet": false,
"itemSetName": null
}
}
],
"expiresTimeSpan":
{
"days": 1,
"hours": 2,
"minutes": 3
}
},
{
"name": "message-0003",
"metadata": "piyo"
}
]
}
UploadToken: nullimport (
"github.com/gs2io/gs2-golang-cdk/core"
"github.com/gs2io/gs2-golang-cdk/inbox"
"github.com/gs2io/gs2-golang-cdk/inventory"
"github.com/openlyinc/pointy"
)
SampleStack := core.NewStack()
inbox.NewNamespace(
&SampleStack,
"namespace-0001",
inbox.NamespaceOptions{},
).MasterData(
[]inbox.GlobalMessage{
inbox.NewGlobalMessage(
"message-0001",
"hoge",
inbox.GlobalMessageOptions{
},
),
inbox.NewGlobalMessage(
"message-0002",
"fuga",
inbox.GlobalMessageOptions{
ReadAcquireActions: []core.AcquireAction{
inventory.AcquireItemSetByUserId(
"namespace-0001",
"inventory-0001",
"item-0001",
1,
nil,
pointy.Bool(false),
nil,
),
},
ExpiresTimeSpan: &inbox.TimeSpan{
},
},
),
inbox.NewGlobalMessage(
"message-0003",
"piyo",
inbox.GlobalMessageOptions{
},
),
},
)
println(SampleStack.Yaml()) // Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
(new \Gs2Cdk\Inbox\Model\Namespace_(
stack: $this,
name: "namespace-0001"
))->masterData(
[
new \Gs2Cdk\Inbox\Model\GlobalMessage(
name:"message-0001",
metadata:"hoge"
),
new \Gs2Cdk\Inbox\Model\GlobalMessage(
name:"message-0002",
metadata:"fuga",
options: new \Gs2Cdk\Inbox\Model\Options\GlobalMessageOptions(
readAcquireActions:[
new \Gs2Cdk\Inventory\StampSheet\AcquireItemSetByUserId(
namespaceName: "namespace-0001",
inventoryName: "inventory-0001",
itemName: "item-0001",
acquireCount: 1,
userId: "#{userId}"
),
],
expiresTimeSpan:new \Gs2Cdk\Inbox\Model\TimeSpan(
days: 1,
hours: 2,
minutes: 3,
)
)
),
new \Gs2Cdk\Inbox\Model\GlobalMessage(
name:"message-0003",
metadata:"piyo"
)
]
);
}
}
print((new SampleStack())->yaml()); // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.inbox.model.Namespace(
this,
"namespace-0001"
).masterData(
Arrays.asList(
new io.gs2.cdk.inbox.model.GlobalMessage(
"message-0001",
"hoge"
),
new io.gs2.cdk.inbox.model.GlobalMessage(
"message-0002",
"fuga",
new io.gs2.cdk.inbox.model.options.GlobalMessageOptions()
.withReadAcquireActions(Arrays.asList(
new io.gs2.cdk.inventory.stampSheet.AcquireItemSetByUserId(
"namespace-0001",
"inventory-0001",
"item-0001",
1L,
0L,
false,
"",
"#{userId}"
)
))
.withExpiresTimeSpan(new io.gs2.cdk.inbox.model.TimeSpan(
1,
2,
3
))
),
new io.gs2.cdk.inbox.model.GlobalMessage(
"message-0003",
"piyo"
)
)
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Templatepublic class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Inbox.Model.Namespace(
stack: this,
name: "namespace-0001"
).MasterData(
new Gs2Cdk.Gs2Inbox.Model.GlobalMessage[] {
new Gs2Cdk.Gs2Inbox.Model.GlobalMessage(
name: "message-0001",
metadata: "hoge"
),
new Gs2Cdk.Gs2Inbox.Model.GlobalMessage(
name: "message-0002",
metadata: "fuga",
options: new Gs2Cdk.Gs2Inbox.Model.Options.GlobalMessageOptions
{
readAcquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
{
new Gs2Cdk.Gs2Inventory.StampSheet.AcquireItemSetByUserId(
namespaceName: "namespace-0001",
inventoryName: "inventory-0001",
itemName: "item-0001",
acquireCount: 1,
userId: "#{userId}"
)
},
expiresTimeSpan = new Gs2Cdk.Gs2Inbox.Model.TimeSpan_(
days: 1,
hours: 2,
minutes: 3
)
}
),
new Gs2Cdk.Gs2Inbox.Model.GlobalMessage(
name: "message-0003",
metadata: "piyo"
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Templateimport core from "@/gs2cdk/core";
import inbox from "@/gs2cdk/inbox";
class SampleStack extends core.Stack
{
public constructor() {
super();
new inbox.model.Namespace(
this,
"namespace-0001",
).masterData(
[
new inbox.model.GlobalMessage(
"message-0001",
"hoge"
),
new inbox.model.GlobalMessage(
"message-0002",
"fuga",
{
readAcquireActions: [
new inventory.stampSheet.AcquireItemSetByUserId(
"namespace-0001",
"inventory-0001",
"item-0001",
1,
null,
null,
"#{userId}"
),
],
expiresTimeSpan: new inbox.model.TimeSpan(
1,
2,
3
)
}
),
new inbox.model.GlobalMessage(
"message-0003",
"piyo"
)
]
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
from gs2_cdk import Stack, core, inbox
class SampleStack(Stack):
def __init__(self):
super().__init__()
inbox.Namespace(
stack=self,
name="namespace-0001",
).master_data(
global_messages=[
inbox.GlobalMessage(
name='message-0001',
metadata='hoge'
),
inbox.GlobalMessage(
name='message-0002',
metadata='fuga',
options=inbox.GlobalMessageOptions(
read_acquire_actions = [
inventory.AcquireItemSetByUserId(
namespace_name='namespace-0001',
inventory_name='inventory-0001',
item_name='item-0001',
acquire_count=1,
user_id='#{userId}'
),
],
expires_time_span = inbox.TimeSpan(
days=1,
hours=2,
minutes=3,
)
),
),
inbox.GlobalMessage(
name='message-0003',
metadata='piyo'
),
],
)
print(SampleStack().yaml()) # Generate TemplateGlobalMessage
Global Messages
Global messages are a mechanism for delivering messages to all game players.
Global messages can have an expiration date, and each game player can receive a global message by executing the process of receiving a global message. Unreceived global messages within the validity period are copied to your message box.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| globalMessageId | string | ✓ | ~ 1024 chars | Message GRN to all users | ||
| name | string | ✓ | ~ 128 chars | Name of message for all users | ||
| metadata | string | ✓ | ~ 4096 chars | Metadata corresponding to the content of the message to all users | ||
| readAcquireActions | List<AcquireAction> | [] | 0 ~ 100 items | Acquisition actions to be performed upon opening | ||
| expiresTimeSpan | TimeSpan | The period of time between receipt of a message and deletion of the message | ||||
| messageReceptionPeriodEventId | string | ~ 1024 chars | GS2-Schedule event GRN that sets the time period during which the message can be received |
TimeSpan
Time Interval
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| days | int | ✓ | 0 | 0 ~ 365 | Number of days from the reference time | |
| hours | int | ✓ | 0 | 0 ~ 24 | Hours from the reference time | |
| minutes | int | ✓ | 0 | 0 ~ 60 | Minutes from the reference time |
AcquireAction
Acquire Action