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

エンティティ

Namespace

ネームスペース

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

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

型必須デフォルト値の制限説明
namestring✓~ 128文字ネームスペース名
descriptionstring~ 1024文字説明文
transactionSettingTransactionSettingトランザクション設定
updateMoldScriptScriptSettingキャパシティを更新するときに実行するスクリプト
updateFormScriptScriptSettingフォームを更新するときに実行するスクリプト
updatePropertyFormScriptScriptSettingプロパティフォームを更新するときに実行するスクリプト
logSettingLogSettingログの出力設定

GetAttr

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

実装例

Type: GS2::Formation::Namespace
Properties:
  Name: namespace1
  Description: null
  TransactionSetting: 
    EnableAutoRun: false
    QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
    KeyId: grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001
  UpdateMoldScript: null
  UpdateFormScript: null
  UpdatePropertyFormScript: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
from gs2_cdk import Stack, core, formation

class SampleStack(Stack):

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

print(SampleStack().yaml())  # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        new \Gs2Cdk\Formation\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\Formation\Model\Options\NamespaceOptions(
                transactionSetting: new \Gs2Cdk\Core\Model\TransactionSetting(
                    enableAutoRun: True,
                    queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
                    options: new \Gs2Cdk\Core\Model\Options\TransactionSettingOptions(
                        keyId: "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-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.formation.model.Namespace(
            this,
            "namespace-0001",
            new io.gs2.cdk.formation.model.options.NamespaceOptions() {
                {
                    transactionSetting = new io.gs2.cdk.core.model.TransactionSetting(){
                        {
                            queueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001";
                        },
                        new io.gs2.cdk.core.model.options.TransactionSettingOptions(
                            "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
                        )
                    );
                    logSetting = new io.gs2.cdk.core.model.LogSetting(
                        loggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                    );
                }
            }
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
import core from "@/gs2cdk/core";
import formation from "@/gs2cdk/formation";

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

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Formation.Model.Namespace(
            this,
            "namespace-0001",
            new Gs2Cdk.Gs2Formation.Model.Options.NamespaceOptions {
                transactionSetting = new Gs2Cdk.Core.Model.TransactionSetting(
                    new Gs2Cdk.Core.Model.Options.TransactionSettingOptions {
                        queueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
                    },
                    new Gs2Cdk.Core.Model.Options.TransactionSettingOptions(
                        KeyId = "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
                    }
                ),
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    LoggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

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

CurrentFormMaster

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

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

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

JSONファイルの形式についてはドキュメントを参照ください。

型必須デフォルト値の制限説明
namespaceNamestring✓~ 128文字ネームスペース名
settingsstring✓~ 5242880文字マスターデータ

GetAttr

型説明
ItemCurrentFormMaster更新した現在有効なフォーム設定

実装例

Type: GS2::Formation::CurrentFormMaster
Properties:
  NamespaceName: namespace1
  Settings: {
    "version": "2019-09-09",
    "moldModels": [
      {
        "name": "party",
        "initialMaxCapacity": 10,
        "maxCapacity": 20,
        "formModel":
          {
            "name": "party",
            "metadata": "PARTY",
            "slots": [
              {
                "name": "tank",
                "metadata": "TANK",
                "propertyRegex": "grn:.*"
              },
              {
                "name": "healer",
                "metadata": "HEALER",
                "propertyRegex": "grn:.*"
              },
              {
                "name": "dps_1",
                "metadata": "DPS",
                "propertyRegex": "grn:.*"
              },
              {
                "name": "dps_2",
                "metadata": "DPS",
                "propertyRegex": "grn:.*"
              }
            ]
          },
        "metadata": "PARTY"
      },
      {
        "name": "equipment",
        "initialMaxCapacity": 20,
        "maxCapacity": 30,
        "formModel":
          {
            "name": "equipment",
            "metadata": "EQUIPMENT",
            "slots": [
              {
                "name": "head",
                "metadata": "HEAD",
                "propertyRegex": "grn:.*"
              },
              {
                "name": "body",
                "metadata": "BODY",
                "propertyRegex": "grn:.*"
              },
              {
                "name": "leg",
                "metadata": "LEG",
                "propertyRegex": "grn:.*"
              }
            ]
          },
        "metadata": "EQUIPMENT"
      }
    ],
    "propertyFormModels": 
    
  }
from gs2_cdk import Stack, core, formation

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        formation.Namespace(
            stack=self,
            # 省略
        ).master_data(
            mold_models=[
                formation.MoldModel(
                    name='party',
                    initial_max_capacity=10,
                    max_capacity=20,
                    form_model=formation.FormModel(
                            name='party',
                            metadata='PARTY',
                            slots=[
                                formation.SlotModel(
                                    name='tank',
                                    metadata='TANK',
                                    property_regex='grn:.*'
                                ),
                                formation.SlotModel(
                                    name='healer',
                                    metadata='HEALER',
                                    property_regex='grn:.*'
                                ),
                                formation.SlotModel(
                                    name='dps_1',
                                    metadata='DPS',
                                    property_regex='grn:.*'
                                ),
                                formation.SlotModel(
                                    name='dps_2',
                                    metadata='DPS',
                                    property_regex='grn:.*'
                                )
                            ]
                        ),
                    options=formation.MoldModelOptions(
                        metadata='PARTY',
                    ),
                ),
                formation.MoldModel(
                    name='equipment',
                    initial_max_capacity=20,
                    max_capacity=30,
                    form_model=formation.FormModel(
                            name='equipment',
                            metadata='EQUIPMENT',
                            slots=[
                                formation.SlotModel(
                                    name='head',
                                    metadata='HEAD',
                                    property_regex='grn:.*'
                                ),
                                formation.SlotModel(
                                    name='body',
                                    metadata='BODY',
                                    property_regex='grn:.*'
                                ),
                                formation.SlotModel(
                                    name='leg',
                                    metadata='LEG',
                                    property_regex='grn:.*'
                                )
                            ]
                        ),
                    options=formation.MoldModelOptions(
                        metadata='EQUIPMENT',
                    ),
                ),
            ],
            property_form_models=[
            ],
        )

print(SampleStack().yaml())  # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Formation\Model\Namespace_(
            stack: $this,
            // 省略
        ))->masterData(
            [
                new \Gs2Cdk\Formation\Model\MoldModel(
                    name:"party",
                    initialMaxCapacity:10,
                    maxCapacity:20,
                    formModel:new \Gs2Cdk\Formation\Model\FormModel(
                        name: "party",
                        metadata: "PARTY",
                        slots: [
                            new \Gs2Cdk\Formation\Model\SlotModel(
                                name: "tank",
                                metadata: "TANK",
                                propertyRegex: "grn:.*"
                            ),
                            new \Gs2Cdk\Formation\Model\SlotModel(
                                name: "healer",
                                metadata: "HEALER",
                                propertyRegex: "grn:.*"
                            ),
                            new \Gs2Cdk\Formation\Model\SlotModel(
                                name: "dps_1",
                                metadata: "DPS",
                                propertyRegex: "grn:.*"
                            ),
                            new \Gs2Cdk\Formation\Model\SlotModel(
                                name: "dps_2",
                                metadata: "DPS",
                                propertyRegex: "grn:.*"
                            )
                        ]
                    ),
                    options: new \Gs2Cdk\Formation\Model\Options\MoldModelOptions(
                        metadata:"PARTY"
                    )
                ),
                new \Gs2Cdk\Formation\Model\MoldModel(
                    name:"equipment",
                    initialMaxCapacity:20,
                    maxCapacity:30,
                    formModel:new \Gs2Cdk\Formation\Model\FormModel(
                        name: "equipment",
                        metadata: "EQUIPMENT",
                        slots: [
                            new \Gs2Cdk\Formation\Model\SlotModel(
                                name: "head",
                                metadata: "HEAD",
                                propertyRegex: "grn:.*"
                            ),
                            new \Gs2Cdk\Formation\Model\SlotModel(
                                name: "body",
                                metadata: "BODY",
                                propertyRegex: "grn:.*"
                            ),
                            new \Gs2Cdk\Formation\Model\SlotModel(
                                name: "leg",
                                metadata: "LEG",
                                propertyRegex: "grn:.*"
                            )
                        ]
                    ),
                    options: new \Gs2Cdk\Formation\Model\Options\MoldModelOptions(
                        metadata:"EQUIPMENT"
                    )
                )
            ],
            [
            ]
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.formation.model.Namespace(
            this,
            // 省略
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.formation.model.MoldModel(
                    "party",
                    10,
                    20,
                    new io.gs2.cdk.formation.model.FormModel(
                        "party",
                        "PARTY",
                        Arrays.asList(
                            new io.gs2.cdk.formation.model.SlotModel(
                                "tank",
                                "TANK",
                                "grn:.*"
                            ),
                            new io.gs2.cdk.formation.model.SlotModel(
                                "healer",
                                "HEALER",
                                "grn:.*"
                            ),
                            new io.gs2.cdk.formation.model.SlotModel(
                                "dps_1",
                                "DPS",
                                "grn:.*"
                            ),
                            new io.gs2.cdk.formation.model.SlotModel(
                                "dps_2",
                                "DPS",
                                "grn:.*"
                            )
                        )
                    ),
                    new io.gs2.cdk.formation.model.options.MoldModelOptions() {
                        {
                            metadata: "PARTY";
                        }
                    }
                ),
                new io.gs2.cdk.formation.model.MoldModel(
                    "equipment",
                    20,
                    30,
                    new io.gs2.cdk.formation.model.FormModel(
                        "equipment",
                        "EQUIPMENT",
                        Arrays.asList(
                            new io.gs2.cdk.formation.model.SlotModel(
                                "head",
                                "HEAD",
                                "grn:.*"
                            ),
                            new io.gs2.cdk.formation.model.SlotModel(
                                "body",
                                "BODY",
                                "grn:.*"
                            ),
                            new io.gs2.cdk.formation.model.SlotModel(
                                "leg",
                                "LEG",
                                "grn:.*"
                            )
                        )
                    ),
                    new io.gs2.cdk.formation.model.options.MoldModelOptions() {
                        {
                            metadata: "EQUIPMENT";
                        }
                    }
                )
            ),
            Arrays.asList(
            )
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
import core from "@/gs2cdk/core";
import formation from "@/gs2cdk/formation";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new formation.model.Namespace(
            this,
            // 省略
        ).masterData(
            [
                new formation.model.MoldModel(
                    "party",
                    10,
                    20,
                    new formation.model.FormModel(
                        "party",
                        "PARTY",
                        new SlotModel[
                            new formation.model.SlotModel(
                                "tank",
                                "TANK",
                                "grn:.*"
                            ),
                            new formation.model.SlotModel(
                                "healer",
                                "HEALER",
                                "grn:.*"
                            ),
                            new formation.model.SlotModel(
                                "dps_1",
                                "DPS",
                                "grn:.*"
                            ),
                            new formation.model.SlotModel(
                                "dps_2",
                                "DPS",
                                "grn:.*"
                            )
                        ]
                    ),
                    {
                        metadata: "PARTY"
                    }
                ),
                new formation.model.MoldModel(
                    "equipment",
                    20,
                    30,
                    new formation.model.FormModel(
                        "equipment",
                        "EQUIPMENT",
                        new SlotModel[
                            new formation.model.SlotModel(
                                "head",
                                "HEAD",
                                "grn:.*"
                            ),
                            new formation.model.SlotModel(
                                "body",
                                "BODY",
                                "grn:.*"
                            ),
                            new formation.model.SlotModel(
                                "leg",
                                "LEG",
                                "grn:.*"
                            )
                        ]
                    ),
                    {
                        metadata: "EQUIPMENT"
                    }
                )
            ],
            [
            ]
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Formation.Model.Namespace(
            this,
            // 省略
        ).MasterData(
            new [] {
                new Gs2Cdk.Gs2Formation.Model.MoldModel(
                    "party",
                    10,
                    20,
                    new Gs2Cdk.Gs2Formation.Model.FormModel(
                        name: "party",
                        metadata: "PARTY",
                        slots: new Gs2Cdk.Gs2Formation.Model.SlotModel[] {
                            new Gs2Cdk.Gs2Formation.Model.SlotModel(
                                name: "tank",
                                metadata: "TANK",
                                propertyRegex: "grn:.*"
                            ),
                            new Gs2Cdk.Gs2Formation.Model.SlotModel(
                                name: "healer",
                                metadata: "HEALER",
                                propertyRegex: "grn:.*"
                            ),
                            new Gs2Cdk.Gs2Formation.Model.SlotModel(
                                name: "dps_1",
                                metadata: "DPS",
                                propertyRegex: "grn:.*"
                            ),
                            new Gs2Cdk.Gs2Formation.Model.SlotModel(
                                name: "dps_2",
                                metadata: "DPS",
                                propertyRegex: "grn:.*"
                            )
                        }
                    ),
                    new Gs2Cdk.Gs2Formation.Model.Options.MoldModelOptions {
                        metadata = "PARTY"
                    }
                ),
                new Gs2Cdk.Gs2Formation.Model.MoldModel(
                    "equipment",
                    20,
                    30,
                    new Gs2Cdk.Gs2Formation.Model.FormModel(
                        name: "equipment",
                        metadata: "EQUIPMENT",
                        slots: new Gs2Cdk.Gs2Formation.Model.SlotModel[] {
                            new Gs2Cdk.Gs2Formation.Model.SlotModel(
                                name: "head",
                                metadata: "HEAD",
                                propertyRegex: "grn:.*"
                            ),
                            new Gs2Cdk.Gs2Formation.Model.SlotModel(
                                name: "body",
                                metadata: "BODY",
                                propertyRegex: "grn:.*"
                            ),
                            new Gs2Cdk.Gs2Formation.Model.SlotModel(
                                name: "leg",
                                metadata: "LEG",
                                propertyRegex: "grn:.*"
                            )
                        }
                    ),
                    new Gs2Cdk.Gs2Formation.Model.Options.MoldModelOptions {
                        metadata = "EQUIPMENT"
                    }
                )
            },
            new [] {
            }
        );
    }
}

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

Slot

スロット

型必須デフォルト値の制限説明
namestring✓~ 128文字スロットモデル名
propertyIdstring~ 1024文字プロパティID
metadatastring~ 1024文字メタデータ

SlotModel

スロットモデル

型必須デフォルト値の制限説明
namestring✓~ 128文字スロットモデル名
propertyRegexstring✓“.*”~ 512文字プロパティとして設定可能な値の正規表現
metadatastring~ 512文字メタデータ

SlotWithSignature

署名付きスロット

型必須デフォルト値の制限説明
namestring✓~ 128文字スロットモデル名
propertyTypeenum [
“gs2_inventory”,
“gs2_simple_inventory”,
“gs2_dictionary”
]
✓~ 128文字プロパティの種類
bodystring~ 1048576文字ペイロード
signaturestring~ 1024文字プロパティIDのリソースを所有していることを証明する署名
metadatastring~ 1024文字メタデータ

AcquireAction

入手アクション

型必須デフォルト値の制限説明
actionenum [
"Gs2AdReward:AcquirePointByUserId",
"Gs2Dictionary:AddEntriesByUserId",
"Gs2Enchant:ReDrawBalanceParameterStatusByUserId",
"Gs2Enchant:SetBalanceParameterStatusByUserId",
"Gs2Enchant:ReDrawRarityParameterStatusByUserId",
"Gs2Enchant:AddRarityParameterStatusByUserId",
"Gs2Enchant:SetRarityParameterStatusByUserId",
"Gs2Enhance:DirectEnhanceByUserId",
"Gs2Enhance:UnleashByUserId",
"Gs2Enhance:CreateProgressByUserId",
"Gs2Exchange:ExchangeByUserId",
"Gs2Exchange:IncrementalExchangeByUserId",
"Gs2Exchange:UnlockIncrementalExchangeByUserId",
"Gs2Exchange:CreateAwaitByUserId",
"Gs2Exchange:SkipByUserId",
"Gs2Experience:AddExperienceByUserId",
"Gs2Experience:SetExperienceByUserId",
"Gs2Experience:AddRankCapByUserId",
"Gs2Experience:SetRankCapByUserId",
"Gs2Experience:MultiplyAcquireActionsByUserId",
"Gs2Formation:AddMoldCapacityByUserId",
"Gs2Formation:SetMoldCapacityByUserId",
"Gs2Formation:AcquireActionsToFormProperties",
"Gs2Formation:SetFormByUserId",
"Gs2Formation:AcquireActionsToPropertyFormProperties",
"Gs2Grade:AddGradeByUserId",
"Gs2Grade:ApplyRankCapByUserId",
"Gs2Grade:MultiplyAcquireActionsByUserId",
"Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Idle:IncreaseMaximumIdleMinutesByUserId",
"Gs2Idle:SetMaximumIdleMinutesByUserId",
"Gs2Idle:ReceiveByUserId",
"Gs2Inbox:SendMessageByUserId",
"Gs2Inventory:AddCapacityByUserId",
"Gs2Inventory:SetCapacityByUserId",
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetWithGradeByUserId",
"Gs2Inventory:AddReferenceOfByUserId",
"Gs2Inventory:DeleteReferenceOfByUserId",
"Gs2Inventory:AcquireSimpleItemsByUserId",
"Gs2Inventory:SetSimpleItemsByUserId",
"Gs2Inventory:AcquireBigItemByUserId",
"Gs2Inventory:SetBigItemByUserId",
"Gs2JobQueue:PushByUserId",
"Gs2Limit:CountDownByUserId",
"Gs2Limit:DeleteCounterByUserId",
"Gs2LoginReward:DeleteReceiveStatusByUserId",
"Gs2LoginReward:UnmarkReceivedByUserId",
"Gs2Lottery:DrawByUserId",
"Gs2Lottery:ResetBoxByUserId",
"Gs2Mission:RevertReceiveByUserId",
"Gs2Mission:IncreaseCounterByUserId",
"Gs2Mission:SetCounterByUserId",
"Gs2Money:DepositByUserId",
"Gs2Money:RevertRecordReceipt",
"Gs2Money2:DepositByUserId",
"Gs2Quest:CreateProgressByUserId",
"Gs2Schedule:TriggerByUserId",
"Gs2SerialKey:RevertUseByUserId",
"Gs2Showcase:DecrementPurchaseCountByUserId",
"Gs2Showcase:ForceReDrawByUserId",
"Gs2SkillTree:MarkReleaseByUserId",
"Gs2Stamina:RecoverStaminaByUserId",
"Gs2Stamina:RaiseMaxValueByUserId",
"Gs2Stamina:SetMaxValueByUserId",
"Gs2Stamina:SetRecoverIntervalByUserId",
"Gs2Stamina:SetRecoverValueByUserId",
"Gs2StateMachine:StartStateMachineByUserId",
]
✓~ 128文字入手アクションで実行するアクションの種類
requeststring✓~ 1048576文字リクエストのJSON

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文字タグ名

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

LogSetting

ログの書き出し設定

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

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

TransactionSetting

トランザクション設定

型必須デフォルト値の制限説明
enableAutoRunbool✓false発行したスタンプシートをサーバーサイドで自動的に実行するか
distributorNamespaceIdstring✓“grn:gs2:{region}:{ownerId}:distributor:default”~ 1024文字スタンプシートの実行に使用する GS2-Distributor ネームスペース
queueNamespaceIdstring✓“grn:gs2:{region}:{ownerId}:queue:default”~ 1024文字スタンプシートの実行に使用する GS2-JobQueue のネームスペース