GS2-Money Deploy/CDK Reference

The template format used when creating stacks with GS2-Deploy, and implementation examples of template output in various languages using CDK

Entities

Resources targeted by the Deploy operation

Namespace

A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. 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.

Request

Resource creation and update requests

Type

Condition

Required

Default

Value Limits

Description

name

string

✓

~ 128 chars

Namespace name

Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).

description

string

~ 1024 chars

Description

transactionSetting

TransactionSetting

Transaction Settings

Configuration for controlling how transactions are processed when executing money operations.

priority

String Enum
enum {
“free”,
“paid”
}

✓

Consumption Priority

Determines the order in which paid and free currency is consumed when withdrawing from the wallet.
When set to “free”, free currency (price=0) is consumed first, then paid currency from the highest unit price.
When set to “paid”, paid currency is consumed first starting from the highest unit price, then free currency.

Definition	Description
“free”	Prioritize the use of free currency
“paid”	Prioritize the use of paid currency

shareFree

bool

✓

Share Free Currency

Whether free currency is shared across all wallet slots.
When enabled, free currency balances are synchronized from slot 0 to all other slots, allowing players on different platforms to share the same free currency pool.
Paid currency always remains separate per slot regardless of this setting.

currency

String Enum
enum {
  “JPY”,
  “USD”,
  “TWD”
}

✓

Currency Type

The real-world currency used for pricing and Funds Settlement Act compliance calculations.
This determines the unit of measurement for tracking paid currency values and calculating refund obligations.
Cannot be changed after namespace creation.

Definition	Description
“JPY”	JPY
“USD”	USD
“TWD”	TWD

appleKey

string

~ 1024 chars

Apple AppStore Bundle ID

The Bundle ID of your iOS app, used to verify Apple AppStore purchase receipts.
Required when accepting in-app purchases from iOS devices.

googleKey

string

~ 5120 chars

Google PlayStore Private Key

The service account private key for Google Play, used to verify Google Play purchase receipts.
Required when accepting in-app purchases from Android devices.

enableFakeReceipt

bool

false

Enable Fake Receipt

Whether to accept fake purchase receipts generated by Unity Editor for testing purposes.
Should only be enabled in development/test environments and must be disabled in production to prevent unauthorized currency grants.
Defaults to false.

createWalletScript

ScriptSetting

Create Wallet Script

Script to run when a new wallet is created for the first time.
Wallets are auto-created on first access, so this script triggers when a player first interacts with the currency system.

depositScript

ScriptSetting

Deposit Script

Script to run when currency is added to the wallet.
Triggered for both paid currency deposits (from store purchases) and free currency grants.

withdrawScript

ScriptSetting

Withdraw Script

Script to run when currency is consumed from the wallet.
Triggered when paid or free currency is deducted according to the consumption priority setting.

logSetting

LogSetting

Log Output Settings

Configuration for outputting API request/response logs to GS2-Log.
When configured, wallet operations (deposit, withdraw, purchase) are logged for monitoring, auditing, and analysis.

GetAttr

Resource creation results that can be retrieved using the !GetAttr tag

	Type	Description
Item	Namespace	Namespace created

Implementation Example

Type: GS2::Money::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSetting: null
  Priority: paid
  ShareFree: false
  Currency: USD
  AppleKey: null
  GoogleKey: null
  EnableFakeReceipt: null
  CreateWalletScript: null
  DepositScript: null
  WithdrawScript: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001

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


SampleStack := core.NewStack()
money.NewNamespace(
    &SampleStack,
    "namespace-0001",
    money.NamespacePriorityPaid,
    false,
    money.NamespaceCurrencyUsd,
    money.NamespaceOptions{
        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\Money\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            priority: \Gs2Cdk\Money\Model\Enums\NamespacePriority::PAID,
            shareFree: false,
            currency: \Gs2Cdk\Money\Model\Enums\NamespaceCurrency::USD,
            options: new \Gs2Cdk\Money\Model\Options\NamespaceOptions(
                logSetting: new \Gs2Cdk\Core\Model\LogSetting(
                    loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            )
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.money.model.Namespace(
                this,
                "namespace-0001",
                io.gs2.cdk.money.model.enums.NamespacePriority.PAID,
                false,
                io.gs2.cdk.money.model.enums.NamespaceCurrency.USD,
                new io.gs2.cdk.money.model.options.NamespaceOptions()
                        .withLogSetting(new io.gs2.cdk.core.model.LogSetting(
                            "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                        ))
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Money.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            priority: Gs2Cdk.Gs2Money.Model.Enums.NamespacePriority.Paid,
            shareFree: false,
            currency: Gs2Cdk.Gs2Money.Model.Enums.NamespaceCurrency.Usd,
            options: new Gs2Cdk.Gs2Money.Model.Options.NamespaceOptions
            {
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

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

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new money.model.Namespace(
            this,
            "namespace-0001",
            money.model.NamespacePriority.PAID,
            false,
            money.model.NamespaceCurrency.USD,
            {
                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, money

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        money.Namespace(
            stack=self,
            name='namespace-0001',
            priority=money.NamespacePriority.PAID,
            share_free=False,
            currency=money.NamespaceCurrency.USD,
            options=money.NamespaceOptions(
                log_setting=core.LogSetting(
                    logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
                ),
            ),
        )

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

TransactionSetting

Transaction Setting

Transaction Setting controls how transactions are executed, including their consistency, asynchronous processing, and conflict avoidance mechanisms. Combining features like AutoRun, AtomicCommit, asynchronous execution using GS2-Distributor, batch application of script results, and asynchronous Acquire Actions via GS2-JobQueue enables robust transaction management tailored to game logic.

	Type	Condition	Default	Value Limits	Description
enableAutoRun	bool		false		Whether to automatically execute issued transactions on the server side
enableAtomicCommit	bool	{enableAutoRun} == true	false		Whether to commit the execution of transactions atomically * Applicable only if enableAutoRun is true
transactionUseDistributor	bool	{enableAtomicCommit} == true	false		Whether to execute transactions asynchronously * Applicable only if enableAtomicCommit is true
commitScriptResultInUseDistributor	bool	{transactionUseDistributor} == true	false		Whether to execute the commit processing of the script result asynchronously * Applicable only if transactionUseDistributor is true
acquireActionUseJobQueue	bool	{enableAtomicCommit} == true	false		Whether to use GS2-JobQueue to execute the acquire action * Applicable only if enableAtomicCommit is true
distributorNamespaceId	string		“grn:gs2:{region}:{ownerId}:distributor:default”	~ 1024 chars	GS2-Distributor Namespace GRN used to execute transactions
queueNamespaceId	string		“grn:gs2:{region}:{ownerId}:queue:default”	~ 1024 chars	GS2-JobQueue Namespace GRN used to execute transactions

ScriptSetting

Script Setting

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’s execution results to halt API execution or control the API’s response content.

In contrast, asynchronous execution does not block processing until the script has finished executing. However, because the script result cannot be used to stop the API execution or modify the API response, asynchronous execution does not affect the API response flow and 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.

Type

Condition

Required

Default

Value Limits

Description

triggerScriptId

string

~ 1024 chars

GS2-Script script GRN executed synchronously when the API is executed

Must be specified in GRN format starting with “grn:gs2:”.

doneTriggerTargetType

String Enum
enum {
  “none”,
  “gs2_script”,
  “aws”
}

“none”

How to execute asynchronous scripts

Specifies the type of script to use for asynchronous execution.
You can choose from “Do not use asynchronous execution (none)”, “Use GS2-Script (gs2_script)”, and “Use Amazon EventBridge (aws)”.

Definition	Description
“none”	None
“gs2_script”	GS2-Script
“aws”	Amazon EventBridge

doneTriggerScriptId

string

{doneTriggerTargetType} == “gs2_script”

~ 1024 chars

GS2-Script script GRN for asynchronous execution

Must be specified in GRN format starting with “grn:gs2:”.

* Applicable only if doneTriggerTargetType is “gs2_script”

doneTriggerQueueNamespaceId

string

{doneTriggerTargetType} == “gs2_script”

~ 1024 chars

GS2-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 are not many cases where GS2-JobQueue is required, so you generally do not need to specify it unless you have a specific reason.

* Applicable only if doneTriggerTargetType is “gs2_script”

LogSetting

Log Output Setting

Log Output Setting defines how log data is exported. 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, debugging, and other operational purposes.

	Type	Condition	Required	Default	Value Limits	Description
loggingNamespaceId	string		✓		~ 1024 chars	GS2-Log namespace GRN to output logs Must be specified in GRN format starting with “grn:gs2:”.