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

Crea una instancia de Elasticsearch.

Sintaxis

{
  "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
  }
}

Propiedades

Nombre de la propiedad	Tipo	Obligatorio	Actualización permitida	Descripción	Restricciones
DataNode	Map	Sí	Sí	La configuración del nodo de datos.	Para obtener más información, consulte DataNode properties.
Password	String	Sí	Sí	La contraseña de la instancia.	Debe tener entre 8 y 32 caracteres y contener como mínimo tres de los siguientes elementos: letras mayúsculas, letras minúsculas, dígitos y caracteres especiales (`!@#$%&*()_+-=`).
VSwitchId	String	Sí	No	El ID del vSwitch.	Ninguna
Version	String	Sí	No	La versión de Elasticsearch para desplegar.	Valores válidos: 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	No	Sí	La descripción de la instancia.	Debe tener entre 0 y 30 caracteres. Debe comenzar con una letra, un dígito o un carácter chino. Puede contener letras, dígitos, caracteres chinos, guiones bajos (_) y guiones (-).
DeleteType	String	No	No	El tipo de liberación.	Valores válidos: immediate: El clúster se elimina de inmediato. Se borran todos los datos y el clúster desaparece de la lista. protective (predeterminado): Los datos se borran después de que la instancia permanece congelada durante 24 horas. Durante este periodo, puede reanudar o liberar la instancia inmediatamente.
EnableKibanaPublic	Boolean	No	No	Indica si se habilita el acceso a la red pública para Kibana.	Valores válidos: true: Habilitado. false (predeterminado): Deshabilitado.
KibanaWhitelist	List	No	Sí	La lista de permitidos de direcciones IP de Kibana.	Ninguna
PublicWhitelist	List	No	Sí	La lista de permitidos de direcciones IP públicas.	Ninguna
InstanceChargeType	String	No	No	El método de facturación.	Valores válidos: PrePaid: suscripción. PostPaid (pay-as-you-go)
Period	Integer	No	No	La duración de la suscripción.	Valores válidos: 1 (predeterminado) 2 3 4 5 6 7 8 9 12 24 36 Unidad: meses.
ResourceGroupId	String	No	Sí	El ID del resource group.	Ninguna
EnablePublic	Boolean	No	Sí	Indica si se habilita el endpoint público.	Valores válidos: true: Habilitado. false (predeterminado): Deshabilitado.
PrivateWhitelist	List	No	Sí	La lista de permitidos de direcciones IP de VPC.	Ninguna
MasterNode	Map	No	Sí	La configuración del nodo maestro.	Si se especifica, se crea un nodo maestro dedicado. Para obtener más información, consulte MasterNode properties.
Tags	List	No	Sí	Las etiquetas.	Puede agregar hasta 20 etiquetas. Para obtener más información, consulte Tags properties.
YMLConfig	Map	No	No	La configuración del archivo YAML.	Para obtener más información, consulte YMLConfig properties.
EnableKibanaPrivate	Boolean	No	No	Indica si se habilita el acceso a la red privada para Kibana.	Valores válidos: true: Habilitado. false (predeterminado): Deshabilitado.
ZoneCount	Integer	No	No	El número de zonas para el despliegue.	Valores válidos: 1 (predeterminado) 2 3
KibanaNode	Map	No	No	La configuración del nodo dedicado de Kibana.	Ninguna
ZoneId	String	No	No	El ID de la zona.	Ninguna
PeriodUnit	String	No	No	La unidad de duración de la suscripción.	Valores válidos: Month Year
InstanceCategory	String	No	No	La edición de la instancia.	Valores válidos: x-pack: Crea una instancia Commercial Edition o una instancia Kernel-enhanced Edition con Indexing Service y OpenStore deshabilitados. IS: Crea una instancia Kernel-enhanced Edition con Indexing Service u OpenStore habilitado.

Sintaxis de DataNode

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

Propiedades de DataNode

Nombre de la propiedad	Tipo	Obligatorio	Actualización permitida	Descripción	Restricciones
Amount	Integer	Sí	Sí	El número de nodos de datos.	Valores válidos: de 2 a 50.
DiskSize	Integer	Sí	Sí	El espacio de almacenamiento por nodo de datos.	Valores válidos: Si establece DiskType en cloud_ssd: de 20 a 6144. Si establece DiskType en cloud_efficiency: de 20 a 20480. Los valores superiores a 2048 están limitados a: 2560 3072 3584 4096 4608 5120 5632 6144 8192 10240 12288 14336 16384 18432 20480 Nota Almacenar más de 5120 GB requiere Elasticsearch 6.7 o 7.X, o bien Advanced Edition. Si establece DiskType en cloud_essd: de 20 a 6144. Unidad: GB.
Spec	String	Sí	Sí	Las especificaciones del nodo de datos.	Las especificaciones de los nodos elásticos. Para obtener más información sobre las especificaciones, consulte Node specifications.
DiskType	String	Sí	Sí	El tipo de disco del nodo de datos.	Valores válidos: cloud_ssd: SSD estándar. Adecuado para escenarios de análisis y búsqueda en línea que requieren IOPS altos y respuestas rápidas de datos. cloud_efficiency: Disco ultra. Almacenamiento rentable, adecuado para escenarios de registros y análisis con grandes volúmenes de datos. cloud_essd: SSD empresarial. Baja latencia y alto throughput. Adecuado para cargas de trabajo sensibles a la latencia o intensivas en E/S.
DiskEncryption	Boolean	No	No	Indica si se habilita el cifrado de disco.	Valores válidos: true: Habilitado. false (predeterminado): Deshabilitado.
PerformanceLevel	String	No	No	El nivel de rendimiento (PL) del SSD empresarial.	Este parámetro es obligatorio si establece DiskType en cloud_essd. Valores válidos: PL1 PL2 PL3

Sintaxis de MasterNode

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

Propiedades de MasterNode

Nombre de la propiedad	Tipo	Obligatorio	Actualización permitida	Descripción	Restricciones
Spec	String	Sí	No	Las especificaciones del nodo maestro.	Las especificaciones del nodo maestro dedicado. Para obtener más información sobre las especificaciones, consulte Node specifications.
Amount	Integer	No	Sí	El número de nodos maestros.	Valor predeterminado: 3.
DiskSize	Integer	No	No	El espacio de disco del nodo maestro.	Valor predeterminado: 20.
DiskType	String	No	No	El tipo de disco del nodo maestro.	Valores válidos: cloud_ssd: SSD estándar cloud_essd (predeterminado): SSD empresarial

Sintaxis de Tags

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

Propiedades de Tags

Nombre de la propiedad	Tipo	Obligatorio	Actualización permitida	Descripción	Restricciones
Key	String	Sí	No	La clave de la etiqueta.	Debe tener entre 1 y 128 caracteres. No puede comenzar con `aliyun` ni con `acs:`, y no puede contener `http://` ni `https://`.
Value	String	No	No	El valor de la etiqueta.	Debe tener entre 0 y 128 caracteres. No puede comenzar con `aliyun` ni con `acs:`, y no puede contener `http://` ni `https://`.

Sintaxis de YMLConfig

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

Propiedades de YMLConfig

Nombre de la propiedad	Tipo	Obligatorio	Actualización permitida	Descripción	Restricciones
AuditLog	Boolean	No	No	Indica si se habilita el índice de registro de auditoría.	Valores válidos: true: Habilita el índice de registro de auditoría. Los registros de auditoría registran operaciones como creación, eliminación, modificación y consultas. Estos registros consumen espacio en disco y afectan el rendimiento. Úselos con precaución. Configure audit logs. false (predeterminado): Deshabilitado. Nota No es compatible con Elasticsearch 7.0 y versiones posteriores.
CreateIndex	String	No	No	Indica si se crean índices automáticamente cuando se indexa un documento en un índice inexistente.	El elemento de configuración correspondiente en el archivo YAML es action.auto_create_index. Valores válidos: true: Se permite la creación automática de índices. false (predeterminado): No se permite la creación automática de índices.
DestructiveRequiresName	Boolean	No	No	Indica si se requiere un nombre de índice explícito para eliminar un índice.	El elemento de configuración correspondiente en el archivo YAML es action.destructive_requires_name. Valores válidos: true (predeterminado): Debe especificar explícitamente el nombre del índice al eliminarlo. false: No es necesario especificar explícitamente el nombre del índice al eliminarlo. Nota Si se permiten caracteres comodín al eliminar o cerrar índices, es posible realizar eliminaciones por lotes. Los índices eliminados no se pueden restaurar. Use esta opción con precaución.
OtherConfigs	Map	No	No	Otras configuraciones.	Elementos de configuración compatibles (compatibles con Elasticsearch 5.x, 6.x y 7.x, salvo que se indique lo contrario): Configure CORS access http.cors.enabled http.cors.allow-origin http.cors.max-age http.cors.allow-methods http.cors.allow-headers http.cors.allow-credentials Configure a reindex whitelist reindex.remote.whitelist Configure audit logs 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 Configure queue size thread_pool.bulk.queue_size (para Elasticsearch 5.x) thread_pool.write.queue_size (para Elasticsearch 6.x y 7.x) thread_pool.search.queue_size Configuración personalizada del plugin SQL xpack.sql.enabled: De forma predeterminada, una instancia de Elasticsearch utiliza el plugin SQL incluido en X-Pack. Si desea cargar un plugin SQL personalizado, establezca xpack.sql.enabled en false.
Watcher	Boolean	No	No	Indica si se habilita Watcher.	El elemento de configuración YAML correspondiente es xpack.watcher.enabled. Valores válidos: true: Habilita Watcher. Borre periódicamente los índices `.watcher-history*` para evitar un uso excesivo del disco. false (predeterminado): Deshabilitado.

Sintaxis de KibanaNode

"KibanaNode": {
  "Spec": String
}

Propiedades de KibanaNode

Nombre de la propiedad	Tipo	Obligatorio	Actualización permitida	Descripción	Restricciones
Spec	String	Sí	No	Las especificaciones del nodo dedicado de Kibana.	Ninguna

Valores de retorno

Fn::GetAtt

Status: el estado de la instancia.
KibanaDomain: el endpoint de Kibana.
PublicDomain: el endpoint público de la instancia.
Domain: el endpoint interno de la instancia.
InstanceId: el ID de la instancia de Elasticsearch.
KibanaPort: el puerto de acceso a Kibana.
Port: el puerto de conexión de la instancia.
VSwitchId: el ID del vSwitch.
Version: la versión de la instancia.
InstanceChargeType: el método de facturación de la instancia.
Arn: el nombre de recurso de Alibaba Cloud (ARN).

Ejemplos

Formato `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: {}

Formato `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": {
  }
}

Sintaxis

Propiedades

Sintaxis de DataNode

Propiedades de DataNode

Sintaxis de MasterNode

Propiedades de MasterNode

Sintaxis de Tags

Propiedades de Tags

Sintaxis de YMLConfig

Propiedades de YMLConfig

Sintaxis de KibanaNode

Propiedades de KibanaNode

Valores de retorno

Ejemplos

Formato YAML

Formato JSON

Formato `YAML`

Formato `JSON`