ALIYUN::ElasticSearch::Instance - Create Elasticsearch instance in ROS - Resource Orchestration Service

Syntaxe

{
  "Type": "ALIYUN::ElasticSearch::Instance",
  "Properties": {
    "KibanaWhitelist": List,
    "PublicWhitelist": List,
    "VSwitchId": String,
    "InstanceChargeType": String,
    "Period": Integer,
    "Version": String,
    "DataNode": Map,
    "PrivateWhitelist": List,
    "ResourceGroupId": String,
    "EnablePublic": Boolean,
    "Password": String,
    "MasterNode": Map,
    "Tags": List,
    "Description": String,
    "EnableKibanaPublic": Boolean,
    "YMLConfig": Map,
    "EnableKibanaPrivate": Boolean,
    "ZoneCount": Integer,
    "KibanaNode": Map,
    "ZoneId": String,
    "PeriodUnit": String,
    "InstanceCategory": String,
    "DeleteType": String
  }
}

Propriétés

Nom de la propriété	Type	Obligatoire	Mise à jour autorisée	Description	Contraintes
DataNode	Map	Oui	Oui	Paramètres du nœud de données.	Pour plus d'informations, consultez les propriétés DataNode.
Password	String	Oui	Oui	Mot de passe de l'instance.	Doit contenir entre 8 et 32 caractères et inclure au moins trois des éléments suivants : lettres majuscules, lettres minuscules, chiffres et caractères spéciaux (`!@#$%&*()_+-=`).
VSwitchId	String	Oui	Non	ID du vSwitch.	Aucune
Version	String	Oui	Non	Version d'Elasticsearch à déployer.	Valeurs valides : 7.10_with_X-Pack 6.7_with_X-Pack 6.7_with_X-Pack 7.7_with_X-Pack 6.8_with_X-Pack 6.3_with_X-Pack 5.6_with_X-Pack 5.5.3_with_X-Pack
Description	String	Non	Oui	Description de l'instance.	Doit contenir entre 0 et 30 caractères. Doit commencer par une lettre, un chiffre ou un caractère chinois. Peut contenir des lettres, des chiffres, des caractères chinois, des traits de soulignement (_) et des tirets (-).
DeleteType	String	Non	Non	Type de suppression.	Valeurs valides : immediate : le cluster est supprimé immédiatement. Toutes les données sont retirées et le cluster disparaît de la liste. protective (par défaut) : les données sont effacées après que l'instance a été gelée pendant 24 heures. Durant cette période, vous pouvez reprendre ou libérer immédiatement l'instance.
EnableKibanaPublic	Boolean	Non	Non	Indique s'il faut activer l'accès au réseau public pour Kibana.	Valeurs valides : true : activé. false (par défaut) : désactivé.
KibanaWhitelist	List	Non	Oui	Liste blanche d'adresses IP pour Kibana.	Aucune
PublicWhitelist	List	Non	Oui	Liste blanche d'adresses IP publiques.	Aucune
InstanceChargeType	String	Non	Non	Méthode de facturation.	Valeurs valides : PrePaid : abonnement. PostPaid (paiement à l'utilisation)
Period	Integer	Non	Non	Durée de l'abonnement.	Valeurs valides : 1 (par défaut) 2 3 4 5 6 7 8 9 12 24 36 Unité : mois.
ResourceGroupId	String	Non	Oui	ID du groupe de ressources.	Aucune
EnablePublic	Boolean	Non	Oui	Indique s'il faut activer l'endpoint public.	Valeurs valides : true : activé. false (par défaut) : désactivé.
PrivateWhitelist	List	Non	Oui	Liste blanche d'adresses IP VPC.	Aucune
MasterNode	Map	Non	Oui	Paramètres du nœud maître.	Si ce paramètre est spécifié, un nœud maître dédié est créé. Pour plus d'informations, consultez les propriétés MasterNode.
Tags	List	Non	Oui	Tags.	Vous pouvez ajouter jusqu'à 20 tags. Pour plus d'informations, consultez les propriétés Tags.
YMLConfig	Map	Non	Non	Configuration du fichier YAML.	Pour plus d'informations, consultez les propriétés YMLConfig.
EnableKibanaPrivate	Boolean	Non	Non	Indique s'il faut activer l'accès au réseau privé pour Kibana.	Valeurs valides : true : activé. false (par défaut) : désactivé.
ZoneCount	Integer	Non	Non	Nombre de zones pour le déploiement.	Valeurs valides : 1 (par défaut) 2 3
KibanaNode	Map	Non	Non	Paramètres du nœud Kibana dédié.	Aucune
ZoneId	String	Non	Non	ID de la zone.	Aucune
PeriodUnit	String	Non	Non	Unité de durée de l'abonnement.	Valeurs valides : Month Year
InstanceCategory	String	Non	Non	Édition de l'instance.	Valeurs valides : x-pack : crée une instance Commercial Edition ou une instance Kernel-enhanced Edition pour laquelle Indexing Service et OpenStore sont désactivés. IS : crée une instance Kernel-enhanced Edition pour laquelle Indexing Service ou OpenStore est activé.

Syntaxe DataNode

"DataNode": {
  "Amount": Integer,
  "DiskSize": Integer,
  "Spec": String,
  "DiskType": String,
  "DiskEncryption": Boolean,
  "PerformanceLevel": String
}

Propriétés DataNode

Nom de la propriété	Type	Obligatoire	Mise à jour autorisée	Description	Contraintes
Amount	Integer	Oui	Oui	Nombre de nœuds de données.	Valeurs valides : 2 à 50.
DiskSize	Integer	Oui	Oui	Espace de stockage par nœud de données.	Valeurs valides : Si DiskType est défini sur cloud_ssd : 20 à 6144. Si DiskType est défini sur cloud_efficiency : 20 à 20480. Les valeurs supérieures à 2 048 sont limitées à : 2560 3072 3584 4096 4608 5120 5632 6144 8192 10240 12288 14336 16384 18432 20480 Remarque Le stockage de plus de 5 120 Go nécessite Elasticsearch 6.7 ou 7.X, ou l'édition Advanced. Si DiskType est défini sur cloud_essd : 20 à 6144. Unité : Go.
Spec	String	Oui	Oui	Spécifications du nœud de données.	Spécifications des nœuds élastiques. Pour plus d'informations sur les spécifications, consultez les spécifications des nœuds.
DiskType	String	Oui	Oui	Type de disque du nœud de données.	Valeurs valides : cloud_ssd : SSD standard. Adapté aux scénarios d'analyse en ligne et de recherche nécessitant des IOPS élevés et des réponses rapides aux données. cloud_efficiency : ultra-disque. Solution de stockage rentable adaptée aux scénarios de journalisation et d'analyse avec de grands volumes de données. cloud_essd : SSD d'entreprise. Faible latence, débit élevé. Adapté aux charges de travail sensibles à la latence ou intensives en E/S.
DiskEncryption	Boolean	Non	Non	Indique s'il faut activer le chiffrement des disques.	Valeurs valides : true : activé. false (par défaut) : désactivé.
PerformanceLevel	String	Non	Non	Niveau de performance (PL) du SSD d'entreprise.	Ce paramètre est requis si DiskType est défini sur cloud_essd. Valeurs valides : PL1 PL2 PL3

Syntaxe MasterNode

"MasterNode": {
  "Amount": Integer,
  "DiskSize": Integer,
  "Spec": String,
  "DiskType": String
}

Propriétés MasterNode

Nom de la propriété	Type	Obligatoire	Mise à jour autorisée	Description	Contraintes
Spec	String	Oui	Non	Spécifications du nœud maître.	Spécifications du nœud maître dédié. Pour plus d'informations sur les spécifications, consultez les spécifications des nœuds.
Amount	Integer	Non	Oui	Nombre de nœuds maîtres.	Valeur par défaut : 3.
DiskSize	Integer	Non	Non	Espace disque du nœud maître.	Valeur par défaut : 20.
DiskType	String	Non	Non	Type de disque du nœud maître.	Valeurs valides : cloud_ssd : SSD standard cloud_essd (par défaut) : SSD d'entreprise

Syntaxe Tags

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

Syntaxe YMLConfig

"YMLConfig": {
    "CreateIndex": String,
    "Watcher": String,
    "DestructiveRequiresName": Boolean,
    "AuditLog": Boolean,
    "OtherConfigs": Map
  }

Propriétés YMLConfig

Nom de la propriété	Type	Obligatoire	Mise à jour autorisée	Description	Contraintes
AuditLog	Boolean	Non	Non	Indique s'il faut activer l'index des journaux d'audit.	Valeurs valides : true : active l'index des journaux d'audit. Les journaux d'audit enregistrent les opérations telles que la création, la suppression, la modification et les requêtes. Ces journaux consomment de l'espace disque et affectent les performances. À utiliser avec précaution. Configurer les journaux d'audit. false (par défaut) : désactivé. Remarque Non pris en charge pour Elasticsearch 7.0 et versions ultérieures.
CreateIndex	String	Non	Non	Indique s'il faut créer automatiquement des index lorsqu'un document est indexé dans un index inexistant.	L'élément de configuration correspondant dans le fichier YAML est action.auto_create_index. Valeurs valides : true : la création automatique d'index est autorisée. false (par défaut) : la création automatique d'index n'est pas autorisée.
DestructiveRequiresName	Boolean	Non	Non	Indique si un nom d'index explicite est requis pour supprimer un index.	L'élément de configuration correspondant dans le fichier YAML est action.destructive_requires_name. Valeurs valides : true (par défaut) : vous devez spécifier explicitement le nom de l'index lors de la suppression d'un index. false : vous n'avez pas besoin de spécifier explicitement le nom de l'index lors de la suppression d'un index. Remarque Si les caractères génériques sont autorisés lors de la suppression ou de la fermeture d'index, une suppression par lot est possible. Les index supprimés ne peuvent pas être restaurés. À utiliser avec précaution.
OtherConfigs	Map	Non	Non	Autres configurations.	Éléments de configuration pris en charge (compatibles avec Elasticsearch 5.x, 6.x et 7.x sauf indication contraire) : Configurer l'accès CORS http.cors.enabled http.cors.allow-origin http.cors.max-age http.cors.allow-methods http.cors.allow-headers http.cors.allow-credentials Configurer une liste blanche de réindexation reindex.remote.whitelist Configurer les journaux d'audit xpack.security.audit.enabled xpack.security.audit.index.bulk_size xpack.security.audit.index.flush_interval xpack.security.audit.index.rollover xpack.security.audit.index.events.include xpack.security.audit.index.events.exclude xpack.security.audit.index.events.emit_request_body Configurer la taille de la file d'attente thread_pool.bulk.queue_size (pour Elasticsearch 5.x) thread_pool.write.queue_size (pour Elasticsearch 6.x et 7.x) thread_pool.search.queue_size Configuration personnalisée du plug-in SQL xpack.sql.enabled : par défaut, une instance Elasticsearch utilise le plug-in SQL fourni avec X-Pack. Si vous souhaitez télécharger un plug-in SQL personnalisé, définissez xpack.sql.enabled sur false.
Watcher	Boolean	Non	Non	Indique s'il faut activer Watcher.	L'élément de configuration YAML correspondant est xpack.watcher.enabled. Valeurs valides : true : active Watcher. Effacez périodiquement les index `.watcher-history*` pour éviter une utilisation excessive du disque. false (par défaut) : désactivé.

Syntaxe KibanaNode

"KibanaNode": {
  "Spec": String
}

Propriétés KibanaNode

|
**Nom de la propriété**
|
**Type**
|
**Obligatoire**
|
**Mise à jour autorisée**
|
**Description**
|
**Contraintes**
| | --- | --- | --- | --- | --- | --- | |
Spec
|
String
|
Oui
|
Non
|
Spécifications du nœud Kibana dédié.
|
Aucune
|

Valeurs de retour

Fn::GetAtt

Status : statut de l'instance.
KibanaDomain : endpoint Kibana.
PublicDomain : endpoint public de l'instance.
Domain : endpoint interne de l'instance.
InstanceId : ID de l'instance Elasticsearch.
KibanaPort : port d'accès Kibana.
Port : port de connexion de l'instance.
VSwitchId : ID du vSwitch.
Version : version de l'instance.
InstanceChargeType : méthode de facturation de l'instance.
Arn : nom de ressource Alibaba Cloud (ARN).

Exemples

Format `YAML`

ROSTemplateFormatVersion: '2015-09-01'
Description: Test ElasticSearch Instance
Parameters:
  VSwitchId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
Resources:
  Instance:
    Type: ALIYUN::ElasticSearch::Instance
    Properties:
      DataNode:
        Spec: elasticsearch.sn1ne.large
        Amount: 2
        DiskSize: 20
        DiskType: cloud_essd
      InstanceChargeType: PostPaid
      Version: 7.10_with_X-Pack
      VSwitchId:
        Ref: VSwitchId
      Password: Admin@123!
Outputs: {}

Format `JSON`

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": "Test ElasticSearch Instance",
  "Parameters": {
    "VSwitchId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId"
    }
  },
  "Resources": {
    "Instance": {
      "Type": "ALIYUN::ElasticSearch::Instance",
      "Properties": {
        "DataNode": {
          "Spec": "elasticsearch.sn1ne.large",
          "Amount": 2,
          "DiskSize": 20,
          "DiskType": "cloud_essd"
        },
        "InstanceChargeType": "PostPaid",
        "Version": "7.10_with_X-Pack",
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "Password": "Admin@123!"
      }
    }
  },
  "Outputs": {
  }
}

Resource Orchestration Service:ALIYUN::ElasticSearch::Instance

Syntaxe

Propriétés

Syntaxe DataNode

Propriétés DataNode

Syntaxe MasterNode

Propriétés MasterNode

Syntaxe Tags

Propriétés Tags

Syntaxe YMLConfig

Propriétés YMLConfig

Syntaxe KibanaNode

Propriétés KibanaNode

Valeurs de retour

Exemples

Format `YAML`

Format `JSON`

Syntaxe

Propriétés

Syntaxe DataNode

Propriétés DataNode

Syntaxe MasterNode

Propriétés MasterNode

Syntaxe Tags

Propriétés Tags

Syntaxe YMLConfig

Propriétés YMLConfig

Syntaxe KibanaNode

Propriétés KibanaNode

Valeurs de retour

Exemples

Format YAML

Format JSON

Format `YAML`

Format `JSON`