> For the complete documentation index, see [llms.txt](/llms.txt)

# GS2-Realtime Deploy/CDK リファレンス

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




## エンティティ

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

### Namespace

ネームスペース<br>

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

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

#### Request

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

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| name | string |  | ✓|  |  ~ 128文字 | ネームスペース名<br>ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| description | string |  | |  |  ~ 1024文字 | 説明文 |
| transactionSettingV2 | [TransactionSettingV2](#transactionsettingv2) |  | |  |  | トランザクション設定（V2）<br>このネームスペースが発行するトランザクションをどのように実行するかを決める設定です。設定する項目は、実行に使用する GS2-Distributor のネームスペースと、トランザクションに含まれるアクションを 1 件ずつ実行して先に実行されたアクションの結果を後続のアクションから使えるようにするか、まとめて同時に実行してレスポンスタイムを短くするか、の 2 つだけです。<br>新しく作成するネームスペースではこちらを設定してください。これに置き換えられて非推奨となった `transactionSetting` は、こちらが設定されていない間だけ使用されます。 |
| serverType | 文字列列挙型<br>enum {<br>"relay"<br>}<br> |  | ✓|  |  | サーバの種類<br>リアルタイム通信のためにプロビジョニングするゲームサーバーのタイプ。<br>現在は `relay` モードをサポートしており、接続されたゲームクライアント間でメッセージを転送するパケットリレーサーバーを提供します。relay: パケットリレー /  |
| serverSpec | 文字列列挙型<br>enum {<br>"realtime1.nano"<br>}<br> |  | ✓|  |  | サーバのスペック<br>プロビジョニングされるゲームサーバーのハードウェアスペックティア。<br>各ルームのサーバーインスタンスに割り当てられるコンピューティングリソース（CPU、メモリ）を決定します。現在 "realtime1.nano" をサポートしています。realtime1.nano: realtime1.nano /  |
| createNotification | [NotificationSetting](#notificationsetting) |  | |  |  | ルーム作成完了通知<br>ルームのプロビジョニングが完了し、接続可能になったときにトリガーされるプッシュ通知設定。<br>ルーム作成は非同期で行われ（IPアドレス、ポート、暗号鍵は少し遅れて割り当てられる）、この通知によりクライアントにルームが接続受付可能になったことを通知します。 |
| logSetting | [LogSetting](#logsetting) |  | |  |  | ログ出力設定<br>リアルタイム関連の操作ログを GS2-Log に出力するための設定。<br>設定すると、ルーム作成、接続イベント、メッセージリレーのアクティビティなどが分析やデバッグのために記録されます。 |

#### GetAttr

[!GetAttr](/articles/tech/deploy/#getattr)タグで取得可能なリソースの生成結果

| | 型 | 説明 |
| --- | --- | --- |
| Item | [Namespace](../sdk#namespace) | 作成したネームスペース

#### 実装例




**GS2-Deploy(YAML)**
```yaml

Type: GS2::Realtime::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSettingV2: null
  ServerType: relay
  ServerSpec: realtime1.nano
  CreateNotification: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001

```

**Go**
```go

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


SampleStack := core.NewStack()
realtime.NewNamespace(
    &SampleStack,
    "namespace-0001",
    realtime.NamespaceServerTypeRelay,
    realtime.NamespaceServerSpecRealtime1Nano,
    realtime.NamespaceOptions{
        LogSetting: &core.LogSetting{
            LoggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
        },
    },
)

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

```

**PHP**
```php

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        new \Gs2Cdk\Realtime\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            serverType: \Gs2Cdk\Realtime\Model\Enums\NamespaceServerType::RELAY,
            serverSpec: \Gs2Cdk\Realtime\Model\Enums\NamespaceServerSpec::REALTIME1_NANO,
            options: new \Gs2Cdk\Realtime\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

```

**Java**
```java

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.realtime.model.Namespace(
                this,
                "namespace-0001",
                io.gs2.cdk.realtime.model.enums.NamespaceServerType.RELAY,
                io.gs2.cdk.realtime.model.enums.NamespaceServerSpec.REALTIME1_NANO,
                new io.gs2.cdk.realtime.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

```

**C#**
```csharp

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Realtime.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            serverType: Gs2Cdk.Gs2Realtime.Model.Enums.NamespaceServerType.Relay,
            serverSpec: Gs2Cdk.Gs2Realtime.Model.Enums.NamespaceServerSpec.Realtime1Nano,
            options: new Gs2Cdk.Gs2Realtime.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

```

**TypeScript**
```typescript

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

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

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

```

**Python**
```python

from gs2_cdk import Stack, core, realtime

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        realtime.Namespace(
            stack=self,
            name='namespace-0001',
            server_type=realtime.NamespaceServerType.RELAY,
            server_spec=realtime.NamespaceServerSpec.REALTIME1_NANO,
            options=realtime.NamespaceOptions(
                log_setting=core.LogSetting(
                    logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
                ),
            ),
        )

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

```


### TransactionSettingV2

トランザクション設定（V2）<br>

トランザクション設定（V2）は、ネームスペースが発行するトランザクションをどのように実行するかを決める設定です。<br>

設定する項目は次の 2 つだけです。<br>

- `distributorNamespaceId`: トランザクションの実行に使用する GS2-Distributor のネームスペース<br>
- `enableParallelExecution`: トランザクションに含まれるアクションを 1 件ずつ実行するか、まとめて同時に実行するか<br>

どちらを選んでも、トランザクションは発行された時点でサーバーが実行し、成否はトランザクション全体でひとつになります。あるアクションが失敗した場合は、それまでに実行されたアクションもろとも取り消され、1 つも反映されません。トランザクションの実行方法に関するそれ以外の項目は推奨構成に固定されているため、設定する必要はありません。<br>

1 件ずつ実行する場合（既定 / `enableParallelExecution` が `false`）、各アクションは先に実行されたアクションの書き込みを踏まえて動作します。アクションは verify・consume・acquire の順に実行され、次のことができます。<br>

- 1 つのトランザクションの中で、同じ行を複数のアクションから更新する（まとめて同時に実行する場合は失敗します）<br>
- 先に実行されたアクションの書き込みを読む。List や Query の結果でも、入れ子になったトランザクションの内側でも読めます<br>
- `%{Gs2Xxx:ActionName.path[0].field}` を使って、先に実行された verify や consume アクションの結果を、後続の verify・consume・acquire アクションの引数として渡す<br>

代わりに、レスポンスタイムは各アクションの実行時間の合計になり、1 つのトランザクションに含められるアクションは最大 20 件になります。また、各フェーズの中での実行順はアクション名、次に対象リソースの順で決まるため、リクエストに並べた順序で実行順を指定することはできません。実行は最初に失敗したアクションで停止します。<br>

まとめて同時に実行する場合（`enableParallelExecution` が `true`）、アクションは同一のデータスナップショットに対して並列に実行されるため、レスポンスタイムは最も遅いアクション 1 件分で済み、アクション数の上限もありません。<br>

代わりに、あるアクションから他のアクションの書き込みを読むことはできず、同じ行を 2 つのアクションが書き換えるとトランザクションは `database:transaction:same.resource`（400）で失敗します。同一トランザクション内で同じデータを 2 つ以上のアクションが書き換えないことを保証できる場合にだけ選択してください。`%{...}` は先行するフェーズ（verify → consume → acquire の順）の結果だけを参照でき、同じフェーズ内のアクションへの参照は解決されずにそのまま残ります。`%{...}` を含むフェーズは先行するフェーズの完了を待ってから実行されるため、その分だけレスポンスタイムが伸びます。<br>

トランザクション設定は、トランザクション設定（V2）に置き換えられた非推奨の設定で、トランザクション設定（V2）が存在しなかった頃に作成されたネームスペースのために残されています。トランザクション設定（V2）が設定されていない間だけ適用され、トランザクション設定（V2）を設定するとそちらが優先されます。トランザクション設定で可能だった、トランザクションをクライアント実行のスタンプシートとして実行する・GS2-Distributor による AutoRun の非同期実行を行う・入手アクションを GS2-JobQueue に畳み込む、という 3 つの挙動は、こちらではあえて提供していません。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| distributorNamespaceId | string |  |  | "grn:gs2:{region}:{ownerId}:distributor:default" |  ~ 1024文字 | トランザクションの実行に使用する GS2-Distributor ネームスペースGRN |
| enableParallelExecution | bool |  |  | false |  | アクションを直列ではなく並列に実行するか |

### NotificationSetting

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

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

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

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| gatewayNamespaceId | string |  |  | "grn:gs2:{region}:{ownerId}:gateway:default" |  ~ 1024文字 | プッシュ通知に使用する GS2-Gateway のネームスペース<br>「grn:gs2:」から始まる GRN 形式で GS2-Gateway のネームスペースIDを指定します。 |
| enableTransferMobileNotification | bool? |  |  | false |  | モバイルプッシュ通知へ転送するか<br>この通知を送信しようとした時、通知先のデバイスがオフラインだった場合、モバイルプッシュ通知へ転送するかどうかを指定します。 |
| sound | string | {enableTransferMobileNotification} == true |  |  |  ~ 1024文字 | モバイルプッシュ通知で使用するサウンドファイル名<br>ここで指定したサウンドファイル名は、モバイルプッシュ通知を送信する際に使用され、特別なサウンドで通知を出すことができます。<br>※ enableTransferMobileNotification が true であれば 有効 |
| mobileNotificationMessages | [List&lt;MobileNotificationMessage&gt;](#mobilenotificationmessage) | {enableTransferMobileNotification} == true |  |  | 0 ~ 100 items | モバイルプッシュ通知へ転送するときの言語別のタイトルと本文<br>オフラインのプレイヤーへモバイルプッシュ通知として転送するときの、言語別のタイトルと本文です。<br>デバイストークンに登録された locale に一致するエントリ → `default` → 先頭 の順に採用します。<br>未設定なら通知の payload の `mobile` 配列、それも無ければ payload をそのまま本文にします。<br>※ enableTransferMobileNotification が true であれば 有効 |
| enable | 文字列列挙型<br>enum {<br>"Enabled",<br>"Disabled"<br>}<br> |  |  | "Enabled" |  | プッシュ通知を有効にするかEnabled: 有効 / Disabled: 無効 /  |

### LogSetting

ログの出力設定<br>

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

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

### TransactionSetting

トランザクション設定<br>

トランザクション設定は非推奨です。トランザクション設定（V2）がこれに置き換わります。トランザクション設定（V2）が存在しなかった頃に作成されたネームスペースのために残されており、トランザクション設定（V2）が設定されていない間だけ適用されます。新しく作成するネームスペースでは使用しないでください。<br>

この設定は、トランザクションの実行に関わる要素――自動実行（AutoRun）、アトミック実行（AtomicCommit）、GS2-Distributor を利用した非同期実行、スクリプト結果の一括適用、GS2-JobQueue による入手アクションの非同期化、直列実行――をそれぞれ個別の項目として公開しているため、推奨構成以外の組み合わせも作れます。その推奨構成を 1 つの設定としてまとめたものがトランザクション設定（V2）です。トランザクション設定を使い続けるのは、トランザクション設定（V2）が提供しない挙動――トランザクションをクライアント実行のスタンプシートとして実行する、GS2-Distributor による AutoRun の非同期実行を行う、入手アクションを GS2-JobQueue に畳み込む――にすでに依存しているネームスペースに限ってください。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| enableAutoRun | bool |  |  | false |  | 発行したトランザクションをサーバーサイドで自動的に実行するか |
| enableAtomicCommit | bool | {enableAutoRun} == true |  | false |  | トランザクションの実行をアトミックにコミットするか<br>※ enableAutoRun が true であれば 有効 |
| transactionUseDistributor | bool | {enableAtomicCommit} == true |  | false |  | トランザクションを非同期処理で実行する<br>※ enableAtomicCommit が true であれば 有効 |
| commitScriptResultInUseDistributor | bool | {transactionUseDistributor} == true |  | false |  | スクリプトの結果コミット処理を非同期処理で実行するか<br>※ transactionUseDistributor が true であれば 有効 |
| acquireActionUseJobQueue | bool | {enableAtomicCommit} == true |  | false |  | 入手アクションを実行する際に GS2-JobQueue を使用するか<br>※ enableAtomicCommit が true であれば 有効 |
| enableSequentialExecution | bool | {enableAtomicCommit} == true |  | false |  | アトミックコミットのアクションを直列に実行し、同じ行を複数のアクションで更新できるようにするか<br>※ 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 |

### MobileNotificationMessage

モバイルプッシュ通知の言語別メッセージ<br>

通知をモバイルプッシュ通知へ転送する際に使用する、言語別メッセージリストの 1 要素です。1 つの要素が 1 つのロケールに対するタイトルと本文を保持します。<br>
採用される要素は、Firebase デバイストークンに登録されたロケールと `locale` が一致する要素 → `locale` が `default` の要素 → リストの先頭の要素、の順で選択されます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| locale | string |  |  |  |  ~ 32文字 | メッセージの言語<br>この要素がどの言語に対するものかを表します。Firebase デバイストークンに登録されたロケールと照合されます。`ja` や `en` のような任意の文字列を指定できます。`default` は特別な値で、端末のロケールに一致する要素がなかったときに使われるフォールバックの要素であることを表します。 |
| title | string |  |  |  |  ~ 256文字 | プッシュ通知のタイトル<br>この要素が採用されたときに、モバイルプッシュ通知のタイトルとして表示されるテキストです。省略した場合は、通知の件名が使用されます。 |
| message | string |  |  |  |  ~ 1024文字 | プッシュ通知の本文<br>この要素が採用されたときに、モバイルプッシュ通知の本文として表示されるテキストです。 |

---