All Products
Search

This Product

    Resource Orchestration Service:DATASOURCE::CS::ClusterUserKubeconfig

    Document Center

    Resource Orchestration Service:DATASOURCE::CS::ClusterUserKubeconfig

    Last Updated:Jun 08, 2026

    Queries the kubeconfig file of an ACK cluster by cluster ID.

    Syntax

    {
  "Type": "DATASOURCE::CS::ClusterUserKubeconfig",
  "Properties": {
    "PrivateIpAddress": Boolean,
    "ClusterId": String,
    "TemporaryDurationMinutes": Integer,
    "RefreshOptions": String
  }
}

    Properties

    Property

    Type

    Required

    Editable

    Description

    Constraint

    PrivateIpAddress

    Boolean

    No

    Yes

    Specifies whether to query only the kubeconfig file for internal network connections.

    Valid values:

    • true: Queries only the kubeconfig file for internal network connections.

    • false (default): Queries only the kubeconfig file for Internet connections.

    ClusterId

    String

    Yes

    Yes

    The cluster ID.

    None.

    TemporaryDurationMinutes

    Integer

    No

    Yes

    Validity period of the temporary kubeconfig file.

    Unit: minutes. Valid values: 15 to 4320.

    Note

    If not specified, the system assigns a validity period, returned in the Expiration attribute.

    RefreshOptions

    String

    No

    Yes

    Refresh policy for data source resources on stack updates.

    Valid values:

    • Never (default): Does not refresh data source resources on stack updates.

    • Always: Refreshes data source resources on stack updates.

    Return values

    Fn::GetAtt

    • ClusterId: The cluster ID.

    • Config: The access configurations of the cluster.

    • Expiration: Expiration time of the kubeconfig file in RFC 3339 format (UTC).

    Examples

    YAML format

    ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ClusterId:
    Description: The ID of the ACK cluster.
    Type: String
Resources:
  ClusterUserKubeconfig:
    Properties:
      ClusterId:
        Ref: ClusterId
    Type: DATASOURCE::CS::ClusterUserKubeconfig
Outputs:
  ClusterId:
    Description: The ID of the ACK cluster.
    Value:
      Fn::GetAtt:
      - ClusterUserKubeconfig
      - ClusterId
  Config:
    Description: The content of the kubeconfig file.
    Value:
      Fn::GetAtt:
      - ClusterUserKubeconfig
      - Config
  Expiration:
    Description: The expiration time of the kubeconfig file. The value is the UTC
      time displayed in RFC3339 format.
    Value:
      Fn::GetAtt:
      - ClusterUserKubeconfig
      - Expiration

    JSON format

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ClusterId": {
      "Type": "String",
      "Description": "The ID of the ACK cluster."
    }
  },
  "Resources": {
    "ClusterUserKubeconfig": {
      "Type": "DATASOURCE::CS::ClusterUserKubeconfig",
      "Properties": {
        "ClusterId": {
          "Ref": "ClusterId"
        }
      }
    }
  },
  "Outputs": {
    "ClusterId": {
      "Description": "The ID of the ACK cluster.",
      "Value": {
        "Fn::GetAtt": [
          "ClusterUserKubeconfig",
          "ClusterId"
        ]
      }
    },
    "Config": {
      "Description": "The content of the kubeconfig file.",
      "Value": {
        "Fn::GetAtt": [
          "ClusterUserKubeconfig",
          "Config"
        ]
      }
    },
    "Expiration": {
      "Description": "The expiration time of the kubeconfig file. The value is the UTC time displayed in RFC3339 format.",
      "Value": {
        "Fn::GetAtt": [
          "ClusterUserKubeconfig",
          "Expiration"
        ]
      }
    }
  }
}