すべてのプロダクト
Search
ドキュメントセンター

Resource Orchestration Service:DATASOURCE::CS::ClusterUserKubeconfig

最終更新日:Jan 16, 2025

DATASOURCE::CS::ClusterUserKubeconfig は、クラスター ID によってコンテナサービス Kubernetes 版(ACK)クラスターの kubeconfig ファイルを照会するために使用されます。

構文

{
  "Type": "DATASOURCE::CS::ClusterUserKubeconfig",
  "Properties": {
    "PrivateIpAddress": Boolean, // プライベートIPアドレスを使用するかどうか
    "ClusterId": String, // クラスターID
    "TemporaryDurationMinutes": Integer, // 一時的なkubeconfigファイルの有効期間(分)
    "RefreshOptions": String // スタックの更新時のデータソースリソースのリフレッシュポリシー
  }
}

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

PrivateIpAddress

Boolean

いいえ

はい

内部ネットワーク経由でクラスターに接続するために使用される kubeconfig ファイルのみを照会するかどうかを指定します。

有効な値:

  • true:内部ネットワーク経由でクラスターに接続するために使用される kubeconfig ファイルのみを照会します。

  • false(デフォルト):インターネット経由でクラスターに接続するために使用される kubeconfig ファイルのみを照会します。

ClusterId

String

はい

はい

クラスター ID。

なし。

TemporaryDurationMinutes

Integer

いいえ

はい

一時的な kubeconfig ファイルの有効期間。

単位:分。有効な値:15~4320。

説明

このプロパティを空のままにすると、システムは自動的に有効期間を指定します。有効期間は、戻り値の Expiration で示されます。

RefreshOptions

String

いいえ

はい

スタックの更新時のデータソースリソースのリフレッシュポリシー。

有効な値:

  • Never(デフォルト):スタックの更新時にデータソースリソースをリフレッシュしません。

  • Always:スタックの更新時にデータソースリソースをリフレッシュします。

戻り値

Fn::GetAtt

  • ClusterId:クラスター ID。

  • Config:クラスターのアクセス設定。

  • Expiration:kubeconfig ファイルの有効期限。時刻は RFC 3339 形式に従います。時刻は UTC で表示されます。

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ClusterId:
    Description: ACK クラスターの ID。
    Type: String
Resources:
  ClusterUserKubeconfig:
    Properties:
      ClusterId:
        Ref: ClusterId
    Type: DATASOURCE::CS::ClusterUserKubeconfig
Outputs:
  ClusterId:
    Description: ACK クラスターの ID。
    Value:
      Fn::GetAtt:
      - ClusterUserKubeconfig
      - ClusterId
  Config:
    Description: kubeconfig ファイルの内容。
    Value:
      Fn::GetAtt:
      - ClusterUserKubeconfig
      - Config
  Expiration:
    Description: kubeconfig ファイルの有効期限。値は RFC3339 形式で表示される UTC 時刻です。
    Value:
      Fn::GetAtt:
      - ClusterUserKubeconfig
      - Expiration

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ClusterId": {
      "Type": "String",
      "Description": "ACK クラスターの ID。" // ACK cluster ID
    }
  },
  "Resources": {
    "ClusterUserKubeconfig": {
      "Type": "DATASOURCE::CS::ClusterUserKubeconfig",
      "Properties": {
        "ClusterId": {
          "Ref": "ClusterId"
        }
      }
    }
  },
  "Outputs": {
    "ClusterId": {
      "Description": "ACK クラスターの ID。", // ACK cluster ID
      "Value": {
        "Fn::GetAtt": [
          "ClusterUserKubeconfig",
          "ClusterId"
        ]
      }
    },
    "Config": {
      "Description": "kubeconfig ファイルの内容。", // kubeconfig file content
      "Value": {
        "Fn::GetAtt": [
          "ClusterUserKubeconfig",
          "Config"
        ]
      }
    },
    "Expiration": {
      "Description": "kubeconfig ファイルの有効期限。値は RFC3339 形式で表示される UTC 時刻です。", // kubeconfig file expiration time. The value is the UTC time displayed in RFC3339 format.
      "Value": {
        "Fn::GetAtt": [
          "ClusterUserKubeconfig",
          "Expiration"
        ]
      }
    }
  }
}