DATASOURCE::CS::KubernetesCluster ACK クラスターリソース参照 - ROS

DATASOURCE::CS::KubernetesCluster は、Container Service for Kubernetes (ACK) クラスタに関する情報をクエリするために使用されます。

構文

{
  "Type": "DATASOURCE::CS::KubernetesCluster",
  "Properties": {
    "ClusterId": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

ClusterId

String

いいえ

はい

クラスタ ID。

なし。

RefreshOptions

String

いいえ

はい

スタックが更新されたときのデータソースリソースの更新ポリシー。

有効な値:

Never (デフォルト): スタックが更新されたときにデータソースリソースを更新しません。
Always: スタックが更新されたときにデータソースリソースを更新します。

戻り値

Fn::GetAtt

SubnetCidr: ポッドの CIDR ブロック。
ExternalLoadbalancerId: クラスタの Ingress で使用される Server Load Balancer (SLB) インスタンスの ID。
ResourceGroupId: クラスタのリソースグループ ID。
InitVersion: クラスタの初期バージョン。
Size: クラスタ内のノード数。
CurrentVersion: クラスタの現在のバージョン。
MasterUrl: クラスタのエンドポイント。
Profile: クラスタのプロファイル。
Name: クラスタ名。
Created: クラスタが作成された日時。
DockerVersion: クラスタの Docker バージョン。
MetaData: クラスタのメタデータ。
Tags: クラスタのタグ。
PrivateZone: クラスタのプライベートゾーン構成。
Parameters: クラスタに指定されたパラメータ。
Updated: クラスタが更新された日時。
ZoneId: クラスタのゾーン ID。
ClusterId: クラスタ ID。
VSwitchId: クラスタの vSwitch ID。
SecurityGroupId: クラスタのセキュリティグループ ID。
ClusterSpec: クラスタの仕様。
NetworkMode: クラスタのネットワークモード。
ClusterType: クラスタタイプ。
DeletionProtection: クラスタの削除保護機能。
VpcId: クラスタの仮想プライベートクラウド (VPC) ID。
State: クラスタの実行状態。
NextVersion: クラスタのアップグレード可能なバージョン。
WorkerRamRoleName: ワーカーノードのリソースアクセス管理 (RAM) ロールの名前。
RegionId: クラスタのリージョン ID。
MaintenanceWindow: クラスタのメンテナンスウィンドウ構成。

例

`YAML` 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ClusterId:
    Description:
      en: Cluster instance ID.
    Required: false
    Type: String
Resources:
  KubernetesCluster:
    Properties:
      ClusterId:
        Ref: ClusterId
    Type: DATASOURCE::CS::KubernetesCluster
Outputs:
  ClusterId:
    Description: クラスタインスタンス ID。
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - ClusterId
  ClusterSpec:
    Description: 'マネージド Kubernetes クラスタのタイプ。このパラメータは、マネージド Kubernetes クラスタに対して返されます。有効な値:

      - ack.pro.small: プロフェッショナルマネージド Kubernetes クラスタ。

      - ack.standard: スタンダードマネージド Kubernetes クラスタ。'
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - ClusterSpec
  ClusterType:
    Description: 'クラスタのタイプ。有効な値:

      - Kubernetes: 専用 Kubernetes クラスタ

      - ManagedKubernetes: マネージド Kubernetes クラスタ

      - Ask: ASK クラスタ

      - ExternalKubernetes: 登録済み外部 Kubernetes クラスタ'
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - ClusterType
  Created:
    Description: クラスタが作成された日時。
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - Created
  CurrentVersion:
    Description: クラスタの現在の Kubernetes バージョン。ACK でサポートされている Kubernetes バージョンについては、Kubernetes バージョンのリリースノートをご参照ください。
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - CurrentVersion
  DeletionProtection:
    Description: '削除保護が有効になっているかどうかを示します。削除保護が有効になっている場合、ACK コンソールまたは API を呼び出すことによってクラスタを削除することはできません。有効な値:

      - true: 削除保護が有効になっています。ACK コンソールまたは API を呼び出すことによってクラスタを削除することはできません。

      - false: 削除保護が有効になっていません。ACK コンソールまたは API を呼び出すことによってクラスタを削除できます。'
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - DeletionProtection
  DockerVersion:
    Description: クラスタで使用される Docker バージョン。
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - DockerVersion
  ExternalLoadbalancerId:
    Description: クラスタの Ingress に使用される Server Load Balancer (SLB) インスタンスの ID。
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - ExternalLoadbalancerId
  InitVersion:
    Description: クラスタで最初に使用される Kubernetes バージョン。
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - InitVersion
  MaintenanceWindow:
    Description: クラスタのメンテナンスウィンドウ。この機能は、プロフェッショナルマネージド Kubernetes クラスタでのみ使用できます。
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - MaintenanceWindow
  MasterUrl:
    Description: クラスタのアドレス。内部エンドポイントとパブリックエンドポイントが含まれます。
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - MasterUrl
  MetaData:
    Description: クラスタのメタデータ。
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - MetaData
  Name:
    Description: クラスタの名前。名前は 1 ～ 63 文字で、数字、文字、およびハイフン (-) を含めることができます。ハイフン (-) で始めることはできません。
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - Name
  NetworkMode:
    Description: "クラスタのネットワークモード。有効な値: \n- classic: クラシックネットワーク \n- vpc: 仮想プライベートクラウド (VPC) \n- overlay: オーバーレイネットワーク\n- calico: Calico を使用したネットワーク\nデフォルト値: vpc。"
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - NetworkMode
  NextVersion:
    Description: クラスタをアップグレードできる Kubernetes バージョン。
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - NextVersion
  Parameters:
    Description: クラスタ ROS パラメータのコレクション。
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - Parameters
  PrivateZone:
    Description: 'Alibaba Cloud DNS PrivateZone が有効になっているかどうかを示します。

      - true: Alibaba Cloud DNS PrivateZone が有効になっていることを示します。- false: Alibaba Cloud DNS PrivateZone が有効になっていないことを示します。'
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - PrivateZone
  Profile:
    Description: 'クラスタが使用されるシナリオを示します。有効な値:

      - Default: クラスタがエッジコンピューティング以外のシナリオで使用されることを示します。

      - Edge: ACK クラスタがエッジコンピューティングシナリオで使用されることを示します。'
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - Profile
  RegionId:
    Description: クラスタがデプロイされているリージョンの ID。
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - RegionId
  ResourceGroupId:
    Description: クラスタが属するリソースグループの ID。
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - ResourceGroupId
  SecurityGroupId:
    Description: クラスタのインスタンスが属するセキュリティグループの ID。
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - SecurityGroupId
  Size:
    Description: クラスタ内のノード数。マスターノードとワーカーノードが含まれます。
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - Size
  State:
    Description: 'クラスタの状態。有効な値:

      - initial: クラスタが作成されています。

      - failed: クラスタの作成に失敗しました。

      - running: クラスタは実行中です。

      - updating: クラスタはアップグレードされています。

      - updating_failed: クラスタのアップグレードに失敗しました。

      - scaling: クラスタはスケーリングされています。

      - waiting: 登録済みクラスタは接続を待機しています。

      - disconnected: 登録済みクラスタは切断されています。

      - stopped: クラスタは停止されています。

      - deleting: クラスタは削除されています。

      - deleted: クラスタは削除されました。

      - delete_failed: クラスタの削除に失敗しました。'
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - State
  SubnetCidr:
    Description: 'ポッド CIDR ブロック。有効なプライベート CIDR ブロックである必要があり、次の CIDR ブロックまたはそのサブネットのいずれかである必要があります。

      - 10.0.0.0/8

      - 172.16-31.0.0/12-16

      - 192.168.0.0/16

      ポッド CIDR ブロックは、VPC の CIDR ブロック、または VPC にデプロイされている ACK クラスタの CIDR ブロックと重複することはできません。ACK クラスタのネットワークセグメンテーションの詳細については、VPC 内の ACK クラスタの CIDR ブロックの計画をご参照ください。'
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - SubnetCidr
  Tags:
    Description: クラスタのラベル。
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - Tags
  Updated:
    Description: クラスタが更新された日時。
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - Updated
  VSwitchId:
    Description: vSwitch の ID。ACK クラスタを作成するときに、1 ～ 3 つの vSwitch を選択できます。高可用性を確保するために、異なるゾーンの vSwitch を使用することをお勧めします。
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - VSwitchId
  VpcId:
    Description: クラスタがデプロイされている VPC の ID。このパラメータは、ACK クラスタを作成するときに必須です。
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - VpcId
  WorkerRamRoleName:
    Description: "ワーカー RAM ロールの名前。 \nRAM ロールはクラスタのワーカーノードに割り当てられ、ワーカーノードが Elastic Compute Service (ECS) インスタンスを管理できるようにします。"
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - WorkerRamRoleName
  ZoneId:
    Description: クラスタがデプロイされているゾーンの ID。
    Value:
      Fn::GetAtt:
      - KubernetesCluster
      - ZoneId

`JSON` 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ClusterId": {
      "Type": "String",
      "Description": {
        "en": "Cluster instance ID."
      },
      "Required": false
    }
  },
  "Resources": {
    "KubernetesCluster": {
      "Type": "DATASOURCE::CS::KubernetesCluster",
      "Properties": {
        "ClusterId": {
          "Ref": "ClusterId"
        }
      }
    }
  },
  "Outputs": {
    "SubnetCidr": {
      "Description": "ポッド CIDR ブロック。有効なプライベート CIDR ブロックである必要があり、次の CIDR ブロックまたはそのサブネットのいずれかである必要があります。\n- 10.0.0.0/8\n- 172.16-31.0.0/12-16\n- 192.168.0.0/16\nポッド CIDR ブロックは、VPC の CIDR ブロック、または VPC にデプロイされている ACK クラスタの CIDR ブロックと重複することはできません。ACK クラスタのネットワークセグメンテーションの詳細については、「VPC 内の ACK クラスタの CIDR ブロックの計画」をご参照ください。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "SubnetCidr"
        ]
      }
    },
    "ExternalLoadbalancerId": {
      "Description": "クラスタの Ingress に使用される Server Load Balancer (SLB) インスタンスの ID。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "ExternalLoadbalancerId"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "クラスタが属するリソースグループの ID。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "ResourceGroupId"
        ]
      }
    },
    "InitVersion": {
      "Description": "クラスタで最初に使用される Kubernetes バージョン。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "InitVersion"
        ]
      }
    },
    "Size": {
      "Description": "クラスタ内のノード数。マスターノードとワーカーノードが含まれます。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "Size"
        ]
      }
    },
    "CurrentVersion": {
      "Description": "クラスタの現在の Kubernetes バージョン。ACK でサポートされている Kubernetes バージョンについては、「Kubernetes バージョンのリリースノート」をご参照ください。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "CurrentVersion"
        ]
      }
    },
    "MasterUrl": {
      "Description": "クラスタのアドレス。内部エンドポイントとパブリックエンドポイントが含まれます。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "MasterUrl"
        ]
      }
    },
    "Profile": {
      "Description": "クラスタが使用されるシナリオを示します。有効な値:\n- Default: クラスタがエッジコンピューティング以外のシナリオで使用されることを示します。\n- Edge: ACK クラスタがエッジコンピューティングシナリオで使用されることを示します。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "Profile"
        ]
      }
    },
    "Name": {
      "Description": "クラスタの名前。名前は 1 ～ 63 文字で、数字、文字、およびハイフン (-) を含めることができます。ハイフン (-) で始めることはできません。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "Name"
        ]
      }
    },
    "Created": {
      "Description": "クラスタが作成された日時。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "Created"
        ]
      }
    },
    "DockerVersion": {
      "Description": "クラスタで使用される Docker バージョン。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "DockerVersion"
        ]
      }
    },
    "MetaData": {
      "Description": "クラスタのメタデータ。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "MetaData"
        ]
      }
    },
    "Tags": {
      "Description": "クラスタのラベル。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "Tags"
        ]
      }
    },
    "PrivateZone": {
      "Description": "Alibaba Cloud DNS PrivateZone が有効になっているかどうかを示します。\n- true: Alibaba Cloud DNS PrivateZone が有効になっていることを示します。- false: Alibaba Cloud DNS PrivateZone が有効になっていないことを示します。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "PrivateZone"
        ]
      }
    },
    "Parameters": {
      "Description": "クラスタ ROS パラメータのコレクション。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "Parameters"
        ]
      }
    },
    "Updated": {
      "Description": "クラスタが更新された日時。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "Updated"
        ]
      }
    },
    "ZoneId": {
      "Description": "クラスタがデプロイされているゾーンの ID。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "ZoneId"
        ]
      }
    },
    "ClusterId": {
      "Description": "クラスタインスタンス ID。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "ClusterId"
        ]
      }
    },
    "VSwitchId": {
      "Description": "vSwitch の ID。ACK クラスタを作成するときに、1 ～ 3 つの vSwitch を選択できます。高可用性を確保するために、異なるゾーンの vSwitch を使用することをお勧めします。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "VSwitchId"
        ]
      }
    },
    "SecurityGroupId": {
      "Description": "クラスタのインスタンスが属するセキュリティグループの ID。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "SecurityGroupId"
        ]
      }
    },
    "ClusterSpec": {
      "Description": "マネージド Kubernetes クラスタのタイプ。このパラメータは、マネージド Kubernetes クラスタに対して返されます。有効な値:\n- ack.pro.small: プロフェッショナルマネージド Kubernetes クラスタ。\n- ack.standard: スタンダードマネージド Kubernetes クラスタ。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "ClusterSpec"
        ]
      }
    },
    "NetworkMode": {
      "Description": "クラスタのネットワークモード。有効な値: \n- classic: クラシックネットワーク \n- vpc: 仮想プライベートクラウド (VPC) \n- overlay: オーバーレイネットワーク\n- calico: Calico を使用したネットワーク\nデフォルト値: vpc。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "NetworkMode"
        ]
      }
    },
    "ClusterType": {
      "Description": "クラスタのタイプ。有効な値:\n- Kubernetes: 専用 Kubernetes クラスタ\n- ManagedKubernetes: マネージド Kubernetes クラスタ\n- Ask: ASK クラスタ\n- ExternalKubernetes: 登録済み外部 Kubernetes クラスタ",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "ClusterType"
        ]
      }
    },
    "DeletionProtection": {
      "Description": "削除保護が有効になっているかどうかを示します。削除保護が有効になっている場合、ACK コンソールまたは API を呼び出すことによってクラスタを削除することはできません。有効な値:\n- true: 削除保護が有効になっています。ACK コンソールまたは API を呼び出すことによってクラスタを削除することはできません。\n- false: 削除保護が有効になっていません。ACK コンソールまたは API を呼び出すことによってクラスタを削除できます。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "DeletionProtection"
        ]
      }
    },
    "VpcId": {
      "Description": "クラスタがデプロイされている VPC の ID。このパラメータは、ACK クラスタを作成するときに必須です。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "VpcId"
        ]
      }
    },
    "State": {
      "Description": "クラスタの状態。有効な値:\n- initial: クラスタが作成されています。\n- failed: クラスタの作成に失敗しました。\n- running: クラスタは実行中です。\n- updating: クラスタはアップグレードされています。\n- updating_failed: クラスタのアップグレードに失敗しました。\n- scaling: クラスタはスケーリングされています。\n- waiting: 登録済みクラスタは接続を待機しています。\n- disconnected: 登録済みクラスタは切断されています。\n- stopped: クラスタは停止されています。\n- deleting: クラスタは削除されています。\n- deleted: クラスタは削除されました。\n- delete_failed: クラスタの削除に失敗しました。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "State"
        ]
      }
    },
    "NextVersion": {
      "Description": "クラスタをアップグレードできる Kubernetes バージョン。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "NextVersion"
        ]
      }
    },
    "WorkerRamRoleName": {
      "Description": "ワーカー RAM ロールの名前。 \nRAM ロールはクラスタのワーカーノードに割り当てられ、ワーカーノードが Elastic Compute Service (ECS) インスタンスを管理できるようにします。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "WorkerRamRoleName"
        ]
      }
    },
    "RegionId": {
      "Description": "クラスタがデプロイされているリージョンの ID。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "RegionId"
        ]
      }
    },
    "MaintenanceWindow": {
      "Description": "クラスタのメンテナンスウィンドウ。この機能は、プロフェッショナルマネージド Kubernetes クラスタでのみ使用できます。",
      "Value": {
        "Fn::GetAtt": [
          "KubernetesCluster",
          "MaintenanceWindow"
        ]
      }
    }
  }
}

構文

プロパティ

戻り値

例

YAML 形式

JSON 形式

`YAML` 形式

`JSON` 形式