NAV
YAML TypeScript (CDK) Python (CDK) PHP (CDK) Java (CDK) C# (CDK)

GS2-Formation

Reference to resource definitions available in GS2-Deploy templates

GS2-Deploy Reference

Entities

Namespace

Namespace

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
  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(
                    enable_auto_run=False,
                    queue_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001',
                    options=core.TransactionSettingOptions(
                        distributor_namespace_id=,
                        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: False,
                    queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
                    options: new \Gs2Cdk\Core\Model\Options\TransactionSettingOptions(
                        distributorNamespaceId: ,
                        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(
                        false,
                        "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(
                        "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(
                    false,
                    "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"
                )
            }
        );
    }
}

System.out.println(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(
                    false,
                    "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
                    new Gs2Cdk.Core.Model.Options.TransactionSettingOptions(
                        DistributorNamespaceId = ,
                        KeyId = "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
                    }
                ),
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                ),
            }
        );
    }
}

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

Namespace

Namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project.
Basically, GS2 services have a layer called namespace, and different namespaces are treated as completely different data spaces, even for the same service.

Therefore, it is necessary to create a namespace before starting to use each service.

Type Require Default Limitation Description
name string ~ 32 chars Namespace name
description string ~ 1024 chars description of Namespace
transactionSetting TransactionSetting Transaction settings
updateMoldScript ScriptSetting Script to run when updating capacity
updateFormScript ScriptSetting Script to run when updating a form
logSetting LogSetting Log output settings

CurrentFormMaster

CurrentFormMaster

Type: GS2::Formation::CurrentFormMaster
Properties:
  NamespaceName: namespace1
  Settings: {
    "version": "2019-09-09",
    "moldModels": [
      {
        "name": "party",
        "metadata": "PARTY",
        "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:.*"
            }
          ]
        },
        "initialMaxCapacity": 10,
        "maxCapacity": 20
      },
      {
        "name": "equipment",
        "metadata": "EQUIPMENT",
        "formModel": {
          "name": "equipment",
          "metadata": "EQUIPMENT",
          "slots": [
            {
              "name": "head",
              "metadata": "HEAD",
              "propertyRegex": "grn:.*"
            },
            {
              "name": "body",
              "metadata": "BODY",
              "propertyRegex": "grn:.*"
            },
            {
              "name": "leg",
              "metadata": "LEG",
              "propertyRegex": "grn:.*"
            }
          ]
        },
        "initialMaxCapacity": 20,
        "maxCapacity": 30
      }
    ]
  }
from gs2_cdk import Stack, core, formation

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        formation.Namespace(
            stack=self,
            # omission
        ).master_data(
            [
                formation.MoldModel(
                    name='party',
                    initial_max_capacity=10,
                    max_capacity=20,
                    form_model={'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:.*'}]},
                    options=formation.MoldModelOptions(
                        metadata='PARTY',
                    ),
                ),
                formation.MoldModel(
                    name='equipment',
                    initial_max_capacity=20,
                    max_capacity=30,
                    form_model={'name': 'equipment', 'metadata': 'EQUIPMENT', 'slots': [{'name': 'head', 'metadata': 'HEAD', 'propertyRegex': 'grn:.*'}, {'name': 'body', 'metadata': 'BODY', 'propertyRegex': 'grn:.*'}, {'name': 'leg', 'metadata': 'LEG', 'propertyRegex': 'grn:.*'}]},
                    options=formation.MoldModelOptions(
                        metadata='EQUIPMENT',
                    ),
                ),
            ],
            [
            ],
        )

print(SampleStack().yaml())  # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Formation\Model\Namespace_(
            stack: $this,
            // omission
        ))->masterData(
            [
                new \Gs2Cdk\Formation\Model\MoldModel(
                    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:.*'}]},
                    options: new \Gs2Cdk\Formation\Model\Options\MoldModelOptions(
                        metadata:"PARTY",
                    ),
                ),
                new \Gs2Cdk\Formation\Model\MoldModel(
                    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:.*'}]},
                    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,
            // omission
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.formation.model.MoldModel(
                    "party",
                    10,
                    20,
                    {'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:.*'}]},
                    new io.gs2.cdk.formation.model.options.MoldModelOptions() {
                        {
                            metadata: "PARTY";
                        }
                    }
                ),
                new io.gs2.cdk.formation.model.MoldModel(
                    "equipment",
                    20,
                    30,
                    {'name': 'equipment', 'metadata': 'EQUIPMENT', 'slots': [{'name': 'head', 'metadata': 'HEAD', 'propertyRegex': 'grn:.*'}, {'name': 'body', 'metadata': 'BODY', 'propertyRegex': 'grn:.*'}, {'name': 'leg', 'metadata': 'LEG', 'propertyRegex': '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,
            // omission
        ).masterData(
            [
                new formation.model.MoldModel(
                    "party",
                    10,
                    20,
                    {'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"
                    }
                ),
                new formation.model.MoldModel(
                    "equipment",
                    20,
                    30,
                    {'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"
                    }
                )
            ],
            [
            ]
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Formation.Model.Namespace(
            this,
            // omission
        ).MasterData(
            new [] {
                new Gs2Cdk.Gs2Formation.Model.MoldModel(
                    "party",
                    10,
                    20,
                    {'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:.*'}]},
                    new Gs2Cdk.Gs2Formation.Model.Options.MoldModelOptions {
                        metadata = "PARTY",
                    }
                ),
                new Gs2Cdk.Gs2Formation.Model.MoldModel(
                    "equipment",
                    20,
                    30,
                    {'name': 'equipment', 'metadata': 'EQUIPMENT', 'slots': [{'name': 'head', 'metadata': 'HEAD', 'propertyRegex': 'grn:.*'}, {'name': 'body', 'metadata': 'BODY', 'propertyRegex': 'grn:.*'}, {'name': 'leg', 'metadata': 'LEG', 'propertyRegex': 'grn:.*'}]},
                    new Gs2Cdk.Gs2Formation.Model.Options.MoldModelOptions {
                        metadata = "EQUIPMENT",
                    }
                )
            },
            new [] {
            }
        );
    }
}

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

Currently available master data

GS2 uses JSON format files for master data management.
By uploading the file, you can actually reflect the settings on the server.

We provide a master data editor on the management console as a way to create JSON files, but you can also create JSON files using the
The service can also be used by creating a tool more appropriate for game management and exporting a JSON file in the appropriate format.

Please refer to the documentation for the format of the JSON file.

Type Require Default Limitation Description
namespaceName string ~ 32 chars Namespace name
settings string ~ 5242880 chars Master data