Use DATASOURCE::MSE::Clusters to query Microservices Registry clusters - Resource Orchestration Service

DATASOURCE::MSE::Clusters is used to query Microservices Registry clusters.

Syntax

{
  "Type": "DATASOURCE::MSE::Clusters",
  "Properties": {
    "ClusterAliasName": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

ClusterAliasName

String

Yes

The cluster name.

Fuzzy match is supported.

RefreshOptions

String

Yes

The refresh policy for data source resources when the stack is updated.

Valid values:

Never (default): does not refresh data source resources when the stack is updated.
Always: refreshes data source resources when the stack is updated.

Return values (Fn::GetAtt)

ClusterIds: the IDs of the clusters.
Clusters: details of the clusters.

Property	Type	Description	Constraint
ClusterIds	List	The IDs of the clusters.	None.
Clusters	List	Details of the clusters.	None.
ClusterId	String	The cluster ID.	None.
ClusterName	String	The cluster name.	None.
ClusterAliasName	String	The alias of the cluster.	None.
InstanceId	String	The instance ID.	None.
AppVersion	String	The version of the application.	None.
VersionCode	String	The version of the cluster.	None.
InstanceCount	Number	The number of clusters.	None.
IntranetAddress	String	The private IP address.	None.
CanUpdate	Boolean	Indicates whether the cluster can be updated.	Valid values: true false
ChargeType	String	The billing method.	Valid values: PrePaid: subscription PostPaid: pay-as-you-go
InitStatus	String	The initialization status of the cluster.	None.
InternetAddress	String	The public IP address.	None.
IntranetDomain	String	The private domain name.	None.
CreateTime	String	The time when the cluster was created.	The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
EndDate	String	The expiration time of the cluster.	The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

Examples

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ClusterAliasName": {
      "Type": "String",
      "Description": "The alias name of cluster."
    }
  },
  "Resources": {
    "Clusters": {
      "Type": "DATASOURCE::MSE::Clusters",
      "Properties": {
        "ClusterAliasName": {
          "Ref": "ClusterAliasName"
        }
      }
    }
  },
  "Outputs": {
    "Clusters": {
      "Description": "The list of clusters.",
      "Value": {
        "Fn::GetAtt": [
          "Clusters",
          "Clusters"
        ]
      }
    },
    "ClusterIds": {
      "Description": "The list of cluster IDs.",
      "Value": {
        "Fn::GetAtt": [
          "Clusters",
          "ClusterIds"
        ]
      }
    }
  }
}

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ClusterAliasName:
    Type: String
    Description: The alias name of cluster.
Resources:
  Clusters:
    Type: DATASOURCE::MSE::Clusters
    Properties:
      ClusterAliasName:
        Ref: ClusterAliasName
Outputs:
  Clusters:
    Description: The list of clusters.
    Value:
      Fn::GetAtt:
        - Clusters
        - Clusters
  ClusterIds:
    Description: The list of cluster IDs.
    Value:
      Fn::GetAtt:
        - Clusters
        - ClusterIds