GS2-Deploy/CDK Reference of GS2-SeasonRating

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

Entity

Resources operated in Deploy process

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.

	Type	Required	Default	Value Limits	Description
namespaceId	string	✓		~ 1024 chars	Namespace GRN
name	string	✓		~ 128 chars	Namespace name
description	string			~ 1024 chars	Description
transactionSetting	TransactionSetting	✓			Transaction settings
logSetting	LogSetting				Log output settings
createdAt	long	✓	Now		Datetime of creation Unix time, milliseconds Automatically configured on the server
updatedAt	long	✓	Now		Datetime of last update Unix time, milliseconds Automatically configured on the server
revision	long		0	0 ~ 9223372036854775805	Revision

GetAttr

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

	Type	Description
Item	Namespace	Namespace created

Implementation Example

Type: GS2::SeasonRating::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSetting: 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/seasonRating"
    "github.com/openlyinc/pointy"
)

SampleStack := core.NewStack()
seasonRating.NewNamespace(
    &SampleStack,
    "namespace-0001",
    seasonRating.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\SeasonRating\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\SeasonRating\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.seasonRating.model.Namespace(
                this,
                "namespace-0001",
                new io.gs2.cdk.seasonRating.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.Gs2SeasonRating.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: new Gs2Cdk.Gs2SeasonRating.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 seasonRating from "@/gs2cdk/seasonRating";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new seasonRating.model.Namespace(
            this,
            "namespace-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, season_rating

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        season_rating.Namespace(
            stack=self,
            name='namespace-0001',
            options=season_rating.NamespaceOptions(
                log_setting=core.LogSetting(
                    logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
                ),
            ),
        )

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

TransactionSetting

Transaction settings

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

	Type	Condition	Required	Default	Value Limits	Description
enableAtomicCommit	bool		✓	false		Whether to commit the execution of transactions atomically
transactionUseDistributor	bool	{enableAtomicCommit} == true	✓*	false		Whether to execute transactions asynchronously * Required if enableAtomicCommit is true
commitScriptResultInUseDistributor	bool	{transactionUseDistributor} == true	✓*	false		Whether to execute the commit processing of the script result asynchronously * Required if transactionUseDistributor is true
acquireActionUseJobQueue	bool	{enableAtomicCommit} == true	✓*	false		Whether to use GS2-JobQueue to execute the acquire action * Required if enableAtomicCommit is true
distributorNamespaceId	string		✓	“grn:gs2:{region}:{ownerId}:distributor:default”	~ 1024 chars	GS2-Distributor namespace used for transaction execution
queueNamespaceId	string		✓	“grn:gs2:{region}:{ownerId}:queue:default”	~ 1024 chars	Namespace in GS2-JobQueue used to run the transaction

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.

	Type	Condition	Required	Default	Value Limits	Description
loggingNamespaceId	string		✓		~ 1024 chars	GS2-Log namespace GRN to output logs

CurrentSeasonModelMaster

Currently Available Master Data

GS2 uses JSON format files for managing master data. By uploading these files, the master data settings are updated on the server.

To create JSON files, GS2 provides a master data editor within the management console. Additionally, you can create tools better suited for operating your game and export JSON files in the appropriate format.

Note

Please refer to Master Data Reference of GS2-SeasonRating for the JSON file format.

	Type	Condition	Required	Default	Value Limits	Description
namespaceId	string		✓		~ 1024 chars	Namespace GRN
settings	string		✓		~ 5242880 bytes (5MB)	Master Data

GetAttr

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

	Type	Description
Item	CurrentSeasonModelMaster	Updated and currently available rating master

Implementation Example

Type: GS2::SeasonRating::CurrentSeasonModelMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  Settings: {
    "version": "2024-02-23",
    "seasonModels": [
      {
        "name": "season1",
        "tiers": [
          {
            "raiseRankBonus": 0,
            "entryFee": 0,
            "minimumChangePoint": -10,
            "maximumChangePoint": 20
          },
          {
            "raiseRankBonus": 30,
            "entryFee": 10,
            "minimumChangePoint": -10,
            "maximumChangePoint": 30
          },
          {
            "raiseRankBonus": 60,
            "entryFee": 20,
            "minimumChangePoint": -20,
            "maximumChangePoint": 50
          },
          {
            "raiseRankBonus": 60,
            "entryFee": 30,
            "minimumChangePoint": -30,
            "maximumChangePoint": 60
          }
        ],
        "experienceModelId": "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
        "challengePeriodEventId": "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001"
      }
    ]
  }
  UploadToken: null

import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/seasonRating"
    "github.com/openlyinc/pointy"
)

SampleStack := core.NewStack()
seasonRating.NewNamespace(
    &SampleStack,
    "namespace-0001",
    seasonRating.NamespaceOptions{},
).MasterData(
    []seasonRating.SeasonModel{
        seasonRating.NewSeasonModel(
            "season1",
            []seasonRating.TierModel{
                seasonRating.NewTierModel(
                    0,
                    0,
                    -10,
                    20,
                    seasonRating.TierModelOptions{},
                ),
                seasonRating.NewTierModel(
                    30,
                    10,
                    -10,
                    30,
                    seasonRating.TierModelOptions{},
                ),
                seasonRating.NewTierModel(
                    60,
                    20,
                    -20,
                    50,
                    seasonRating.TierModelOptions{},
                ),
                seasonRating.NewTierModel(
                    60,
                    30,
                    -30,
                    60,
                    seasonRating.TierModelOptions{},
                ),
            },
            "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
            seasonRating.SeasonModelOptions{
                ChallengePeriodEventId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001"),
            },
        ),
    },
)

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

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\SeasonRating\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
                new \Gs2Cdk\SeasonRating\Model\SeasonModel(
                    name:"season1",
                    tiers:[
                        new \Gs2Cdk\SeasonRating\Model\TierModel(
                            raiseRankBonus: 0,
                            entryFee: 0,
                            minimumChangePoint: -10,
                            maximumChangePoint: 20,    
                        ),
                        new \Gs2Cdk\SeasonRating\Model\TierModel(
                            raiseRankBonus: 30,
                            entryFee: 10,
                            minimumChangePoint: -10,
                            maximumChangePoint: 30,    
                        ),
                        new \Gs2Cdk\SeasonRating\Model\TierModel(
                            raiseRankBonus: 60,
                            entryFee: 20,
                            minimumChangePoint: -20,
                            maximumChangePoint: 50,    
                        ),
                        new \Gs2Cdk\SeasonRating\Model\TierModel(
                            raiseRankBonus: 60,
                            entryFee: 30,
                            minimumChangePoint: -30,
                            maximumChangePoint: 60,    
                        ),
                    ],
                    experienceModelId:"grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
                    options: new \Gs2Cdk\SeasonRating\Model\Options\SeasonModelOptions(
                        challengePeriodEventId:"grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001"
                    )
                )
            ]
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.seasonRating.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.seasonRating.model.SeasonModel(
                    "season1",
                    Arrays.asList(
                        new io.gs2.cdk.seasonRating.model.TierModel(
                            0,
                            0,
                            -10,
                            20        
                        ),
                        new io.gs2.cdk.seasonRating.model.TierModel(
                            30,
                            10,
                            -10,
                            30        
                        ),
                        new io.gs2.cdk.seasonRating.model.TierModel(
                            60,
                            20,
                            -20,
                            50        
                        ),
                        new io.gs2.cdk.seasonRating.model.TierModel(
                            60,
                            30,
                            -30,
                            60        
                        )
                    ),
                    "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
                    new io.gs2.cdk.seasonRating.model.options.SeasonModelOptions()
                        .withChallengePeriodEventId("grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001")
                )
            )
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2SeasonRating.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2SeasonRating.Model.SeasonModel[] {
                new Gs2Cdk.Gs2SeasonRating.Model.SeasonModel(
                    name: "season1",
                    tiers: new Gs2Cdk.Gs2SeasonRating.Model.TierModel[]
                    {
                        new Gs2Cdk.Gs2SeasonRating.Model.TierModel(
                            raiseRankBonus: 0,
                            entryFee: 0,
                            minimumChangePoint: -10,
                            maximumChangePoint: 20    
                        ),
                        new Gs2Cdk.Gs2SeasonRating.Model.TierModel(
                            raiseRankBonus: 30,
                            entryFee: 10,
                            minimumChangePoint: -10,
                            maximumChangePoint: 30    
                        ),
                        new Gs2Cdk.Gs2SeasonRating.Model.TierModel(
                            raiseRankBonus: 60,
                            entryFee: 20,
                            minimumChangePoint: -20,
                            maximumChangePoint: 50    
                        ),
                        new Gs2Cdk.Gs2SeasonRating.Model.TierModel(
                            raiseRankBonus: 60,
                            entryFee: 30,
                            minimumChangePoint: -30,
                            maximumChangePoint: 60    
                        )
                    },
                    experienceModelId: "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
                    options: new Gs2Cdk.Gs2SeasonRating.Model.Options.SeasonModelOptions
                    {
                        challengePeriodEventId = "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001"
                    }
                )
            }
        );
    }
}

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

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new seasonRating.model.Namespace(
            this,
            "namespace-0001",
        ).masterData(
            [
                new seasonRating.model.SeasonModel(
                    "season1",
                    [
                        new seasonRating.model.TierModel(
                            0,
                            0,
                            -10,
                            20        
                        ),
                        new seasonRating.model.TierModel(
                            30,
                            10,
                            -10,
                            30        
                        ),
                        new seasonRating.model.TierModel(
                            60,
                            20,
                            -20,
                            50        
                        ),
                        new seasonRating.model.TierModel(
                            60,
                            30,
                            -30,
                            60        
                        ),
                    ],
                    "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
                    {
                        challengePeriodEventId: "grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001"
                    }
                )
            ]
        );
    }
}

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

from gs2_cdk import Stack, core, season_rating

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        season_rating.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            season_models=[
                season_rating.SeasonModel(
                    name='season1',
                    tiers=[
                        season_rating.TierModel(
                            raise_rank_bonus=0,
                            entry_fee=0,
                            minimum_change_point=-10,
                            maximum_change_point=20,        
                        ),
                        season_rating.TierModel(
                            raise_rank_bonus=30,
                            entry_fee=10,
                            minimum_change_point=-10,
                            maximum_change_point=30,        
                        ),
                        season_rating.TierModel(
                            raise_rank_bonus=60,
                            entry_fee=20,
                            minimum_change_point=-20,
                            maximum_change_point=50,        
                        ),
                        season_rating.TierModel(
                            raise_rank_bonus=60,
                            entry_fee=30,
                            minimum_change_point=-30,
                            maximum_change_point=60,        
                        ),
                    ],
                    experience_model_id='grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level',
                    options=season_rating.SeasonModelOptions(
                        challenge_period_event_id = 'grn:gs2:ap-northeast-1:YourOwnerId:schedule:namespace-0001:event:event-0001'
                    ),
                ),
            ],
        )

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

SeasonModel

Season Model

GS2 uses Glicko-2 as its rating algorithm. Glicko-2 has several parameters, but GS2-Matchmaking aggregates them into a single parameter, volatility, which represents the totality of the parameters. Volatility is a parameter that expresses the magnitude of change; the larger the value, the greater the change in the rating value.

	Type	Required	Value Limits	Description
seasonModelId	string	✓	~ 1024 chars	Season Model GRN
name	string	✓	~ 128 chars	Season Model Name
metadata	string		~ 128 chars	Metadata
tiers	List<TierModel>	✓	1 ~ 100 items	List of Tier
experienceModelId	string	✓	~ 1024 chars	Experience Model GRN
challengePeriodEventId	string		~ 1024 chars	GS2-Schedule event GRN that sets the period during which the season is open.

TierModel

Tier Model

	Type	Required	Value Limits	Description
metadata	string		~ 128 chars	Metadata
raiseRankBonus	int	✓	0 ~ 10000	The bonus points added to prevent immediate rank demotion when the rank is promoted.
entryFee	int	✓	0 ~ 10000	Points to be subtracted as an entry fee to start the game.
minimumChangePoint	int	✓	-99999999 ~ -1	Change point minimum value when losing
maximumChangePoint	int	✓	1 ~ 99999999	Change point maximum value when winning