NAV
YAML TypeScript (CDK) Python (CDK) PHP (CDK) Java (CDK) C# (CDK)

GS2-Version

Reference to resource definitions available in GS2-Deploy templates

GS2-Deploy Reference

Entities

Namespace

Namespace

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"
                )
            }
        );
    }
}

System.out.println(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

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 ~ 32 chars Namespace name
description string ~ 1024 chars description of Namespace
assumeUserId string ~ 1024 chars User GRN
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

CurrentVersionMaster

CurrentVersionMaster

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',
                    warning_version={'major': 2, 'minor': 2, 'micro': 2},
                    error_version={'major': 1, 'minor': 1, 'micro': 1},
                    scope='passive',
                    options=version.VersionModelOptions(
                        metadata='APP',
                    ),
                ),
                version.VersionModel(
                    name='asset',
                    warning_version={'major': 3, 'minor': 3, 'micro': 3},
                    error_version={'major': 2, 'minor': 2, 'micro': 2},
                    scope='passive',
                    options=version.VersionModelOptions(
                        metadata='ASSET',
                        need_signature=True,
                        signature_key_id='grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001',
                    ),
                ),
                version.VersionModel(
                    name='eula',
                    warning_version={'major': 4, 'minor': 4, 'micro': 4},
                    error_version={'major': 3, 'minor': 3, 'micro': 3},
                    scope='active',
                    options=version.VersionModelOptions(
                        metadata='EULA',
                        current_version={'major': 2, 'minor': 2, 'micro': 2},
                    ),
                ),
            ],
        )

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",
                    warningVersion:{'major': 2, 'minor': 2, 'micro': 2},
                    errorVersion:{'major': 1, 'minor': 1, 'micro': 1},
                    scope:"passive",
                    options: new \Gs2Cdk\Version\Model\Options\VersionModelOptions(
                        metadata:"APP",
                    ),
                ),
                new \Gs2Cdk\Version\Model\VersionModel(
                    name:"asset",
                    warningVersion:{'major': 3, 'minor': 3, 'micro': 3},
                    errorVersion:{'major': 2, 'minor': 2, 'micro': 2},
                    scope:"passive",
                    options: new \Gs2Cdk\Version\Model\Options\VersionModelOptions(
                        metadata:"ASSET",
                        needSignature:True,
                        signatureKeyId:"grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
                    ),
                ),
                new \Gs2Cdk\Version\Model\VersionModel(
                    name:"eula",
                    warningVersion:{'major': 4, 'minor': 4, 'micro': 4},
                    errorVersion:{'major': 3, 'minor': 3, 'micro': 3},
                    scope:"active",
                    options: new \Gs2Cdk\Version\Model\Options\VersionModelOptions(
                        metadata:"EULA",
                        currentVersion:{'major': 2, 'minor': 2, 'micro': 2},
                    ),
                ),
            ],
        );
    }
}

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",
                    {'major': 2, 'minor': 2, 'micro': 2},
                    {'major': 1, 'minor': 1, 'micro': 1},
                    "passive",
                    new io.gs2.cdk.version.model.options.VersionModelOptions() {
                        {
                            metadata: "APP";
                        }
                    }
                ),
                new io.gs2.cdk.version.model.VersionModel(
                    "asset",
                    {'major': 3, 'minor': 3, 'micro': 3},
                    {'major': 2, 'minor': 2, 'micro': 2},
                    "passive",
                    new io.gs2.cdk.version.model.options.VersionModelOptions() {
                        {
                            metadata: "ASSET";
                            needSignature: true;
                            signatureKeyId: "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001";
                        }
                    }
                ),
                new io.gs2.cdk.version.model.VersionModel(
                    "eula",
                    {'major': 4, 'minor': 4, 'micro': 4},
                    {'major': 3, 'minor': 3, 'micro': 3},
                    "active",
                    new io.gs2.cdk.version.model.options.VersionModelOptions() {
                        {
                            metadata: "EULA";
                            currentVersion: {'major': 2, 'minor': 2, 'micro': 2};
                        }
                    }
                )
            )
        );
    }
}

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",
                    {'major': 2, 'minor': 2, 'micro': 2},
                    {'major': 1, 'minor': 1, 'micro': 1},
                    "passive",
                    {
                        metadata: "APP"
                    }
                ),
                new version.model.VersionModel(
                    "asset",
                    {'major': 3, 'minor': 3, 'micro': 3},
                    {'major': 2, 'minor': 2, 'micro': 2},
                    "passive",
                    {
                        metadata: "ASSET",
                        needSignature: true,
                        signatureKeyId: "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
                    }
                ),
                new version.model.VersionModel(
                    "eula",
                    {'major': 4, 'minor': 4, 'micro': 4},
                    {'major': 3, 'minor': 3, 'micro': 3},
                    "active",
                    {
                        metadata: "EULA",
                        currentVersion: {'major': 2, 'minor': 2, 'micro': 2}
                    }
                )
            ]
        );
    }
}

System.out.println(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",
                    {'major': 2, 'minor': 2, 'micro': 2},
                    {'major': 1, 'minor': 1, 'micro': 1},
                    "passive",
                    new Gs2Cdk.Gs2Version.Model.Options.VersionModelOptions {
                        metadata = "APP",
                    }
                ),
                new Gs2Cdk.Gs2Version.Model.VersionModel(
                    "asset",
                    {'major': 3, 'minor': 3, 'micro': 3},
                    {'major': 2, 'minor': 2, 'micro': 2},
                    "passive",
                    new Gs2Cdk.Gs2Version.Model.Options.VersionModelOptions {
                        metadata = "ASSET",
                        needSignature = true,
                        signatureKeyId = "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
                    }
                ),
                new Gs2Cdk.Gs2Version.Model.VersionModel(
                    "eula",
                    {'major': 4, 'minor': 4, 'micro': 4},
                    {'major': 3, 'minor': 3, 'micro': 3},
                    "active",
                    new Gs2Cdk.Gs2Version.Model.Options.VersionModelOptions {
                        metadata = "EULA",
                        currentVersion = {'major': 2, 'minor': 2, 'micro': 2},
                    }
                )
            }
        );
    }
}

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

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