ALIYUN::ClickHouse::EnterpriseDBCluster - Resource Orchestration Service: Central de Documentação do Alibaba Cloud

Sintaxe

{
  "Type": "ALIYUN::ClickHouse::EnterpriseDBCluster",
  "Properties": {
    "Engine": String,
    "NodeScaleMin": Integer,
    "NodeCount": Integer,
    "NodeScaleMax": Integer,
    "VSwitchId": String,
    "VpcId": String,
    "ZoneId": String,
    "BackupSetId": String,
    "DBTimeZone": String,
    "DeploySchema": String,
    "DBInstanceDescription": String,
    "MultiZone": List,
    "ResourceGroupId": String,
    "StorageType": String,
    "SourceDBInstanceId": String,
    "StorageQuota": Integer,
    "PublicConnectionSetting": Map,
    "Tags": List
  }
}

Propriedades

Nome da propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrição
Engine	String	Sim	Não	Tipo do mecanismo.	Valor: ClickHouse
NodeCount	Integer	Sim	Não	Número de nós.	Valores válidos: 2 a 16. Obrigatório ao configurar o intervalo de dimensionamento elástico com NodeScaleMin e NodeScaleMax.
NodeScaleMax	Integer	Sim	Não	Número máximo de nós Serverless para dimensionamento elástico.	Valores válidos: 4 a 32. Deve ser maior que NodeScaleMin.
NodeScaleMin	Integer	Sim	Não	Número mínimo de nós Serverless para dimensionamento elástico.	Valores válidos: 4 a 32.
VpcId	String	Sim	Não	ID da VPC.	Nenhuma
VSwitchId	String	Sim	Não	ID do vSwitch.	Nenhuma
ZoneId	String	Sim	Não	ID da zona.	Nenhuma
BackupSetId	String	Não	Não	ID do conjunto de backup.	Nenhuma
DBInstanceDescription	String	Não	Não	Descrição do cluster.	Nenhuma
DBTimeZone	String	Não	Não	Fuso horário do kernel do banco de dados.	Nenhuma
DeploySchema	String	Não	Não	Modo de implantação do cluster entre zonas.	Valores válidos: single_az: implanta servidores na zona primária especificada por ZoneId. multi_az: implanta servidores em várias zonas especificadas por MultiZone.
MultiZone	List	Não	Não	Configuração multizona.	Para mais informações, consulte Propriedade MultiZone.
PublicConnectionSetting	Map	Não	Não	Configurações de conexão de rede pública.	Nenhuma
ResourceGroupId	String	Não	Não	ID do grupo de recursos ao qual o cluster pertence.	Nenhuma
SourceDBInstanceId	String	Não	Não	ID da instância de banco de dados de source.	Nenhuma
StorageQuota	Integer	Não	Não	Capacidade de armazenamento pré-adquirida, em GB.	Nenhuma
StorageType	String	Não	Não	Classe de armazenamento.	Nenhuma
Tags	List	Não	Não	Tags personalizadas associadas ao cluster.	Para mais informações, consulte Propriedade Tags.

Sintaxe de PublicConnectionSetting

"PublicConnectionSetting": 
  {
    "ConnectionPrefix": String,
    "EnablePublicConnection": Boolean
  }

Propriedades de PublicConnectionSetting

Nome da propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrição
ConnectionPrefix	String	Sim	Não	Prefixo do endpoint de destino.	Nenhuma
EnablePublicConnection	Boolean	Sim	Não	Indica se as conexões de rede pública devem ser ativadas.	Nenhuma

Sintaxe de MultiZone

"MultiZone": [
  {
    "ZoneId": String,
    "VSwitchIds": List
  }
]

Propriedades de MultiZone

Nome da propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrição
VSwitchIds	List	Sim	Não	Lista de IDs de vSwitch.	Nenhuma
ZoneId	String	Sim	Não	ID da zona.	Nenhuma

Sintaxe de Tags

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Propriedades de Tags

Nome da propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrição
Key	String	Sim	Não	Chave da tag.	Nenhuma
Value	String	Não	Não	Valor da tag.	Nenhuma

Valores de retorno

Fn::GetAtt

DBInstanceId: ID da instância de banco de dados Enterprise Edition.
PrivateConnectionString: endpoint de rede privada da instância de banco de dados Enterprise Edition.
PublicConnectionString: endpoint de rede pública da instância de banco de dados Enterprise Edition.

Exemplos

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  NodeScaleMin:
    Type: Number
    Description:
      en: The minimum number of nodes for scaling.
    Required: true
    MinValue: 4
    MaxValue: 32
  ZoneId:
    AssociationProperty: ZoneId
    Type: String
    Description:
      en: The ID of the zone.
    Required: true
  NodeCount:
    Type: Number
    Description:
      en: The number of nodes.
    Required: true
    MinValue: 2
    MaxValue: 16
  VSwitchId:
    AssociationPropertyMetadata:
      VpcId: ${VpcId}
      ZoneId: ${ZoneId}
    AssociationProperty: ALIYUN::VPC::VSwitch::VSwitchId
    Type: String
    Description:
      en: The ID of the VSwitch.
    Required: true
  VpcId:
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
    Type: String
    Description:
      en: The ID of the VPC.
    Required: true
  NodeScaleMax:
    Type: Number
    Description:
      en: The maximum number of nodes for scaling.
    Required: true
    MinValue: 4
    MaxValue: 32
  Engine:
    Type: String
    Description:
      en: The engine type.
    AllowedValues:
      - clickhouse
    Required: true
    Default: clickhouse
Resources:
  EnterpriseDBCluster:
    Type: ALIYUN::ClickHouse::EnterpriseDBCluster
    Properties:
      NodeScaleMin:
        Ref: NodeScaleMin
      ZoneId:
        Ref: ZoneId
      NodeCount:
        Ref: NodeCount
      VSwitchId:
        Ref: VSwitchId
      VpcId:
        Ref: VpcId
      NodeScaleMax:
        Ref: NodeScaleMax
      Engine:
        Ref: Engine
Outputs:
  DBInstanceId:
    Description: The ID of the database instance.
    Value:
      Fn::GetAtt:
        - EnterpriseDBCluster
        - DBInstanceId

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "NodeScaleMin": {
      "Type": "Number",
      "Description": {
        "en": "The minimum number of nodes for scaling."
      },
      "Required": true,
      "MinValue": 4,
      "MaxValue": 32
    },
    "ZoneId": {
      "AssociationProperty": "ZoneId",
      "Type": "String",
      "Description": {
        "en": "The ID of the zone."
      },
      "Required": true
    },
    "NodeCount": {
      "Type": "Number",
      "Description": {
        "en": "The number of nodes."
      },
      "Required": true,
      "MinValue": 2,
      "MaxValue": 16
    },
    "VSwitchId": {
      "AssociationPropertyMetadata": {
        "VpcId": "${VpcId}",
        "ZoneId": "${ZoneId}"
      },
      "AssociationProperty": "ALIYUN::VPC::VSwitch::VSwitchId",
      "Type": "String",
      "Description": {
        "en": "The ID of the VSwitch."
      },
      "Required": true
    },
    "VpcId": {
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "Type": "String",
      "Description": {
        "en": "The ID of the VPC."
      },
      "Required": true
    },
    "NodeScaleMax": {
      "Type": "Number",
      "Description": {
        "en": "The maximum number of nodes for scaling."
      },
      "Required": true,
      "MinValue": 4,
      "MaxValue": 32
    },
    "Engine": {
      "Type": "String",
      "Description": {
        "en": "The engine type."
      },
      "AllowedValues": [
        "clickhouse"
      ],
      "Required": true,
      "Default": "clickhouse"
    }
  },
  "Resources": {
    "EnterpriseDBCluster": {
      "Type": "ALIYUN::ClickHouse::EnterpriseDBCluster",
      "Properties": {
        "NodeScaleMin": {
          "Ref": "NodeScaleMin"
        },
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "NodeCount": {
          "Ref": "NodeCount"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "VpcId": {
          "Ref": "VpcId"
        },
        "NodeScaleMax": {
          "Ref": "NodeScaleMax"
        },
        "Engine": {
          "Ref": "Engine"
        }
      }
    }
  },
  "Outputs": {
    "DBInstanceId": {
      "Description": "The ID of the database instance.",
      "Value": {
        "Fn::GetAtt": [
          "EnterpriseDBCluster",
          "DBInstanceId"
        ]
      }
    }
  }
}