GS2-Deploy/CDK Reference of GS2-Version

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.

	Type	Required	Default	Value Limits	Description
namespaceId	string	✓*		~ 1024 chars	Namespace GRN * Automatically configured on the server
name	string	✓		~ 128 chars	Namespace name
description	string			~ 1024 chars	Description
transactionSetting	TransactionSetting				Transaction settings
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
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::Version::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSetting: null
  AssumeUserId: grn:gs2::YourOwnerId:identifier:user:user-0001
  AcceptVersionScript: null
  CheckVersionTriggerScriptId: 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/version"
    "github.com/openlyinc/pointy"
)

SampleStack := core.NewStack()
version.NewNamespace(
    &SampleStack,
    "namespace-0001",
    "grn:gs2::YourOwnerId:identifier:user:user-0001",
    version.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\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()
                        .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.Gs2Version.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            assumeUserId: "grn:gs2::YourOwnerId:identifier:user:user-0001",
            options: new Gs2Cdk.Gs2Version.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 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

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

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

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.

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 to be executed during processing

Must be specified in GRN format starting with “grn:gs2:”.

doneTriggerTargetType

String Enum
enum {
  “none”,
  “gs2_script”,
  “aws”
}

✓

“none”

Notification of Completion

Enumerator String Definition	Description
“none”	None
“gs2_script”	GS2-Script
“aws”	Amazon EventBridge

doneTriggerScriptId

string

{doneTriggerTargetType} == “gs2_script”

~ 1024 chars

Script GRN to be executed upon completion

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

Used when you want to know the completion of the done script.

* Enabled if doneTriggerTargetType is “gs2_script”

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 Must be specified in GRN format starting with “grn:gs2:”.

CurrentVersionMaster

Currently Active Master Data

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-Version for the JSON file format.

	Type	Condition	Required	Default	Value Limits	Description
namespaceId	string		✓*		~ 1024 chars	Namespace GRN * Automatically configured on the server
settings	string		✓		~ 5242880 bytes (5MB)	Master Data

GetAttr

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

	Type	Description
Item	CurrentVersionMaster	Updated, currently available version

Implementation Example

Type: GS2::Version::CurrentVersionMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  Settings: {
    "version": "2019-10-09",
    "versionModels": [
      {
        "name": "app",
        "scope": "passive",
        "type": "simple",
        "metadata": "APP",
        "warningVersion":
          {
            "major": 2,
            "minor": 2,
            "micro": 2
          },
        "errorVersion":
          {
            "major": 1,
            "minor": 1,
            "micro": 1
          }
      },
      {
        "name": "asset",
        "scope": "passive",
        "type": "simple",
        "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"
      },
      {
        "name": "eula",
        "scope": "active",
        "type": "simple",
        "metadata": "EULA",
        "currentVersion":
          {
            "major": 2,
            "minor": 2,
            "micro": 2
          },
        "warningVersion":
          {
            "major": 4,
            "minor": 4,
            "micro": 4
          },
        "errorVersion":
          {
            "major": 3,
            "minor": 3,
            "micro": 3
          }
      }
    ]
  }
  UploadToken: null

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

SampleStack := core.NewStack()
version.NewNamespace(
    &SampleStack,
    "namespace-0001",
    "user-0001",
    version.NamespaceOptions{},
).MasterData(
    []version.VersionModel{
        version.NewVersionModel(
            "app",
            version.VersionModelScopePassive,
            version.VersionModelTypeSimple,
            version.VersionModelOptions{
                Metadata: pointy.String("APP"),
                WarningVersion: &version.Version{
                    
                },
                ErrorVersion: &version.Version{
                    
                },
            },
        ),
        version.NewVersionModel(
            "asset",
            version.VersionModelScopePassive,
            version.VersionModelTypeSimple,
            version.VersionModelOptions{
                Metadata: pointy.String("ASSET"),
                WarningVersion: &version.Version{
                    
                },
                ErrorVersion: &version.Version{
                    
                },
                NeedSignature: pointy.Bool(true),
                SignatureKeyId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"),
            },
        ),
        version.NewVersionModel(
            "eula",
            version.VersionModelScopeActive,
            version.VersionModelTypeSimple,
            version.VersionModelOptions{
                Metadata: pointy.String("EULA"),
                CurrentVersion: &version.Version{
                    
                },
                WarningVersion: &version.Version{
                    
                },
                ErrorVersion: &version.Version{
                    
                },
            },
        ),
    },
)

println(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: "user-0001"
        ))->masterData(
            [
                new \Gs2Cdk\Version\Model\VersionModel(
                    name:"app",
                    scope: \Gs2Cdk\Version\Model\Enums\VersionModelScope::PASSIVE,
                    type: \Gs2Cdk\Version\Model\Enums\VersionModelType::SIMPLE,
                    options: new \Gs2Cdk\Version\Model\Options\VersionModelOptions(
                        metadata:"APP",
                        warningVersion:new \Gs2Cdk\Version\Model\Version(
                            major: 2,
                            minor: 2,
                            micro: 2,    
                        ),
                        errorVersion:new \Gs2Cdk\Version\Model\Version(
                            major: 1,
                            minor: 1,
                            micro: 1,    
                        )
                    )
                ),
                new \Gs2Cdk\Version\Model\VersionModel(
                    name:"asset",
                    scope: \Gs2Cdk\Version\Model\Enums\VersionModelScope::PASSIVE,
                    type: \Gs2Cdk\Version\Model\Enums\VersionModelType::SIMPLE,
                    options: new \Gs2Cdk\Version\Model\Options\VersionModelOptions(
                        metadata:"ASSET",
                        warningVersion:new \Gs2Cdk\Version\Model\Version(
                            major: 3,
                            minor: 3,
                            micro: 3,    
                        ),
                        errorVersion:new \Gs2Cdk\Version\Model\Version(
                            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\VersionModelScope::ACTIVE,
                    type: \Gs2Cdk\Version\Model\Enums\VersionModelType::SIMPLE,
                    options: new \Gs2Cdk\Version\Model\Options\VersionModelOptions(
                        metadata:"EULA",
                        currentVersion:new \Gs2Cdk\Version\Model\Version(
                            major: 2,
                            minor: 2,
                            micro: 2,    
                        ),
                        warningVersion:new \Gs2Cdk\Version\Model\Version(
                            major: 4,
                            minor: 4,
                            micro: 4,    
                        ),
                        errorVersion:new \Gs2Cdk\Version\Model\Version(
                            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,
            "namespace-0001",
            "user-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.version.model.VersionModel(
                    "app",
                    io.gs2.cdk.version.model.enums.VersionModelScope.PASSIVE,
                    io.gs2.cdk.version.model.enums.VersionModelType.SIMPLE,
                    new io.gs2.cdk.version.model.options.VersionModelOptions()
                        .withMetadata("APP")
                        .withWarningVersion(new io.gs2.cdk.version.model.Version(
                            2,
                            2,
                            2        
                        ))
                        .withErrorVersion(new io.gs2.cdk.version.model.Version(
                            1,
                            1,
                            1        
                        ))
                ),
                new io.gs2.cdk.version.model.VersionModel(
                    "asset",
                    io.gs2.cdk.version.model.enums.VersionModelScope.PASSIVE,
                    io.gs2.cdk.version.model.enums.VersionModelType.SIMPLE,
                    new io.gs2.cdk.version.model.options.VersionModelOptions()
                        .withMetadata("ASSET")
                        .withWarningVersion(new io.gs2.cdk.version.model.Version(
                            3,
                            3,
                            3        
                        ))
                        .withErrorVersion(new io.gs2.cdk.version.model.Version(
                            2,
                            2,
                            2        
                        ))
                        .withNeedSignature(true)
                        .withSignatureKeyId("grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001")
                ),
                new io.gs2.cdk.version.model.VersionModel(
                    "eula",
                    io.gs2.cdk.version.model.enums.VersionModelScope.ACTIVE,
                    io.gs2.cdk.version.model.enums.VersionModelType.SIMPLE,
                    new io.gs2.cdk.version.model.options.VersionModelOptions()
                        .withMetadata("EULA")
                        .withCurrentVersion(new io.gs2.cdk.version.model.Version(
                            2,
                            2,
                            2        
                        ))
                        .withWarningVersion(new io.gs2.cdk.version.model.Version(
                            4,
                            4,
                            4        
                        ))
                        .withErrorVersion(new io.gs2.cdk.version.model.Version(
                            3,
                            3,
                            3        
                        ))
                )
            )
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Version.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            assumeUserId: "user-0001"
        ).MasterData(
            new Gs2Cdk.Gs2Version.Model.VersionModel[] {
                new Gs2Cdk.Gs2Version.Model.VersionModel(
                    name: "app",
                    scope: Gs2Cdk.Gs2Version.Model.Enums.VersionModelScope.Passive,
                    type: Gs2Cdk.Gs2Version.Model.Enums.VersionModelType.Simple,
                    options: new Gs2Cdk.Gs2Version.Model.Options.VersionModelOptions
                    {
                        metadata = "APP",
                        warningVersion = new Gs2Cdk.Gs2Version.Model.Version_(
                            major: 2,
                            minor: 2,
                            micro: 2    
                        ),
                        errorVersion = new Gs2Cdk.Gs2Version.Model.Version_(
                            major: 1,
                            minor: 1,
                            micro: 1    
                        )
                    }
                ),
                new Gs2Cdk.Gs2Version.Model.VersionModel(
                    name: "asset",
                    scope: Gs2Cdk.Gs2Version.Model.Enums.VersionModelScope.Passive,
                    type: Gs2Cdk.Gs2Version.Model.Enums.VersionModelType.Simple,
                    options: new Gs2Cdk.Gs2Version.Model.Options.VersionModelOptions
                    {
                        metadata = "ASSET",
                        warningVersion = new Gs2Cdk.Gs2Version.Model.Version_(
                            major: 3,
                            minor: 3,
                            micro: 3    
                        ),
                        errorVersion = new Gs2Cdk.Gs2Version.Model.Version_(
                            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(
                    name: "eula",
                    scope: Gs2Cdk.Gs2Version.Model.Enums.VersionModelScope.Active,
                    type: Gs2Cdk.Gs2Version.Model.Enums.VersionModelType.Simple,
                    options: new Gs2Cdk.Gs2Version.Model.Options.VersionModelOptions
                    {
                        metadata = "EULA",
                        currentVersion = new Gs2Cdk.Gs2Version.Model.Version_(
                            major: 2,
                            minor: 2,
                            micro: 2    
                        ),
                        warningVersion = new Gs2Cdk.Gs2Version.Model.Version_(
                            major: 4,
                            minor: 4,
                            micro: 4    
                        ),
                        errorVersion = new Gs2Cdk.Gs2Version.Model.Version_(
                            major: 3,
                            minor: 3,
                            micro: 3    
                        )
                    }
                )
            }
        );
    }
}

Debug.Log(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",
            "user-0001",
        ).masterData(
            [
                new version.model.VersionModel(
                    "app",
                    version.model.VersionModelScope.PASSIVE,
                    version.model.VersionModelType.SIMPLE,
                    {
                        metadata: "APP",
                        warningVersion: new version.model.Version(
                            2,
                            2,
                            2        
                        ),
                        errorVersion: new version.model.Version(
                            1,
                            1,
                            1        
                        )
                    }
                ),
                new version.model.VersionModel(
                    "asset",
                    version.model.VersionModelScope.PASSIVE,
                    version.model.VersionModelType.SIMPLE,
                    {
                        metadata: "ASSET",
                        warningVersion: new version.model.Version(
                            3,
                            3,
                            3        
                        ),
                        errorVersion: new version.model.Version(
                            2,
                            2,
                            2        
                        ),
                        needSignature: true,
                        signatureKeyId: "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
                    }
                ),
                new version.model.VersionModel(
                    "eula",
                    version.model.VersionModelScope.ACTIVE,
                    version.model.VersionModelType.SIMPLE,
                    {
                        metadata: "EULA",
                        currentVersion: new version.model.Version(
                            2,
                            2,
                            2        
                        ),
                        warningVersion: new version.model.Version(
                            4,
                            4,
                            4        
                        ),
                        errorVersion: new version.model.Version(
                            3,
                            3,
                            3        
                        )
                    }
                )
            ]
        );
    }
}

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

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="user-0001"
        ).master_data(
            version_models=[
                version.VersionModel(
                    name='app',
                    scope=version.VersionModelScope.PASSIVE,
                    type=version.VersionModelType.SIMPLE,
                    options=version.VersionModelOptions(
                        metadata = 'APP',
                        warning_version = version.Version(
                            major=2,
                            minor=2,
                            micro=2,        
                        ),
                        error_version = version.Version(
                            major=1,
                            minor=1,
                            micro=1,        
                        )
                    ),
                ),
                version.VersionModel(
                    name='asset',
                    scope=version.VersionModelScope.PASSIVE,
                    type=version.VersionModelType.SIMPLE,
                    options=version.VersionModelOptions(
                        metadata = 'ASSET',
                        warning_version = version.Version(
                            major=3,
                            minor=3,
                            micro=3,        
                        ),
                        error_version = version.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=version.VersionModelScope.ACTIVE,
                    type=version.VersionModelType.SIMPLE,
                    options=version.VersionModelOptions(
                        metadata = 'EULA',
                        current_version = version.Version(
                            major=2,
                            minor=2,
                            micro=2,        
                        ),
                        warning_version = version.Version(
                            major=4,
                            minor=4,
                            micro=4,        
                        ),
                        error_version = version.Version(
                            major=3,
                            minor=3,
                            micro=3,        
                        )
                    ),
                ),
            ],
        )

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

VersionModel

Version Model

You can set a warning version that accepts login but notifies you that you can upgrade, and an error version that does not accept login.

You can specify whether or not to have the client declare the current version with or without a signature. If you select signed, the client will not be able to declare a false version.

Type

Condition

Required

Default

Value Limits

Description

versionModelId

string

✓*

~ 1024 chars

Version Model GRN

* Automatically configured on the server

name

string

✓

~ 128 chars

Version Model Name

metadata

string

~ 2048 chars

Metadata

scope

String Enum
enum {
“passive”,
“active”
}

✓

Type of version value used for judgment

Enumerator String Definition	Description
“passive”	Sent by Client
“active”	Version explicitly approved in the past

type

String Enum
enum {
“simple”,
“schedule”
}

✓

“simple”

Version Check Mode

Enumerator String Definition	Description
“simple”	Simple
“schedule”	Schedule Change

currentVersion

Version

{type} == “simple” and {scope} == “active”

✓*

Current Version

* Required if type is “simple” and scope is “active”

warningVersion

Version

{type} == “simple”

✓*

Version that prompts for version upgrade

* Required if type is “simple”

errorVersion

Version

{type} == “simple”

✓*

Version that is determined to be an error by the version check

* Required if type is “simple”

scheduleVersions

List<ScheduleVersion>

{type} == “schedule”

0 ~ 10 items

List of Version check content that switches over time series

* Enabled if type is “schedule”

needSignature

bool

{scope} == “passive”

✓*

Whether the version value to be determined requires signature verification

* Required if scope is “passive”

signatureKeyId

string

{needSignature}

✓*

~ 1024 chars

encryption key GRN

* Required if needSignature is “true”

approveRequirement

String Enum
enum {
“required”,
“optional”
}

{scope} == “active”

✓*

“required”

Requirement for approval

Enumerator String Definition	Description
“required”	Approval required
“optional”	Any approval

* Required if scope is “active”

Version

	Type	Required	Value Limits	Description
major	int	✓	0 ~ 2147483646	Major version
minor	int	✓	0 ~ 2147483646	Minor version
micro	int	✓	0 ~ 2147483646	Micro version

ScheduleVersion

Version that switches in chronological order

	Type	Required	Value Limits	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