ALIYUN::ElasticSearch::Instance - Criar instância do Elasticsearch no ROS - Resource Orchestration Service: Central de Documentação do Alibaba Cloud

Sintaxe

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

Propriedades

Nome da propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrições
DataNode	Map	Sim	Sim	Configurações do nó de dados.	Para mais informações, consulte Propriedades de DataNode.
Password	String	Sim	Sim	Senha da instância.	Deve ter de 8 a 32 caracteres e conter pelo menos três dos seguintes tipos: letras maiúsculas, letras minúsculas, dígitos e caracteres especiais (`!@#$%&*()_+-=`).
VSwitchId	String	Sim	Não	ID do vSwitch.	Nenhuma
Version	String	Sim	Não	Versão do Elasticsearch a implantar.	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	Não	Sim	Descrição da instância.	Deve ter de 0 a 30 caracteres. Deve começar com uma letra, dígito ou caractere chinês. Pode conter letras, dígitos, caracteres chineses, sublinhados (_) e hifens (-).
DeleteType	String	Não	Não	Tipo de liberação.	Valores válidos: immediate: exclua o cluster imediatamente. Todos os dados são removidos e o cluster desaparece da lista. protective (padrão): limpa os dados após a instância ficar congelada por 24 horas. Durante esse período, você pode retomar ou liberar imediatamente a instância.
EnableKibanaPublic	Boolean	Não	Não	Indica se o acesso à rede pública para o Kibana está ativado.	Valores válidos: true: ativado. false (padrão): desativado.
KibanaWhitelist	List	Não	Sim	Lista de permissões de endereços IP do Kibana.	Nenhuma
PublicWhitelist	List	Não	Sim	Lista de permissões de endereços IP públicos.	Nenhuma
InstanceChargeType	String	Não	Não	Método de faturamento.	Valores válidos: PrePaid: assinatura. PostPaid (pagamento conforme o uso)
Period	Integer	Não	Não	Duração da assinatura.	Valores válidos: 1 (padrão) 2 3 4 5 6 7 8 9 12 24 36 Unidade: meses.
ResourceGroupId	String	Não	Sim	ID do grupo de recursos.	Nenhuma
EnablePublic	Boolean	Não	Sim	Indica se o endpoint público está ativado.	Valores válidos: true: ativado. false (padrão): desativado.
PrivateWhitelist	List	Não	Sim	Lista de permissões de endereços IP da VPC.	Nenhuma
MasterNode	Map	Não	Sim	Configurações do nó mestre.	Se especificado, crie um nó mestre dedicado. Para mais informações, consulte Propriedades de MasterNode.
Tags	List	Não	Sim	Tags.	É possível adicionar até 20 tags. Para mais informações, consulte Propriedades de Tags.
YMLConfig	Map	Não	Não	Configuração do arquivo YAML.	Para mais informações, consulte Propriedades de YMLConfig.
EnableKibanaPrivate	Boolean	Não	Não	Indica se o acesso à rede privada para o Kibana está ativado.	Valores válidos: true: ativado. false (padrão): desativado.
ZoneCount	Integer	Não	Não	Número de zonas para implantação.	Valores válidos: 1 (padrão) 2 3
KibanaNode	Map	Não	Não	Configurações do nó dedicado do Kibana.	Nenhuma
ZoneId	String	Não	Não	ID da zona.	Nenhuma
PeriodUnit	String	Não	Não	Unidade de duração da assinatura.	Valores válidos: Month Year
InstanceCategory	String	Não	Não	Edição da instância.	Valores válidos: x-pack: crie uma instância da Commercial Edition ou da Kernel-enhanced Edition com Indexing Service e OpenStore desativados. IS: crie uma instância da Kernel-enhanced Edition com Indexing Service ou OpenStore ativado.

Sintaxe de DataNode

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

Propriedades de DataNode

Nome da propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrições
Amount	Integer	Sim	Sim	Número de nós de dados.	Valores válidos: 2 a 50.
DiskSize	Integer	Sim	Sim	Espaço de armazenamento por nó de dados.	Valores válidos: Se DiskType for definido como cloud_ssd: 20 a 6144. Se DiskType for definido como cloud_efficiency: 20 a 20480. Valores acima de 2.048 são limitados a: 2560 3072 3584 4096 4608 5120 5632 6144 8192 10240 12288 14336 16384 18432 20480 Nota Armazenar mais de 5.120 GB requer Elasticsearch 6.7 ou 7.X, ou Advanced Edition. Se DiskType for definido como cloud_essd: 20 a 6144. Unidade: GB.
Spec	String	Sim	Sim	Especificações do nó de dados.	Especificações dos nós elásticos. Para mais informações sobre as especificações, consulte Especificações de nós.
DiskType	String	Sim	Sim	Tipo de disco do nó de dados.	Valores válidos: cloud_ssd: SSD padrão. Adequado para cenários de análise e pesquisa online que exigem alto IOPS e respostas rápidas de dados. cloud_efficiency: disco ultra. Armazenamento econômico adequado para cenários de log e análise com grandes volumes de dados. cloud_essd: SSD empresarial. Baixa latência e alto throughput. Adequado para cargas de trabalho sensíveis à latência ou intensivas em E/S.
DiskEncryption	Boolean	Não	Não	Indica se a criptografia de disco está ativada.	Valores válidos: true: ativado. false (padrão): desativado.
PerformanceLevel	String	Não	Não	Nível de desempenho (PL) do SSD empresarial.	Este parâmetro é obrigatório se DiskType for definido como cloud_essd. Valores válidos: PL1 PL2 PL3

Sintaxe de MasterNode

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

Propriedades de MasterNode

Nome da propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrições
Spec	String	Sim	Não	Especificações do nó mestre.	Especificações do nó mestre dedicado. Para mais informações sobre as especificações, consulte Especificações de nós.
Amount	Integer	Não	Sim	Número de nós mestres.	Valor padrão: 3.
DiskSize	Integer	Não	Não	Espaço em disco do nó mestre.	Valor padrão: 20.
DiskType	String	Não	Não	Tipo de disco do nó mestre.	Valores válidos: cloud_ssd: SSD padrão cloud_essd (padrão): SSD empresarial

Sintaxe de Tags

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

Propriedades de Tags

Nome da propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrições
Key	String	Sim	Não	Chave da tag.	Deve ter de 1 a 128 caracteres. Não pode começar com `aliyun` ou `acs:` e não pode conter `http://` ou `https://`.
Value	String	Não	Não	Valor da tag.	Deve ter de 0 a 128 caracteres. Não pode começar com `aliyun` ou `acs:` e não pode conter `http://` ou `https://`.

Sintaxe de YMLConfig

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

Propriedades de YMLConfig

Nome da propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrições
AuditLog	Boolean	Não	Não	Indica se o índice de log de auditoria está ativado.	Valores válidos: true: ative o índice de log de auditoria. Os logs de auditoria registram operações como criação, exclusão, modificação e consultas. Esses logs consomem espaço em disco e afetam o desempenho. Use com cautela. Configurar logs de auditoria. false (padrão): desativado. Nota Não compatível com Elasticsearch 7.0 e versões posteriores.
CreateIndex	String	Não	Não	Indica se índices devem ser criados automaticamente quando um documento é indexado em um índice inexistente.	O item de configuração correspondente no arquivo YAML é action.auto_create_index. Valores válidos: true: permite a criação automática de índices. false (padrão): não permite a criação automática de índices.
DestructiveRequiresName	Boolean	Não	Não	Indica se um nome de índice explícito é necessário para excluir um índice.	O item de configuração correspondente no arquivo YAML é action.destructive_requires_name. Valores válidos: true (padrão): exige a especificação explícita do nome do índice ao excluir um índice. false: não exige a especificação explícita do nome do índice ao excluir um índice. Nota Se caracteres curinga forem permitidos ao excluir ou fechar índices, a exclusão em lote será possível. Índices excluídos não podem ser restaurados. Use com cautela.
OtherConfigs	Map	Não	Não	Outras configurações.	Itens de configuração compatíveis (suportados em Elasticsearch 5.x, 6.x e 7.x, salvo indicação em contrário): Configurar acesso CORS http.cors.enabled http.cors.allow-origin http.cors.max-age http.cors.allow-methods http.cors.allow-headers http.cors.allow-credentials Configurar lista de permissões de reindexação reindex.remote.whitelist Configurar logs de auditoria 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 Configurar tamanho da fila thread_pool.bulk.queue_size (para Elasticsearch 5.x) thread_pool.write.queue_size (para Elasticsearch 6.x e 7.x) thread_pool.search.queue_size Configuração personalizada do plugin SQL xpack.sql.enabled: por padrão, uma instância do Elasticsearch usa o plugin SQL fornecido com o X-Pack. Se você quiser carregar um plugin SQL personalizado, defina xpack.sql.enabled como false.
Watcher	Boolean	Não	Não	Indica se o Watcher está ativado.	O item de configuração YAML correspondente é xpack.watcher.enabled. Valores válidos: true: ative o Watcher. Limpe periodicamente os índices `.watcher-history*` para evitar uso excessivo de disco. false (padrão): desativado.

Sintaxe de KibanaNode

"KibanaNode": {
  "Spec": String
}

Propriedades de KibanaNode

Nome da propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrições
Spec	String	Sim	Não	Especificações do nó dedicado do Kibana.	Nenhuma

Valores de retorno

Fn::GetAtt

Status: status da instância.
KibanaDomain: endpoint do Kibana.
PublicDomain: endpoint público da instância.
Domain: endpoint interno da instância.
InstanceId: ID da instância do Elasticsearch.
KibanaPort: porta de acesso do Kibana.
Port: porta de conexão da instância.
VSwitchId: ID do vSwitch.
Version: versão da instância.
InstanceChargeType: método de faturamento da instância.
Arn: Alibaba Cloud Resource Name (ARN).

Exemplos

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

Sintaxe

Propriedades

Sintaxe de DataNode

Propriedades de DataNode

Sintaxe de MasterNode

Propriedades de MasterNode

Sintaxe de Tags

Propriedades de Tags

Sintaxe de YMLConfig

Propriedades de YMLConfig

Sintaxe de KibanaNode

Propriedades de KibanaNode

Valores de retorno

Exemplos

Formato YAML

Formato JSON

Formato `YAML`

Formato `JSON`