GS2-Version GS2-Deploy/CDK リファレンス

GS2-Deployのスタックを作成する際に使用するテンプレートのフォーマットと、CDKによる各種言語のテンプレート出力の実装例
Tags:

エンティティ

Deploy処理で操作する対象リソース

Namespace

ネームスペース

ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。
GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。

そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。

型有効化条件必須デフォルト値の制限説明
namespaceIdstring
✓
~ 1024文字ネームスペース GRN
namestring
✓
~ 128文字ネームスペース名
descriptionstring~ 1024文字説明文
transactionSettingTransactionSettingトランザクション設定
assumeUserIdstring
✓
~ 1024文字バージョンチェックを通過した場合に昇格する GS2-Identifier ユーザー GRN
acceptVersionScriptScriptSettingバージョンを承認したときに実行するスクリプト
checkVersionTriggerScriptIdstring~ 1024文字バージョンチェック処理を実行する GS2-Script のスクリプト
logSettingLogSettingログの出力設定
createdAtlong
✓
現在時刻作成日時
UNIX 時間・ミリ秒
サーバー側で自動的に設定
updatedAtlong
✓
現在時刻最終更新日時
UNIX 時間・ミリ秒
サーバー側で自動的に設定
revisionlong00 ~ 9223372036854775805リビジョン

GetAttr

!GetAttrタグで取得可能なリソースの生成結果

型説明
ItemNamespace作成したネームスペース

実装例

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

トランザクション設定

トランザクション設定は、トランザクションの実行方法・整合性・非同期処理・競合回避の仕組みを制御する設定です。
自動実行（AutoRun）、アトミック実行（AtomicCommit）、非同期実行（Distributor）、スクリプト結果の一括適用、JobQueue による入手アクションの非同期化などを組み合わせ、ゲームロジックに応じた堅牢なトランザクション管理を可能にします。

型有効化条件必須デフォルト値の制限説明
enableAutoRunbool
✓
false発行したトランザクションをサーバーサイドで自動的に実行するか
enableAtomicCommitbool{enableAutoRun} == true
✓*
falseトランザクションの実行をアトミックにコミットするか
※ enableAutoRun が true であれば必須
transactionUseDistributorbool{enableAtomicCommit} == true
✓*
falseトランザクションを非同期処理で実行する
※ enableAtomicCommit が true であれば必須
commitScriptResultInUseDistributorbool{transactionUseDistributor} == true
✓*
falseスクリプトの結果コミット処理を非同期処理で実行するか
※ transactionUseDistributor が true であれば必須
acquireActionUseJobQueuebool{enableAtomicCommit} == true
✓*
false入手アクションを実行する際に GS2-JobQueue を使用するか
※ enableAtomicCommit が true であれば必須
distributorNamespaceIdstring
✓
“grn:gs2:{region}:{ownerId}:distributor:default”~ 1024文字トランザクションの実行に使用する GS2-Distributor ネームスペース
queueNamespaceIdstring
✓
“grn:gs2:{region}:{ownerId}:queue:default”~ 1024文字トランザクションの実行に使用する GS2-JobQueue のネームスペース

ScriptSetting

スクリプト設定

GS2 ではマイクロサービスのイベントに関連づけて、カスタムスクリプトを実行することができます。
このモデルは、スクリプトの実行をトリガーするための設定を保持します。

スクリプトの実行方式は大きく2種類あり、それは「同期実行」と「非同期実行」です。
同期実行は、スクリプトの実行が完了するまで処理がブロックされます。
代わりに、スクリプトの実行結果を使ってAPIの実行を止めたり、APIの結果を改ざんすることができます。

一方、非同期実行ではスクリプトの完了を待つために処理がブロックされることはありません。
ただし、スクリプトの実行結果を利用して API の実行を停止したり、API の応答内容を変更することはできません。
非同期実行は API の応答フローに影響を与えないため、原則として非同期実行を推奨します。

非同期実行には実行方式が2種類あり、GS2-Script と Amazon EventBridge があります。
Amazon EventBridge を使用することで、Lua 以外の言語で処理を記述することができます。

型有効化条件必須デフォルト値の制限説明
triggerScriptIdstring~ 1024文字処理時に実行するスクリプト GRN
「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。
doneTriggerTargetType文字列列挙型
enum {
  “none”,
  “gs2_script”,
  “aws”
}
✓
“none”完了通知の通知先
定義説明
“none”なし
“gs2_script”GS2-Script
“aws”Amazon EventBridge
doneTriggerScriptIdstring{doneTriggerTargetType} == “gs2_script”~ 1024文字完了時に実行するスクリプト GRN
「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。

※ doneTriggerTargetType が “gs2_script” であれば有効
doneTriggerQueueNamespaceIdstring{doneTriggerTargetType} == “gs2_script”~ 1024文字完了時のスクリプトを実行する GS2-JobQueue ネームスペース GRN
完了スクリプトの完了を知りたい時に使用します。

※ doneTriggerTargetType が “gs2_script” であれば有効

LogSetting

ログの書き出し設定

ログデータの書き出し設定を管理します。この型は、ログデータを書き出すために使用される GS2-Log 名前空間の識別子（Namespace ID）を保持します。
ログ名前空間ID(loggingNamespaceId)には、ログデータを収集し保存する GS2-Log の名前空間を、GRNの形式で指定します。
この設定をすることで、設定された名前空間内で発生したAPIリクエスト・レスポンスのログデータが、対象の GS2-Log 名前空間側へ出力されるようになります。
GS2-Log ではリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。

型有効化条件必須デフォルト値の制限説明
loggingNamespaceIdstring
✓
~ 1024文字ログを出力する GS2-Log のネームスペース GRN

CurrentVersionMaster

現在有効なマスターデータ

GS2ではマスターデータの管理にJSON形式のファイルを使用します。
ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。

JSONファイルを作成する方法として、マネージメントコンソール内にマスターデータエディタを提供しています。
また、よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。

型有効化条件必須デフォルト値の制限説明
namespaceIdstring
✓
~ 1024文字ネームスペース GRN
settingsstring
✓
~ 5242880 バイト (5MB)マスターデータ

GetAttr

!GetAttrタグで取得可能なリソースの生成結果

型説明
ItemCurrentVersionMaster更新した現在有効なバージョン

実装例

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

バージョンモデル

ログインを受け入れるが、バージョンアップ出来ることを通知する警告バージョンと、ログインを受け入れないエラーバージョンを設定できます。

現在のバージョンをクライアントに申告させるのに、署名の有無を指定できます。
署名付きを選択した場合、クライアントは嘘のバージョン申告を出来なくなります。

型有効化条件必須デフォルト値の制限説明
versionModelIdstring
✓
~ 1024文字バージョンモデル GRN
namestring
✓
~ 128文字バージョンモデル名
metadatastring~ 2048文字メタデータ
scope文字列列挙型
enum {
  “passive”,
  “active”
}
✓
判定に使用するバージョン値の種類
定義説明
“passive”クライアントから送信
“active”過去明示的に承認したバージョン
type文字列列挙型
enum {
  “simple”,
  “schedule”
}
✓
“simple”バージョンチェックモード
定義説明
“simple”シンプル
“schedule”時系列切り替え
currentVersionVersion{type} == “simple” and {scope} == “active”
✓*
現在のバージョン
※ type が “simple” で かつ scope が “active” であれば 必須
warningVersionVersion{type} == “simple”
✓*
バージョンアップを促すバージョン
※ type が “simple” であれば必須
errorVersionVersion{type} == “simple”
✓*
バージョンチェックでエラーになるバージョン
※ type が “simple” であれば必須
scheduleVersionsList<ScheduleVersion>{type} == “schedule”0 ~ 10 items時系列で切り替わるバージョンチェック内容リスト
※ type が “schedule” であれば有効
needSignaturebool{scope} == “passive”
✓*
判定するバージョン値に署名検証を必要とするか
※ scope が “passive” であれば必須
signatureKeyIdstring{needSignature}
✓*
~ 1024文字暗号鍵 GRN
※ needSignature が “true” であれば必須
approveRequirement文字列列挙型
enum {
  “required”,
  “optional”
}
{scope} == “active”
✓*
“required”承認の必要性
※ scope が “active” であれば必須

Version

バージョン

型有効化条件必須デフォルト値の制限説明
majorint
✓
0 ~ 2147483646メジャーバージョン
minorint
✓
0 ~ 2147483646マイナーバージョン
microint
✓
0 ~ 2147483646マイクロバージョン

ScheduleVersion

時系列で切り替わるバージョン

型有効化条件必須デフォルト値の制限説明
currentVersionVersion
✓
現在のバージョン
warningVersionVersion
✓
バージョンアップを促すバージョン
errorVersionVersion
✓
バージョンチェックでエラーになるバージョン
scheduleEventIdstring~ 1024文字バージョンチェックを有効化する期間を設定した GS2-Schedule のイベント GRN