GS2-Deploy/CDK Reference of GS2-Version

Entities

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	Limitation	Description
name	string	✓	~ 32 chars	Namespace name
description	string		~ 1024 chars	Description
assumeUserId	string	✓	~ 1024 chars	GS2-Identifier user GRN to be promoted if the version check is passed
acceptVersionScript	ScriptSetting			Script to run when version is approved
checkVersionTriggerScriptId	string		~ 1024 chars	GS2-Script script to perform version checking process
logSetting	LogSetting			Log output settings

GetAttr

	Type	Description
Item	Namespace	Namespace created

Implementation Example

Type: GS2::Version::Namespace
Properties:
  Name: namespace1
  Description: null
  AssumeUserId: grn:gs2::YourOwnerId:identifier:user:user-0001
  AcceptVersionScript: null
  CheckVersionTriggerScriptId: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1

from gs2_cdk import Stack, core, version

class SampleStack(Stack):

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

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

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        new \Gs2Cdk\Version\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            assumeUserId: "grn:gs2::YourOwnerId:identifier:user:user-0001",
            options: new \Gs2Cdk\Version\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.version.model.Namespace(
            this,
            "namespace-0001",
            "grn:gs2::YourOwnerId:identifier:user:user-0001",
            new io.gs2.cdk.version.model.options.NamespaceOptions() {
                {
                    logSetting = new io.gs2.cdk.core.model.LogSetting(
                        "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                    );
                }
            }
        );
    }
}

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

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new version.model.Namespace(
            this,
            "namespace-0001",
            "grn:gs2::YourOwnerId:identifier:user:user-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.Gs2Version.Model.Namespace(
            this,
            "namespace-0001",
            "grn:gs2::YourOwnerId:identifier:user:user-0001",
            new Gs2Cdk.Gs2Version.Model.Options.NamespaceOptions {
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                ),
            }
        );
    }
}

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

CurrentVersionMaster

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.

Please refer to the documentation for the format of the JSON file.

	Type	Require	Default	Limitation	Description
namespaceName	string	✓		~ 32 chars	Namespace name
settings	string	✓		~ 5242880 chars	Master data

GetAttr

	Type	Description
Item	CurrentVersionMaster	Updated, currently available version

Implementation Example

Type: GS2::Version::CurrentVersionMaster
Properties:
  NamespaceName: namespace1
  Settings: {
    "version": "2019-10-09",
    "versionModels": [
      {
        "name": "app",
        "metadata": "APP",
        "warningVersion": {
          "major": 2,
          "minor": 2,
          "micro": 2
        },
        "errorVersion": {
          "major": 1,
          "minor": 1,
          "micro": 1
        },
        "scope": "passive",
        "needSignature": false
      },
      {
        "name": "asset",
        "metadata": "ASSET",
        "warningVersion": {
          "major": 3,
          "minor": 3,
          "micro": 3
        },
        "errorVersion": {
          "major": 2,
          "minor": 2,
          "micro": 2
        },
        "scope": "passive",
        "needSignature": true,
        "signatureKeyId": "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
      },
      {
        "name": "eula",
        "metadata": "EULA",
        "warningVersion": {
          "major": 4,
          "minor": 4,
          "micro": 4
        },
        "errorVersion": {
          "major": 3,
          "minor": 3,
          "micro": 3
        },
        "scope": "active",
        "currentVersion": {
          "major": 2,
          "minor": 2,
          "micro": 2
        }
      }
    ]
  }

from gs2_cdk import Stack, core, version

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        version.Namespace(
            stack=self,
            # omission
        ).master_data(
            [
                version.VersionModel(
                    name='app',
                    scope='passive',
                    options=version.VersionModelOptions(
                        metadata='APP',
                        warning_version={'major': 2, 'minor': 2, 'micro': 2},
                        error_version={'major': 1, 'minor': 1, 'micro': 1},
                    ),
                ),
                version.VersionModel(
                    name='asset',
                    scope='passive',
                    options=version.VersionModelOptions(
                        metadata='ASSET',
                        warning_version={'major': 3, 'minor': 3, 'micro': 3},
                        error_version={'major': 2, 'minor': 2, 'micro': 2},
                        need_signature=True,
                        signature_key_id='grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001',
                    ),
                ),
                version.VersionModel(
                    name='eula',
                    scope='active',
                    options=version.VersionModelOptions(
                        metadata='EULA',
                        current_version={'major': 2, 'minor': 2, 'micro': 2},
                        warning_version={'major': 4, 'minor': 4, 'micro': 4},
                        error_version={'major': 3, 'minor': 3, 'micro': 3},
                    ),
                ),
            ],
        )

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

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Version\Model\Namespace_(
            stack: $this,
            // omission
        ))->masterData(
            [
                new \Gs2Cdk\Version\Model\VersionModel(
                    name:"app",
                    scope: \Gs2Cdk\Version\Model\Enums\CurrentVersionMasterScope::PASSIVE
                    options: new \Gs2Cdk\Version\Model\Options\VersionModelOptions(
                        metadata:"APP",
                        warningVersion:{'major': 2, 'minor': 2, 'micro': 2},
                        errorVersion:{'major': 1, 'minor': 1, 'micro': 1},
                    ),
                ),
                new \Gs2Cdk\Version\Model\VersionModel(
                    name:"asset",
                    scope: \Gs2Cdk\Version\Model\Enums\CurrentVersionMasterScope::PASSIVE
                    options: new \Gs2Cdk\Version\Model\Options\VersionModelOptions(
                        metadata:"ASSET",
                        warningVersion:{'major': 3, 'minor': 3, 'micro': 3},
                        errorVersion:{'major': 2, 'minor': 2, 'micro': 2},
                        needSignature:True,
                        signatureKeyId:"grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
                    ),
                ),
                new \Gs2Cdk\Version\Model\VersionModel(
                    name:"eula",
                    scope: \Gs2Cdk\Version\Model\Enums\CurrentVersionMasterScope::ACTIVE
                    options: new \Gs2Cdk\Version\Model\Options\VersionModelOptions(
                        metadata:"EULA",
                        currentVersion:{'major': 2, 'minor': 2, 'micro': 2},
                        warningVersion:{'major': 4, 'minor': 4, 'micro': 4},
                        errorVersion:{'major': 3, 'minor': 3, 'micro': 3},
                    ),
                ),
            ],
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.version.model.Namespace(
            this,
            // omission
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.version.model.VersionModel(
                    "app",
                    Passive,
                    new io.gs2.cdk.version.model.options.VersionModelOptions() {
                        {
                            metadata: "APP";
                            warningVersion: {'major': 2, 'minor': 2, 'micro': 2};
                            errorVersion: {'major': 1, 'minor': 1, 'micro': 1};
                        }
                    }
                ),
                new io.gs2.cdk.version.model.VersionModel(
                    "asset",
                    Passive,
                    new io.gs2.cdk.version.model.options.VersionModelOptions() {
                        {
                            metadata: "ASSET";
                            warningVersion: {'major': 3, 'minor': 3, 'micro': 3};
                            errorVersion: {'major': 2, 'minor': 2, 'micro': 2};
                            needSignature: true;
                            signatureKeyId: "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001";
                        }
                    }
                ),
                new io.gs2.cdk.version.model.VersionModel(
                    "eula",
                    Active,
                    new io.gs2.cdk.version.model.options.VersionModelOptions() {
                        {
                            metadata: "EULA";
                            currentVersion: {'major': 2, 'minor': 2, 'micro': 2};
                            warningVersion: {'major': 4, 'minor': 4, 'micro': 4};
                            errorVersion: {'major': 3, 'minor': 3, 'micro': 3};
                        }
                    }
                )
            )
        );
    }
}

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

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new version.model.Namespace(
            this,
            // omission
        ).masterData(
            [
                new version.model.VersionModel(
                    "app",
                    version.model.CurrentVersionMasterScope.PASSIVE,
                    {
                        metadata: "APP",
                        warningVersion: {'major': 2, 'minor': 2, 'micro': 2},
                        errorVersion: {'major': 1, 'minor': 1, 'micro': 1}
                    }
                ),
                new version.model.VersionModel(
                    "asset",
                    version.model.CurrentVersionMasterScope.PASSIVE,
                    {
                        metadata: "ASSET",
                        warningVersion: {'major': 3, 'minor': 3, 'micro': 3},
                        errorVersion: {'major': 2, 'minor': 2, 'micro': 2},
                        needSignature: true,
                        signatureKeyId: "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
                    }
                ),
                new version.model.VersionModel(
                    "eula",
                    version.model.CurrentVersionMasterScope.ACTIVE,
                    {
                        metadata: "EULA",
                        currentVersion: {'major': 2, 'minor': 2, 'micro': 2},
                        warningVersion: {'major': 4, 'minor': 4, 'micro': 4},
                        errorVersion: {'major': 3, 'minor': 3, 'micro': 3}
                    }
                )
            ]
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Version.Model.Namespace(
            this,
            // omission
        ).MasterData(
            new [] {
                new Gs2Cdk.Gs2Version.Model.VersionModel(
                    "app",
                    Gs2Cdk.Gs2Version.Model.Enums.CurrentVersionMasterScope.Passive,
                    new Gs2Cdk.Gs2Version.Model.Options.VersionModelOptions {
                        metadata = "APP",
                        warningVersion = {'major': 2, 'minor': 2, 'micro': 2},
                        errorVersion = {'major': 1, 'minor': 1, 'micro': 1},
                    }
                ),
                new Gs2Cdk.Gs2Version.Model.VersionModel(
                    "asset",
                    Gs2Cdk.Gs2Version.Model.Enums.CurrentVersionMasterScope.Passive,
                    new Gs2Cdk.Gs2Version.Model.Options.VersionModelOptions {
                        metadata = "ASSET",
                        warningVersion = {'major': 3, 'minor': 3, 'micro': 3},
                        errorVersion = {'major': 2, 'minor': 2, 'micro': 2},
                        needSignature = true,
                        signatureKeyId = "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
                    }
                ),
                new Gs2Cdk.Gs2Version.Model.VersionModel(
                    "eula",
                    Gs2Cdk.Gs2Version.Model.Enums.CurrentVersionMasterScope.Active,
                    new Gs2Cdk.Gs2Version.Model.Options.VersionModelOptions {
                        metadata = "EULA",
                        currentVersion = {'major': 2, 'minor': 2, 'micro': 2},
                        warningVersion = {'major': 4, 'minor': 4, 'micro': 4},
                        errorVersion = {'major': 3, 'minor': 3, 'micro': 3},
                    }
                )
            }
        );
    }
}

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

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

GitHubCheckoutSetting

Setup to check out master data from GitHub

	Type	Require	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

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

Version

	Type	Require	Limitation	Description
major	int	✓	~ 2147483646	Major version
minor	int	✓	~ 2147483646	Minor version
micro	int	✓	~ 2147483646	Micro version

ScheduleVersion

Version that switches in chronological order

	Type	Require	Limitation	Description
currentVersion	Version	✓		Current Version
warningVersion	Version	✓		Version that prompts for version upgrade
errorVersion	Version	✓		Version that is determined to be an error by the version check
scheduleEventId	string		~ 1024 chars	GS2-Schedule event GRN that enables version check