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

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

エンティティ

Deploy処理で操作の対象となるリソース

Namespace

ネームスペース

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

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

Request

リソースの生成・更新リクエスト

	型	必須	デフォルト	値の制限	説明
name	string	✓		~ 128文字	ネームスペース名ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
description	string			~ 1024文字	説明文
transactionSetting	TransactionSetting				トランザクション設定ギルド操作時の分散トランザクションの実行方法を制御する設定です。自動実行、アトミックコミット、非同期処理などのオプションをサポートします。
changeNotification	NotificationSetting				ギルド変更通知ギルド情報（表示名、属性、参加ポリシーなど）が更新されたときに GS2-Gateway 経由で送信されるプッシュ通知です。ギルドメンバーがギルドの変更についてリアルタイムで更新を受け取ることができます。
joinNotification	NotificationSetting				メンバー参加通知新しいメンバーがギルドに参加したときに GS2-Gateway 経由で送信されるプッシュ通知です。自由参加または参加リクエストの承認によるものの両方に対応します。既存メンバーが新規追加を通知されるようになります。
leaveNotification	NotificationSetting				メンバー離脱通知メンバーがギルドから離脱または除籍されたときに GS2-Gateway 経由で送信されるプッシュ通知です。自発的な脱退とギルドマスターによる追放の両方に対応します。
changeMemberNotification	NotificationSetting				メンバー変更通知ギルドメンバーの情報（ロール、メタデータ）が更新されたときに GS2-Gateway 経由で送信されるプッシュ通知です。メタデータの変更でこの通知がトリガーされるかどうかは changeMemberNotificationIgnoreChangeMetadata で制御できます。
changeMemberNotificationIgnoreChangeMetadata	bool?		false		メンバーの情報が更新されたときの通知を発行する際にメタデータの変更を無視する
receiveRequestNotification	NotificationSetting				リクエスト受信通知ユーザーからの新しい参加リクエストをギルドが受信したときに GS2-Gateway 経由で送信されるプッシュ通知です。ギルドマスターや権限を持つメンバーが承認待ちのリクエストを通知されるようになります。
removeRequestNotification	NotificationSetting				リクエスト削除通知ギルド参加リクエストが削除されたときに GS2-Gateway 経由で送信されるプッシュ通知です。送信者によるキャンセル、ギルドによる拒否、または承認（リクエスト削除とメンバー追加）のいずれかに対応します。
createGuildScript	ScriptSetting				ギルドを作成するときに実行するスクリプトの設定 Script トリガーリファレンス - `createGuild`
updateGuildScript	ScriptSetting				ギルドを更新するときに実行するスクリプトの設定 Script トリガーリファレンス - `updateGuild`
joinGuildScript	ScriptSetting				ギルドに参加するときに実行するスクリプトの設定 Script トリガーリファレンス - `joinGuild`
receiveJoinRequestScript	ScriptSetting				ギルドに参加申請を受け付けたときに実行するスクリプトの設定 Script トリガーリファレンス - `receiveJoinRequest`
leaveGuildScript	ScriptSetting				ギルドを脱退するときに実行するスクリプトの設定 Script トリガーリファレンス - `leaveGuild`
changeRoleScript	ScriptSetting				メンバーに割り当てているロールを変更するときに実行するスクリプトの設定 Script トリガーリファレンス - `changeRole`
deleteGuildScript	ScriptSetting				ギルドを削除するときに実行するスクリプトの設定 Script トリガーリファレンス - `deleteGuild`
logSetting	LogSetting				ログの出力設定ギルド操作のログデータを GS2-Log に出力するための設定です。GS2-Log のネームスペースを指定することで、ギルド作成、参加、脱退、ロール変更の API リクエスト・レスポンスログを収集できます。

GetAttr

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

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

実装例

Type: GS2::Guild::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSetting: 
    EnableAutoRun: true
    QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
  ChangeNotification: null
  JoinNotification: null
  LeaveNotification: null
  ChangeMemberNotification: null
  ChangeMemberNotificationIgnoreChangeMetadata: null
  ReceiveRequestNotification: null
  RemoveRequestNotification: null
  CreateGuildScript: null
  UpdateGuildScript: null
  JoinGuildScript: null
  ReceiveJoinRequestScript: null
  LeaveGuildScript: null
  ChangeRoleScript: null
  DeleteGuildScript: 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/guild"
    "github.com/openlyinc/pointy"
)


SampleStack := core.NewStack()
guild.NewNamespace(
    &SampleStack,
    "namespace-0001",
    guild.NamespaceOptions{
        TransactionSetting: &core.TransactionSetting{
            QueueNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"),
        },
        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\Guild\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\Guild\Model\Options\NamespaceOptions(
                transactionSetting: new \Gs2Cdk\Core\Model\TransactionSetting(
                    new \Gs2Cdk\Core\Model\TransactionSettingOptions(
                        queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
                    )
                ),
                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.guild.model.Namespace(
                this,
                "namespace-0001",
                new io.gs2.cdk.guild.model.options.NamespaceOptions()
                        .withTransactionSetting(new io.gs2.cdk.core.model.TransactionSetting(
                            new io.gs2.cdk.core.model.options.TransactionSettingOptions()
                                .withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001")
                        ))
                        .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.Gs2Guild.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: new Gs2Cdk.Gs2Guild.Model.Options.NamespaceOptions
            {
                transactionSetting = new Gs2Cdk.Core.Model.TransactionSetting(
                    options: new Gs2Cdk.Core.Model.TransactionSettingOptions
                    {
                        queueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
                    }
                ),
                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 guild from "@/gs2cdk/guild";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new guild.model.Namespace(
            this,
            "namespace-0001",
            {
                transactionSetting: new core.TransactionSetting(
                    {
                        queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-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, guild

class SampleStack(Stack):

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

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

TransactionSetting

トランザクション設定

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

	型	有効化条件	デフォルト	値の制限	説明
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 ネームスペース GRN
queueNamespaceId	string		“grn:gs2:{region}:{ownerId}:queue:default”	~ 1024文字	トランザクションの実行に使用する GS2-JobQueue のネームスペース GRN

ScriptSetting

スクリプト設定

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

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

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

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

型

有効化条件

必須

デフォルト

値の制限

説明

triggerScriptId

string

~ 1024文字

API 実行時に同期的に実行される GS2-Script のスクリプト GRN

「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。

doneTriggerTargetType

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

“none”

非同期スクリプトの実行方法

非同期実行で使用するスクリプトの種類を指定します。
「非同期実行のスクリプトを使用しない(none)」「GS2-Scriptを使用する(gs2_script)」「Amazon EventBridgeを使用する(aws)」が選択できます。

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

doneTriggerScriptId

string

{doneTriggerTargetType} == “gs2_script”

~ 1024文字

非同期実行する GS2-Script スクリプト GRN

「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。

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

doneTriggerQueueNamespaceId

string

{doneTriggerTargetType} == “gs2_script”

~ 1024文字

非同期実行スクリプトを実行する GS2-JobQueue ネームスペース GRN

非同期実行スクリプトを直接実行するのではなく、GS2-JobQueue を経由する場合は GS2-JobQueue のネームスペースGRN を指定します。
GS2-JobQueue を利用する理由は多くはありませんので、特に理由がなければ指定する必要はありません。

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

NotificationSetting

プッシュ通知に関する設定

GS2 のマイクロサービス内で何らかのイベントが発生した際に、プッシュ通知を送信するための設定です。
ここでいうプッシュ通知は GS2-Gateway の提供する WebSocket インターフェースを経由した処理であり、スマートフォンのプッシュ通知とは性質が異なります。
たとえば、マッチメイキングが完了した時やフレンドリクエストが届いた時など、ゲームクライアントの操作とは関係なく状態が変化した際に GS2-Gateway を経由してプッシュ通知をすることで、ゲームクライアントは状態の変化を検知することができます。

GS2-Gateway のプッシュ通知は通知先のデバイスがオフラインだった時に追加の処理としてモバイルプッシュ通知を送信できます。
モバイルプッシュ通知をうまく利用すれば、マッチメイキング中にゲームを終了しても、モバイルプッシュ通知を使用してプレイヤーに通知し、ゲームに戻ってくるフローを実現できる可能性があります。

型

有効化条件

必須

デフォルト

値の制限

説明

gatewayNamespaceId

string

“grn:gs2:{region}:{ownerId}:gateway:default”

~ 1024文字

プッシュ通知に使用する GS2-Gateway のネームスペース

「grn:gs2:」から始まる GRN 形式で GS2-Gateway のネームスペースIDを指定します。

enableTransferMobileNotification

bool?

false

モバイルプッシュ通知へ転送するか

この通知を送信しようとした時、通知先のデバイスがオフラインだった場合、モバイルプッシュ通知へ転送するかどうかを指定します。

sound

string

{enableTransferMobileNotification} == true

~ 1024文字

モバイルプッシュ通知で使用するサウンドファイル名

ここで指定したサウンドファイル名は、モバイルプッシュ通知を送信する際に使用され、特別なサウンドで通知を出すことができます。

※ enableTransferMobileNotification が true であれば有効

enable

文字列列挙型
enum {
“Enabled”,
“Disabled”
}

“Enabled”

プッシュ通知を有効にするか

定義	説明
“Enabled”	有効
“Disabled”	無効

LogSetting

ログの出力設定

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

	型	有効化条件	必須	デフォルト	値の制限	説明
loggingNamespaceId	string		✓		~ 1024文字	ログを出力する GS2-Log のネームスペース GRN 「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。

CurrentGuildMaster

現在アクティブなギルドモデルのマスターデータ

現在ネームスペース内で有効な、ギルドモデルの定義を記述したマスターデータです。
GS2ではマスターデータの管理にJSON形式のファイルを使用します。
ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。

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

Note

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

Request

リソースの生成・更新リクエスト

型

有効化条件

必須

デフォルト

値の制限

説明

namespaceName

string

✓

~ 128文字

ネームスペース名

ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。

mode

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

“direct”

更新モード

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

settings

string

{mode} == “direct”

✓※

~ 5242880文字

マスターデータ

※ mode が “direct” であれば必須

uploadToken

string

{mode} == “preUpload”

✓※

~ 1024文字

事前アップロードで取得したトークン

アップロードしたマスターデータを適用するために使用されます。

※ mode が “preUpload” であれば必須

GetAttr

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

	型	説明
Item	CurrentGuildMaster	更新された現在アクティブなギルドモデルのマスターデータ

実装例

Type: GS2::Guild::CurrentGuildMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  Settings: {
    "version": "2024-04-25",
    "guildModels": [
      {
        "name": "guild-0001",
        "defaultMaximumMemberCount": 10,
        "maximumMemberCount": 50,
        "inactivityPeriodDays": 10,
        "roles": [
          {
            "name": "master",
            "policyDocument": "{\\"Version\\": \\"2016-04-01\\", \\"Statements\\": [{\\"Effect\\": \\"Allow\\", \\"Actions\\": [\\"Gs2Guild:UpdateGuild\\"], \\"Resources\\": [\\"*\\"]}]}"
          },
          {
            "name": "member",
            "policyDocument": "{\\"Version\\": \\"2016-04-01\\", \\"Statements\\": [{\\"Effect\\": \\"Allow\\", \\"Actions\\": [\\"Gs2Guild:UpdateGuild\\"], \\"Resources\\": [\\"*\\"]}]}"
          }
        ],
        "guildMasterRole": "master",
        "guildMemberDefaultRole": "member",
        "rejoinCoolTimeMinutes": 1440
      },
      {
        "name": "guild-0002",
        "defaultMaximumMemberCount": 20,
        "maximumMemberCount": 40,
        "inactivityPeriodDays": 10,
        "roles": [
          {
            "name": "master",
            "policyDocument": "{\\"Version\\": \\"2016-04-01\\", \\"Statements\\": [{\\"Effect\\": \\"Allow\\", \\"Actions\\": [\\"Gs2Guild:UpdateGuild\\"], \\"Resources\\": [\\"*\\"]}]}"
          },
          {
            "name": "member",
            "policyDocument": "{\\"Version\\": \\"2016-04-01\\", \\"Statements\\": [{\\"Effect\\": \\"Allow\\", \\"Actions\\": [\\"Gs2Guild:UpdateGuild\\"], \\"Resources\\": [\\"*\\"]}]}"
          }
        ],
        "guildMasterRole": "master",
        "guildMemberDefaultRole": "member",
        "rejoinCoolTimeMinutes": 360
      }
    ]
  }
  UploadToken: null

import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/guild"
)


SampleStack := core.NewStack()
guild.NewNamespace(
    &SampleStack,
    "namespace-0001",
    guild.NamespaceOptions{},
).MasterData(
    []guild.GuildModel{
        guild.NewGuildModel(
            "guild-0001",
            10,
            50,
            10,
            []guild.RoleModel{
                guild.NewRoleModel(
                    "master",
                    "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}",
                    guild.RoleModelOptions{},
                ),
                guild.NewRoleModel(
                    "member",
                    "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}",
                    guild.RoleModelOptions{},
                ),
            },
            "master",
            "member",
            1440,
            guild.GuildModelOptions{
            },
        ),
        guild.NewGuildModel(
            "guild-0002",
            20,
            40,
            10,
            []guild.RoleModel{
                guild.NewRoleModel(
                    "master",
                    "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}",
                    guild.RoleModelOptions{},
                ),
                guild.NewRoleModel(
                    "member",
                    "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}",
                    guild.RoleModelOptions{},
                ),
            },
            "master",
            "member",
            360,
            guild.GuildModelOptions{
            },
        ),
    },
)

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

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Guild\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
                new \Gs2Cdk\Guild\Model\GuildModel(
                    name:"guild-0001",
                    defaultMaximumMemberCount:10,
                    maximumMemberCount:50,
                    inactivityPeriodDays:10,
                    roles:[
                        new \Gs2Cdk\Guild\Model\RoleModel(
                            name: "master",
                            policyDocument: "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}",    
                        ),
                        new \Gs2Cdk\Guild\Model\RoleModel(
                            name: "member",
                            policyDocument: "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}",    
                        ),
                    ],
                    guildMasterRole:"master",
                    guildMemberDefaultRole:"member",
                    rejoinCoolTimeMinutes:1440
                ),
                new \Gs2Cdk\Guild\Model\GuildModel(
                    name:"guild-0002",
                    defaultMaximumMemberCount:20,
                    maximumMemberCount:40,
                    inactivityPeriodDays:10,
                    roles:[
                        new \Gs2Cdk\Guild\Model\RoleModel(
                            name: "master",
                            policyDocument: "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}",    
                        ),
                        new \Gs2Cdk\Guild\Model\RoleModel(
                            name: "member",
                            policyDocument: "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}",    
                        ),
                    ],
                    guildMasterRole:"master",
                    guildMemberDefaultRole:"member",
                    rejoinCoolTimeMinutes:360
                )
            ]
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.guild.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.guild.model.GuildModel(
                    "guild-0001",
                    10,
                    50,
                    10,
                    Arrays.asList(
                        new io.gs2.cdk.guild.model.RoleModel(
                            "master",
                            "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}"        
                        ),
                        new io.gs2.cdk.guild.model.RoleModel(
                            "member",
                            "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}"        
                        )
                    ),
                    "master",
                    "member",
                    1440
                ),
                new io.gs2.cdk.guild.model.GuildModel(
                    "guild-0002",
                    20,
                    40,
                    10,
                    Arrays.asList(
                        new io.gs2.cdk.guild.model.RoleModel(
                            "master",
                            "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}"        
                        ),
                        new io.gs2.cdk.guild.model.RoleModel(
                            "member",
                            "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}"        
                        )
                    ),
                    "master",
                    "member",
                    360
                )
            )
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Guild.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2Guild.Model.GuildModel[] {
                new Gs2Cdk.Gs2Guild.Model.GuildModel(
                    name: "guild-0001",
                    defaultMaximumMemberCount: 10,
                    maximumMemberCount: 50,
                    inactivityPeriodDays: 10,
                    roles: new Gs2Cdk.Gs2Guild.Model.RoleModel[]
                    {
                        new Gs2Cdk.Gs2Guild.Model.RoleModel(
                            name: "master",
                            policyDocument: "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}"    
                        ),
                        new Gs2Cdk.Gs2Guild.Model.RoleModel(
                            name: "member",
                            policyDocument: "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}"    
                        )
                    },
                    guildMasterRole: "master",
                    guildMemberDefaultRole: "member",
                    rejoinCoolTimeMinutes: 1440
                ),
                new Gs2Cdk.Gs2Guild.Model.GuildModel(
                    name: "guild-0002",
                    defaultMaximumMemberCount: 20,
                    maximumMemberCount: 40,
                    inactivityPeriodDays: 10,
                    roles: new Gs2Cdk.Gs2Guild.Model.RoleModel[]
                    {
                        new Gs2Cdk.Gs2Guild.Model.RoleModel(
                            name: "master",
                            policyDocument: "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}"    
                        ),
                        new Gs2Cdk.Gs2Guild.Model.RoleModel(
                            name: "member",
                            policyDocument: "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}"    
                        )
                    },
                    guildMasterRole: "master",
                    guildMemberDefaultRole: "member",
                    rejoinCoolTimeMinutes: 360
                )
            }
        );
    }
}

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

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new guild.model.Namespace(
            this,
            "namespace-0001",
        ).masterData(
            [
                new guild.model.GuildModel(
                    "guild-0001",
                    10,
                    50,
                    10,
                    [
                        new guild.model.RoleModel(
                            "master",
                            "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}"        
                        ),
                        new guild.model.RoleModel(
                            "member",
                            "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}"        
                        ),
                    ],
                    "master",
                    "member",
                    1440
                ),
                new guild.model.GuildModel(
                    "guild-0002",
                    20,
                    40,
                    10,
                    [
                        new guild.model.RoleModel(
                            "master",
                            "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}"        
                        ),
                        new guild.model.RoleModel(
                            "member",
                            "{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}"        
                        ),
                    ],
                    "master",
                    "member",
                    360
                )
            ]
        );
    }
}

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

from gs2_cdk import Stack, core, guild

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        guild.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            guild_models=[
                guild.GuildModel(
                    name='guild-0001',
                    default_maximum_member_count=10,
                    maximum_member_count=50,
                    inactivity_period_days=10,
                    roles=[
                        guild.RoleModel(
                            name='master',
                            policy_document='{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}',        
                        ),
                        guild.RoleModel(
                            name='member',
                            policy_document='{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}',        
                        ),
                    ],
                    guild_master_role='master',
                    guild_member_default_role='member',
                    rejoin_cool_time_minutes=1440
                ),
                guild.GuildModel(
                    name='guild-0002',
                    default_maximum_member_count=20,
                    maximum_member_count=40,
                    inactivity_period_days=10,
                    roles=[
                        guild.RoleModel(
                            name='master',
                            policy_document='{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}',        
                        ),
                        guild.RoleModel(
                            name='member',
                            policy_document='{\\\"Version\\\": \\\"2016-04-01\\\", \\\"Statements\\\": [{\\\"Effect\\\": \\\"Allow\\\", \\\"Actions\\\": [\\\"Gs2Guild:UpdateGuild\\\"], \\\"Resources\\\": [\\\"*\\\"]}]}',        
                        ),
                    ],
                    guild_master_role='master',
                    guild_member_default_role='member',
                    rejoin_cool_time_minutes=360
                ),
            ],
        )

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

GuildModel

ギルドモデル

ギルドモデルとは、ギルドの加入可能最大人数の設定や、ギルド内での役職ごとの権限設定を持つエンティティです。

	型	必須	デフォルト	値の制限	説明
guildModelId	string	※		~ 1024文字	ギルドモデル GRN ※ サーバーが自動で設定
name	string	✓		~ 128文字	ギルドモデル名ギルドモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
metadata	string			~ 2048文字	メタデータメタデータには任意の値を設定できます。これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。
defaultMaximumMemberCount	int	✓		1 ~ 2147483646	デフォルト最大メンバー数新しいギルドが作成される際に許可されるメンバーの初期最大数です。この値は新規ギルドの currentMaximumMemberCount の初期値として使用されます。ギルド操作や入手アクションを通じて、後から maximumMemberCount の上限まで増加させることができます。
maximumMemberCount	int	✓		1 ~ 2147483646	最大メンバー数上限ギルドが持つことができるメンバー数の絶対的な上限です。ギルドの currentMaximumMemberCount はこの値を超えることができません。ギルドが意図されたサイズを超えて成長するのを防ぐハードキャップとして機能します。
inactivityPeriodDays	int		7	1 ~ 365	無活動期間（日数）ギルドマスターの無活動がこの日数を超えた場合に、残りのギルドメンバーから新しいギルドマスターが自動的に選出されます。ギルドマスターがプレイを停止した際にギルドが管理不能になるのを防ぎます。
roles	List<RoleModel>	✓		1 ~ 10 items	ロールモデルリストこのタイプのギルド内で利用可能なロール定義のリストです。guildMasterRole および guildMemberDefaultRole で参照されるロールを少なくとも含む必要があります。各ロールはポリシードキュメントを介して固有の権限セットを定義します。最大10個のロールを定義できます。
guildMasterRole	string	✓		~ 128文字	ギルドマスターロール名ギルドマスターに割り当てられるロールの名前です。roles リストで定義されたロールを参照する必要があります。ギルドマスターは通常、参加リクエストの承認、メンバー追放、ロール変更、ギルド設定の更新など、ギルドを管理する全権限を持ちます。
guildMemberDefaultRole	string	✓		~ 128文字	デフォルトメンバーロール名新しいギルドメンバーが参加した際に自動的に割り当てられるロールの名前です。roles リストで定義されたロールを参照する必要があります。これはギルドマスターによるロール変更前の一般メンバーの基本権限セットです。
rejoinCoolTimeMinutes	int		0	0 ~ 2147483646	再参加クールタイム（分）ユーザーがギルドを離脱した後、再度ギルドに参加できるようになるまでのクールダウン期間（分）です。0 に設定すると即時再参加が可能になります。ユーザーが繰り返しギルドに参加・離脱する悪用パターンを防止します。
maxConcurrentJoinGuilds	int			1 ~ 10	同時参加可能ギルド最大数ユーザーがこのタイプのギルドに同時にメンバーとして参加できる最大数です。プレイヤーが複数のギルドに同時に所属できるデザイン（例: 戦闘ギルドとソーシャルギルド）を可能にします。値は 1 から 10 の範囲です。
maxConcurrentGuildMasterCount	int			1 ~ 100	同時存在可能ギルドマスター最大数 1つのギルドに同時に存在できるギルドマスターの最大人数です。複数のプレイヤーがギルドマスターの責任と権限を共有する共同リーダーシップのデザインを可能にします。値は 1 から 100 の範囲です。

RoleModel

ロールモデル

ロールモデルはギルド内での役割を定義し、その役割ごと実行できる処理に関する権限を設定します。

	型	必須	値の制限	説明
name	string	✓	~ 128文字	ロールモデル名ロールモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
metadata	string		~ 2048文字	メタデータメタデータには任意の値を設定できます。これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。
policyDocument	string	✓	~ 10240文字	ポリシードキュメントこのロールの権限を定義する JSON 形式のポリシードキュメントです。このロールに割り当てられたメンバーに対して、どのギルド操作（参加リクエストの承認/拒否、メンバー追放、ギルド情報の更新、メンバーロールの変更など）が許可または拒否されるかを指定します。