GS2-Deploy/CDK Reference of GS2-Limit

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

Entities

Namespace

Namespace

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

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

TypeConditionRequireDefaultLimitationDescription
namestring
~ 128 charsNamespace name
descriptionstring~ 1024 charsDescription
transactionSettingTransactionSettingTransaction settings
logSettingLogSettingLog output settings

GetAttr

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

TypeDescription
ItemNamespaceNamespace created

Implementation Example

Type: GS2::Limit::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/limit"
    "github.com/openlyinc/pointy"
)

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

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

class SampleStack(Stack):

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

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

CurrentLimitMaster

Currently available master data

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

We provide a master data editor on the management console as a way to create JSON files, but you can also use the service by creating a tool that is more suitable for game operation and writing out a JSON file in the appropriate format.

TypeConditionRequireDefaultLimitationDescription
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
If mode is “direct”, then required
uploadTokenstring{mode} == “preUpload”
~ 1024 charsToken used to reflect results after upload
If mode is “preUpload”, then required

GetAttr

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

TypeDescription
ItemCurrentLimitMasterUpdated, currently available limit settings

Implementation Example

Type: GS2::Limit::CurrentLimitMaster
Properties:
  NamespaceName: namespace-0001
  Mode: null
  Settings: {
    "version": "2019-04-05",
    "limitModels": [
      {
        "name": "daily",
        "resetType": "daily",
        "metadata": "DAILY",
        "resetHour": 9
      },
      {
        "name": "weekly",
        "resetType": "weekly",
        "metadata": "WEEKLY",
        "resetDayOfWeek": "sunday",
        "resetHour": 18
      }
    ]
  }
  UploadToken: null
import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/limit"
    "github.com/openlyinc/pointy"
)

SampleStack := core.NewStack()
limit.NewNamespace(
    &SampleStack,
    "namespace-0001",
    limit.NamespaceOptions{},
).MasterData(
    []limit.LimitModel{
        limit.NewLimitModel(
            "daily",
            limit.LimitModelResetTypeDaily,
            limit.LimitModelOptions{
                Metadata: pointy.String("DAILY"),
                ResetHour: pointy.Int32(9),
            },
        ),
        limit.NewLimitModel(
            "weekly",
            limit.LimitModelResetTypeWeekly,
            limit.LimitModelOptions{
                Metadata: pointy.String("WEEKLY"),
                ResetDayOfWeek: limit.LimitModelResetDayOfWeekSunday.Pointer(),
                ResetHour: pointy.Int32(18),
            },
        ),
    },
)

println(SampleStack.Yaml())  // Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Limit\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
                new \Gs2Cdk\Limit\Model\LimitModel(
                    name:"daily",
                    resetType: \Gs2Cdk\Limit\Model\Enums\LimitModelResetType::DAILY,
                    options: new \Gs2Cdk\Limit\Model\Options\LimitModelOptions(
                        metadata:"DAILY",
                        resetHour:9
                    )
                ),
                new \Gs2Cdk\Limit\Model\LimitModel(
                    name:"weekly",
                    resetType: \Gs2Cdk\Limit\Model\Enums\LimitModelResetType::WEEKLY,
                    options: new \Gs2Cdk\Limit\Model\Options\LimitModelOptions(
                        metadata:"WEEKLY",
                        resetDayOfWeek:Gs2Cdk\Limit\Model\Enums\LimitModelResetDayOfWeek::SUNDAY,
                        resetHour:18
                    )
                )
            ]
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.limit.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.limit.model.LimitModel(
                    "daily",
                    io.gs2.cdk.limit.model.enums.LimitModelResetType.DAILY,
                    new io.gs2.cdk.limit.model.options.LimitModelOptions()
                        .withMetadata("DAILY")
                        .withResetHour(9)
                ),
                new io.gs2.cdk.limit.model.LimitModel(
                    "weekly",
                    io.gs2.cdk.limit.model.enums.LimitModelResetType.WEEKLY,
                    new io.gs2.cdk.limit.model.options.LimitModelOptions()
                        .withMetadata("WEEKLY")
                        .withResetDayOfWeek(io.gs2.cdk.limit.model.enums.LimitModelResetDayOfWeek.SUNDAY)
                        .withResetHour(18)
                )
            )
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Limit.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2Limit.Model.LimitModel[] {
                new Gs2Cdk.Gs2Limit.Model.LimitModel(
                    name: "daily",
                    resetType: Gs2Cdk.Gs2Limit.Model.Enums.LimitModelResetType.Daily,
                    options: new Gs2Cdk.Gs2Limit.Model.Options.LimitModelOptions
                    {
                        metadata = "DAILY",
                        resetHour = 9
                    }
                ),
                new Gs2Cdk.Gs2Limit.Model.LimitModel(
                    name: "weekly",
                    resetType: Gs2Cdk.Gs2Limit.Model.Enums.LimitModelResetType.Weekly,
                    options: new Gs2Cdk.Gs2Limit.Model.Options.LimitModelOptions
                    {
                        metadata = "WEEKLY",
                        resetDayOfWeek = Gs2Cdk.Gs2Limit.Model.Enums.LimitModelResetDayOfWeek.Sunday,
                        resetHour = 18
                    }
                )
            }
        );
    }
}

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new limit.model.Namespace(
            this,
            "namespace-0001",
        ).masterData(
            [
                new limit.model.LimitModel(
                    "daily",
                    limit.model.LimitModelResetType.DAILY,
                    {
                        metadata: "DAILY",
                        resetHour: 9
                    }
                ),
                new limit.model.LimitModel(
                    "weekly",
                    limit.model.LimitModelResetType.WEEKLY,
                    {
                        metadata: "WEEKLY",
                        resetDayOfWeek: limit.model.LimitModelResetDayOfWeek.SUNDAY,
                        resetHour: 18
                    }
                )
            ]
        );
    }
}

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

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        limit.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            limit_models=[
                limit.LimitModel(
                    name='daily',
                    reset_type=limit.LimitModelResetType.DAILY,
                    options=limit.LimitModelOptions(
                        metadata = 'DAILY',
                        reset_hour = 9
                    ),
                ),
                limit.LimitModel(
                    name='weekly',
                    reset_type=limit.LimitModelResetType.WEEKLY,
                    options=limit.LimitModelOptions(
                        metadata = 'WEEKLY',
                        reset_day_of_week = limit.LimitModelResetDayOfWeek.SUNDAY,
                        reset_hour = 18
                    ),
                ),
            ],
        )

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

GitHubCheckoutSetting

Setup to check out master data from GitHub

TypeConditionRequireDefaultLimitationDescription
apiKeyIdstring
~ 1024 charsGitHub API key GRN
repositoryNamestring
~ 1024 charsRepository Name
sourcePathstring
~ 1024 charsSource code 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
If referenceType is “commit_hash”, then required
branchNamestring{referenceType} == “branch”
~ 1024 charsBranch Name
If referenceType is “branch”, then required
tagNamestring{referenceType} == “tag”
~ 1024 charsTag Name
If referenceType is “tag”, then required

LogSetting

Log setting

This type manages log output settings. This type holds the identifier of the log namespace used to output log data. The log namespace ID specifies the GS2-Log namespace to aggregate and store the log data. Through this setting, API request and response log data under this namespace will be output to the target GS2-Log. GS2-Log provides logs in real time, which can be used for system monitoring, analysis, debugging, etc.

TypeConditionRequireDefaultLimitationDescription
loggingNamespaceIdstring
~ 1024 charsGS2-Log namespace GRN to output logs

TransactionSetting

Transaction settings

TypeConditionRequireDefaultLimitationDescription
enableAutoRunbool
falseWhether to automatically execute issued transactions on the server side
enableAtomicCommitbool{enableAutoRun} == true
falseWhether to commit the execution of transactions atomically
If enableAutoRun is true, then required
transactionUseDistributorbool{enableAtomicCommit} == true
falseWhether to execute transactions asynchronously
If enableAtomicCommit is true, then required
acquireActionUseJobQueuebool{enableAtomicCommit} == true
falseWhether to use GS2-JobQueue to execute the acquire action
If enableAtomicCommit is true, then required
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