GS2-Deploy/CDK Reference of GS2-Idle
Entities
Namespace
Namespace
Namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project. Basically, GS2 services have a layer called namespace, and different namespaces are treated as completely different data spaces, even for the same service.
Therefore, it is necessary to create a namespace before starting to use each service.
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| name | string | ✓ | ~ 128 chars | Namespace name | |
| description | string | ~ 1024 chars | Description | ||
| transactionSetting | TransactionSetting | ✓ | Transaction settings | ||
| receiveScript | ScriptSetting | Script to be executed when the receive rewards | |||
| overrideAcquireActionsScriptId | string | ~ 1024 chars | Dynamic script to determine the action to obtain the placement reward | ||
| logSetting | LogSetting | Log output settings |
GetAttr
| Type | Description | |
|---|---|---|
| Item | Namespace | Namespace created |
Implementation Example
Type: GS2::Idle::Namespace
Properties:
Name: namespace1
Description: null
TransactionSetting:
EnableAutoRun: false
QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
KeyId: grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001
ReceiveScript: null
OverrideAcquireActionsScriptId: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1from gs2_cdk import Stack, core, idle
class SampleStack(Stack):
def __init__(self):
super().__init__()
idle.Namespace(
stack=self,
name="namespace-0001",
options=idle.NamespaceOptions(
transaction_setting=core.TransactionSetting(
queue_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001',
options=core.TransactionSettingOptions(
key_id='grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001',
)
),
log_setting=core.LogSetting(
logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
),
),
)
print(SampleStack().yaml()) # Generate Templateclass SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
new \Gs2Cdk\Idle\Model\Namespace_(
stack: $this,
name: "namespace-0001",
options: new \Gs2Cdk\Idle\Model\Options\NamespaceOptions(
transactionSetting: new \Gs2Cdk\Core\Model\TransactionSetting(
enableAutoRun: True,
queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
options: new \Gs2Cdk\Core\Model\Options\TransactionSettingOptions(
keyId: "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-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.idle.model.Namespace(
this,
"namespace-0001",
new io.gs2.cdk.idle.model.options.NamespaceOptions() {
{
transactionSetting = new io.gs2.cdk.core.model.TransactionSetting(){
{
queueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001";
},
new io.gs2.cdk.core.model.options.TransactionSettingOptions(
"grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
)
);
logSetting = new io.gs2.cdk.core.model.LogSetting(
loggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
);
}
}
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Templateimport core from "@/gs2cdk/core";
import idle from "@/gs2cdk/idle";
class SampleStack extends core.Stack
{
public constructor() {
super();
new idle.model.Namespace(
this,
"namespace-0001",
{
transactionSetting: new core.TransactionSetting(
,
"grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
{
"grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
}
),
logSetting: new core.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Idle.Model.Namespace(
this,
"namespace-0001",
new Gs2Cdk.Gs2Idle.Model.Options.NamespaceOptions {
transactionSetting = new Gs2Cdk.Core.Model.TransactionSetting(
new Gs2Cdk.Core.Model.Options.TransactionSettingOptions {
queueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
},
new Gs2Cdk.Core.Model.Options.TransactionSettingOptions(
KeyId = "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
}
),
logSetting = new Gs2Cdk.Core.Model.LogSetting(
LoggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate TemplateCurrentCategoryMaster
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.
We provide a master data editor on the management console as a way to create JSON files, but you can also create JSON files using the The service can also be used by creating a tool more appropriate for game management and exporting a JSON file in the appropriate format.
Note
Please refer to Master Data Reference of GS2-Idle for the JSON file format.| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name | |
| settings | string | ✓ | ~ 5242880 chars | Master data |
GetAttr
| Type | Description | |
|---|---|---|
| Item | CurrentCategoryMaster | Updated and currently available idle settings |
Implementation Example
Type: GS2::Idle::CurrentCategoryMaster
Properties:
NamespaceName: namespace1
Settings: {
"version": "2023-06-06",
"categoryModels": [
{
"name": "category-0001",
"rewardIntervalMinutes": 5,
"defaultMaximumIdleMinutes": 1440,
"acquireActions": [
{
"acquireActions": [
{
"action": "ca",
"request":
"namespaceName": "namespace-0001",
"experienceName": "player",
"userId": "#{userId}",
"propertyId": "player",
"experienceValue": 10
}
]
},
{
"acquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request":
"namespaceName": "namespace-0001",
"experienceName": "player",
"userId": "#{userId}",
"propertyId": "player",
"experienceValue": 5
}
]
}
]
},
{
"name": "category-0002",
"rewardIntervalMinutes": 5,
"defaultMaximumIdleMinutes": 1440,
"acquireActions": [
{
"acquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request":
"namespaceName": "namespace-0001",
"experienceName": "player",
"userId": "#{userId}",
"propertyId": "player",
"experienceValue": 10
}
]
},
{
"acquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request":
"namespaceName": "namespace-0001",
"experienceName": "player",
"userId": "#{userId}",
"propertyId": "player",
"experienceValue": 5
}
]
}
],
"idlePeriodScheduleId": "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001",
"receivePeriodScheduleId": "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002"
}
]
}from gs2_cdk import Stack, core, idle
class SampleStack(Stack):
def __init__(self):
super().__init__()
idle.Namespace(
stack=self,
# omission
).master_data(
category_models=[
idle.CategoryModel(
name='category-0001',
reward_interval_minutes=5,
default_maximum_idle_minutes=1440,
acquire_actions=[
idle.AcquireActionList(
acquire_actions=[
idle.AcquireAction(
action='ca',
request=
idle.str(
namespace_name='namespace-0001',
experience_name='player',
user_id='#{userId}',
property_id='player',
experience_value=10
)
)
]
),
idle.AcquireActionList(
acquire_actions=[
idle.AcquireAction(
action='Gs2Experience:AddExperienceByUserId',
request=
idle.str(
namespace_name='namespace-0001',
experience_name='player',
user_id='#{userId}',
property_id='player',
experience_value=5
)
)
]
),
],
),
idle.CategoryModel(
name='category-0002',
reward_interval_minutes=5,
default_maximum_idle_minutes=1440,
acquire_actions=[
idle.AcquireActionList(
acquire_actions=[
idle.AcquireAction(
action='Gs2Experience:AddExperienceByUserId',
request=
idle.str(
namespace_name='namespace-0001',
experience_name='player',
user_id='#{userId}',
property_id='player',
experience_value=10
)
)
]
),
idle.AcquireActionList(
acquire_actions=[
idle.AcquireAction(
action='Gs2Experience:AddExperienceByUserId',
request=
idle.str(
namespace_name='namespace-0001',
experience_name='player',
user_id='#{userId}',
property_id='player',
experience_value=5
)
)
]
),
],
options=idle.CategoryModelOptions(
idle_period_schedule_id='grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001',
receive_period_schedule_id='grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002',
),
),
],
)
print(SampleStack().yaml()) # Generate Templateclass SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
(new \Gs2Cdk\Idle\Model\Namespace_(
stack: $this,
// omission
))->masterData(
[
new \Gs2Cdk\Idle\Model\CategoryModel(
name:"category-0001",
rewardIntervalMinutes:5,
defaultMaximumIdleMinutes:1440,
acquireActions:[
new \Gs2Cdk\Idle\Model\AcquireActionList(
acquireActions: [
new \Gs2Cdk\Core\Model\AcquireAction(
action: "ca",
request:
namespaceName: "namespace-0001",
experienceName: "player",
userId: "#{userId}",
propertyId: "player",
experienceValue: 10
)
)
]
),
new \Gs2Cdk\Idle\Model\AcquireActionList(
acquireActions: [
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Experience:AddExperienceByUserId",
request:
namespaceName: "namespace-0001",
experienceName: "player",
userId: "#{userId}",
propertyId: "player",
experienceValue: 5
)
)
]
),
]
),
new \Gs2Cdk\Idle\Model\CategoryModel(
name:"category-0002",
rewardIntervalMinutes:5,
defaultMaximumIdleMinutes:1440,
acquireActions:[
new \Gs2Cdk\Idle\Model\AcquireActionList(
acquireActions: [
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Experience:AddExperienceByUserId",
request:
namespaceName: "namespace-0001",
experienceName: "player",
userId: "#{userId}",
propertyId: "player",
experienceValue: 10
)
)
]
),
new \Gs2Cdk\Idle\Model\AcquireActionList(
acquireActions: [
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Experience:AddExperienceByUserId",
request:
namespaceName: "namespace-0001",
experienceName: "player",
userId: "#{userId}",
propertyId: "player",
experienceValue: 5
)
)
]
),
],
options: new \Gs2Cdk\Idle\Model\Options\CategoryModelOptions(
idlePeriodScheduleId:"grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001",
receivePeriodScheduleId:"grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002"
)
)
]
);
}
}
print((new SampleStack())->yaml()); // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.idle.model.Namespace(
this,
// omission
).masterData(
Arrays.asList(
new io.gs2.cdk.idle.model.CategoryModel(
"category-0001",
5,
1440,
Arrays.asList(
new io.gs2.cdk.idle.model.AcquireActionList(
Arrays.asList(
new io.gs2.cdk.core.acquire_action(
"ca",
new io.gs2.cdk.idle.model.StampSheetRequest(
"namespace-0001",
"player",
"#{userId}",
"player",
10
)
)
)
),
new io.gs2.cdk.idle.model.AcquireActionList(
Arrays.asList(
new io.gs2.cdk.core.acquire_action(
"Gs2Experience:AddExperienceByUserId",
new io.gs2.cdk.idle.model.StampSheetRequest(
"namespace-0001",
"player",
"#{userId}",
"player",
5
)
)
)
)
)
),
new io.gs2.cdk.idle.model.CategoryModel(
"category-0002",
5,
1440,
Arrays.asList(
new io.gs2.cdk.idle.model.AcquireActionList(
Arrays.asList(
new io.gs2.cdk.core.acquire_action(
"Gs2Experience:AddExperienceByUserId",
new io.gs2.cdk.idle.model.StampSheetRequest(
"namespace-0001",
"player",
"#{userId}",
"player",
10
)
)
)
),
new io.gs2.cdk.idle.model.AcquireActionList(
Arrays.asList(
new io.gs2.cdk.core.acquire_action(
"Gs2Experience:AddExperienceByUserId",
new io.gs2.cdk.idle.model.StampSheetRequest(
"namespace-0001",
"player",
"#{userId}",
"player",
5
)
)
)
)
),
new io.gs2.cdk.idle.model.options.CategoryModelOptions() {
{
idlePeriodScheduleId: "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001";
receivePeriodScheduleId: "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002";
}
}
)
)
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Templateimport core from "@/gs2cdk/core";
import idle from "@/gs2cdk/idle";
class SampleStack extends core.Stack
{
public constructor() {
super();
new idle.model.Namespace(
this,
// omission
).masterData(
[
new idle.model.CategoryModel(
"category-0001",
5,
1440,
[
new idle.model.AcquireActionList(
new AcquireAction[
new AcquireAction(
"ca",
new idle.model.string(
"namespace-0001",
"player",
"#{userId}",
"player",
10
)
)
]
),
new idle.model.AcquireActionList(
new AcquireAction[
new AcquireAction(
"Gs2Experience:AddExperienceByUserId",
new idle.model.string(
"namespace-0001",
"player",
"#{userId}",
"player",
5
)
)
]
),
]
),
new idle.model.CategoryModel(
"category-0002",
5,
1440,
[
new idle.model.AcquireActionList(
new AcquireAction[
new AcquireAction(
"Gs2Experience:AddExperienceByUserId",
new idle.model.string(
"namespace-0001",
"player",
"#{userId}",
"player",
10
)
)
]
),
new idle.model.AcquireActionList(
new AcquireAction[
new AcquireAction(
"Gs2Experience:AddExperienceByUserId",
new idle.model.string(
"namespace-0001",
"player",
"#{userId}",
"player",
5
)
)
]
),
],
{
idlePeriodScheduleId: "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001",
receivePeriodScheduleId: "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002"
}
)
]
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Idle.Model.Namespace(
this,
// omission
).MasterData(
new [] {
new Gs2Cdk.Gs2Idle.Model.CategoryModel(
"category-0001",
5,
1440,
new Gs2Cdk.Gs2Idle.Model.AcquireActionList[] {
new Gs2Cdk.Gs2Idle.Model.AcquireActionList(
acquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
new Gs2Cdk.Core.Model.AcquireAction(
action: "ca",
request:
new string(
namespaceName: "namespace-0001",
experienceName: "player",
userId: "#{userId}",
propertyId: "player",
experienceValue: 10
)
)
}
),
new Gs2Cdk.Gs2Idle.Model.AcquireActionList(
acquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Experience:AddExperienceByUserId",
request:
new string(
namespaceName: "namespace-0001",
experienceName: "player",
userId: "#{userId}",
propertyId: "player",
experienceValue: 5
)
)
}
),
}
),
new Gs2Cdk.Gs2Idle.Model.CategoryModel(
"category-0002",
5,
1440,
new Gs2Cdk.Gs2Idle.Model.AcquireActionList[] {
new Gs2Cdk.Gs2Idle.Model.AcquireActionList(
acquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Experience:AddExperienceByUserId",
request:
new string(
namespaceName: "namespace-0001",
experienceName: "player",
userId: "#{userId}",
propertyId: "player",
experienceValue: 10
)
)
}
),
new Gs2Cdk.Gs2Idle.Model.AcquireActionList(
acquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Experience:AddExperienceByUserId",
request:
new string(
namespaceName: "namespace-0001",
experienceName: "player",
userId: "#{userId}",
propertyId: "player",
experienceValue: 5
)
)
}
),
},
new Gs2Cdk.Gs2Idle.Model.Options.CategoryModelOptions {
idlePeriodScheduleId = "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001",
receivePeriodScheduleId = "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0002"
}
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate TemplateConfig
Configration
Set values to be applied to transaction variables
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| key | string | ✓ | ~ 64 chars | Name | |
| value | string | ~ 51200 chars | Value |
AcquireAction
Acquire Action
AcquireActionList
Acquisition Action List
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| acquireActions | List<AcquireAction> | ~ 100 items | List of Acquire Action |
TransactionSetting
Transaction settings
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| enableAutoRun | bool | ✓ | false | Automatically run issued transactions on the server side, or | |
| 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 |
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.
On the other hand, asynchronous execution does not block 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. However, asynchronous execution does not block processing until the script has finished executing, so it is generally recommended to use asynchronous execution.
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 | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| triggerScriptId | string | ~ 1024 chars | Script GRN | ||
| doneTriggerTargetType | enum { “none”, “gs2_script”, “aws” } | ✓ | “none” | ~ 128 chars | Notification of Completion |
| doneTriggerScriptId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024 chars | Script GRN | |
| doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024 chars | Namespace GRN |
Enumeration type definition to specify as doneTriggerTargetType
| Enumerator String Definition | Description |
|---|---|
| none | None |
| gs2_script | GS2-Script |
| aws | Amazon EventBridge |
LogSetting
Log setting
This type manages log output settings. This type holds the identifier of the log namespace used to output log data. The log namespace ID specifies the GS2-Log namespace to aggregate and store the log data. Through this setting, API request and response log data under this namespace will be output to the target GS2-Log. GS2-Log provides logs in real time, which can be used for system monitoring, analysis, debugging, etc.
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| loggingNamespaceId | string | ✓ | ~ 1024 chars | Namespace GRN |
GitHubCheckoutSetting
Setup to check out master data from GitHub
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| apiKeyId | string | ✓ | ~ 1024 chars | GitHub API key GRN | |
| repositoryName | string | ✓ | ~ 1024 chars | Repository Name | |
| sourcePath | string | ✓ | ~ 1024 chars | Source code file path | |
| referenceType | enum { “commit_hash”, “branch”, “tag” } | ✓ | ~ 128 chars | Source of code | |
| commitHash | string | {referenceType} == “commit_hash” | ~ 1024 chars | Commit hash | |
| branchName | string | {referenceType} == “branch” | ~ 1024 chars | Branch Name | |
| tagName | string | {referenceType} == “tag” | ~ 1024 chars | Tag Name |
Enumeration type definition to specify as referenceType
| Enumerator String Definition | Description |
|---|---|
| commit_hash | Commit hash |
| branch | Branch |
| tag | Tag |