GS2-Distributor
Reference to resource definitions available in GS2-Deploy templates
GS2-Deploy Reference
Entities
Namespace
Namespace
Type: GS2::Distributor::Namespace
Properties:
Name: namespace1
Description: null
AssumeUserId: grn:gs2::YourOwnerId:identifier:user:user-0001
AutoRunStampSheetNotification: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
from gs2_cdk import Stack, core, distributor
class SampleStack(Stack):
def __init__(self):
super().__init__()
distributor.Namespace(
stack=self,
name="namespace-0001",
options=distributor.NamespaceOptions(
assume_user_id='grn:gs2::YourOwnerId:identifier:user:user-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\Distributor\Model\Namespace_(
stack: $this,
name: "namespace-0001",
options: new \Gs2Cdk\Distributor\Model\Options\NamespaceOptions(
assumeUserId: "grn:gs2::YourOwnerId:identifier:user:user-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.distributor.model.Namespace(
this,
"namespace-0001",
new io.gs2.cdk.distributor.model.options.NamespaceOptions() {
{
assumeUserId = "grn:gs2::YourOwnerId:identifier:user:user-0001";
logSetting = new io.gs2.cdk.core.model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
);
}
}
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
import core from "@/gs2cdk/core";
import distributor from "@/gs2cdk/distributor";
class SampleStack extends core.Stack
{
public constructor() {
super();
new distributor.model.Namespace(
this,
"namespace-0001",
{
assumeUserId: "grn:gs2::YourOwnerId:identifier:user:user-0001",
logSetting: new core.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.Gs2Distributor.Model.Namespace(
this,
"namespace-0001",
new Gs2Cdk.Gs2Distributor.Model.Options.NamespaceOptions {
assumeUserId = "grn:gs2::YourOwnerId:identifier:user:user-0001",
logSetting = new Gs2Cdk.Core.Model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
),
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
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 | Default | Limitation | Description | |
---|---|---|---|---|---|
name | string | ✓ | ~ 32 chars | Namespace name | |
description | string | ~ 1024 chars | description of Namespace | ||
assumeUserId | string | ~ 1024 chars | User GRN | ||
autoRunStampSheetNotification | NotificationSetting | Push notification when stamp sheet auto-execution is complete | |||
logSetting | LogSetting | Log output settings |
CurrentDistributorMaster
CurrentDistributorMaster
Type: GS2::Distributor::CurrentDistributorMaster
Properties:
NamespaceName: namespace1
Settings: {
"version": "2019-03-01",
"distributorModels": [
{
"name": "basic",
"metadata": "BASIC",
"inboxNamespaceId": "grn:gs2:ap-northeast-1:YourOwnerId:inbox:inbox-0001"
},
{
"name": "special",
"metadata": "SPECIAL",
"inboxNamespaceId": "grn:gs2:ap-northeast-1:YourOwnerId:inbox:inbox-0001",
"whiteListTargetIds": [
"test"
]
}
]
}
from gs2_cdk import Stack, core, distributor
class SampleStack(Stack):
def __init__(self):
super().__init__()
distributor.Namespace(
stack=self,
# omission
).master_data(
[
distributor.DistributorModel(
name='basic',
options=distributor.DistributorModelOptions(
metadata='BASIC',
inbox_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:inbox:inbox-0001',
),
),
distributor.DistributorModel(
name='special',
options=distributor.DistributorModelOptions(
metadata='SPECIAL',
inbox_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:inbox:inbox-0001',
white_list_target_ids=[ 'test',
],
),
),
],
)
print(SampleStack().yaml()) # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
(new \Gs2Cdk\Distributor\Model\Namespace_(
stack: $this,
// omission
))->masterData(
[
new \Gs2Cdk\Distributor\Model\DistributorModel(
name:"basic",
options: new \Gs2Cdk\Distributor\Model\Options\DistributorModelOptions(
metadata:"BASIC",
inboxNamespaceId:"grn:gs2:ap-northeast-1:YourOwnerId:inbox:inbox-0001",
),
),
new \Gs2Cdk\Distributor\Model\DistributorModel(
name:"special",
options: new \Gs2Cdk\Distributor\Model\Options\DistributorModelOptions(
metadata:"SPECIAL",
inboxNamespaceId:"grn:gs2:ap-northeast-1:YourOwnerId:inbox:inbox-0001",
whiteListTargetIds:[ "test",
],
),
),
],
);
}
}
print((new SampleStack())->yaml()); // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.distributor.model.Namespace(
this,
// omission
).masterData(
Arrays.asList(
new io.gs2.cdk.distributor.model.DistributorModel(
"basic",
new io.gs2.cdk.distributor.model.options.DistributorModelOptions() {
{
metadata: "BASIC";
inboxNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:inbox:inbox-0001";
}
}
),
new io.gs2.cdk.distributor.model.DistributorModel(
"special",
new io.gs2.cdk.distributor.model.options.DistributorModelOptions() {
{
metadata: "SPECIAL";
inboxNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:inbox:inbox-0001";
whiteListTargetIds: Arrays.asList(
"test"
);
}
}
)
)
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
import core from "@/gs2cdk/core";
import distributor from "@/gs2cdk/distributor";
class SampleStack extends core.Stack
{
public constructor() {
super();
new distributor.model.Namespace(
this,
// omission
).masterData(
[
new distributor.model.DistributorModel(
"basic",
{
metadata: "BASIC",
inboxNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:inbox:inbox-0001"
}
),
new distributor.model.DistributorModel(
"special",
{
metadata: "SPECIAL",
inboxNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:inbox:inbox-0001",
whiteListTargetIds: [
"test"
]
}
)
]
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Distributor.Model.Namespace(
this,
// omission
).MasterData(
new [] {
new Gs2Cdk.Gs2Distributor.Model.DistributorModel(
"basic",
new Gs2Cdk.Gs2Distributor.Model.Options.DistributorModelOptions {
metadata = "BASIC",
inboxNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:inbox:inbox-0001",
}
),
new Gs2Cdk.Gs2Distributor.Model.DistributorModel(
"special",
new Gs2Cdk.Gs2Distributor.Model.Options.DistributorModelOptions {
metadata = "SPECIAL",
inboxNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:inbox:inbox-0001",
whiteListTargetIds = new string[] {
"test"
},
}
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
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 we also provide a master data editor on the management console as a way to create JSON files.
The service can also be used by creating a tool more appropriate for game management and exporting a JSON file in the appropriate format.
Please refer to the documentation for the format of the JSON file.
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32 chars | Namespace name | |
settings | string | ✓ | ~ 5242880 chars | Master data |