Deploy/CDK Reference of GS2-SerialKey

The template format used when creating stacks with GS2-Deploy, and implementation examples of template output in various languages using CDK

Entity

Resources operated in Deploy process

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.

Request

Resource generation request

	Type	Required	Value Limits	Description
name	string	✓	~ 128 chars	Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
description	string		~ 1024 chars	Description
transactionSetting	TransactionSetting			Transaction settings
logSetting	LogSetting			Log output settings

GetAttr

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

	Type	Description
Item	Namespace	The created Namespace

Implementation Example

Type: GS2::SerialKey::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSetting: 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/serialKey"
    "github.com/openlyinc/pointy"
)

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

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

class SampleStack(Stack):

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

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

TransactionSetting

Transaction settings

Transaction settings control how transactions are executed, their consistency, asynchronous processing, and conflict avoidance mechanisms. Combining features like AutoRun, AtomicCommit, asynchronous execution using GS2-Distributor, batch application of script results, and asynchronous acquisition actions via GS2-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 GRN used for transaction execution
queueNamespaceId	string		✓	“grn:gs2:{region}:{ownerId}:queue:default”	~ 1024 chars	Namespace GRN in GS2-JobQueue used to run the transaction

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	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:”.

CurrentCampaignMaster

Currently Active Campaign Model Master Data

Currently active master data describing the campaign model definitions within the namespace. GS2 uses JSON format files for managing master data. By uploading these files, the master data settings are updated on 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-SerialKey for the JSON file format.

Request

Resource generation request

Type

Condition

Required

Default

Value Limits

Description

namespaceName

string

✓

~ 128 chars

Namespace name

Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).

mode

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

✓

“direct”

Update mode

Enumerator String Definition	Description
“direct”	Directly update the master data
“preUpload”	Upload master data in preparation for updates

settings

string

{mode} == “direct”

✓*

~ 5242880 chars

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

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

	Type	Description
Item	CurrentCampaignMaster	Updated Currently Active Campaign Model Master Data

Implementation Example

Type: GS2::SerialKey::CurrentCampaignMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  Settings: {
    "version": "2022-09-13",
    "campaignModels": [
      {
        "name": "campaign-0001",
        "enableCampaignCode": true,
        "metadata": "CAMPAIGN_0001"
      }
    ]
  }
  UploadToken: null

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

SampleStack := core.NewStack()
serialKey.NewNamespace(
    &SampleStack,
    "namespace-0001",
    serialKey.NamespaceOptions{},
).MasterData(
    []serialKey.CampaignModel{
        serialKey.NewCampaignModel(
            "campaign-0001",
            true,
            serialKey.CampaignModelOptions{
                Metadata: pointy.String("CAMPAIGN_0001"),
            },
        ),
    },
)

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

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\SerialKey\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
                new \Gs2Cdk\SerialKey\Model\CampaignModel(
                    name:"campaign-0001",
                    enableCampaignCode:True,
                    options: new \Gs2Cdk\SerialKey\Model\Options\CampaignModelOptions(
                        metadata:"CAMPAIGN_0001"
                    )
                )
            ]
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.serialKey.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.serialKey.model.CampaignModel(
                    "campaign-0001",
                    true,
                    new io.gs2.cdk.serialKey.model.options.CampaignModelOptions()
                        .withMetadata("CAMPAIGN_0001")
                )
            )
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2SerialKey.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2SerialKey.Model.CampaignModel[] {
                new Gs2Cdk.Gs2SerialKey.Model.CampaignModel(
                    name: "campaign-0001",
                    enableCampaignCode: true,
                    options: new Gs2Cdk.Gs2SerialKey.Model.Options.CampaignModelOptions
                    {
                        metadata = "CAMPAIGN_0001"
                    }
                )
            }
        );
    }
}

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

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new serialKey.model.Namespace(
            this,
            "namespace-0001",
        ).masterData(
            [
                new serialKey.model.CampaignModel(
                    "campaign-0001",
                    true,
                    {
                        metadata: "CAMPAIGN_0001"
                    }
                )
            ]
        );
    }
}

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

from gs2_cdk import Stack, core, serial_key

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        serial_key.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            campaign_models=[
                serial_key.CampaignModel(
                    name='campaign-0001',
                    enable_campaign_code=True,
                    options=serial_key.CampaignModelOptions(
                        metadata = 'CAMPAIGN_0001'
                    ),
                ),
            ],
        )

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

CampaignModel

Campaign Model

The campaign model is used to define and manage campaigns, linking them to serial codes.

	Type	Required	Default	Value Limits	Description
campaignId	string	✓*		~ 1024 chars	Campaign Model GRN * Automatically configured on the server
name	string	✓		~ 128 chars	Campaign name
metadata	string			~ 2048 chars	Metadata Arbitrary values can be set in the metadata. Since they do not affect GS2’s behavior, they can be used to store information used in the game.
enableCampaignCode	bool	✓	false		Whether to allow redemption with campaign code