GS2-Deploy/CDK Reference of GS2-Enchant

Template format used to create GS2-Deploy stacks and examples of template output implementation in various languages using CDK

Entities

Namespace

Namespace

A namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space.

Therefore, you must create a namespace before you can start using each service.

TypeConditionRequiredDefaultValue LimitsDescription
namestring
~ 128 charsNamespace name
descriptionstring~ 1024 charsDescription
transactionSettingTransactionSetting
Transaction settings
logSettingLogSettingLog output settings

GetAttr

Generation results of resources that can be obtained with the !GetAttr tag

TypeDescription
ItemNamespaceNamespace created

Implementation Example

Type: GS2::Enchant::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSetting: 
    EnableAutoRun: true
    QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
  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/enchant"
    "github.com/openlyinc/pointy"
)

SampleStack := core.NewStack()
enchant.NewNamespace(
    &SampleStack,
    "namespace-0001",
    enchant.NamespaceOptions{
        TransactionSetting: core.NewTransactionSetting(
            core.TransactionSettingOptions{
                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\Enchant\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\Enchant\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.enchant.model.Namespace(
                this,
                "namespace-0001",
                new io.gs2.cdk.enchant.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.Gs2Enchant.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: new Gs2Cdk.Gs2Enchant.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 enchant from "@/gs2cdk/enchant";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new enchant.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, enchant

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        enchant.Namespace(
            stack=self,
            name='namespace-0001',
            options=enchant.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

CurrentParameterMaster

Currently active parameter master

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

To create JSON files, we provide a master data editor within the management console. Additionally, you can utilize the service by creating tools more suited to game operations and exporting JSON files in the appropriate format.

TypeConditionRequiredDefaultValue LimitsDescription
namespaceNamestring
~ 128 charsNamespace name
modeString Enum
enum {
  “direct”,
  “preUpload”
}
“direct”~ 128 charsUpdate mode
Enumerator String DefinitionDescription
“direct”Directly update the settings
“preUpload”Upload the settings and then update
settingsstring{mode} == “direct”
✓*
~ 5242880 charsMaster Data
* Required if mode is “direct”
uploadTokenstring{mode} == “preUpload”
✓*
~ 1024 charsToken used to reflect results after upload
* Required if mode is “preUpload”

GetAttr

Generation results of resources that can be obtained with the !GetAttr tag

TypeDescription
ItemCurrentParameterMasterUpdated and currently available parameter settings

Implementation Example

Type: GS2::Enchant::CurrentParameterMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  Settings: {
    "version": "2023-07-18",
    "balanceParameterModels": [
      {
        "name": "balance-0001",
        "totalValue": 100,
        "initialValueStrategy": "average",
        "parameters": [
          {
            "name": "parameter-0001",
            "metadata": "PARAMETER_0001"
          },
          {
            "name": "parameter-0002",
            "metadata": "PARAMETER_0002"
          },
          {
            "name": "parameter-0003",
            "metadata": "PARAMETER_0003"
          }
        ],
        "metadata": "BALANCE_0001"
      },
      {
        "name": "balance-0002",
        "totalValue": 200,
        "initialValueStrategy": "lottery",
        "parameters": [
          {
            "name": "parameter-0001",
            "metadata": "PARAMETER_0001"
          },
          {
            "name": "parameter-0002",
            "metadata": "PARAMETER_0002"
          },
          {
            "name": "parameter-0003",
            "metadata": "PARAMETER_0003"
          },
          {
            "name": "parameter-0004",
            "metadata": "PARAMETER_0004"
          }
        ],
        "metadata": "BALANCE_0002"
      },
      {
        "name": "balance-0003",
        "totalValue": 500,
        "initialValueStrategy": "average",
        "parameters": [
          {
            "name": "parameter-0001",
            "metadata": "PARAMETER_0001"
          },
          {
            "name": "parameter-0002",
            "metadata": "PARAMETER_0002"
          }
        ],
        "metadata": "BALANCE_0003"
      }
    ],
    "rarityParameterModels": [
      {
        "name": "rarity-0001",
        "maximumParameterCount": 5,
        "parameterCounts": [
          {
            "count": 0,
            "weight": 1
          },
          {
            "count": 1,
            "weight": 2
          },
          {
            "count": 2,
            "weight": 3
          }
        ],
        "parameters": [
          {
            "name": "parameter-0001",
            "metadata": "PARAMETER_0001",
            "resourceName": "resource-0001",
            "resourceValue": 10,
            "weight": 1
          },
          {
            "name": "parameter-0002",
            "metadata": "PARAMETER_0002",
            "resourceName": "resource-0002",
            "resourceValue": 20,
            "weight": 2
          },
          {
            "name": "parameter-0003",
            "metadata": "PARAMETER_0003",
            "resourceName": "resource-0003",
            "resourceValue": 30,
            "weight": 3
          }
        ],
        "metadata": "RARITY_0001"
      },
      {
        "name": "rarity-0002",
        "maximumParameterCount": 10,
        "parameterCounts": [
          {
            "count": 1,
            "weight": 10
          },
          {
            "count": 2,
            "weight": 20
          },
          {
            "count": 3,
            "weight": 30
          }
        ],
        "parameters": [
          {
            "name": "parameter-1001",
            "metadata": "PARAMETER_1001",
            "resourceName": "resource-1001",
            "resourceValue": 100,
            "weight": 10
          },
          {
            "name": "parameter-1002",
            "metadata": "PARAMETER_1002",
            "resourceName": "resource-1002",
            "resourceValue": 200,
            "weight": 20
          },
          {
            "name": "parameter-1003",
            "metadata": "PARAMETER_1003",
            "resourceName": "resource-1003",
            "resourceValue": 300,
            "weight": 30
          }
        ],
        "metadata": "RARITY_0002"
      },
      {
        "name": "rarity-0003",
        "maximumParameterCount": 3,
        "parameterCounts": [
          {
            "count": 2,
            "weight": 5
          },
          {
            "count": 3,
            "weight": 10
          },
          {
            "count": 4,
            "weight": 15
          }
        ],
        "parameters": [
          {
            "name": "parameter-2001",
            "metadata": "PARAMETER_2001",
            "resourceName": "resource-2001",
            "resourceValue": 1000,
            "weight": 2
          },
          {
            "name": "parameter-2002",
            "metadata": "PARAMETER_2002",
            "resourceName": "resource-2002",
            "resourceValue": 2000,
            "weight": 4
          },
          {
            "name": "parameter-2003",
            "metadata": "PARAMETER_2003",
            "resourceName": "resource-2003",
            "resourceValue": 3000,
            "weight": 6
          },
          {
            "name": "parameter-0004",
            "metadata": "PARAMETER_0004",
            "resourceName": "resource-2004",
            "resourceValue": 4000,
            "weight": 8
          }
        ],
        "metadata": "RARITY_0003"
      }
    ]
  }
  UploadToken: null
import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/enchant"
    "github.com/openlyinc/pointy"
)

SampleStack := core.NewStack()
enchant.NewNamespace(
    &SampleStack,
    "namespace-0001",
    enchant.NamespaceOptions{},
).MasterData(
    []enchant.BalanceParameterModel{
        enchant.NewBalanceParameterModel(
            "balance-0001",
            100,
            enchant.BalanceParameterModelInitialValueStrategyAverage,
            []enchant.BalanceParameterValueModel{
                enchant.NewBalanceParameterValueModel(
                    "parameter-0001",
                    enchant.BalanceParameterValueModelOptions{
                        Metadata: pointy.String("PARAMETER_0001"),
                    },
                ),
                enchant.NewBalanceParameterValueModel(
                    "parameter-0002",
                    enchant.BalanceParameterValueModelOptions{
                        Metadata: pointy.String("PARAMETER_0002"),
                    },
                ),
                enchant.NewBalanceParameterValueModel(
                    "parameter-0003",
                    enchant.BalanceParameterValueModelOptions{
                        Metadata: pointy.String("PARAMETER_0003"),
                    },
                ),
            },
            enchant.BalanceParameterModelOptions{
                Metadata: pointy.String("BALANCE_0001"),
            },
        ),
        enchant.NewBalanceParameterModel(
            "balance-0002",
            200,
            enchant.BalanceParameterModelInitialValueStrategyLottery,
            []enchant.BalanceParameterValueModel{
                enchant.NewBalanceParameterValueModel(
                    "parameter-0001",
                    enchant.BalanceParameterValueModelOptions{
                        Metadata: pointy.String("PARAMETER_0001"),
                    },
                ),
                enchant.NewBalanceParameterValueModel(
                    "parameter-0002",
                    enchant.BalanceParameterValueModelOptions{
                        Metadata: pointy.String("PARAMETER_0002"),
                    },
                ),
                enchant.NewBalanceParameterValueModel(
                    "parameter-0003",
                    enchant.BalanceParameterValueModelOptions{
                        Metadata: pointy.String("PARAMETER_0003"),
                    },
                ),
                enchant.NewBalanceParameterValueModel(
                    "parameter-0004",
                    enchant.BalanceParameterValueModelOptions{
                        Metadata: pointy.String("PARAMETER_0004"),
                    },
                ),
            },
            enchant.BalanceParameterModelOptions{
                Metadata: pointy.String("BALANCE_0002"),
            },
        ),
        enchant.NewBalanceParameterModel(
            "balance-0003",
            500,
            enchant.BalanceParameterModelInitialValueStrategyAverage,
            []enchant.BalanceParameterValueModel{
                enchant.NewBalanceParameterValueModel(
                    "parameter-0001",
                    enchant.BalanceParameterValueModelOptions{
                        Metadata: pointy.String("PARAMETER_0001"),
                    },
                ),
                enchant.NewBalanceParameterValueModel(
                    "parameter-0002",
                    enchant.BalanceParameterValueModelOptions{
                        Metadata: pointy.String("PARAMETER_0002"),
                    },
                ),
            },
            enchant.BalanceParameterModelOptions{
                Metadata: pointy.String("BALANCE_0003"),
            },
        ),
    },
    []enchant.RarityParameterModel{
        enchant.NewRarityParameterModel(
            "rarity-0001",
            5,
            []enchant.RarityParameterCountModel{
                enchant.NewRarityParameterCountModel(
                    0,
                    1,
                    enchant.RarityParameterCountModelOptions{},
                ),
                enchant.NewRarityParameterCountModel(
                    1,
                    2,
                    enchant.RarityParameterCountModelOptions{},
                ),
                enchant.NewRarityParameterCountModel(
                    2,
                    3,
                    enchant.RarityParameterCountModelOptions{},
                ),
            },
            []enchant.RarityParameterValueModel{
                enchant.NewRarityParameterValueModel(
                    "parameter-0001",
                    "resource-0001",
                    10,
                    1,
                    enchant.RarityParameterValueModelOptions{
                        Metadata: pointy.String("PARAMETER_0001"),
                    },
                ),
                enchant.NewRarityParameterValueModel(
                    "parameter-0002",
                    "resource-0002",
                    20,
                    2,
                    enchant.RarityParameterValueModelOptions{
                        Metadata: pointy.String("PARAMETER_0002"),
                    },
                ),
                enchant.NewRarityParameterValueModel(
                    "parameter-0003",
                    "resource-0003",
                    30,
                    3,
                    enchant.RarityParameterValueModelOptions{
                        Metadata: pointy.String("PARAMETER_0003"),
                    },
                ),
            },
            enchant.RarityParameterModelOptions{
                Metadata: pointy.String("RARITY_0001"),
            },
        ),
        enchant.NewRarityParameterModel(
            "rarity-0002",
            10,
            []enchant.RarityParameterCountModel{
                enchant.NewRarityParameterCountModel(
                    1,
                    10,
                    enchant.RarityParameterCountModelOptions{},
                ),
                enchant.NewRarityParameterCountModel(
                    2,
                    20,
                    enchant.RarityParameterCountModelOptions{},
                ),
                enchant.NewRarityParameterCountModel(
                    3,
                    30,
                    enchant.RarityParameterCountModelOptions{},
                ),
            },
            []enchant.RarityParameterValueModel{
                enchant.NewRarityParameterValueModel(
                    "parameter-1001",
                    "resource-1001",
                    100,
                    10,
                    enchant.RarityParameterValueModelOptions{
                        Metadata: pointy.String("PARAMETER_1001"),
                    },
                ),
                enchant.NewRarityParameterValueModel(
                    "parameter-1002",
                    "resource-1002",
                    200,
                    20,
                    enchant.RarityParameterValueModelOptions{
                        Metadata: pointy.String("PARAMETER_1002"),
                    },
                ),
                enchant.NewRarityParameterValueModel(
                    "parameter-1003",
                    "resource-1003",
                    300,
                    30,
                    enchant.RarityParameterValueModelOptions{
                        Metadata: pointy.String("PARAMETER_1003"),
                    },
                ),
            },
            enchant.RarityParameterModelOptions{
                Metadata: pointy.String("RARITY_0002"),
            },
        ),
        enchant.NewRarityParameterModel(
            "rarity-0003",
            3,
            []enchant.RarityParameterCountModel{
                enchant.NewRarityParameterCountModel(
                    2,
                    5,
                    enchant.RarityParameterCountModelOptions{},
                ),
                enchant.NewRarityParameterCountModel(
                    3,
                    10,
                    enchant.RarityParameterCountModelOptions{},
                ),
                enchant.NewRarityParameterCountModel(
                    4,
                    15,
                    enchant.RarityParameterCountModelOptions{},
                ),
            },
            []enchant.RarityParameterValueModel{
                enchant.NewRarityParameterValueModel(
                    "parameter-2001",
                    "resource-2001",
                    1000,
                    2,
                    enchant.RarityParameterValueModelOptions{
                        Metadata: pointy.String("PARAMETER_2001"),
                    },
                ),
                enchant.NewRarityParameterValueModel(
                    "parameter-2002",
                    "resource-2002",
                    2000,
                    4,
                    enchant.RarityParameterValueModelOptions{
                        Metadata: pointy.String("PARAMETER_2002"),
                    },
                ),
                enchant.NewRarityParameterValueModel(
                    "parameter-2003",
                    "resource-2003",
                    3000,
                    6,
                    enchant.RarityParameterValueModelOptions{
                        Metadata: pointy.String("PARAMETER_2003"),
                    },
                ),
                enchant.NewRarityParameterValueModel(
                    "parameter-0004",
                    "resource-2004",
                    4000,
                    8,
                    enchant.RarityParameterValueModelOptions{
                        Metadata: pointy.String("PARAMETER_0004"),
                    },
                ),
            },
            enchant.RarityParameterModelOptions{
                Metadata: pointy.String("RARITY_0003"),
            },
        ),
    },
)

println(SampleStack.Yaml())  // Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Enchant\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
                new \Gs2Cdk\Enchant\Model\BalanceParameterModel(
                    name:"balance-0001",
                    totalValue:100,
                    initialValueStrategy: \Gs2Cdk\Enchant\Model\Enums\BalanceParameterModelInitialValueStrategy::AVERAGE,
                    parameters:[
                        new \Gs2Cdk\Enchant\Model\BalanceParameterValueModel(
                            name: "parameter-0001",
                            options: new \Gs2Cdk\Enchant\Model\Options\BalanceParameterValueModelOptions(
                                metadata: "PARAMETER_0001",
                            )
                        ),
                        new \Gs2Cdk\Enchant\Model\BalanceParameterValueModel(
                            name: "parameter-0002",
                            options: new \Gs2Cdk\Enchant\Model\Options\BalanceParameterValueModelOptions(
                                metadata: "PARAMETER_0002",
                            )
                        ),
                        new \Gs2Cdk\Enchant\Model\BalanceParameterValueModel(
                            name: "parameter-0003",
                            options: new \Gs2Cdk\Enchant\Model\Options\BalanceParameterValueModelOptions(
                                metadata: "PARAMETER_0003",
                            )
                        ),
                    ],
                    options: new \Gs2Cdk\Enchant\Model\Options\BalanceParameterModelOptions(
                        metadata:"BALANCE_0001"
                    )
                ),
                new \Gs2Cdk\Enchant\Model\BalanceParameterModel(
                    name:"balance-0002",
                    totalValue:200,
                    initialValueStrategy: \Gs2Cdk\Enchant\Model\Enums\BalanceParameterModelInitialValueStrategy::LOTTERY,
                    parameters:[
                        new \Gs2Cdk\Enchant\Model\BalanceParameterValueModel(
                            name: "parameter-0001",
                            options: new \Gs2Cdk\Enchant\Model\Options\BalanceParameterValueModelOptions(
                                metadata: "PARAMETER_0001",
                            )
                        ),
                        new \Gs2Cdk\Enchant\Model\BalanceParameterValueModel(
                            name: "parameter-0002",
                            options: new \Gs2Cdk\Enchant\Model\Options\BalanceParameterValueModelOptions(
                                metadata: "PARAMETER_0002",
                            )
                        ),
                        new \Gs2Cdk\Enchant\Model\BalanceParameterValueModel(
                            name: "parameter-0003",
                            options: new \Gs2Cdk\Enchant\Model\Options\BalanceParameterValueModelOptions(
                                metadata: "PARAMETER_0003",
                            )
                        ),
                        new \Gs2Cdk\Enchant\Model\BalanceParameterValueModel(
                            name: "parameter-0004",
                            options: new \Gs2Cdk\Enchant\Model\Options\BalanceParameterValueModelOptions(
                                metadata: "PARAMETER_0004",
                            )
                        ),
                    ],
                    options: new \Gs2Cdk\Enchant\Model\Options\BalanceParameterModelOptions(
                        metadata:"BALANCE_0002"
                    )
                ),
                new \Gs2Cdk\Enchant\Model\BalanceParameterModel(
                    name:"balance-0003",
                    totalValue:500,
                    initialValueStrategy: \Gs2Cdk\Enchant\Model\Enums\BalanceParameterModelInitialValueStrategy::AVERAGE,
                    parameters:[
                        new \Gs2Cdk\Enchant\Model\BalanceParameterValueModel(
                            name: "parameter-0001",
                            options: new \Gs2Cdk\Enchant\Model\Options\BalanceParameterValueModelOptions(
                                metadata: "PARAMETER_0001",
                            )
                        ),
                        new \Gs2Cdk\Enchant\Model\BalanceParameterValueModel(
                            name: "parameter-0002",
                            options: new \Gs2Cdk\Enchant\Model\Options\BalanceParameterValueModelOptions(
                                metadata: "PARAMETER_0002",
                            )
                        ),
                    ],
                    options: new \Gs2Cdk\Enchant\Model\Options\BalanceParameterModelOptions(
                        metadata:"BALANCE_0003"
                    )
                )
            ],
            [
                new \Gs2Cdk\Enchant\Model\RarityParameterModel(
                    name:"rarity-0001",
                    maximumParameterCount:5,
                    parameterCounts:[
                        new \Gs2Cdk\Enchant\Model\RarityParameterCountModel(
                            count: 0,
                            weight: 1,    
                        ),
                        new \Gs2Cdk\Enchant\Model\RarityParameterCountModel(
                            count: 1,
                            weight: 2,    
                        ),
                        new \Gs2Cdk\Enchant\Model\RarityParameterCountModel(
                            count: 2,
                            weight: 3,    
                        ),
                    ],
                    parameters:[
                        new \Gs2Cdk\Enchant\Model\RarityParameterValueModel(
                            name: "parameter-0001",
                            resourceName: "resource-0001",
                            resourceValue: 10,
                            weight: 1,
                            options: new \Gs2Cdk\Enchant\Model\Options\RarityParameterValueModelOptions(
                                metadata: "PARAMETER_0001",
                            )
                        ),
                        new \Gs2Cdk\Enchant\Model\RarityParameterValueModel(
                            name: "parameter-0002",
                            resourceName: "resource-0002",
                            resourceValue: 20,
                            weight: 2,
                            options: new \Gs2Cdk\Enchant\Model\Options\RarityParameterValueModelOptions(
                                metadata: "PARAMETER_0002",
                            )
                        ),
                        new \Gs2Cdk\Enchant\Model\RarityParameterValueModel(
                            name: "parameter-0003",
                            resourceName: "resource-0003",
                            resourceValue: 30,
                            weight: 3,
                            options: new \Gs2Cdk\Enchant\Model\Options\RarityParameterValueModelOptions(
                                metadata: "PARAMETER_0003",
                            )
                        ),
                    ],
                    options: new \Gs2Cdk\Enchant\Model\Options\RarityParameterModelOptions(
                        metadata:"RARITY_0001"
                    )
                ),
                new \Gs2Cdk\Enchant\Model\RarityParameterModel(
                    name:"rarity-0002",
                    maximumParameterCount:10,
                    parameterCounts:[
                        new \Gs2Cdk\Enchant\Model\RarityParameterCountModel(
                            count: 1,
                            weight: 10,    
                        ),
                        new \Gs2Cdk\Enchant\Model\RarityParameterCountModel(
                            count: 2,
                            weight: 20,    
                        ),
                        new \Gs2Cdk\Enchant\Model\RarityParameterCountModel(
                            count: 3,
                            weight: 30,    
                        ),
                    ],
                    parameters:[
                        new \Gs2Cdk\Enchant\Model\RarityParameterValueModel(
                            name: "parameter-1001",
                            resourceName: "resource-1001",
                            resourceValue: 100,
                            weight: 10,
                            options: new \Gs2Cdk\Enchant\Model\Options\RarityParameterValueModelOptions(
                                metadata: "PARAMETER_1001",
                            )
                        ),
                        new \Gs2Cdk\Enchant\Model\RarityParameterValueModel(
                            name: "parameter-1002",
                            resourceName: "resource-1002",
                            resourceValue: 200,
                            weight: 20,
                            options: new \Gs2Cdk\Enchant\Model\Options\RarityParameterValueModelOptions(
                                metadata: "PARAMETER_1002",
                            )
                        ),
                        new \Gs2Cdk\Enchant\Model\RarityParameterValueModel(
                            name: "parameter-1003",
                            resourceName: "resource-1003",
                            resourceValue: 300,
                            weight: 30,
                            options: new \Gs2Cdk\Enchant\Model\Options\RarityParameterValueModelOptions(
                                metadata: "PARAMETER_1003",
                            )
                        ),
                    ],
                    options: new \Gs2Cdk\Enchant\Model\Options\RarityParameterModelOptions(
                        metadata:"RARITY_0002"
                    )
                ),
                new \Gs2Cdk\Enchant\Model\RarityParameterModel(
                    name:"rarity-0003",
                    maximumParameterCount:3,
                    parameterCounts:[
                        new \Gs2Cdk\Enchant\Model\RarityParameterCountModel(
                            count: 2,
                            weight: 5,    
                        ),
                        new \Gs2Cdk\Enchant\Model\RarityParameterCountModel(
                            count: 3,
                            weight: 10,    
                        ),
                        new \Gs2Cdk\Enchant\Model\RarityParameterCountModel(
                            count: 4,
                            weight: 15,    
                        ),
                    ],
                    parameters:[
                        new \Gs2Cdk\Enchant\Model\RarityParameterValueModel(
                            name: "parameter-2001",
                            resourceName: "resource-2001",
                            resourceValue: 1000,
                            weight: 2,
                            options: new \Gs2Cdk\Enchant\Model\Options\RarityParameterValueModelOptions(
                                metadata: "PARAMETER_2001",
                            )
                        ),
                        new \Gs2Cdk\Enchant\Model\RarityParameterValueModel(
                            name: "parameter-2002",
                            resourceName: "resource-2002",
                            resourceValue: 2000,
                            weight: 4,
                            options: new \Gs2Cdk\Enchant\Model\Options\RarityParameterValueModelOptions(
                                metadata: "PARAMETER_2002",
                            )
                        ),
                        new \Gs2Cdk\Enchant\Model\RarityParameterValueModel(
                            name: "parameter-2003",
                            resourceName: "resource-2003",
                            resourceValue: 3000,
                            weight: 6,
                            options: new \Gs2Cdk\Enchant\Model\Options\RarityParameterValueModelOptions(
                                metadata: "PARAMETER_2003",
                            )
                        ),
                        new \Gs2Cdk\Enchant\Model\RarityParameterValueModel(
                            name: "parameter-0004",
                            resourceName: "resource-2004",
                            resourceValue: 4000,
                            weight: 8,
                            options: new \Gs2Cdk\Enchant\Model\Options\RarityParameterValueModelOptions(
                                metadata: "PARAMETER_0004",
                            )
                        ),
                    ],
                    options: new \Gs2Cdk\Enchant\Model\Options\RarityParameterModelOptions(
                        metadata:"RARITY_0003"
                    )
                )
            ]
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.enchant.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.enchant.model.BalanceParameterModel(
                    "balance-0001",
                    100L,
                    io.gs2.cdk.enchant.model.enums.BalanceParameterModelInitialValueStrategy.AVERAGE,
                    Arrays.asList(
                        new io.gs2.cdk.enchant.model.BalanceParameterValueModel(
                            "parameter-0001",
                            new io.gs2.cdk.enchant.model.options.BalanceParameterValueModelOptions()
                                .withMetadata("PARAMETER_0001")
                        ),
                        new io.gs2.cdk.enchant.model.BalanceParameterValueModel(
                            "parameter-0002",
                            new io.gs2.cdk.enchant.model.options.BalanceParameterValueModelOptions()
                                .withMetadata("PARAMETER_0002")
                        ),
                        new io.gs2.cdk.enchant.model.BalanceParameterValueModel(
                            "parameter-0003",
                            new io.gs2.cdk.enchant.model.options.BalanceParameterValueModelOptions()
                                .withMetadata("PARAMETER_0003")
                        )
                    ),
                    new io.gs2.cdk.enchant.model.options.BalanceParameterModelOptions()
                        .withMetadata("BALANCE_0001")
                ),
                new io.gs2.cdk.enchant.model.BalanceParameterModel(
                    "balance-0002",
                    200L,
                    io.gs2.cdk.enchant.model.enums.BalanceParameterModelInitialValueStrategy.LOTTERY,
                    Arrays.asList(
                        new io.gs2.cdk.enchant.model.BalanceParameterValueModel(
                            "parameter-0001",
                            new io.gs2.cdk.enchant.model.options.BalanceParameterValueModelOptions()
                                .withMetadata("PARAMETER_0001")
                        ),
                        new io.gs2.cdk.enchant.model.BalanceParameterValueModel(
                            "parameter-0002",
                            new io.gs2.cdk.enchant.model.options.BalanceParameterValueModelOptions()
                                .withMetadata("PARAMETER_0002")
                        ),
                        new io.gs2.cdk.enchant.model.BalanceParameterValueModel(
                            "parameter-0003",
                            new io.gs2.cdk.enchant.model.options.BalanceParameterValueModelOptions()
                                .withMetadata("PARAMETER_0003")
                        ),
                        new io.gs2.cdk.enchant.model.BalanceParameterValueModel(
                            "parameter-0004",
                            new io.gs2.cdk.enchant.model.options.BalanceParameterValueModelOptions()
                                .withMetadata("PARAMETER_0004")
                        )
                    ),
                    new io.gs2.cdk.enchant.model.options.BalanceParameterModelOptions()
                        .withMetadata("BALANCE_0002")
                ),
                new io.gs2.cdk.enchant.model.BalanceParameterModel(
                    "balance-0003",
                    500L,
                    io.gs2.cdk.enchant.model.enums.BalanceParameterModelInitialValueStrategy.AVERAGE,
                    Arrays.asList(
                        new io.gs2.cdk.enchant.model.BalanceParameterValueModel(
                            "parameter-0001",
                            new io.gs2.cdk.enchant.model.options.BalanceParameterValueModelOptions()
                                .withMetadata("PARAMETER_0001")
                        ),
                        new io.gs2.cdk.enchant.model.BalanceParameterValueModel(
                            "parameter-0002",
                            new io.gs2.cdk.enchant.model.options.BalanceParameterValueModelOptions()
                                .withMetadata("PARAMETER_0002")
                        )
                    ),
                    new io.gs2.cdk.enchant.model.options.BalanceParameterModelOptions()
                        .withMetadata("BALANCE_0003")
                )
            ),
            Arrays.asList(
                new io.gs2.cdk.enchant.model.RarityParameterModel(
                    "rarity-0001",
                    5,
                    Arrays.asList(
                        new io.gs2.cdk.enchant.model.RarityParameterCountModel(
                            0,
                            1        
                        ),
                        new io.gs2.cdk.enchant.model.RarityParameterCountModel(
                            1,
                            2        
                        ),
                        new io.gs2.cdk.enchant.model.RarityParameterCountModel(
                            2,
                            3        
                        )
                    ),
                    Arrays.asList(
                        new io.gs2.cdk.enchant.model.RarityParameterValueModel(
                            "parameter-0001",
                            "resource-0001",
                            10L,
                            1,
                            new io.gs2.cdk.enchant.model.options.RarityParameterValueModelOptions()
                                .withMetadata("PARAMETER_0001")
                        ),
                        new io.gs2.cdk.enchant.model.RarityParameterValueModel(
                            "parameter-0002",
                            "resource-0002",
                            20L,
                            2,
                            new io.gs2.cdk.enchant.model.options.RarityParameterValueModelOptions()
                                .withMetadata("PARAMETER_0002")
                        ),
                        new io.gs2.cdk.enchant.model.RarityParameterValueModel(
                            "parameter-0003",
                            "resource-0003",
                            30L,
                            3,
                            new io.gs2.cdk.enchant.model.options.RarityParameterValueModelOptions()
                                .withMetadata("PARAMETER_0003")
                        )
                    ),
                    new io.gs2.cdk.enchant.model.options.RarityParameterModelOptions()
                        .withMetadata("RARITY_0001")
                ),
                new io.gs2.cdk.enchant.model.RarityParameterModel(
                    "rarity-0002",
                    10,
                    Arrays.asList(
                        new io.gs2.cdk.enchant.model.RarityParameterCountModel(
                            1,
                            10        
                        ),
                        new io.gs2.cdk.enchant.model.RarityParameterCountModel(
                            2,
                            20        
                        ),
                        new io.gs2.cdk.enchant.model.RarityParameterCountModel(
                            3,
                            30        
                        )
                    ),
                    Arrays.asList(
                        new io.gs2.cdk.enchant.model.RarityParameterValueModel(
                            "parameter-1001",
                            "resource-1001",
                            100L,
                            10,
                            new io.gs2.cdk.enchant.model.options.RarityParameterValueModelOptions()
                                .withMetadata("PARAMETER_1001")
                        ),
                        new io.gs2.cdk.enchant.model.RarityParameterValueModel(
                            "parameter-1002",
                            "resource-1002",
                            200L,
                            20,
                            new io.gs2.cdk.enchant.model.options.RarityParameterValueModelOptions()
                                .withMetadata("PARAMETER_1002")
                        ),
                        new io.gs2.cdk.enchant.model.RarityParameterValueModel(
                            "parameter-1003",
                            "resource-1003",
                            300L,
                            30,
                            new io.gs2.cdk.enchant.model.options.RarityParameterValueModelOptions()
                                .withMetadata("PARAMETER_1003")
                        )
                    ),
                    new io.gs2.cdk.enchant.model.options.RarityParameterModelOptions()
                        .withMetadata("RARITY_0002")
                ),
                new io.gs2.cdk.enchant.model.RarityParameterModel(
                    "rarity-0003",
                    3,
                    Arrays.asList(
                        new io.gs2.cdk.enchant.model.RarityParameterCountModel(
                            2,
                            5        
                        ),
                        new io.gs2.cdk.enchant.model.RarityParameterCountModel(
                            3,
                            10        
                        ),
                        new io.gs2.cdk.enchant.model.RarityParameterCountModel(
                            4,
                            15        
                        )
                    ),
                    Arrays.asList(
                        new io.gs2.cdk.enchant.model.RarityParameterValueModel(
                            "parameter-2001",
                            "resource-2001",
                            1000L,
                            2,
                            new io.gs2.cdk.enchant.model.options.RarityParameterValueModelOptions()
                                .withMetadata("PARAMETER_2001")
                        ),
                        new io.gs2.cdk.enchant.model.RarityParameterValueModel(
                            "parameter-2002",
                            "resource-2002",
                            2000L,
                            4,
                            new io.gs2.cdk.enchant.model.options.RarityParameterValueModelOptions()
                                .withMetadata("PARAMETER_2002")
                        ),
                        new io.gs2.cdk.enchant.model.RarityParameterValueModel(
                            "parameter-2003",
                            "resource-2003",
                            3000L,
                            6,
                            new io.gs2.cdk.enchant.model.options.RarityParameterValueModelOptions()
                                .withMetadata("PARAMETER_2003")
                        ),
                        new io.gs2.cdk.enchant.model.RarityParameterValueModel(
                            "parameter-0004",
                            "resource-2004",
                            4000L,
                            8,
                            new io.gs2.cdk.enchant.model.options.RarityParameterValueModelOptions()
                                .withMetadata("PARAMETER_0004")
                        )
                    ),
                    new io.gs2.cdk.enchant.model.options.RarityParameterModelOptions()
                        .withMetadata("RARITY_0003")
                )
            )
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Enchant.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2Enchant.Model.BalanceParameterModel[] {
                new Gs2Cdk.Gs2Enchant.Model.BalanceParameterModel(
                    name: "balance-0001",
                    totalValue: 100L,
                    initialValueStrategy: Gs2Cdk.Gs2Enchant.Model.Enums.BalanceParameterModelInitialValueStrategy.Average,
                    parameters: new Gs2Cdk.Gs2Enchant.Model.BalanceParameterValueModel[]
                    {
                        new Gs2Cdk.Gs2Enchant.Model.BalanceParameterValueModel(
                            name: "parameter-0001",
                            options: new Gs2Cdk.Gs2Enchant.Model.Options.BalanceParameterValueModelOptions
                            {
                                metadata = "PARAMETER_0001"
                            }
                        ),
                        new Gs2Cdk.Gs2Enchant.Model.BalanceParameterValueModel(
                            name: "parameter-0002",
                            options: new Gs2Cdk.Gs2Enchant.Model.Options.BalanceParameterValueModelOptions
                            {
                                metadata = "PARAMETER_0002"
                            }
                        ),
                        new Gs2Cdk.Gs2Enchant.Model.BalanceParameterValueModel(
                            name: "parameter-0003",
                            options: new Gs2Cdk.Gs2Enchant.Model.Options.BalanceParameterValueModelOptions
                            {
                                metadata = "PARAMETER_0003"
                            }
                        )
                    },
                    options: new Gs2Cdk.Gs2Enchant.Model.Options.BalanceParameterModelOptions
                    {
                        metadata = "BALANCE_0001"
                    }
                ),
                new Gs2Cdk.Gs2Enchant.Model.BalanceParameterModel(
                    name: "balance-0002",
                    totalValue: 200L,
                    initialValueStrategy: Gs2Cdk.Gs2Enchant.Model.Enums.BalanceParameterModelInitialValueStrategy.Lottery,
                    parameters: new Gs2Cdk.Gs2Enchant.Model.BalanceParameterValueModel[]
                    {
                        new Gs2Cdk.Gs2Enchant.Model.BalanceParameterValueModel(
                            name: "parameter-0001",
                            options: new Gs2Cdk.Gs2Enchant.Model.Options.BalanceParameterValueModelOptions
                            {
                                metadata = "PARAMETER_0001"
                            }
                        ),
                        new Gs2Cdk.Gs2Enchant.Model.BalanceParameterValueModel(
                            name: "parameter-0002",
                            options: new Gs2Cdk.Gs2Enchant.Model.Options.BalanceParameterValueModelOptions
                            {
                                metadata = "PARAMETER_0002"
                            }
                        ),
                        new Gs2Cdk.Gs2Enchant.Model.BalanceParameterValueModel(
                            name: "parameter-0003",
                            options: new Gs2Cdk.Gs2Enchant.Model.Options.BalanceParameterValueModelOptions
                            {
                                metadata = "PARAMETER_0003"
                            }
                        ),
                        new Gs2Cdk.Gs2Enchant.Model.BalanceParameterValueModel(
                            name: "parameter-0004",
                            options: new Gs2Cdk.Gs2Enchant.Model.Options.BalanceParameterValueModelOptions
                            {
                                metadata = "PARAMETER_0004"
                            }
                        )
                    },
                    options: new Gs2Cdk.Gs2Enchant.Model.Options.BalanceParameterModelOptions
                    {
                        metadata = "BALANCE_0002"
                    }
                ),
                new Gs2Cdk.Gs2Enchant.Model.BalanceParameterModel(
                    name: "balance-0003",
                    totalValue: 500L,
                    initialValueStrategy: Gs2Cdk.Gs2Enchant.Model.Enums.BalanceParameterModelInitialValueStrategy.Average,
                    parameters: new Gs2Cdk.Gs2Enchant.Model.BalanceParameterValueModel[]
                    {
                        new Gs2Cdk.Gs2Enchant.Model.BalanceParameterValueModel(
                            name: "parameter-0001",
                            options: new Gs2Cdk.Gs2Enchant.Model.Options.BalanceParameterValueModelOptions
                            {
                                metadata = "PARAMETER_0001"
                            }
                        ),
                        new Gs2Cdk.Gs2Enchant.Model.BalanceParameterValueModel(
                            name: "parameter-0002",
                            options: new Gs2Cdk.Gs2Enchant.Model.Options.BalanceParameterValueModelOptions
                            {
                                metadata = "PARAMETER_0002"
                            }
                        )
                    },
                    options: new Gs2Cdk.Gs2Enchant.Model.Options.BalanceParameterModelOptions
                    {
                        metadata = "BALANCE_0003"
                    }
                )
            },
            new Gs2Cdk.Gs2Enchant.Model.RarityParameterModel[] {
                new Gs2Cdk.Gs2Enchant.Model.RarityParameterModel(
                    name: "rarity-0001",
                    maximumParameterCount: 5,
                    parameterCounts: new Gs2Cdk.Gs2Enchant.Model.RarityParameterCountModel[]
                    {
                        new Gs2Cdk.Gs2Enchant.Model.RarityParameterCountModel(
                            count: 0,
                            weight: 1    
                        ),
                        new Gs2Cdk.Gs2Enchant.Model.RarityParameterCountModel(
                            count: 1,
                            weight: 2    
                        ),
                        new Gs2Cdk.Gs2Enchant.Model.RarityParameterCountModel(
                            count: 2,
                            weight: 3    
                        )
                    },
                    parameters: new Gs2Cdk.Gs2Enchant.Model.RarityParameterValueModel[]
                    {
                        new Gs2Cdk.Gs2Enchant.Model.RarityParameterValueModel(
                            name: "parameter-0001",
                            resourceName: "resource-0001",
                            resourceValue: 10L,
                            weight: 1,
                            options: new Gs2Cdk.Gs2Enchant.Model.Options.RarityParameterValueModelOptions
                            {
                                metadata = "PARAMETER_0001"
                            }
                        ),
                        new Gs2Cdk.Gs2Enchant.Model.RarityParameterValueModel(
                            name: "parameter-0002",
                            resourceName: "resource-0002",
                            resourceValue: 20L,
                            weight: 2,
                            options: new Gs2Cdk.Gs2Enchant.Model.Options.RarityParameterValueModelOptions
                            {
                                metadata = "PARAMETER_0002"
                            }
                        ),
                        new Gs2Cdk.Gs2Enchant.Model.RarityParameterValueModel(
                            name: "parameter-0003",
                            resourceName: "resource-0003",
                            resourceValue: 30L,
                            weight: 3,
                            options: new Gs2Cdk.Gs2Enchant.Model.Options.RarityParameterValueModelOptions
                            {
                                metadata = "PARAMETER_0003"
                            }
                        )
                    },
                    options: new Gs2Cdk.Gs2Enchant.Model.Options.RarityParameterModelOptions
                    {
                        metadata = "RARITY_0001"
                    }
                ),
                new Gs2Cdk.Gs2Enchant.Model.RarityParameterModel(
                    name: "rarity-0002",
                    maximumParameterCount: 10,
                    parameterCounts: new Gs2Cdk.Gs2Enchant.Model.RarityParameterCountModel[]
                    {
                        new Gs2Cdk.Gs2Enchant.Model.RarityParameterCountModel(
                            count: 1,
                            weight: 10    
                        ),
                        new Gs2Cdk.Gs2Enchant.Model.RarityParameterCountModel(
                            count: 2,
                            weight: 20    
                        ),
                        new Gs2Cdk.Gs2Enchant.Model.RarityParameterCountModel(
                            count: 3,
                            weight: 30    
                        )
                    },
                    parameters: new Gs2Cdk.Gs2Enchant.Model.RarityParameterValueModel[]
                    {
                        new Gs2Cdk.Gs2Enchant.Model.RarityParameterValueModel(
                            name: "parameter-1001",
                            resourceName: "resource-1001",
                            resourceValue: 100L,
                            weight: 10,
                            options: new Gs2Cdk.Gs2Enchant.Model.Options.RarityParameterValueModelOptions
                            {
                                metadata = "PARAMETER_1001"
                            }
                        ),
                        new Gs2Cdk.Gs2Enchant.Model.RarityParameterValueModel(
                            name: "parameter-1002",
                            resourceName: "resource-1002",
                            resourceValue: 200L,
                            weight: 20,
                            options: new Gs2Cdk.Gs2Enchant.Model.Options.RarityParameterValueModelOptions
                            {
                                metadata = "PARAMETER_1002"
                            }
                        ),
                        new Gs2Cdk.Gs2Enchant.Model.RarityParameterValueModel(
                            name: "parameter-1003",
                            resourceName: "resource-1003",
                            resourceValue: 300L,
                            weight: 30,
                            options: new Gs2Cdk.Gs2Enchant.Model.Options.RarityParameterValueModelOptions
                            {
                                metadata = "PARAMETER_1003"
                            }
                        )
                    },
                    options: new Gs2Cdk.Gs2Enchant.Model.Options.RarityParameterModelOptions
                    {
                        metadata = "RARITY_0002"
                    }
                ),
                new Gs2Cdk.Gs2Enchant.Model.RarityParameterModel(
                    name: "rarity-0003",
                    maximumParameterCount: 3,
                    parameterCounts: new Gs2Cdk.Gs2Enchant.Model.RarityParameterCountModel[]
                    {
                        new Gs2Cdk.Gs2Enchant.Model.RarityParameterCountModel(
                            count: 2,
                            weight: 5    
                        ),
                        new Gs2Cdk.Gs2Enchant.Model.RarityParameterCountModel(
                            count: 3,
                            weight: 10    
                        ),
                        new Gs2Cdk.Gs2Enchant.Model.RarityParameterCountModel(
                            count: 4,
                            weight: 15    
                        )
                    },
                    parameters: new Gs2Cdk.Gs2Enchant.Model.RarityParameterValueModel[]
                    {
                        new Gs2Cdk.Gs2Enchant.Model.RarityParameterValueModel(
                            name: "parameter-2001",
                            resourceName: "resource-2001",
                            resourceValue: 1000L,
                            weight: 2,
                            options: new Gs2Cdk.Gs2Enchant.Model.Options.RarityParameterValueModelOptions
                            {
                                metadata = "PARAMETER_2001"
                            }
                        ),
                        new Gs2Cdk.Gs2Enchant.Model.RarityParameterValueModel(
                            name: "parameter-2002",
                            resourceName: "resource-2002",
                            resourceValue: 2000L,
                            weight: 4,
                            options: new Gs2Cdk.Gs2Enchant.Model.Options.RarityParameterValueModelOptions
                            {
                                metadata = "PARAMETER_2002"
                            }
                        ),
                        new Gs2Cdk.Gs2Enchant.Model.RarityParameterValueModel(
                            name: "parameter-2003",
                            resourceName: "resource-2003",
                            resourceValue: 3000L,
                            weight: 6,
                            options: new Gs2Cdk.Gs2Enchant.Model.Options.RarityParameterValueModelOptions
                            {
                                metadata = "PARAMETER_2003"
                            }
                        ),
                        new Gs2Cdk.Gs2Enchant.Model.RarityParameterValueModel(
                            name: "parameter-0004",
                            resourceName: "resource-2004",
                            resourceValue: 4000L,
                            weight: 8,
                            options: new Gs2Cdk.Gs2Enchant.Model.Options.RarityParameterValueModelOptions
                            {
                                metadata = "PARAMETER_0004"
                            }
                        )
                    },
                    options: new Gs2Cdk.Gs2Enchant.Model.Options.RarityParameterModelOptions
                    {
                        metadata = "RARITY_0003"
                    }
                )
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template
import core from "@/gs2cdk/core";
import enchant from "@/gs2cdk/enchant";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new enchant.model.Namespace(
            this,
            "namespace-0001",
        ).masterData(
            [
                new enchant.model.BalanceParameterModel(
                    "balance-0001",
                    100,
                    enchant.model.BalanceParameterModelInitialValueStrategy.AVERAGE,
                    [
                        new enchant.model.BalanceParameterValueModel(
                            "parameter-0001",
                            {
                                metadata: "PARAMETER_0001"
                            }
                        ),
                        new enchant.model.BalanceParameterValueModel(
                            "parameter-0002",
                            {
                                metadata: "PARAMETER_0002"
                            }
                        ),
                        new enchant.model.BalanceParameterValueModel(
                            "parameter-0003",
                            {
                                metadata: "PARAMETER_0003"
                            }
                        ),
                    ],
                    {
                        metadata: "BALANCE_0001"
                    }
                ),
                new enchant.model.BalanceParameterModel(
                    "balance-0002",
                    200,
                    enchant.model.BalanceParameterModelInitialValueStrategy.LOTTERY,
                    [
                        new enchant.model.BalanceParameterValueModel(
                            "parameter-0001",
                            {
                                metadata: "PARAMETER_0001"
                            }
                        ),
                        new enchant.model.BalanceParameterValueModel(
                            "parameter-0002",
                            {
                                metadata: "PARAMETER_0002"
                            }
                        ),
                        new enchant.model.BalanceParameterValueModel(
                            "parameter-0003",
                            {
                                metadata: "PARAMETER_0003"
                            }
                        ),
                        new enchant.model.BalanceParameterValueModel(
                            "parameter-0004",
                            {
                                metadata: "PARAMETER_0004"
                            }
                        ),
                    ],
                    {
                        metadata: "BALANCE_0002"
                    }
                ),
                new enchant.model.BalanceParameterModel(
                    "balance-0003",
                    500,
                    enchant.model.BalanceParameterModelInitialValueStrategy.AVERAGE,
                    [
                        new enchant.model.BalanceParameterValueModel(
                            "parameter-0001",
                            {
                                metadata: "PARAMETER_0001"
                            }
                        ),
                        new enchant.model.BalanceParameterValueModel(
                            "parameter-0002",
                            {
                                metadata: "PARAMETER_0002"
                            }
                        ),
                    ],
                    {
                        metadata: "BALANCE_0003"
                    }
                )
            ],
            [
                new enchant.model.RarityParameterModel(
                    "rarity-0001",
                    5,
                    [
                        new enchant.model.RarityParameterCountModel(
                            0,
                            1        
                        ),
                        new enchant.model.RarityParameterCountModel(
                            1,
                            2        
                        ),
                        new enchant.model.RarityParameterCountModel(
                            2,
                            3        
                        ),
                    ],
                    [
                        new enchant.model.RarityParameterValueModel(
                            "parameter-0001",
                            "resource-0001",
                            10,
                            1,
                            {
                                metadata: "PARAMETER_0001"
                            }
                        ),
                        new enchant.model.RarityParameterValueModel(
                            "parameter-0002",
                            "resource-0002",
                            20,
                            2,
                            {
                                metadata: "PARAMETER_0002"
                            }
                        ),
                        new enchant.model.RarityParameterValueModel(
                            "parameter-0003",
                            "resource-0003",
                            30,
                            3,
                            {
                                metadata: "PARAMETER_0003"
                            }
                        ),
                    ],
                    {
                        metadata: "RARITY_0001"
                    }
                ),
                new enchant.model.RarityParameterModel(
                    "rarity-0002",
                    10,
                    [
                        new enchant.model.RarityParameterCountModel(
                            1,
                            10        
                        ),
                        new enchant.model.RarityParameterCountModel(
                            2,
                            20        
                        ),
                        new enchant.model.RarityParameterCountModel(
                            3,
                            30        
                        ),
                    ],
                    [
                        new enchant.model.RarityParameterValueModel(
                            "parameter-1001",
                            "resource-1001",
                            100,
                            10,
                            {
                                metadata: "PARAMETER_1001"
                            }
                        ),
                        new enchant.model.RarityParameterValueModel(
                            "parameter-1002",
                            "resource-1002",
                            200,
                            20,
                            {
                                metadata: "PARAMETER_1002"
                            }
                        ),
                        new enchant.model.RarityParameterValueModel(
                            "parameter-1003",
                            "resource-1003",
                            300,
                            30,
                            {
                                metadata: "PARAMETER_1003"
                            }
                        ),
                    ],
                    {
                        metadata: "RARITY_0002"
                    }
                ),
                new enchant.model.RarityParameterModel(
                    "rarity-0003",
                    3,
                    [
                        new enchant.model.RarityParameterCountModel(
                            2,
                            5        
                        ),
                        new enchant.model.RarityParameterCountModel(
                            3,
                            10        
                        ),
                        new enchant.model.RarityParameterCountModel(
                            4,
                            15        
                        ),
                    ],
                    [
                        new enchant.model.RarityParameterValueModel(
                            "parameter-2001",
                            "resource-2001",
                            1000,
                            2,
                            {
                                metadata: "PARAMETER_2001"
                            }
                        ),
                        new enchant.model.RarityParameterValueModel(
                            "parameter-2002",
                            "resource-2002",
                            2000,
                            4,
                            {
                                metadata: "PARAMETER_2002"
                            }
                        ),
                        new enchant.model.RarityParameterValueModel(
                            "parameter-2003",
                            "resource-2003",
                            3000,
                            6,
                            {
                                metadata: "PARAMETER_2003"
                            }
                        ),
                        new enchant.model.RarityParameterValueModel(
                            "parameter-0004",
                            "resource-2004",
                            4000,
                            8,
                            {
                                metadata: "PARAMETER_0004"
                            }
                        ),
                    ],
                    {
                        metadata: "RARITY_0003"
                    }
                )
            ]
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template
from gs2_cdk import Stack, core, enchant

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        enchant.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            balance_parameter_models=[
                enchant.BalanceParameterModel(
                    name='balance-0001',
                    total_value=100,
                    initial_value_strategy=enchant.BalanceParameterModelInitialValueStrategy.AVERAGE,
                    parameters=[
                        enchant.BalanceParameterValueModel(
                            name='parameter-0001',
                            options=enchant.BalanceParameterValueModelOptions(
                                metadata='PARAMETER_0001',
                            ),
                        ),
                        enchant.BalanceParameterValueModel(
                            name='parameter-0002',
                            options=enchant.BalanceParameterValueModelOptions(
                                metadata='PARAMETER_0002',
                            ),
                        ),
                        enchant.BalanceParameterValueModel(
                            name='parameter-0003',
                            options=enchant.BalanceParameterValueModelOptions(
                                metadata='PARAMETER_0003',
                            ),
                        ),
                    ],
                    options=enchant.BalanceParameterModelOptions(
                        metadata = 'BALANCE_0001'
                    ),
                ),
                enchant.BalanceParameterModel(
                    name='balance-0002',
                    total_value=200,
                    initial_value_strategy=enchant.BalanceParameterModelInitialValueStrategy.LOTTERY,
                    parameters=[
                        enchant.BalanceParameterValueModel(
                            name='parameter-0001',
                            options=enchant.BalanceParameterValueModelOptions(
                                metadata='PARAMETER_0001',
                            ),
                        ),
                        enchant.BalanceParameterValueModel(
                            name='parameter-0002',
                            options=enchant.BalanceParameterValueModelOptions(
                                metadata='PARAMETER_0002',
                            ),
                        ),
                        enchant.BalanceParameterValueModel(
                            name='parameter-0003',
                            options=enchant.BalanceParameterValueModelOptions(
                                metadata='PARAMETER_0003',
                            ),
                        ),
                        enchant.BalanceParameterValueModel(
                            name='parameter-0004',
                            options=enchant.BalanceParameterValueModelOptions(
                                metadata='PARAMETER_0004',
                            ),
                        ),
                    ],
                    options=enchant.BalanceParameterModelOptions(
                        metadata = 'BALANCE_0002'
                    ),
                ),
                enchant.BalanceParameterModel(
                    name='balance-0003',
                    total_value=500,
                    initial_value_strategy=enchant.BalanceParameterModelInitialValueStrategy.AVERAGE,
                    parameters=[
                        enchant.BalanceParameterValueModel(
                            name='parameter-0001',
                            options=enchant.BalanceParameterValueModelOptions(
                                metadata='PARAMETER_0001',
                            ),
                        ),
                        enchant.BalanceParameterValueModel(
                            name='parameter-0002',
                            options=enchant.BalanceParameterValueModelOptions(
                                metadata='PARAMETER_0002',
                            ),
                        ),
                    ],
                    options=enchant.BalanceParameterModelOptions(
                        metadata = 'BALANCE_0003'
                    ),
                ),
            ],
            rarity_parameter_models=[
                enchant.RarityParameterModel(
                    name='rarity-0001',
                    maximum_parameter_count=5,
                    parameter_counts=[
                        enchant.RarityParameterCountModel(
                            count=0,
                            weight=1,        
                        ),
                        enchant.RarityParameterCountModel(
                            count=1,
                            weight=2,        
                        ),
                        enchant.RarityParameterCountModel(
                            count=2,
                            weight=3,        
                        ),
                    ],
                    parameters=[
                        enchant.RarityParameterValueModel(
                            name='parameter-0001',
                            resource_name='resource-0001',
                            resource_value=10,
                            weight=1,
                            options=enchant.RarityParameterValueModelOptions(
                                metadata='PARAMETER_0001',
                            ),
                        ),
                        enchant.RarityParameterValueModel(
                            name='parameter-0002',
                            resource_name='resource-0002',
                            resource_value=20,
                            weight=2,
                            options=enchant.RarityParameterValueModelOptions(
                                metadata='PARAMETER_0002',
                            ),
                        ),
                        enchant.RarityParameterValueModel(
                            name='parameter-0003',
                            resource_name='resource-0003',
                            resource_value=30,
                            weight=3,
                            options=enchant.RarityParameterValueModelOptions(
                                metadata='PARAMETER_0003',
                            ),
                        ),
                    ],
                    options=enchant.RarityParameterModelOptions(
                        metadata = 'RARITY_0001'
                    ),
                ),
                enchant.RarityParameterModel(
                    name='rarity-0002',
                    maximum_parameter_count=10,
                    parameter_counts=[
                        enchant.RarityParameterCountModel(
                            count=1,
                            weight=10,        
                        ),
                        enchant.RarityParameterCountModel(
                            count=2,
                            weight=20,        
                        ),
                        enchant.RarityParameterCountModel(
                            count=3,
                            weight=30,        
                        ),
                    ],
                    parameters=[
                        enchant.RarityParameterValueModel(
                            name='parameter-1001',
                            resource_name='resource-1001',
                            resource_value=100,
                            weight=10,
                            options=enchant.RarityParameterValueModelOptions(
                                metadata='PARAMETER_1001',
                            ),
                        ),
                        enchant.RarityParameterValueModel(
                            name='parameter-1002',
                            resource_name='resource-1002',
                            resource_value=200,
                            weight=20,
                            options=enchant.RarityParameterValueModelOptions(
                                metadata='PARAMETER_1002',
                            ),
                        ),
                        enchant.RarityParameterValueModel(
                            name='parameter-1003',
                            resource_name='resource-1003',
                            resource_value=300,
                            weight=30,
                            options=enchant.RarityParameterValueModelOptions(
                                metadata='PARAMETER_1003',
                            ),
                        ),
                    ],
                    options=enchant.RarityParameterModelOptions(
                        metadata = 'RARITY_0002'
                    ),
                ),
                enchant.RarityParameterModel(
                    name='rarity-0003',
                    maximum_parameter_count=3,
                    parameter_counts=[
                        enchant.RarityParameterCountModel(
                            count=2,
                            weight=5,        
                        ),
                        enchant.RarityParameterCountModel(
                            count=3,
                            weight=10,        
                        ),
                        enchant.RarityParameterCountModel(
                            count=4,
                            weight=15,        
                        ),
                    ],
                    parameters=[
                        enchant.RarityParameterValueModel(
                            name='parameter-2001',
                            resource_name='resource-2001',
                            resource_value=1000,
                            weight=2,
                            options=enchant.RarityParameterValueModelOptions(
                                metadata='PARAMETER_2001',
                            ),
                        ),
                        enchant.RarityParameterValueModel(
                            name='parameter-2002',
                            resource_name='resource-2002',
                            resource_value=2000,
                            weight=4,
                            options=enchant.RarityParameterValueModelOptions(
                                metadata='PARAMETER_2002',
                            ),
                        ),
                        enchant.RarityParameterValueModel(
                            name='parameter-2003',
                            resource_name='resource-2003',
                            resource_value=3000,
                            weight=6,
                            options=enchant.RarityParameterValueModelOptions(
                                metadata='PARAMETER_2003',
                            ),
                        ),
                        enchant.RarityParameterValueModel(
                            name='parameter-0004',
                            resource_name='resource-2004',
                            resource_value=4000,
                            weight=8,
                            options=enchant.RarityParameterValueModelOptions(
                                metadata='PARAMETER_0004',
                            ),
                        ),
                    ],
                    options=enchant.RarityParameterModelOptions(
                        metadata = 'RARITY_0003'
                    ),
                ),
            ],
        )

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

BalanceParameterValue

Balance Parameter Value

TypeConditionRequiredDefaultValue LimitsDescription
namestring
~ 64 charsName
valuelong
0 ~ 9223372036854775805Value

RarityParameterValue

Rarity Parameter Value

TypeConditionRequiredDefaultValue LimitsDescription
namestring
~ 64 charsName
resourceNamestring
~ 64 charsResource Name
resourceValuelong
0 ~ 9223372036854775805Resource Value

VerifyActionResult

Verify action execution result

TypeConditionRequiredDefaultValue LimitsDescription
actionString Enum
enum {
"Gs2Dictionary:VerifyEntryByUserId",
"Gs2Distributor:IfExpressionByUserId",
"Gs2Distributor:AndExpressionByUserId",
"Gs2Distributor:OrExpressionByUserId",
"Gs2Enchant:VerifyRarityParameterStatusByUserId",
"Gs2Experience:VerifyRankByUserId",
"Gs2Experience:VerifyRankCapByUserId",
"Gs2Grade:VerifyGradeByUserId",
"Gs2Grade:VerifyGradeUpMaterialByUserId",
"Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName",
"Gs2Guild:VerifyIncludeMemberByUserId",
"Gs2Inventory:VerifyInventoryCurrentMaxCapacityByUserId",
"Gs2Inventory:VerifyItemSetByUserId",
"Gs2Inventory:VerifyReferenceOfByUserId",
"Gs2Inventory:VerifySimpleItemByUserId",
"Gs2Inventory:VerifyBigItemByUserId",
"Gs2Limit:VerifyCounterByUserId",
"Gs2Matchmaking:VerifyIncludeParticipantByUserId",
"Gs2Mission:VerifyCompleteByUserId",
"Gs2Mission:VerifyCounterValueByUserId",
"Gs2Ranking2:VerifyGlobalRankingScoreByUserId",
"Gs2Ranking2:VerifyClusterRankingScoreByUserId",
"Gs2Ranking2:VerifySubscribeRankingScoreByUserId",
"Gs2Schedule:VerifyTriggerByUserId",
"Gs2Schedule:VerifyEventByUserId",
"Gs2SerialKey:VerifyCodeByUserId",
"Gs2Stamina:VerifyStaminaValueByUserId",
"Gs2Stamina:VerifyStaminaMaxValueByUserId",
"Gs2Stamina:VerifyStaminaRecoverIntervalMinutesByUserId",
"Gs2Stamina:VerifyStaminaRecoverValueByUserId",
"Gs2Stamina:VerifyStaminaOverflowValueByUserId",
}
~ 128 charsTypes of actions to be performed in the verify task
verifyRequeststring
~ 524288 charsJSON string of the request used when executing the action
statusCodeint0 ~ 999Status code
verifyResultstring~ 1048576 charsResult payload

ConsumeActionResult

Consume action execution result

TypeConditionRequiredDefaultValue LimitsDescription
actionString Enum
enum {
"Gs2AdReward:ConsumePointByUserId",
"Gs2Dictionary:DeleteEntriesByUserId",
"Gs2Enhance:DeleteProgressByUserId",
"Gs2Exchange:DeleteAwaitByUserId",
"Gs2Experience:SubExperienceByUserId",
"Gs2Experience:SubRankCapByUserId",
"Gs2Formation:SubMoldCapacityByUserId",
"Gs2Grade:SubGradeByUserId",
"Gs2Guild:DecreaseMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Idle:DecreaseMaximumIdleMinutesByUserId",
"Gs2Inbox:OpenMessageByUserId",
"Gs2Inbox:DeleteMessageByUserId",
"Gs2Inventory:ConsumeItemSetByUserId",
"Gs2Inventory:ConsumeSimpleItemsByUserId",
"Gs2Inventory:ConsumeBigItemByUserId",
"Gs2JobQueue:DeleteJobByUserId",
"Gs2Limit:CountUpByUserId",
"Gs2LoginReward:MarkReceivedByUserId",
"Gs2Mission:ReceiveByUserId",
"Gs2Mission:BatchReceiveByUserId",
"Gs2Mission:DecreaseCounterByUserId",
"Gs2Mission:ResetCounterByUserId",
"Gs2Money:WithdrawByUserId",
"Gs2Money:RecordReceipt",
"Gs2Money2:WithdrawByUserId",
"Gs2Money2:VerifyReceiptByUserId",
"Gs2Quest:DeleteProgressByUserId",
"Gs2Ranking2:CreateGlobalRankingReceivedRewardByUserId",
"Gs2Ranking2:CreateClusterRankingReceivedRewardByUserId",
"Gs2Schedule:DeleteTriggerByUserId",
"Gs2SerialKey:UseByUserId",
"Gs2Showcase:IncrementPurchaseCountByUserId",
"Gs2SkillTree:MarkRestrainByUserId",
"Gs2Stamina:DecreaseMaxValueByUserId",
"Gs2Stamina:ConsumeStaminaByUserId",
}
~ 128 charsTypes of actions to be performed in the consume action
consumeRequeststring
~ 524288 charsJSON string of the request used when executing the action
statusCodeint0 ~ 999Status code
consumeResultstring~ 1048576 charsResult payload

AcquireActionResult

Acquire action execution result

TypeConditionRequiredDefaultValue LimitsDescription
actionString Enum
enum {
"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:CreateAwaitByUserId",
"Gs2Exchange:AcquireForceByUserId",
"Gs2Exchange:SkipByUserId",
"Gs2Experience:AddExperienceByUserId",
"Gs2Experience:SetExperienceByUserId",
"Gs2Experience:AddRankCapByUserId",
"Gs2Experience:SetRankCapByUserId",
"Gs2Experience:MultiplyAcquireActionsByUserId",
"Gs2Formation:AddMoldCapacityByUserId",
"Gs2Formation:SetMoldCapacityByUserId",
"Gs2Formation:AcquireActionsToFormProperties",
"Gs2Formation:SetFormByUserId",
"Gs2Formation:AcquireActionsToPropertyFormProperties",
"Gs2Friend:UpdateProfileByUserId",
"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",
"Gs2Schedule:ExtendTriggerByUserId",
"Gs2Script:InvokeScript",
"Gs2SerialKey:RevertUseByUserId",
"Gs2SerialKey:IssueOnce",
"Gs2Showcase:DecrementPurchaseCountByUserId",
"Gs2Showcase:ForceReDrawByUserId",
"Gs2SkillTree:MarkReleaseByUserId",
"Gs2Stamina:RecoverStaminaByUserId",
"Gs2Stamina:RaiseMaxValueByUserId",
"Gs2Stamina:SetMaxValueByUserId",
"Gs2Stamina:SetRecoverIntervalByUserId",
"Gs2Stamina:SetRecoverValueByUserId",
"Gs2StateMachine:StartStateMachineByUserId",
}
~ 128 charsTypes of actions to be performed in the acquire action
acquireRequeststring
~ 524288 charsJSON string of the request used when executing the action
statusCodeint0 ~ 999Status code
acquireResultstring~ 1048576 charsResult payload

TransactionResult

Transaction execution results

Transaction execution results executed using server-side transaction auto-execution functionality

TypeConditionRequiredDefaultValue LimitsDescription
transactionIdstring
36 ~ 36 charsTransaction ID
verifyResultsList<VerifyActionResult>0 ~ 10 itemsList of verify action execution results
consumeResultsList<ConsumeActionResult>[]0 ~ 10 itemsList of consume action execution results
acquireResultsList<AcquireActionResult>[]0 ~ 100 itemsList of acquire action execution results
hasErrorbool
falseWhether an error occurred during transaction execution

Config

Configuration

Set values to be applied to transaction variables

TypeConditionRequiredDefaultValue LimitsDescription
keystring
~ 64 charsName
valuestring~ 51200 charsValue

ScriptSetting

Script settings

In GS2, you can associate custom scripts with microservice events and execute them. This model holds the settings for triggering script execution.

There are two main ways to execute a script: synchronous execution and asynchronous execution. Synchronous execution blocks processing until the script has finished executing. Instead, you can use the script execution result to stop the execution of the API or to tamper with the result of the API.

In contrast, asynchronous execution does not block processing until the script has finished executing. Since the script result cannot be used to stop the API execution or modify the API response, asynchronous execution does not affect the API’s response flow. For this reason, asynchronous execution is generally recommended.

There are two types of asynchronous execution methods: GS2-Script and Amazon EventBridge. By using Amazon EventBridge, you can write processing in languages other than Lua.

TypeConditionRequiredDefaultValue LimitsDescription
triggerScriptIdstring~ 1024 charsScript GRN of synchronous execution script
Must be specified in GRN format starting with “grn:gs2:”.
doneTriggerTargetTypeString Enum
enum {
  “none”,
  “gs2_script”,
  “aws”
}
“none”~ 128 charsHow to execute asynchronous scripts
Specifies the type of script to use for asynchronous execution.
You can choose from “Do not use asynchronous execution scripts (none)”, “Use GS2-Script (gs2_script)”, and “Use Amazon EventBridge (aws)”.
Enumerator String DefinitionDescription
“none”None
“gs2_script”GS2-Script
“aws”Amazon EventBridge
doneTriggerScriptIdstring{doneTriggerTargetType} == “gs2_script”~ 1024 charsScript GRN of asynchronous execution script
Must be specified in GRN format starting with “grn:gs2:”.

* Enabled if doneTriggerTargetType is “gs2_script”
doneTriggerQueueNamespaceIdstring{doneTriggerTargetType} == “gs2_script”~ 1024 charsGS2-JobQueue namespace GRN to execute asynchronous execution scripts
If you want to execute asynchronous execution scripts via GS2-JobQueue instead of executing them directly, specify the GS2-JobQueue namespace GRN.
There is little reason to use GS2-JobQueue, so you don’t need to specify it unless you have a specific reason.

* Enabled if doneTriggerTargetType is “gs2_script”

LogSetting

Log Export Settings

Manages log data export settings. This type holds the GS2-Log namespace identifier (Namespace ID) used to export log data. Specify the GS2-Log namespace where log data is collected and stored in the GRN format for the Log Namespace ID (loggingNamespaceId). Configuring this setting ensures that log data for API requests and responses occurring within the specified namespace is output to the target GS2-Log namespace. GS2-Log provides real-time logs that can be used for system monitoring, analysis, and debugging.

TypeConditionRequiredDefaultValue LimitsDescription
loggingNamespaceIdstring
~ 1024 charsGS2-Log namespace GRN to output logs

TransactionSetting

Transaction settings

Transaction settings control how transactions are executed, their consistency, asynchronous processing, and conflict avoidance mechanisms. Combining features like AutoRun, AtomicCommit, Distributor, batch application of script results, and asynchronous acquisition actions via JobQueue enables robust transaction management tailored to game logic.

TypeConditionRequiredDefaultValue LimitsDescription
enableAutoRunbool
falseWhether to automatically execute issued transactions on the server side
enableAtomicCommitbool{enableAutoRun} == true
✓*
falseWhether to commit the execution of transactions atomically
* Required if enableAutoRun is true
transactionUseDistributorbool{enableAtomicCommit} == true
✓*
falseWhether to execute transactions asynchronously
* Required if enableAtomicCommit is true
commitScriptResultInUseDistributorbool{transactionUseDistributor} == true
✓*
falseWhether to execute the commit processing of the script result asynchronously
* Required if transactionUseDistributor is true
acquireActionUseJobQueuebool{enableAtomicCommit} == true
✓*
falseWhether to use GS2-JobQueue to execute the acquire action
* Required if enableAtomicCommit is true
distributorNamespaceIdstring
“grn:gs2:{region}:{ownerId}:distributor:default”~ 1024 charsGS2-Distributor namespace used for transaction execution
queueNamespaceIdstring
“grn:gs2:{region}:{ownerId}:queue:default”~ 1024 charsNamespace in GS2-JobQueue used to run the transaction

GitHubCheckoutSetting

Setup to check out master data from GitHub

TypeConditionRequiredDefaultValue LimitsDescription
apiKeyIdstring
~ 1024 charsGitHub API key GRN
repositoryNamestring
~ 1024 charsRepository Name
sourcePathstring
~ 1024 charsMaster data (JSON) file path
referenceTypeString Enum
enum {
  “commit_hash”,
  “branch”,
  “tag”
}
~ 128 charsSource of code
Enumerator String DefinitionDescription
“commit_hash”Commit hash
“branch”Branch
“tag”Tag
commitHashstring{referenceType} == “commit_hash”
✓*
~ 1024 charsCommit hash
* Required if referenceType is “commit_hash”
branchNamestring{referenceType} == “branch”
✓*
~ 1024 charsBranch Name
* Required if referenceType is “branch”
tagNamestring{referenceType} == “tag”
✓*
~ 1024 charsTag Name
* Required if referenceType is “tag”

BalanceParameterValueModel

Balance Parameter Value Model

TypeConditionRequiredDefaultValue LimitsDescription
namestring
~ 64 charsName
metadatastring~ 512 charsMetadata

RarityParameterCountModel

Model of the number of rarity parameters granted

TypeConditionRequiredDefaultValue LimitsDescription
countint
0 ~ 10Value
weightint
1 ~ 2147483646Weight

RarityParameterValueModel

Rarity Parameter Value Model

TypeConditionRequiredDefaultValue LimitsDescription
namestring
~ 64 charsName
metadatastring~ 512 charsMetadata
resourceNamestring
~ 64 charsParameter Resource Name for Game(Not used for GS2)
resourceValuelong
0 ~ 9223372036854775805Parameter Resource Value for Game(Not used for GS2)
weightint
1 ~ 2147483646Weight