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

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

エンティティ

Namespace

ネームスペース

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

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

型必須デフォルト値の制限説明
namestring✓~ 128文字ネームスペース名
descriptionstring~ 1024文字説明文
entryScriptScriptSettingエントリー登録時に実行するスクリプト
duplicateEntryScriptstring~ 1024文字登録済みのエントリーを再度登録しようとした時に実行するスクリプト
logSettingLogSettingログの出力設定

GetAttr

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

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

実装例

Type: GS2::Dictionary::Namespace
Properties:
  Name: namespace-0001
  Description: 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ファイルを書き出すことでもサービスを利用可能です。

型必須デフォルト値の制限説明
namespaceNamestring✓~ 128文字ネームスペース名
modestring✓“direct”~ 128文字更新モード
settingsstring{mode} == “direct”~ 5242880文字マスターデータ
uploadTokenstring{mode} == “preUpload”~ 1024文字プレアップロードで取得したトークン

GetAttr

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

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

実装例

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

コンフィグ設定

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

型必須デフォルト値の制限説明
keystring✓~ 64文字名前
valuestring~ 51200文字値

GitHubCheckoutSetting

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

型必須デフォルト値の制限説明
apiKeyIdstring✓~ 1024文字GitHub のAPIキーGRN
repositoryNamestring✓~ 1024文字リポジトリ名
sourcePathstring✓~ 1024文字ソースコードのファイルパス
referenceTypeenum {
    “commit_hash”,
    “branch”,
    “tag”
}
✓~ 128文字コードの取得元
commitHashstring{referenceType} == “commit_hash”~ 1024文字コミットハッシュ
branchNamestring{referenceType} == “branch”~ 1024文字ブランチ名
tagNamestring{referenceType} == “tag”~ 1024文字タグ名

referenceType に指定する列挙型の定義

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

ScriptSetting

スクリプト設定

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

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

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

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

型必須デフォルト値の制限説明
triggerScriptIdstring~ 1024文字スクリプトGRN
doneTriggerTargetTypeenum {
    “none”,
    “gs2_script”,
    “aws”
}
✓“none”~ 128文字完了通知の通知先
doneTriggerScriptIdstring{doneTriggerTargetType} == “gs2_script”~ 1024文字スクリプトGRN
doneTriggerQueueNamespaceIdstring{doneTriggerTargetType} == “gs2_script”~ 1024文字ネームスペースGRN

doneTriggerTargetType に指定する列挙型の定義

定義説明
noneなし
gs2_scriptGS2-Script
awsAmazon EventBridge

LogSetting

ログの書き出し設定

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

型必須デフォルト値の制限説明
loggingNamespaceIdstring✓~ 1024文字ネームスペースGRN