GS2-Limit Deploy/CDK 레퍼런스
GS2-Deploy의 스택을 생성할 때 사용하는 템플릿 포맷과, CDK를 이용한 각종 언어의 템플릿 출력 구현 예제
엔티티
Deploy 처리에서 조작 대상이 되는 리소스
Namespace
네임스페이스
네임스페이스는 하나의 프로젝트 내에서 동일한 서비스를 서로 다른 용도로 여러 개 이용하기 위한 엔티티입니다.
GS2의 각 서비스는 네임스페이스 단위로 관리됩니다. 네임스페이스가 다르면 동일한 서비스라도 완전히 독립된 데이터 공간으로 취급됩니다.
따라서 각 서비스의 이용을 시작하려면 먼저 네임스페이스를 생성해야 합니다.
Request
리소스 생성·갱신 요청
| 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 | |
|---|---|---|---|---|---|---|
| name | string | ✓ | ~ 128자 | 네임스페이스 이름 네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다. | ||
| description | string | ~ 1024자 | 설명문 | |||
| transactionSetting | TransactionSetting | 트랜잭션 설정 카운트업이나 카운터 리셋 등 사용 횟수 제한 조작 시 트랜잭션 처리 방식을 제어하는 설정입니다. | ||||
| countUpScript | ScriptSetting | 카운트업 시 실행할 스크립트 설정 Script 트리거 레퍼런스 - countUp | ||||
| logSetting | LogSetting | 로그 출력 설정 사용 횟수 제한 조작의 API 요청·응답 로그를 출력하기 위한 GS2-Log 네임스페이스를 지정합니다. 디버그나 분석을 위해 카운터의 증가, 리셋, 제한 확인을 추적하는 데 유용합니다. |
GetAttr
!GetAttr 태그로 취득 가능한 리소스 생성 결과
| 타입 | 설명 | |
|---|---|---|
| Item | Namespace | 생성한 네임스페이스 |
구현 예제
Type: GS2::Limit::Namespace
Properties:
Name: namespace-0001
Description: null
TransactionSetting: null
CountUpScript: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001import (
"github.com/gs2io/gs2-golang-cdk/core"
"github.com/gs2io/gs2-golang-cdk/limit"
)
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 Templateclass 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 Templatepublic 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 Templateimport 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 TemplateTransactionSetting
트랜잭션 설정
트랜잭션 설정은 트랜잭션의 실행 방법·정합성·비동기 처리·충돌 회피 메커니즘을 제어하는 설정입니다.
자동 실행(AutoRun), 원자적 실행(AtomicCommit), GS2-Distributor를 이용한 비동기 실행, 스크립트 결과의 일괄 적용, GS2-JobQueue를 통한 입수 액션의 비동기화 등을 조합하여 게임 로직에 맞는 견고한 트랜잭션 관리를 가능하게 합니다.
| 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 | |
|---|---|---|---|---|---|---|
| enableAutoRun | bool | false | 발행한 트랜잭션을 서버 사이드에서 자동으로 실행할지 여부 | |||
| enableAtomicCommit | bool | {enableAutoRun} == true | false | 트랜잭션의 실행을 원자적으로 커밋할지 여부 ※ enableAutoRun이(가) true 이면 활성화 | ||
| transactionUseDistributor | bool | {enableAtomicCommit} == true | false | 트랜잭션을 비동기 처리로 실행할지 여부 ※ enableAtomicCommit이(가) true 이면 활성화 | ||
| commitScriptResultInUseDistributor | bool | {transactionUseDistributor} == true | false | 스크립트의 결과 커밋 처리를 비동기 처리로 실행할지 여부 ※ transactionUseDistributor이(가) true 이면 활성화 | ||
| acquireActionUseJobQueue | bool | {enableAtomicCommit} == true | false | 입수 액션을 실행할 때 GS2-JobQueue를 사용할지 여부 ※ enableAtomicCommit이(가) true 이면 활성화 | ||
| distributorNamespaceId | string | “grn:gs2:{region}:{ownerId}:distributor:default” | ~ 1024자 | 트랜잭션 실행에 사용하는 GS2-Distributor 네임스페이스 GRN | ||
| queueNamespaceId | string | “grn:gs2:{region}:{ownerId}:queue:default” | ~ 1024자 | 트랜잭션 실행에 사용하는 GS2-JobQueue의 네임스페이스 GRN |
ScriptSetting
스크립트 설정
GS2에서는 마이크로서비스의 이벤트에 연결하여 커스텀 스크립트를 실행할 수 있습니다.
이 모델은 스크립트 실행을 트리거하기 위한 설정을 보유합니다.
스크립트 실행 방식은 크게 두 가지로, 바로 “동기 실행"과 “비동기 실행"입니다.
동기 실행은 스크립트 실행이 완료될 때까지 처리가 블록됩니다.
대신 스크립트 실행 결과를 이용하여 API 실행을 중단시키거나 API 응답 내용을 제어할 수 있습니다.
한편, 비동기 실행에서는 스크립트 완료를 기다리기 위해 처리가 블록되는 일이 없습니다.
다만 스크립트 실행 결과를 이용하여 API 실행을 중단하거나 API 응답 내용을 변경할 수는 없습니다.
비동기 실행은 API의 응답 흐름에 영향을 주지 않으므로 원칙적으로 비동기 실행을 권장합니다.
비동기 실행에는 실행 방식이 두 가지 있으며, GS2-Script와 Amazon EventBridge가 있습니다.
Amazon EventBridge를 사용함으로써 Lua 이외의 언어로 처리를 작성할 수 있습니다.
| 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| triggerScriptId | string | ~ 1024자 | API 실행 시 동기적으로 실행되는 GS2-Script의 스크립트
GRN
“grn:gs2:“로 시작하는 GRN 형식의 ID로 지정해야 합니다. | |||||||||||
| doneTriggerTargetType | 문자열 열거형 enum { “none”, “gs2_script”, “aws” } | “none” | 비동기 스크립트의 실행 방법 비동기 실행에서 사용할 스크립트의 종류를 지정합니다. “비동기 실행의 스크립트를 사용하지 않음(none)”, “GS2-Script를 사용함(gs2_script)”, “Amazon EventBridge를 사용함(aws)” 중에서 선택할 수 있습니다.
| |||||||||||
| doneTriggerScriptId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024자 | 비동기 실행할 GS2-Script 스크립트
GRN
“grn:gs2:“로 시작하는 GRN 형식의 ID로 지정해야 합니다. ※ doneTriggerTargetType이(가) “gs2_script” 이면 활성화 | ||||||||||
| doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024자 | 비동기 실행 스크립트를 실행하는 GS2-JobQueue 네임스페이스
GRN
비동기 실행 스크립트를 직접 실행하지 않고 GS2-JobQueue를 경유하는 경우 GS2-JobQueue의 네임스페이스GRN을 지정합니다. GS2-JobQueue를 이용해야 할 이유는 많지 않으므로, 특별한 이유가 없다면 지정할 필요는 없습니다. ※ doneTriggerTargetType이(가) “gs2_script” 이면 활성화 |
LogSetting
로그 출력 설정
로그 데이터의 출력 설정을 관리합니다. 이 타입은 로그 데이터를 출력하기 위해 사용되는 GS2-Log 네임스페이스의 식별자(Namespace ID)를 보관합니다.
로그 네임스페이스ID(loggingNamespaceId)에는 로그 데이터를 수집하여 저장하는 GS2-Log의 네임스페이스를 GRN 형식으로 지정합니다.
이 설정을 하면 설정된 네임스페이스 내에서 발생한 API 요청·응답 로그 데이터가 대상 GS2-Log 네임스페이스 쪽으로 출력됩니다.
GS2-Log에서는 실시간으로 로그가 제공되어 시스템 모니터링, 분석, 디버깅 등에 활용할 수 있습니다.
| 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 | |
|---|---|---|---|---|---|---|
| loggingNamespaceId | string | ✓ | ~ 1024자 | 로그를 출력할 GS2-Log의 네임스페이스
GRN
“grn:gs2:“로 시작하는 GRN 형식의 ID로 지정해야 합니다. |
CurrentLimitMaster
현재 활성화된 사용 횟수 제한 모델의 마스터 데이터
현재 네임스페이스 내에서 유효한 사용 횟수 제한 모델의 정의를 기술한 마스터 데이터입니다.
GS2에서는 마스터 데이터 관리에 JSON 형식의 파일을 사용합니다.
파일을 업로드하면 실제로 서버에 설정을 반영할 수 있습니다.
JSON 파일을 작성하는 방법으로, 매니지먼트 콘솔 내에 마스터 데이터 에디터를 제공하고 있습니다.
또한 게임 운영에 더 적합한 도구를 직접 만들어 적절한 형식의 JSON 파일을 출력하는 방식으로도 서비스를 이용할 수 있습니다.
Note
JSON 파일 형식에 대해서는 GS2-Limit 마스터 데이터 레퍼런스를 참조해 주세요.
Request
리소스 생성·갱신 요청
| 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128자 | 네임스페이스 이름 네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다. | ||||||||
| mode | 문자열 열거형 enum { “direct”, “preUpload” } | “direct” | 업데이트 모드
| |||||||||
| settings | string | {mode} == “direct” | ✓※ | ~ 5242880 바이트 (5MB) | 마스터 데이터 ※ mode이(가) “direct” 이면 필수 | |||||||
| uploadToken | string | {mode} == “preUpload” | ✓※ | ~ 1024자 | 사전 업로드로 획득한 토큰 업로드한 마스터 데이터를 적용하기 위해 사용됩니다. ※ mode이(가) “preUpload” 이면 필수 |
GetAttr
!GetAttr 태그로 취득 가능한 리소스 생성 결과
| 타입 | 설명 | |
|---|---|---|
| Item | CurrentLimitMaster | 갱신된 현재 활성화되어 있는 횟수 제한 모델의 마스터 데이터 |
구현 예제
Type: GS2::Limit::CurrentLimitMaster
Properties:
NamespaceName: namespace-0001
Mode: direct
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: nullimport (
"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 Templateclass 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 Templatepublic 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 Templateimport 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 TemplateLimitModel
횟수 제한 모델
횟수 제한 모델에는 사용 횟수를 리셋하는 타이밍을 설정할 수 있습니다.
리셋 간격은 “매일”, “매주”, “매월”, “리셋하지 않음”, “일정 일수마다” 5가지 중에서 선택할 수 있습니다.
또한, 횟수 제한의 최대값은 마스터 데이터 쪽에서는 고정하지 않습니다.
이는 게임 내 컨텍스트에 따라 허용되는 최대 횟수를 동적으로 변경할 수 있도록 하기 위함입니다.
예를 들어 스텝업 가챠처럼,
- 구매 횟수 카운터가 3회 미만일 때 구매할 수 있는 상품
- 위 상품을 구매할 수 없을 때, 구매 횟수 카운터가 5회 미만이면 구매할 수 있는 다른 상품
과 같이, 상황에 따라 “최대 횟수"를 전환할 수 있는 설계를 상정하고 있습니다.
| 타입 | 활성화 조건 | 필수 | 기본값 | 값 제한 | 설명 | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| limitModelId | string | ※ | ~ 1024자 | 횟수 제한 모델 GRN
※ 서버가 자동으로 설정 | ||||||||||||||||||
| name | string | ✓ | ~ 128자 | 횟수 제한 모델명 횟수 제한 모델 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다. | ||||||||||||||||||
| metadata | string | ~ 2048자 | 메타데이터 메타데이터에는 임의의 값을 설정할 수 있습니다. 이 값들은 GS2의 동작에는 영향을 주지 않으므로, 게임 내에서 사용하는 정보를 저장하는 용도로 사용할 수 있습니다. | |||||||||||||||||||
| resetType | 문자열 열거형 enum { “notReset”, “daily”, “weekly”, “monthly”, “days” } | ✓ | 리셋 타이밍 이 횟수 제한 모델 하위의 카운터 값이 자동으로 0으로 리셋되는 타이밍을 결정합니다. notReset(영구적, 리셋 없음), daily(매일 지정된 시각에 리셋), weekly(지정된 요일에 리셋), monthly(지정된 날짜에 리셋), days(기준 일시로부터 일정 일수마다 리셋) 중에서 선택합니다. 모든 시각은 UTC입니다.
| |||||||||||||||||||
| resetDayOfMonth | int | {resetType} == “monthly” | ✓※ | 1 ~ 31 | 리셋 날짜 resetType이 “monthly"인 경우 카운터가 리셋되는 날짜(일)입니다. 1~31 사이의 값이 유효합니다. 지정한 날짜가 해당 월의 일수를 초과하는 경우(예: 2월의 31일), 해당 월의 마지막 날에 리셋됩니다. ※ resetType이(가) “monthly” 이면 필수 | |||||||||||||||||
| resetDayOfWeek | 문자열 열거형 enum { “sunday”, “monday”, “tuesday”, “wednesday”, “thursday”, “friday”, “saturday” } | {resetType} == “weekly” | ✓※ | 리셋 요일 resetType이 “weekly"인 경우 카운터가 리셋되는 요일입니다. 이 요일의 resetHour(UTC)로 지정된 시각에 리셋됩니다.
※ resetType이(가) “weekly” 이면 필수 | ||||||||||||||||||
| resetHour | int | {resetType} in [“monthly”, “weekly”, “daily”] | ✓※ | 0 ~ 23 | 리셋 시각 daily, weekly, monthly 리셋 타입에서 카운터가 리셋되는 UTC 시각(0~23)입니다. 예를 들어 값이 0이면 UTC 자정에 카운터가 리셋됩니다. ※ resetType이(가) “monthly”,“weekly”,“daily"이면 필수 | |||||||||||||||||
| anchorTimestamp | long | {resetType} == “days” | ✓※ | 경과 일수를 계산하는 기준 일시 UNIX 시간(밀리초) ※ resetType이(가) “days” 이면 필수 | ||||||||||||||||||
| days | int | {resetType} == “days” | ✓※ | 1 ~ 2147483646 | 리셋 일수 resetType이 “days"인 경우 카운터 리셋 간격(일수)입니다. 리셋 주기는 anchorTimestamp를 기준으로 계산됩니다. 예를 들어 days가 7이고 anchorTimestamp가 월요일 정오라면, 매주 월요일 정오에 카운터가 리셋됩니다. ※ resetType이(가) “days” 이면 필수 |