> For the complete documentation index, see [llms.txt](/llms.txt)

# GS2-Enhance Deploy/CDK リファレンス

GS2-Deployのスタックを作成する際に使用するテンプレートのフォーマットと、CDKによる各種言語のテンプレート出力の実装例




## エンティティ

Deploy処理で操作の対象となるリソース

### Namespace

ネームスペース<br>

ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。<br>
GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。<br>

そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。

#### Request

リソースの生成・更新リクエスト

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| name | string |  | ✓|  |  ~ 128文字 | ネームスペース名<br>ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| description | string |  | |  |  ~ 1024文字 | 説明文 |
| transactionSetting | [TransactionSetting](#transactionsetting) |  | ✓|  |  | トランザクション設定<br>強化操作時の分散トランザクションの実行方法を制御する設定です。自動実行、アトミックコミット、非同期処理などのオプションをサポートします。 |
| enhanceScript | [ScriptSetting](#scriptsetting) |  | |  |  | 強化時に実行するスクリプトの設定<br>Script トリガーリファレンス - [`enhance`](../script/#enhance) |
| logSetting | [LogSetting](#logsetting) |  | |  |  | ログの出力設定<br>強化操作のログデータを GS2-Log に出力するための設定です。GS2-Log のネームスペースを指定することで、強化および限界突破操作の API リクエスト・レスポンスログを収集できます。 |

#### GetAttr

[!GetAttr](/articles/tech/deploy/#getattr)タグで取得可能なリソースの生成結果

| | 型 | 説明 |
| --- | --- | --- |
| Item | [Namespace](../sdk#namespace) | 作成したネームスペース

#### 実装例




**GS2-Deploy(YAML)**
```yaml

Type: GS2::Enhance::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSetting: 
    EnableAutoRun: true
    QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
  EnhanceScript: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001

```

**Go**
```go

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


SampleStack := core.NewStack()
enhance.NewNamespace(
    &SampleStack,
    "namespace-0001",
    enhance.NamespaceOptions{
        TransactionSetting: core.NewTransactionSetting(
            core.TransactionSettingOptions{
                QueueNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"),
            },
        ),
        LogSetting: &core.LogSetting{
            LoggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
        },
    },
)

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

```

**PHP**
```php

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

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

```

**Java**
```java

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.enhance.model.Namespace(
                this,
                "namespace-0001",
                new io.gs2.cdk.enhance.model.options.NamespaceOptions()
                        .withTransactionSetting(new io.gs2.cdk.core.model.TransactionSetting(
                            new io.gs2.cdk.core.model.options.TransactionSettingOptions()
                                .withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001")
                        ))
                        .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

```

**C#**
```csharp

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Enhance.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: new Gs2Cdk.Gs2Enhance.Model.Options.NamespaceOptions
            {
                transactionSetting = new Gs2Cdk.Core.Model.TransactionSetting(
                    options: new Gs2Cdk.Core.Model.TransactionSettingOptions
                    {
                        queueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
                    }
                ),
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

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

```

**TypeScript**
```typescript

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

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

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

```

**Python**
```python

from gs2_cdk import Stack, core, enhance

class SampleStack(Stack):

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

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

```


#### TransactionSetting

トランザクション設定<br>

トランザクション設定は、トランザクションの実行方法・整合性・非同期処理・競合回避の仕組みを制御する設定です。<br>
自動実行（AutoRun）、アトミック実行（AtomicCommit）、GS2-Distributor を利用した非同期実行、スクリプト結果の一括適用、GS2-JobQueue による入手アクションの非同期化などを組み合わせ、ゲームロジックに応じた堅牢なトランザクション管理を可能にします。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| enableAutoRun | bool |  |  | false |  | 発行したトランザクションをサーバーサイドで自動的に実行するか |
| enableAtomicCommit | bool | {enableAutoRun} == true |  | false |  | トランザクションの実行をアトミックにコミットするか<br>※ enableAutoRun が true であれば 有効 |
| transactionUseDistributor | bool | {enableAtomicCommit} == true |  | false |  | トランザクションを非同期処理で実行する<br>※ enableAtomicCommit が true であれば 有効 |
| commitScriptResultInUseDistributor | bool | {transactionUseDistributor} == true |  | false |  | スクリプトの結果コミット処理を非同期処理で実行するか<br>※ transactionUseDistributor が true であれば 有効 |
| acquireActionUseJobQueue | bool | {enableAtomicCommit} == true |  | false |  | 入手アクションを実行する際に GS2-JobQueue を使用するか<br>※ 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

スクリプト設定<br>

GS2 ではマイクロサービスのイベントに関連づけて、カスタムスクリプトを実行することができます。<br>
このモデルは、スクリプトの実行をトリガーするための設定を保持します。<br>

スクリプトの実行方式は大きく2種類あり、それは「同期実行」と「非同期実行」です。<br>
同期実行は、スクリプトの実行が完了するまで処理がブロックされます。<br>
代わりに、スクリプトの実行結果を使って API の実行を止めたり、API のレスポンス内容を制御することができます。<br>

一方、非同期実行ではスクリプトの完了を待つために処理がブロックされることはありません。<br>
ただし、スクリプトの実行結果を利用して API の実行を停止したり、API の応答内容を変更することはできません。<br>
非同期実行は API の応答フローに影響を与えないため、原則として非同期実行を推奨します。<br>

非同期実行には実行方式が2種類あり、GS2-Script と Amazon EventBridge があります。<br>
Amazon EventBridge を使用することで、Lua 以外の言語で処理を記述することができます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| triggerScriptId | string |  |  |  |  ~ 1024文字 | API 実行時に同期的に実行される GS2-Script のスクリプトGRN<br>「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。 |
| doneTriggerTargetType | 文字列列挙型<br>enum {<br>&nbsp;&nbsp;"none",<br>&nbsp;&nbsp;"gs2_script",<br>&nbsp;&nbsp;"aws"<br>}<br> |  |  | "none" |  | 非同期スクリプトの実行方法<br>非同期実行で使用するスクリプトの種類を指定します。<br>「非同期実行のスクリプトを使用しない(none)」「GS2-Scriptを使用する(gs2_script)」「Amazon EventBridgeを使用する(aws)」が選択できます。"none": なし / "gs2_script": GS2-Script / "aws": Amazon EventBridge /  |
| doneTriggerScriptId | string | {doneTriggerTargetType} == "gs2_script" |  |  |  ~ 1024文字 | 非同期実行する GS2-Script スクリプトGRN<br>「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。<br>※ doneTriggerTargetType が "gs2_script" であれば 有効 |
| doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == "gs2_script" |  |  |  ~ 1024文字 | 非同期実行スクリプトを実行する GS2-JobQueue ネームスペースGRN<br>非同期実行スクリプトを直接実行するのではなく、GS2-JobQueue を経由する場合は GS2-JobQueue のネームスペースGRN を指定します。<br>GS2-JobQueue を利用する理由は多くはありませんので、特に理由がなければ指定する必要はありません。<br>※ doneTriggerTargetType が "gs2_script" であれば 有効 |

#### LogSetting

ログの出力設定<br>

ログデータの出力設定を管理します。この型は、ログデータを書き出すために使用される GS2-Log ネームスペースの識別子（Namespace ID）を保持します。<br>
ログネームスペースID(loggingNamespaceId)には、ログデータを収集し保存する GS2-Log のネームスペースを、GRNの形式で指定します。<br>
この設定をすることで、設定されたネームスペース内で発生したAPIリクエスト・レスポンスのログデータが、対象の GS2-Log ネームスペース側へ出力されるようになります。<br>
GS2-Log ではリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| loggingNamespaceId | string |  | ✓ |  |  ~ 1024文字 | ログを出力する GS2-Log のネームスペースGRN<br>「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。 |

---

### CurrentRateMaster

現在アクティブなレートモデルのマスターデータ<br>

現在ネームスペース内で有効な、レートモデルの定義を記述したマスターデータです。<br>
GS2ではマスターデータの管理にJSON形式のファイルを使用します。<br>
ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。<br>

JSONファイルを作成する方法として、マネージメントコンソール内にマスターデータエディタを提供しています。<br>
また、よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
{{% alert title="Note" color="info" %}}
JSONファイルの形式については [GS2-Enhance マスターデータリファレンス](api_reference/enhance/master_data/) をご参照ください。
{{% /alert %}}

#### Request

リソースの生成・更新リクエスト

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string |  | ✓|  |  ~ 128文字 | ネームスペース名<br>ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| mode | 文字列列挙型<br>enum {<br>&nbsp;&nbsp;"direct",<br>&nbsp;&nbsp;"preUpload"<br>}<br> |  | | "direct" |  | 更新モード"direct": マスターデータを直接更新 / "preUpload": マスターデータをアップロードしてから更新 /  |
| settings | string | {mode} == "direct" | ✓※|  |  ~ 5242880 バイト (5MB) | マスターデータ<br>※ mode が "direct" であれば必須 |
| uploadToken | string | {mode} == "preUpload" | ✓※|  |  ~ 1024文字 | 事前アップロードで取得したトークン<br>アップロードしたマスターデータを適用するために使用されます。<br>※ mode が "preUpload" であれば必須 |

#### GetAttr

[!GetAttr](/articles/tech/deploy/#getattr)タグで取得可能なリソースの生成結果

| | 型 | 説明 |
| --- | --- | --- |
| Item | [CurrentRateMaster](../sdk#currentratemaster) | 更新された現在アクティブなレートモデルのマスターデータ

#### 実装例




**GS2-Deploy(YAML)**
```yaml

Type: GS2::Enhance::CurrentRateMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  Settings: {
    "version": "2020-08-22",
    "rateModels": [
      {
        "name": "character-friendly",
        "targetInventoryModelId": "grn:inventory:character",
        "acquireExperienceSuffix": ":friendly",
        "materialInventoryModelId": "grn:inventory:sweet",
        "experienceModelId": "grn:experience:friendly",
        "metadata": "CHARACTER_FRIENDLY",
        "acquireExperienceHierarchy": [
          "taste"
        ],
        "bonusRates": [
          {
            "rate": 1,
            "weight": 90
          }
        ]
      },
      {
        "name": "character-level",
        "targetInventoryModelId": "grn:inventory:character",
        "acquireExperienceSuffix": ":level",
        "materialInventoryModelId": "grn:inventory:material",
        "experienceModelId": "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
        "metadata": "CHARACTER_LEVEL",
        "acquireExperienceHierarchy": [
          "experience"
        ],
        "bonusRates": [
          {
            "rate": 1,
            "weight": 90
          },
          {
            "rate": 1.5,
            "weight": 9
          },
          {
            "rate": 2,
            "weight": 1
          }
        ]
      }
    ],
    "unleashRateModels": [
    ]
  }
  UploadToken: null

```

**Go**
```go

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


SampleStack := core.NewStack()
enhance.NewNamespace(
    &SampleStack,
    "namespace-0001",
    enhance.NamespaceOptions{},
).MasterData(
    []enhance.RateModel{
        enhance.NewRateModel(
            "character-friendly",
            "grn:inventory:character",
            ":friendly",
            "grn:inventory:sweet",
            "grn:experience:friendly",
            enhance.RateModelOptions{
                Metadata: pointy.String("CHARACTER_FRIENDLY"),
                AcquireExperienceHierarchy: []string{
                    "taste",
                },
                BonusRates: []enhance.BonusRate{
                    enhance.NewBonusRate(
                        1,
                        90,
                        enhance.BonusRateOptions{},
                    ),
                },
            },
        ),
        enhance.NewRateModel(
            "character-level",
            "grn:inventory:character",
            ":level",
            "grn:inventory:material",
            "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
            enhance.RateModelOptions{
                Metadata: pointy.String("CHARACTER_LEVEL"),
                AcquireExperienceHierarchy: []string{
                    "experience",
                },
                BonusRates: []enhance.BonusRate{
                    enhance.NewBonusRate(
                        1,
                        90,
                        enhance.BonusRateOptions{},
                    ),
                    enhance.NewBonusRate(
                        1.5,
                        9,
                        enhance.BonusRateOptions{},
                    ),
                    enhance.NewBonusRate(
                        2,
                        1,
                        enhance.BonusRateOptions{},
                    ),
                },
            },
        ),
    },
    []enhance.UnleashRateModel{
    },
)

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

```

**PHP**
```php

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Enhance\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
                new \Gs2Cdk\Enhance\Model\RateModel(
                    name:"character-friendly",
                    targetInventoryModelId:"grn:inventory:character",
                    acquireExperienceSuffix:":friendly",
                    materialInventoryModelId:"grn:inventory:sweet",
                    experienceModelId:"grn:experience:friendly",
                    options: new \Gs2Cdk\Enhance\Model\Options\RateModelOptions(
                        metadata:"CHARACTER_FRIENDLY",
                        acquireExperienceHierarchy:[
                            "taste",
                        ],
                        bonusRates:[
                            new \Gs2Cdk\Enhance\Model\BonusRate(
                                rate: 1,
                                weight: 90,
                            ),
                        ]
                    )
                ),
                new \Gs2Cdk\Enhance\Model\RateModel(
                    name:"character-level",
                    targetInventoryModelId:"grn:inventory:character",
                    acquireExperienceSuffix:":level",
                    materialInventoryModelId:"grn:inventory:material",
                    experienceModelId:"grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
                    options: new \Gs2Cdk\Enhance\Model\Options\RateModelOptions(
                        metadata:"CHARACTER_LEVEL",
                        acquireExperienceHierarchy:[
                            "experience",
                        ],
                        bonusRates:[
                            new \Gs2Cdk\Enhance\Model\BonusRate(
                                rate: 1,
                                weight: 90,
                            ),
                            new \Gs2Cdk\Enhance\Model\BonusRate(
                                rate: 1.5,
                                weight: 9,
                            ),
                            new \Gs2Cdk\Enhance\Model\BonusRate(
                                rate: 2,
                                weight: 1,
                            ),
                        ]
                    )
                )
            ],
            [
            ]
        );
    }
}

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

```

**Java**
```java

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.enhance.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.enhance.model.RateModel(
                    "character-friendly",
                    "grn:inventory:character",
                    ":friendly",
                    "grn:inventory:sweet",
                    "grn:experience:friendly",
                    new io.gs2.cdk.enhance.model.options.RateModelOptions()
                        .withMetadata("CHARACTER_FRIENDLY")
                        .withAcquireExperienceHierarchy(Arrays.asList(
                            "taste"
                        ))
                        .withBonusRates(Arrays.asList(
                            new io.gs2.cdk.enhance.model.BonusRate(
                                1f,
                                90
                            )
                        ))
                ),
                new io.gs2.cdk.enhance.model.RateModel(
                    "character-level",
                    "grn:inventory:character",
                    ":level",
                    "grn:inventory:material",
                    "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
                    new io.gs2.cdk.enhance.model.options.RateModelOptions()
                        .withMetadata("CHARACTER_LEVEL")
                        .withAcquireExperienceHierarchy(Arrays.asList(
                            "experience"
                        ))
                        .withBonusRates(Arrays.asList(
                            new io.gs2.cdk.enhance.model.BonusRate(
                                1f,
                                90
                            ),
                            new io.gs2.cdk.enhance.model.BonusRate(
                                1.5f,
                                9
                            ),
                            new io.gs2.cdk.enhance.model.BonusRate(
                                2f,
                                1
                            )
                        ))
                )
            ),
            Arrays.asList(
            )
        );
    }
}

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

```

**C#**
```csharp

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Enhance.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2Enhance.Model.RateModel[] {
                new Gs2Cdk.Gs2Enhance.Model.RateModel(
                    name: "character-friendly",
                    targetInventoryModelId: "grn:inventory:character",
                    acquireExperienceSuffix: ":friendly",
                    materialInventoryModelId: "grn:inventory:sweet",
                    experienceModelId: "grn:experience:friendly",
                    options: new Gs2Cdk.Gs2Enhance.Model.Options.RateModelOptions
                    {
                        metadata = "CHARACTER_FRIENDLY",
                        acquireExperienceHierarchy = new string[]
                        {
                            "taste"
                        },
                        bonusRates = new Gs2Cdk.Gs2Enhance.Model.BonusRate[]
                        {
                            new Gs2Cdk.Gs2Enhance.Model.BonusRate(
                                rate: 1f,
                                weight: 90
                            )
                        }
                    }
                ),
                new Gs2Cdk.Gs2Enhance.Model.RateModel(
                    name: "character-level",
                    targetInventoryModelId: "grn:inventory:character",
                    acquireExperienceSuffix: ":level",
                    materialInventoryModelId: "grn:inventory:material",
                    experienceModelId: "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
                    options: new Gs2Cdk.Gs2Enhance.Model.Options.RateModelOptions
                    {
                        metadata = "CHARACTER_LEVEL",
                        acquireExperienceHierarchy = new string[]
                        {
                            "experience"
                        },
                        bonusRates = new Gs2Cdk.Gs2Enhance.Model.BonusRate[]
                        {
                            new Gs2Cdk.Gs2Enhance.Model.BonusRate(
                                rate: 1f,
                                weight: 90
                            ),
                            new Gs2Cdk.Gs2Enhance.Model.BonusRate(
                                rate: 1.5f,
                                weight: 9
                            ),
                            new Gs2Cdk.Gs2Enhance.Model.BonusRate(
                                rate: 2f,
                                weight: 1
                            )
                        }
                    }
                )
            },
            new Gs2Cdk.Gs2Enhance.Model.UnleashRateModel[] {
            }
        );
    }
}

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

```

**TypeScript**
```typescript

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new enhance.model.Namespace(
            this,
            "namespace-0001",
        ).masterData(
            [
                new enhance.model.RateModel(
                    "character-friendly",
                    "grn:inventory:character",
                    ":friendly",
                    "grn:inventory:sweet",
                    "grn:experience:friendly",
                    {
                        metadata: "CHARACTER_FRIENDLY",
                        acquireExperienceHierarchy: [
                            "taste",
                        ],
                        bonusRates: [
                            new enhance.model.BonusRate(
                                1,
                                90
                            ),
                        ]
                    }
                ),
                new enhance.model.RateModel(
                    "character-level",
                    "grn:inventory:character",
                    ":level",
                    "grn:inventory:material",
                    "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level",
                    {
                        metadata: "CHARACTER_LEVEL",
                        acquireExperienceHierarchy: [
                            "experience",
                        ],
                        bonusRates: [
                            new enhance.model.BonusRate(
                                1,
                                90
                            ),
                            new enhance.model.BonusRate(
                                1.5,
                                9
                            ),
                            new enhance.model.BonusRate(
                                2,
                                1
                            ),
                        ]
                    }
                )
            ],
            [
            ]
        );
    }
}

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

```

**Python**
```python

from gs2_cdk import Stack, core, enhance

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        enhance.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            rate_models=[
                enhance.RateModel(
                    name='character-friendly',
                    target_inventory_model_id='grn:inventory:character',
                    acquire_experience_suffix=':friendly',
                    material_inventory_model_id='grn:inventory:sweet',
                    experience_model_id='grn:experience:friendly',
                    options=enhance.RateModelOptions(
                        metadata = 'CHARACTER_FRIENDLY',
                        acquire_experience_hierarchy = [
                            'taste',
                        ],
                        bonus_rates = [
                            enhance.BonusRate(
                                rate=1,
                                weight=90,        
                            ),
                        ]
                    ),
                ),
                enhance.RateModel(
                    name='character-level',
                    target_inventory_model_id='grn:inventory:character',
                    acquire_experience_suffix=':level',
                    material_inventory_model_id='grn:inventory:material',
                    experience_model_id='grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:level',
                    options=enhance.RateModelOptions(
                        metadata = 'CHARACTER_LEVEL',
                        acquire_experience_hierarchy = [
                            'experience',
                        ],
                        bonus_rates = [
                            enhance.BonusRate(
                                rate=1,
                                weight=90,        
                            ),
                            enhance.BonusRate(
                                rate=1.5,
                                weight=9,        
                            ),
                            enhance.BonusRate(
                                rate=2,
                                weight=1,        
                            ),
                        ]
                    ),
                ),
            ],
            unleash_rate_models=[
            ],
        )

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

```


#### RateModel

強化レートモデル<br>

強化レートは強化に使用する素材と強化対象を定義したデータです。<br>

素材データ、強化対象データは共に GS2-Inventory で管理されている必要があります。<br>
強化で得られる経験値は GS2-Inventory のメタデータにJSON形式で記録します。<br>
ここではメタデータのどの階層に経験値の値が格納されているかを記載する必要があります。<br>

強化時に一定の確率で `大成功` といった形で入手できる経験値量に補正値をかけることができます。<br>
その抽選確率もこのエンティティで定義します。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| rateModelId | string |  | ※ |  |  ~ 1024文字 | 強化レートモデルGRN<br>※ サーバーが自動で設定 |
| name | string |  | ✓ |  |  ~ 128文字 | 強化レートモデル名<br>強化レートモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| description | string |  |  |  |  ~ 1024文字 | 説明文 |
| metadata | string |  |  |  |  ~ 2048文字 | メタデータ<br>メタデータには任意の値を設定できます。<br>これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| targetInventoryModelId | string |  | ✓ |  |  ~ 1024文字 | 強化対象に使用できる GS2-Inventory インベントリモデルの GRN<br>強化対象となるアイテムを保持する GS2-Inventory のインベントリモデルを指定します。強化されるアイテムはこのインベントリモデルに属している必要があります。 |
| acquireExperienceSuffix | string |  | ✓ |  |  ~ 1024文字 | GS2-Experience で入手した経験値を格納するプロパティID に付与するサフィックス<br>アイテムのプロパティ ID の末尾に追加され、経験値が保存される GS2-Experience のプロパティ ID を構成する文字列です。同じアイテムに複数の経験値種別を持たせることができます（例: キャラクターレベルの "level"、好感度の "like"）。 |
| materialInventoryModelId | string |  | ✓ |  |  ~ 1024文字 | 強化の素材に使用できる GS2-Inventory インベントリモデル GRN<br>強化素材として使用できるアイテムを保持する GS2-Inventory のインベントリモデルを指定します。各素材が提供する経験値は、acquireExperienceHierarchy で指定された JSON 階層を使用してアイテムモデルのメタデータに定義されます。 |
| acquireExperienceHierarchy | List&lt;string&gt; |  |  |  | 0 ~ 10 items | ItemModelのメタデータに格納する、入手経験値を定義するJSONデータの階層構造の定義<br>GS2-EnhanceにはGS2-Inventoryと連携して強化を行う仕組みがあり、ItemModelのメタデータにJSON形式で、強化素材として使用した場合の経験値量を設定します。<br>例えば、{ "aaa": { "bbb": { "experienceValue": 100 } } } というような構造のデータ定義でメタデータに設定したい場合は、[ "aaa", "bbb", "experienceValue" ] のように指定します。<br>詳細は [マイクロサービス紹介 / GS2-Enhance](/microservices/enhance/#強化レート) の項で解説しています。 |
| experienceModelId | string |  | ✓ |  |  ~ 1024文字 | 強化の結果得られる GS2-Experience 経験値モデル GRN<br>強化で得られた経験値が記録される GS2-Experience の経験値モデルを指定します。経験値は、対象アイテムのプロパティ ID と acquireExperienceSuffix を組み合わせて識別されるプロパティに加算されます。 |
| bonusRates | [List&lt;BonusRate&gt;](#bonusrate) |  |  |  | 0 ~ 1000 items | 経験値獲得量ボーナス<br>強化時のボーナス経験値倍率の重み付き抽選を定義します。各エントリは倍率（例: 1.5 で 150%）と排出重みを指定します。強化実行時に重み付き抽選で1つのエントリが選択され、「大成功」ボーナスが獲得経験値に適用されるかどうかが決定されます。 |

#### BonusRate

経験値獲得量ボーナス<br>

強化時の経験値ボーナス倍率を決定する重み付き抽選の単一エントリを定義します。異なる倍率と重みを持つ複数のエントリを設定することで、制御された確率による「大成功」や「超成功」の仕組みを実装できます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| rate | float |  |  | 1.0 | 0 ~ 10000 | 経験値ボーナスの倍率 (1.0 = ボーナスなし)<br>このエントリが抽選された際に基本経験値に適用される倍率です。1.0 はボーナスなしの通常強化、1.5 は経験値 150%（大成功）、2.0 は経験値 200%（超成功）などを意味します。 |
| weight | int |  |  | 1 | 0 ~ 2147483645 | 抽選重み<br>ボーナスレートを選択する重み付き抽選で使用される相対的な重みです。値が大きいほど、このボーナスレートが選択される確率が高くなります。実際の確率は、この重みをボーナスレートリスト内のすべての重みの合計で割った値になります。 |

#### UnleashRateModel

限界突破レートモデル<br>

アイテムの限界突破（解放）条件を定義します。GS2-Inventory で管理されるアイテムと GS2-Grade のグレードモデルを関連付け、グレードの進行を可能にします。各グレードレベルで消費する同種アイテムの数を個別に設定でき、各限界突破段階のコストを細かく制御できます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| unleashRateModelId | string |  | ※ |  |  ~ 1024文字 | 限界突破レートモデルGRN<br>※ サーバーが自動で設定 |
| name | string |  | ✓ |  |  ~ 128文字 | 限界突破レートモデル名<br>限界突破レートモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| description | string |  |  |  |  ~ 1024文字 | 説明文 |
| metadata | string |  |  |  |  ~ 2048文字 | メタデータ<br>メタデータには任意の値を設定できます。<br>これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| targetInventoryModelId | string |  | ✓ |  |  ~ 1024文字 | 限界突破対象に使用できる GS2-Inventory インベントリモデル GRN<br>限界突破対象となるアイテムを保持する GS2-Inventory のインベントリモデルを指定します。限界突破するアイテムと素材として消費する同種アイテムの両方がこのインベントリモデルに属している必要があります。 |
| gradeModelId | string |  | ✓ |  |  ~ 1024文字 | グレードモデル GRN<br>対象アイテムの限界突破レベルを追跡する GS2-Grade のグレードモデルを指定します。限界突破が成功すると、このグレードモデル内でアイテムのグレードが加算されます。 |
| gradeEntries | [List&lt;UnleashRateEntryModel&gt;](#unleashrateentrymodel) |  | ✓ |  | 1 ~ 1000 items | グレードエントリーリスト<br>限界突破の各グレードレベルに対する素材コストを定義します。各エントリはグレード値と、そのグレードに到達するために消費する必要がある同種アイテム数をマッピングします。例えば、グレード1は複製1個、グレード2は複製3個のように設定できます。 |

#### UnleashRateEntryModel

限界突破レートエントリモデル<br>

限界突破の進行における単一グレードレベルの素材コストを定義します。各エントリは対象となるグレード値と、そのグレードを達成するために消費する必要がある同種アイテムの数を指定します。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| gradeValue | long |  | ✓ |  | 1 ~ 1000 | 対象グレード<br>このエントリがコストを定義するグレード値です。このグレードレベルへの限界突破を実行する際、needCount で指定された数のアイテムが消費されます。 |
| needCount | int |  | ✓ |  | 1 ~ 1000 | 同種のアイテムを何個消費するか<br>対象グレードへの限界突破を実行するために消費する必要がある同種アイテムの数です。これらのアイテムは、限界突破されるアイテムと同じアイテムモデルのものです。 |

---