GS2-News GS2-Deploy/CDK リファレンス
GS2-Deployのスタックの作成に使用するテンプレートのフォーマットと、CDKによる各種言語のテンプレート出力の実装例
エンティティ
Namespace
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。
GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| name | string | ✓ | ~ 128文字 | ネームスペースの名前 | ||
| description | string | ~ 1024文字 | 説明文 | |||
| logSetting | LogSetting | ログの出力設定 | 
GetAttr
!GetAttrタグで取得可能なリソースの生成結果
| 型 | 説明 | |
|---|---|---|
| Item | Namespace | 作成したネームスペース | 
実装例
Type: GS2::News::Namespace
Properties:
  Name: namespace-0001
  Description: 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/news"
)
SampleStack := core.NewStack()
news.NewNamespace(
    &SampleStack,
    "namespace-0001",
    news.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\News\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\News\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.news.model.Namespace(
                this,
                "namespace-0001",
                new io.gs2.cdk.news.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.Gs2News.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: new Gs2Cdk.Gs2News.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 news from "@/gs2cdk/news";
class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new news.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, news
class SampleStack(Stack):
    def __init__(self):
        super().__init__()
        news.Namespace(
            stack=self,
            name='namespace-0001',
            options=news.NamespaceOptions(
                log_setting=core.LogSetting(
                    logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
                ),
            ),
        )
print(SampleStack().yaml())  # Generate TemplateView
ビュー
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| contents | List<Content> | 0 ~ 1000 items | ビューに含めるコンテンツのリスト | |||
| removeContents | List<Content> | 0 ~ 1000 items | ビューに含めないコンテンツのリスト | 
Content
コンテンツ
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| section | string | ✓ | ~ 1024文字 | セクション | ||
| content | string | ✓ | ~ 1024文字 | コンテンツ名 | ||
| frontMatter | string | ✓ | ~ 1048576文字 | Front Matter | 
News
お知らせ記事
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| section | string | ✓ | ~ 1024文字 | セクション名 | ||
| content | string | ✓ | ~ 1024文字 | コンテンツ名 | ||
| title | string | ✓ | ~ 1024文字 | 記事見出し | ||
| scheduleEventId | string | ~ 1024文字 | GS2-Schedule イベントGRN | |||
| timestamp | long | ✓ | タイムスタンプ (UNIX時間 単位:ミリ秒) | |||
| frontMatter | string | ✓ | ~ 1024文字 | Front Matter | 
LogSetting
ログの書き出し設定
ログデータの書き出し設定を管理します。この型は、ログデータを書き出すために使用されるログ名前空間の識別子(Namespace ID)を保持します。
ログ名前空間IDは、ログデータを集約し、保存する対象の GS2-Log の名前空間を指定します。
この設定を通じて、この名前空間以下のAPIリクエスト・レスポンスログデータが対象の GS2-Log へ出力されるようになります。
GS2-Log にはリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|---|
| loggingNamespaceId | string | ✓ | ~ 1024文字 | ログを出力する GS2-Log のネームスペースGRN | 
GitHubCheckoutSetting
GitHubからマスターデータをチェックアウトする設定
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| apiKeyId | string | ✓ | ~ 1024文字 | GitHub のAPIキーGRN | ||||||||||
| repositoryName | string | ✓ | ~ 1024文字 | リポジトリ名 | ||||||||||
| sourcePath | string | ✓ | ~ 1024文字 | ソースコードのファイルパス | ||||||||||
| referenceType | 文字列列挙型 enum { “commit_hash”, “branch”, “tag” } | ✓ | ~ 128文字 | コードの取得元 
 | ||||||||||
| commitHash | string | {referenceType} == “commit_hash” | ✓ | ~ 1024文字 | コミットハッシュ referenceType が “commit_hash” であれば必須 | |||||||||
| branchName | string | {referenceType} == “branch” | ✓ | ~ 1024文字 | ブランチ名 referenceType が “branch” であれば必須 | |||||||||
| tagName | string | {referenceType} == “tag” | ✓ | ~ 1024文字 | タグ名 referenceType が “tag” であれば必須 |