GS2-Deploy/CDK Reference of GS2-Formation

Entities

Namespace

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

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

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

GetAttr

	Type	Description
Item	Namespace	Namespace created

Implementation Example

Type: GS2::Formation::Namespace
Properties:
  Name: namespace1
  Description: null
  TransactionSetting: 
    EnableAutoRun: false
    QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
    KeyId: grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001
  UpdateMoldScript: null
  UpdateFormScript: null
  UpdatePropertyFormScript: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1

from gs2_cdk import Stack, core, formation

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        formation.Namespace(
            stack=self,
            name="namespace-0001",
            options=formation.NamespaceOptions(
                transaction_setting=core.TransactionSetting(
                    queue_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001',
                    options=core.TransactionSettingOptions(
                        enable_atomic_commit=,
                        transaction_use_distributor=,
                        acquire_action_use_job_queue=,
                        key_id='grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001',
                    )
                ),
                log_setting=core.LogSetting(
                    logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
                ),
            ),
        )

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

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        new \Gs2Cdk\Formation\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\Formation\Model\Options\NamespaceOptions(
                transactionSetting: new \Gs2Cdk\Core\Model\TransactionSetting(
                    enableAutoRun: True,
                    queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
                    options: new \Gs2Cdk\Core\Model\Options\TransactionSettingOptions(
                        enableAtomicCommit: ,
                        transactionUseDistributor: ,
                        acquireActionUseJobQueue: ,
                        keyId: "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
                    )
                ),
                logSetting: new \Gs2Cdk\Core\Model\LogSetting(
                    loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            )
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.formation.model.Namespace(
            this,
            "namespace-0001",
            new io.gs2.cdk.formation.model.options.NamespaceOptions() {
                {
                    transactionSetting = new io.gs2.cdk.core.model.TransactionSetting(){
                        {
                            queueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001";
                        },
                        new io.gs2.cdk.core.model.options.TransactionSettingOptions(
                            ,
                            ,
                            ,
                            "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
                        )
                    );
                    logSetting = new io.gs2.cdk.core.model.LogSetting(
                        loggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                    );
                }
            }
        );
    }
}

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

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new formation.model.Namespace(
            this,
            "namespace-0001",
            {
                transactionSetting: new core.TransactionSetting(
                    ,
                    "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
                    {
                        ,
                        ,
                        ,
                        "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
                    }
                ),
                logSetting: new core.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Formation.Model.Namespace(
            this,
            "namespace-0001",
            new Gs2Cdk.Gs2Formation.Model.Options.NamespaceOptions {
                transactionSetting = new Gs2Cdk.Core.Model.TransactionSetting(
                    new Gs2Cdk.Core.Model.Options.TransactionSettingOptions {
                        queueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
                    },
                    new Gs2Cdk.Core.Model.Options.TransactionSettingOptions(
                        EnableAtomicCommit = ,
                        TransactionUseDistributor = ,
                        AcquireActionUseJobQueue = ,
                        KeyId = "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
                    }
                ),
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    LoggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

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

CurrentFormMaster

Currently available master data

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

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

Note

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

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

GetAttr

	Type	Description
Item	CurrentFormMaster	Updated and currently available form settings

Implementation Example

Type: GS2::Formation::CurrentFormMaster
Properties:
  NamespaceName: namespace1
  Settings: {
    "version": "2019-09-09",
    "moldModels": [
      {
        "name": "party",
        "initialMaxCapacity": 10,
        "maxCapacity": 20,
        "formModel":
          {
            "name": "party",
            "metadata": "PARTY",
            "slots": [
              {
                "name": "tank",
                "metadata": "TANK",
                "propertyRegex": "grn:.*"
              },
              {
                "name": "healer",
                "metadata": "HEALER",
                "propertyRegex": "grn:.*"
              },
              {
                "name": "dps_1",
                "metadata": "DPS",
                "propertyRegex": "grn:.*"
              },
              {
                "name": "dps_2",
                "metadata": "DPS",
                "propertyRegex": "grn:.*"
              }
            ]
          },
        "metadata": "PARTY"
      },
      {
        "name": "equipment",
        "initialMaxCapacity": 20,
        "maxCapacity": 30,
        "formModel":
          {
            "name": "equipment",
            "metadata": "EQUIPMENT",
            "slots": [
              {
                "name": "head",
                "metadata": "HEAD",
                "propertyRegex": "grn:.*"
              },
              {
                "name": "body",
                "metadata": "BODY",
                "propertyRegex": "grn:.*"
              },
              {
                "name": "leg",
                "metadata": "LEG",
                "propertyRegex": "grn:.*"
              }
            ]
          },
        "metadata": "EQUIPMENT"
      }
    ],
    "propertyFormModels": 
    
  }

from gs2_cdk import Stack, core, formation

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        formation.Namespace(
            stack=self,
            # omission
        ).master_data(
            mold_models=[
                formation.MoldModel(
                    name='party',
                    initial_max_capacity=10,
                    max_capacity=20,
                    form_model=formation.FormModel(
                            name='party',
                            metadata='PARTY',
                            slots=[
                                formation.SlotModel(
                                    name='tank',
                                    metadata='TANK',
                                    property_regex='grn:.*'
                                ),
                                formation.SlotModel(
                                    name='healer',
                                    metadata='HEALER',
                                    property_regex='grn:.*'
                                ),
                                formation.SlotModel(
                                    name='dps_1',
                                    metadata='DPS',
                                    property_regex='grn:.*'
                                ),
                                formation.SlotModel(
                                    name='dps_2',
                                    metadata='DPS',
                                    property_regex='grn:.*'
                                )
                            ]
                        ),
                    options=formation.MoldModelOptions(
                        metadata='PARTY',
                    ),
                ),
                formation.MoldModel(
                    name='equipment',
                    initial_max_capacity=20,
                    max_capacity=30,
                    form_model=formation.FormModel(
                            name='equipment',
                            metadata='EQUIPMENT',
                            slots=[
                                formation.SlotModel(
                                    name='head',
                                    metadata='HEAD',
                                    property_regex='grn:.*'
                                ),
                                formation.SlotModel(
                                    name='body',
                                    metadata='BODY',
                                    property_regex='grn:.*'
                                ),
                                formation.SlotModel(
                                    name='leg',
                                    metadata='LEG',
                                    property_regex='grn:.*'
                                )
                            ]
                        ),
                    options=formation.MoldModelOptions(
                        metadata='EQUIPMENT',
                    ),
                ),
            ],
            property_form_models=[
            ],
        )

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

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Formation\Model\Namespace_(
            stack: $this,
            // omission
        ))->masterData(
            [
                new \Gs2Cdk\Formation\Model\MoldModel(
                    name:"party",
                    initialMaxCapacity:10,
                    maxCapacity:20,
                    formModel:new \Gs2Cdk\Formation\Model\FormModel(
                        name: "party",
                        metadata: "PARTY",
                        slots: [
                            new \Gs2Cdk\Formation\Model\SlotModel(
                                name: "tank",
                                metadata: "TANK",
                                propertyRegex: "grn:.*"
                            ),
                            new \Gs2Cdk\Formation\Model\SlotModel(
                                name: "healer",
                                metadata: "HEALER",
                                propertyRegex: "grn:.*"
                            ),
                            new \Gs2Cdk\Formation\Model\SlotModel(
                                name: "dps_1",
                                metadata: "DPS",
                                propertyRegex: "grn:.*"
                            ),
                            new \Gs2Cdk\Formation\Model\SlotModel(
                                name: "dps_2",
                                metadata: "DPS",
                                propertyRegex: "grn:.*"
                            )
                        ]
                    ),
                    options: new \Gs2Cdk\Formation\Model\Options\MoldModelOptions(
                        metadata:"PARTY"
                    )
                ),
                new \Gs2Cdk\Formation\Model\MoldModel(
                    name:"equipment",
                    initialMaxCapacity:20,
                    maxCapacity:30,
                    formModel:new \Gs2Cdk\Formation\Model\FormModel(
                        name: "equipment",
                        metadata: "EQUIPMENT",
                        slots: [
                            new \Gs2Cdk\Formation\Model\SlotModel(
                                name: "head",
                                metadata: "HEAD",
                                propertyRegex: "grn:.*"
                            ),
                            new \Gs2Cdk\Formation\Model\SlotModel(
                                name: "body",
                                metadata: "BODY",
                                propertyRegex: "grn:.*"
                            ),
                            new \Gs2Cdk\Formation\Model\SlotModel(
                                name: "leg",
                                metadata: "LEG",
                                propertyRegex: "grn:.*"
                            )
                        ]
                    ),
                    options: new \Gs2Cdk\Formation\Model\Options\MoldModelOptions(
                        metadata:"EQUIPMENT"
                    )
                )
            ],
            [
            ]
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.formation.model.Namespace(
            this,
            // omission
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.formation.model.MoldModel(
                    "party",
                    10,
                    20,
                    new io.gs2.cdk.formation.model.FormModel(
                        "party",
                        "PARTY",
                        Arrays.asList(
                            new io.gs2.cdk.formation.model.SlotModel(
                                "tank",
                                "TANK",
                                "grn:.*"
                            ),
                            new io.gs2.cdk.formation.model.SlotModel(
                                "healer",
                                "HEALER",
                                "grn:.*"
                            ),
                            new io.gs2.cdk.formation.model.SlotModel(
                                "dps_1",
                                "DPS",
                                "grn:.*"
                            ),
                            new io.gs2.cdk.formation.model.SlotModel(
                                "dps_2",
                                "DPS",
                                "grn:.*"
                            )
                        )
                    ),
                    new io.gs2.cdk.formation.model.options.MoldModelOptions() {
                        {
                            metadata: "PARTY";
                        }
                    }
                ),
                new io.gs2.cdk.formation.model.MoldModel(
                    "equipment",
                    20,
                    30,
                    new io.gs2.cdk.formation.model.FormModel(
                        "equipment",
                        "EQUIPMENT",
                        Arrays.asList(
                            new io.gs2.cdk.formation.model.SlotModel(
                                "head",
                                "HEAD",
                                "grn:.*"
                            ),
                            new io.gs2.cdk.formation.model.SlotModel(
                                "body",
                                "BODY",
                                "grn:.*"
                            ),
                            new io.gs2.cdk.formation.model.SlotModel(
                                "leg",
                                "LEG",
                                "grn:.*"
                            )
                        )
                    ),
                    new io.gs2.cdk.formation.model.options.MoldModelOptions() {
                        {
                            metadata: "EQUIPMENT";
                        }
                    }
                )
            ),
            Arrays.asList(
            )
        );
    }
}

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

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new formation.model.Namespace(
            this,
            // omission
        ).masterData(
            [
                new formation.model.MoldModel(
                    "party",
                    10,
                    20,
                    new formation.model.FormModel(
                        "party",
                        "PARTY",
                        new SlotModel[
                            new formation.model.SlotModel(
                                "tank",
                                "TANK",
                                "grn:.*"
                            ),
                            new formation.model.SlotModel(
                                "healer",
                                "HEALER",
                                "grn:.*"
                            ),
                            new formation.model.SlotModel(
                                "dps_1",
                                "DPS",
                                "grn:.*"
                            ),
                            new formation.model.SlotModel(
                                "dps_2",
                                "DPS",
                                "grn:.*"
                            )
                        ]
                    ),
                    {
                        metadata: "PARTY"
                    }
                ),
                new formation.model.MoldModel(
                    "equipment",
                    20,
                    30,
                    new formation.model.FormModel(
                        "equipment",
                        "EQUIPMENT",
                        new SlotModel[
                            new formation.model.SlotModel(
                                "head",
                                "HEAD",
                                "grn:.*"
                            ),
                            new formation.model.SlotModel(
                                "body",
                                "BODY",
                                "grn:.*"
                            ),
                            new formation.model.SlotModel(
                                "leg",
                                "LEG",
                                "grn:.*"
                            )
                        ]
                    ),
                    {
                        metadata: "EQUIPMENT"
                    }
                )
            ],
            [
            ]
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Formation.Model.Namespace(
            this,
            // omission
        ).MasterData(
            new [] {
                new Gs2Cdk.Gs2Formation.Model.MoldModel(
                    "party",
                    10,
                    20,
                    new Gs2Cdk.Gs2Formation.Model.FormModel(
                        name: "party",
                        metadata: "PARTY",
                        slots: new Gs2Cdk.Gs2Formation.Model.SlotModel[] {
                            new Gs2Cdk.Gs2Formation.Model.SlotModel(
                                name: "tank",
                                metadata: "TANK",
                                propertyRegex: "grn:.*"
                            ),
                            new Gs2Cdk.Gs2Formation.Model.SlotModel(
                                name: "healer",
                                metadata: "HEALER",
                                propertyRegex: "grn:.*"
                            ),
                            new Gs2Cdk.Gs2Formation.Model.SlotModel(
                                name: "dps_1",
                                metadata: "DPS",
                                propertyRegex: "grn:.*"
                            ),
                            new Gs2Cdk.Gs2Formation.Model.SlotModel(
                                name: "dps_2",
                                metadata: "DPS",
                                propertyRegex: "grn:.*"
                            )
                        }
                    ),
                    new Gs2Cdk.Gs2Formation.Model.Options.MoldModelOptions {
                        metadata = "PARTY"
                    }
                ),
                new Gs2Cdk.Gs2Formation.Model.MoldModel(
                    "equipment",
                    20,
                    30,
                    new Gs2Cdk.Gs2Formation.Model.FormModel(
                        name: "equipment",
                        metadata: "EQUIPMENT",
                        slots: new Gs2Cdk.Gs2Formation.Model.SlotModel[] {
                            new Gs2Cdk.Gs2Formation.Model.SlotModel(
                                name: "head",
                                metadata: "HEAD",
                                propertyRegex: "grn:.*"
                            ),
                            new Gs2Cdk.Gs2Formation.Model.SlotModel(
                                name: "body",
                                metadata: "BODY",
                                propertyRegex: "grn:.*"
                            ),
                            new Gs2Cdk.Gs2Formation.Model.SlotModel(
                                name: "leg",
                                metadata: "LEG",
                                propertyRegex: "grn:.*"
                            )
                        }
                    ),
                    new Gs2Cdk.Gs2Formation.Model.Options.MoldModelOptions {
                        metadata = "EQUIPMENT"
                    }
                )
            },
            new [] {
            }
        );
    }
}

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

Slot

	Type	Require	Limitation	Description
name	string	✓	~ 128 chars	Slot model name
propertyId	string		~ 1024 chars	Property ID
metadata	string		~ 1024 chars	metadata

SlotModel

Slot Model

	Type	Require	Default	Limitation	Description
name	string	✓		~ 128 chars	Slot model name
propertyRegex	string	✓	“.*”	~ 512 chars	Regular expressions for values that can be set as properties
metadata	string			~ 512 chars	metadata

SlotWithSignature

Signature Slot

	Type	Require	Limitation	Description
name	string	✓	~ 128 chars	Slot model name
propertyType	enum { “gs2_inventory”, “gs2_simple_inventory”, “gs2_dictionary” }	✓	~ 128 chars	Property Type
body	string		~ 1048576 chars	payload
signature	string		~ 1024 chars	Signature that proves ownership of the resource for the property ID
metadata	string		~ 1024 chars	metadata

Enumeration type definition to specify as propertyType

Enumerator String Definition	Description
gs2_inventory	GS2-Inventory::ItemSet
gs2_simple_inventory	GS2-Inventory::SimpleItem
gs2_dictionary	GS2-Dictionary::Entry

AcquireAction

Acquire Action

	Type	Require	Default	Limitation	Description
action	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", "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 chars	Types of actions to be performed in the acquire action
request	string	✓		~ 1048576 chars	JSON of request

Config

Configration

Set values to be applied to transaction variables

	Type	Require	Default	Limitation	Description
key	string	✓		~ 64 chars	Name
value	string			~ 51200 chars	Value

VerifyActionResult

Verify action execution result

	Type	Require	Limitation	Description
action	enum { }	✓	~ 128 chars	Types of actions to be performed in the verify task
verifyRequest	string	✓	~ 1048576 chars	JSON of request
statusCode	int		~ 999	Status code
verifyResult	string		~ 1048576 chars	Result payload

Enumeration type definition to specify as action

Enumerator String Definition	Description

ConsumeActionResult

Consume action execution result

	Type	Require	Limitation	Description
action	enum { }	✓	~ 128 chars	Types of actions to be performed in the consume action
consumeRequest	string	✓	~ 1048576 chars	JSON of request
statusCode	int		~ 999	Status code
consumeResult	string		~ 1048576 chars	Result payload

Enumeration type definition to specify as action

Enumerator String Definition	Description

AcquireActionResult

Acquire action execution result

	Type	Require	Limitation	Description
action	enum { }	✓	~ 128 chars	Types of actions to be performed in the acquire action
acquireRequest	string	✓	~ 1048576 chars	JSON of request
statusCode	int		~ 999	Status code
acquireResult	string		~ 1048576 chars	Result payload

Enumeration type definition to specify as action

Enumerator String Definition	Description

TransactionResult

Transaction execution results

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

	Type	Require	Limitation	Description
transactionId	string	✓	36 ~ 36 chars	Transaction ID
verifyResults	List<VerifyActionResult>		~ 10 items	List of verify action execution results
consumeResults	List<ConsumeActionResult>		~ 10 items	List of consume action execution results
acquireResults	List<AcquireActionResult>		~ 100 items	List of acquire action execution results

GitHubCheckoutSetting

Setup to check out master data from GitHub

	Type	Require	Limitation	Description
apiKeyId	string	✓	~ 1024 chars	GitHub API key GRN
repositoryName	string	✓	~ 1024 chars	Repository Name
sourcePath	string	✓	~ 1024 chars	Source code file path
referenceType	enum { “commit_hash”, “branch”, “tag” }	✓	~ 128 chars	Source of code
commitHash	string	{referenceType} == “commit_hash”	~ 1024 chars	Commit hash
branchName	string	{referenceType} == “branch”	~ 1024 chars	Branch Name
tagName	string	{referenceType} == “tag”	~ 1024 chars	Tag Name

Enumeration type definition to specify as referenceType

Enumerator String Definition	Description
commit_hash	Commit hash
branch	Branch
tag	Tag

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.

On the other hand, asynchronous execution does not block 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. However, asynchronous execution does not block processing until the script has finished executing, so it is generally recommended to use asynchronous execution.

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	Require	Default	Limitation	Description
triggerScriptId	string			~ 1024 chars	Script GRN
doneTriggerTargetType	enum { “none”, “gs2_script”, “aws” }	✓	“none”	~ 128 chars	Notification of Completion
doneTriggerScriptId	string	{doneTriggerTargetType} == “gs2_script”		~ 1024 chars	Script GRN
doneTriggerQueueNamespaceId	string	{doneTriggerTargetType} == “gs2_script”		~ 1024 chars	Namespace GRN

Enumeration type definition to specify as doneTriggerTargetType

Enumerator String Definition	Description
none	None
gs2_script	GS2-Script
aws	Amazon EventBridge

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.

	Type	Require	Default	Limitation	Description
loggingNamespaceId	string	✓		~ 1024 chars	Namespace GRN

TransactionSetting

Transaction settings

	Type	Require	Default	Limitation	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
transactionUseDistributor	bool	{enableAtomicCommit} == true	false		Whether to execute transactions asynchronously
acquireActionUseJobQueue	bool	{enableAtomicCommit} == true	false		Whether to use GS2-JobQueue to execute the acquire action
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