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

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

エンティティ

Namespace

ネームスペース

ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。
GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。

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

	型	必須	値の制限	説明
name	string	✓	~ 128文字	ネームスペース名
description	string		~ 1024文字	説明文
transactionSetting	TransactionSetting			トランザクション設定
entryScript	ScriptSetting			エントリー登録時に実行するスクリプト
duplicateEntryScript	string		~ 1024文字	登録済みのエントリーを再度登録しようとした時に実行するスクリプト
logSetting	LogSetting			ログの出力設定

GetAttr

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

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

実装例

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

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new dictionary.model.Namespace(
            this,
            "namespace-0001",
            {
                logSetting: new core.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

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

from gs2_cdk import Stack, core, dictionary

class SampleStack(Stack):

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

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

CurrentEntryMaster

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

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

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

Note

JSONファイルの形式については GS2-Dictionary マスターデータリファレンスをご参照ください。

型

有効化条件

必須

デフォルト

値の制限

説明

namespaceName

string

✓

~ 128文字

ネームスペース名

mode

文字列列挙型
enum {
“direct”,
“preUpload”
}

✓

“direct”

~ 128文字

更新モード

定義	説明
“direct”	設定を直接更新
“preUpload”	設定をアップロードしてから更新

settings

string

{mode} == “direct”

✓

~ 5242880文字

マスターデータ
mode が “direct” であれば必須

uploadToken

string

{mode} == “preUpload”

✓

~ 1024文字

プレアップロードで取得したトークン
mode が “preUpload” であれば必須

GetAttr

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

	型	説明
Item	CurrentEntryMaster	更新した現在有効なマスターデータ

実装例

Type: GS2::Dictionary::CurrentEntryMaster
Properties:
  NamespaceName: namespace-0001
  Mode: null
  Settings: {
    "version": "2020-04-30",
    "entryModels": [
      {
        "name": "monster-0001",
        "metadata": "MONSTER-0001"
      },
      {
        "name": "monster-0002",
        "metadata": "MONSTER-0002"
      }
    ]
  }
  UploadToken: null

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

SampleStack := core.NewStack()
dictionary.NewNamespace(
    &SampleStack,
    "namespace-0001",
    dictionary.NamespaceOptions{},
).MasterData(
    []dictionary.EntryModel{
        dictionary.NewEntryModel(
            "monster-0001",
            dictionary.EntryModelOptions{
                Metadata: pointy.String("MONSTER-0001"),
            },
        ),
        dictionary.NewEntryModel(
            "monster-0002",
            dictionary.EntryModelOptions{
                Metadata: pointy.String("MONSTER-0002"),
            },
        ),
    },
)

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

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Dictionary\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
                new \Gs2Cdk\Dictionary\Model\EntryModel(
                    name:"monster-0001",
                    options: new \Gs2Cdk\Dictionary\Model\Options\EntryModelOptions(
                        metadata:"MONSTER-0001"
                    )
                ),
                new \Gs2Cdk\Dictionary\Model\EntryModel(
                    name:"monster-0002",
                    options: new \Gs2Cdk\Dictionary\Model\Options\EntryModelOptions(
                        metadata:"MONSTER-0002"
                    )
                )
            ]
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.dictionary.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.dictionary.model.EntryModel(
                    "monster-0001",
                    new io.gs2.cdk.dictionary.model.options.EntryModelOptions()
                        .withMetadata("MONSTER-0001")
                ),
                new io.gs2.cdk.dictionary.model.EntryModel(
                    "monster-0002",
                    new io.gs2.cdk.dictionary.model.options.EntryModelOptions()
                        .withMetadata("MONSTER-0002")
                )
            )
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Dictionary.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2Dictionary.Model.EntryModel[] {
                new Gs2Cdk.Gs2Dictionary.Model.EntryModel(
                    name: "monster-0001",
                    options: new Gs2Cdk.Gs2Dictionary.Model.Options.EntryModelOptions
                    {
                        metadata = "MONSTER-0001"
                    }
                ),
                new Gs2Cdk.Gs2Dictionary.Model.EntryModel(
                    name: "monster-0002",
                    options: new Gs2Cdk.Gs2Dictionary.Model.Options.EntryModelOptions
                    {
                        metadata = "MONSTER-0002"
                    }
                )
            }
        );
    }
}

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

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new dictionary.model.Namespace(
            this,
            "namespace-0001",
        ).masterData(
            [
                new dictionary.model.EntryModel(
                    "monster-0001",
                    {
                        metadata: "MONSTER-0001"
                    }
                ),
                new dictionary.model.EntryModel(
                    "monster-0002",
                    {
                        metadata: "MONSTER-0002"
                    }
                )
            ]
        );
    }
}

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

from gs2_cdk import Stack, core, dictionary

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        dictionary.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            entry_models=[
                dictionary.EntryModel(
                    name='monster-0001',
                    options=dictionary.EntryModelOptions(
                        metadata = 'MONSTER-0001'
                    ),
                ),
                dictionary.EntryModel(
                    name='monster-0002',
                    options=dictionary.EntryModelOptions(
                        metadata = 'MONSTER-0002'
                    ),
                ),
            ],
        )

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

Config

コンフィグ設定

トランザクションの変数に適用する設定値

	型	有効化条件	必須	デフォルト	値の制限	説明
key	string		✓		~ 64文字	名前
value	string				~ 51200文字	値

GitHubCheckoutSetting

GitHubからマスターデータをチェックアウトする設定

型

有効化条件

必須

デフォルト

値の制限

説明

apiKeyId

string

✓

~ 1024文字

GitHub のAPIキーGRN

repositoryName

string

✓

~ 1024文字

リポジトリ名

sourcePath

string

✓

~ 1024文字

ソースコードのファイルパス

referenceType

文字列列挙型
enum {
  “commit_hash”,
  “branch”,
  “tag”
}

✓

~ 128文字

コードの取得元

定義	説明
“commit_hash”	コミットハッシュ
“branch”	ブランチ
“tag”	タグ

commitHash

string

{referenceType} == “commit_hash”

✓

~ 1024文字

コミットハッシュ
referenceType が “commit_hash” であれば必須

branchName

string

{referenceType} == “branch”

✓

~ 1024文字

ブランチ名
referenceType が “branch” であれば必須

tagName

string

{referenceType} == “tag”

✓

~ 1024文字

タグ名
referenceType が “tag” であれば必須

ScriptSetting

スクリプト設定

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

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

一方、非同期実行は、スクリプトの実行が完了するまで処理がブロックされません。
かわりに、スクリプトの実行結果を使ってAPIの実行を止めたり、APIの結果を改ざんすることはできません。
しかし、非同期実行は、スクリプトの実行が完了するまで処理がブロックされないため、APIの応答に影響を与えないため、原則非同期実行を使用することをおすすめします。

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

型

有効化条件

必須

デフォルト

値の制限

説明

triggerScriptId

string

~ 1024文字

処理時に実行するスクリプト

doneTriggerTargetType

文字列列挙型
enum {
  “none”,
  “gs2_script”,
  “aws”
}

✓

“none”

~ 128文字

完了通知の通知先

定義	説明
“none”	なし
“gs2_script”	GS2-Script
“aws”	Amazon EventBridge

doneTriggerScriptId

string

{doneTriggerTargetType} == “gs2_script”

~ 1024文字

完了時に実行するスクリプト
doneTriggerTargetType が “gs2_script” であれば有効

doneTriggerQueueNamespaceId

string

{doneTriggerTargetType} == “gs2_script”

~ 1024文字

完了時のスクリプトを実行するためのジョブキューのネームスペース
doneTriggerTargetType が “gs2_script” であれば有効

LogSetting

ログの書き出し設定

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

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

TransactionSetting

トランザクション設定

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