Use ALIYUN::MONGODB::ShardingInstance to create or clone an ApsaraDB for MongoDB sharded cluster instance - Resource Orchestration Service: Central de Documentação do Alibaba Cloud

Sintaxe

{
  "Type": "ALIYUN::MONGODB::ShardingInstance",
  "Properties": {
    "EngineVersion": String,
    "ZoneId": String,
    "AutoRenew": Boolean,
    "VSwitchId": String,
    "Period": Integer,
    "SecurityIPArray": String,
    "Mongos": List,
    "StorageEngine": String,
    "RestoreTime": String,
    "AccountPassword": String,
    "VpcId": String,
    "ProtocolType": String,
    "ChargeType": String,
    "ConfigServer": List,
    "SrcDBInstanceId": String,
    "ReplicaSet": List,
    "Tags": List,
    "TDEStatus": Boolean,
    "DBInstanceDescription": String,
    "ResourceGroupId": String,
    "SecondaryZoneId": String,
    "HiddenZoneId": String,
    "StorageType": String
  }
}

Propriedades

Property	Type	Required	Editable	Description	Constraint
ConfigServer	List	Yes	No	Configurações do nó Configserver.	Para obter mais informações, consulte Propriedades de ConfigServer.
Mongos	List	Yes	No	Nós mongos.	Use de 2 a 32 nós mongos. Para obter mais informações, consulte Propriedade de Mongos.
ReplicaSet	List	Yes	No	Nós de shard.	Configure de 2 a 32 nós de shard. Para obter mais informações, consulte Propriedades de ReplicaSet.
EngineVersion	String	No	No	Versão do mecanismo de banco de dados.	Valores válidos: 3.4 4.0 4.2 Nota Ao clonar uma instância, o valor desta propriedade deve ser idêntico à versão do mecanismo de banco de dados da instância de origem.
ZoneId	String	No	No	ID da zona.	Nenhuma.
AutoRenew	Boolean	No	No	Define se a renovação automática da instância estará ativada.	Valores válidos: true: ativa a renovação automática da instância. false (padrão): desativa a renovação automática. Nesse caso, renove a instância manualmente. Nota Esta propriedade só tem efeito quando ChargeType está definido como PrePaid.
VSwitchId	String	No	No	ID do vSwitch.	Nenhuma.
Period	Integer	No	Yes	Duração da assinatura da instância.	Valores válidos: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24 e 36. Unidade: mês. Nota Especifique esta propriedade quando ChargeType estiver definido como PrePaid.
SecurityIPArray	String	No	Yes	Entradas na lista de permissões de endereços IP da instância.	Separe vários endereços IP na lista de permissões com vírgulas (,). Cada endereço IP deve ser único na lista, que pode conter até 1.000 endereços. Os formatos aceitos para as entradas da lista de permissões são: %. 0.0.0.0/0. Endereços IP, como 10.23.XX.XX. Blocos CIDR, como 10.23.XX.XX/24. O sufixo /24 indica que o prefixo do bloco CIDR tem 24 bits. Substitua 24 por qualquer valor entre 1 e 32. Nota Os valores % e 0.0.0.0/0 permitem o acesso aos bancos de dados da instância a partir de qualquer endereço IP, o que gera riscos de segurança. Utilize essas configurações com cautela.
StorageEngine	String	No	No	Mecanismo de armazenamento utilizado pela instância.	Valores válidos: WiredTiger (padrão): adequado para a maioria dos cenários. RocksDB: recomendado para cenários com alto volume de operações de escrita e poucas leituras. TerarkDB: ideal para cenários com predominância de leituras sobre escritas, ou para situações que exigem múltiplas escritas simultâneas combinadas a um grande volume de leituras. Nota Na clonagem de instâncias, esta propriedade deve corresponder ao mecanismo de armazenamento da instância de origem.
RestoreTime	String	No	No	Ponto no tempo para restauração dos dados durante a clonagem da instância.	Especifique o horário no padrão ISO 8601, formato yyyy-MM-ddTHH:mm:ssZ, em UTC. Esta propriedade aplica-se exclusivamente à clonagem de instâncias e deve ser configurada em conjunto com SrcDBInstanceId. Nota O ponto de restauração pode ser qualquer momento dentro dos últimos sete dias.
AccountPassword	String	No	Yes	Senha da conta root.	A senha deve ter entre 8 e 32 caracteres e incluir pelo menos três dos seguintes tipos: letras maiúsculas, letras minúsculas, dígitos e caracteres especiais. Caracteres especiais suportados: `! # $ % ^ & * ( ) _ + - =`.
VpcId	String	No	No	ID da Virtual Private Cloud (VPC).	Nenhuma.
ProtocolType	String	No	No	Tipo de protocolo de acesso.	Valores válidos: mongodb dynamodb
ChargeType	String	No	Yes	Método de faturamento da instância.	Valores válidos: PostPaid (padrão): pagamento conforme o uso. PrePaid: assinatura. Nota Se você definir esta propriedade como PrePaid, especifique Period.
SrcDBInstanceId	String	No	No	ID da instância de origem.	Aplicável apenas na clonagem de instâncias. Configure este parâmetro juntamente com RestoreTime.
Tags	List	No	Yes	Tags associadas.	Limite máximo de 20 tags. Para obter mais informações, consulte Propriedades de Tags.
TDEStatus	Boolean	No	Yes	Indica se a criptografia transparente de dados (TDE) deve ser ativada.	Valores válidos: true: ativa o TDE. Nota Uma vez ativado, o TDE não pode ser desativado. false (padrão): mantém o TDE desativado.
ResourceGroupId	String	No	Yes	ID do grupo de recursos ao qual a instância pertence.	Nenhuma.
DBInstanceDescription	String	No	No	Nome da instância.	Deve conter entre 2 e 256 caracteres, incluindo letras, dígitos, sublinhados (_) e hifens (-), iniciando sempre com uma letra.
SecondaryZoneId	String	No	No	ID da zona do nó secundário.	Valores válidos: cn-hangzhou-g: ID da Zona G de Hangzhou. cn-hangzhou-h: ID da Zona H de Hangzhou. cn-hangzhou-i: ID da Zona I de Hangzhou. cn-hongkong-b: ID da Zona B de Hong Kong. cn-hongkong-c: ID da Zona C de Hong Kong. cn-hongkong-d: ID da Zona D de Hong Kong. cn-wulanchabu-a: ID da Zona A de Ulanqab. cn-wulanchabu-b: ID da Zona B de Ulanqab. cn-wulanchabu-c: ID da Zona C de Ulanqab. ap-southeast-1a: ID da Zona A de Singapura. ap-southeast-1b: ID da Zona B de Singapura. ap-southeast-1c: ID da Zona C de Singapura. ap-southeast-5a: ID da Zona A de Jacarta. ap-southeast-5b: ID da Zona B de Jacarta. ap-southeast-5c: ID da Zona C de Jacarta. eu-central-1a: ID da Zona A de Frankfurt. eu-central-1b: ID da Zona B de Frankfurt. eu-central-1c: ID da Zona C de Frankfurt. Nota Defina esta propriedade quando EngineVersion for 4.4 ou 5.0. O valor de SecondaryZoneId deve diferir dos valores de ZoneId e HiddenZoneId.
HiddenZoneId	String	No	No	ID da zona do nó oculto.	Valores válidos: cn-hangzhou-g: ID da Zona G de Hangzhou. cn-hangzhou-h: ID da Zona H de Hangzhou. cn-hangzhou-i: ID da Zona I de Hangzhou. cn-hongkong-b: ID da Zona B de Hong Kong. cn-hongkong-c: ID da Zona C de Hong Kong. cn-hongkong-d: ID da Zona D de Hong Kong. cn-wulanchabu-a: ID da Zona A de Ulanqab. cn-wulanchabu-b: ID da Zona B de Ulanqab. cn-wulanchabu-c: ID da Zona C de Ulanqab. ap-southeast-1a: ID da Zona A de Singapura. ap-southeast-1b: ID da Zona B de Singapura. ap-southeast-1c: ID da Zona C de Singapura. ap-southeast-5a: ID da Zona A de Jacarta. ap-southeast-5b: ID da Zona B de Jacarta. ap-southeast-5c: ID da Zona C de Jacarta. eu-central-1a: ID da Zona A de Frankfurt. eu-central-1b: ID da Zona B de Frankfurt. eu-central-1c: ID da Zona C de Frankfurt. Nota Configure esta propriedade quando EngineVersion for 4.4 ou 5.0. O valor de HiddenZoneId deve ser diferente dos valores de ZoneId e SecondaryZoneId.
StorageType	String	No	No	Categoria de armazenamento.	Valores válidos: cloud_essd1: SSD Empresarial (ESSD) PL1. cloud_essd2: ESSD PL2. cloud_essd3: ESSD PL3. local_ssd: SSD local.

Sintaxe de Mongos

"Mongos": [
  {
    "Class": String
  }
]

Propriedade de Mongos

Property	Type	Required	Editable	Description	Constraint
Class	String	Yes	No	Tipo de instância do nó mongos.	Para obter mais informações, consulte Especificações de instância.

Sintaxe de ConfigServer

"ConfigServer": [
  {
    "Storage": Integer,
    "Class": String
  }
]

Propriedades de ConfigServer

Property

Type

Required

Editable

Description

Constraint

Class

String

Yes

No

Tipo de instância do nó Configserver.

Defina o valor como dds.cs.mid.

Nota

Este tipo de instância possui 1 vCPU e 2 GB de memória. A quantidade de nós Configserver é fixa em 1.

Storage

Integer

Yes

No

Capacidade de armazenamento do nó Configserver.

Defina o valor como 20.

Unidade: GB.

Nota

A capacidade de armazenamento é fixa em 20 GB.

Sintaxe de ReplicaSet

"ReplicaSet": [
  {
    "Storage": Integer,
    "Class": String,
    "ReadonlyReplicas": Integer
  }
]

Propriedades de ReplicaSet

Property	Type	Required	Editable	Description	Constraint
Class	String	Yes	No	Tipo de instância do nó de shard.	Para obter mais informações, consulte Especificações de instância.
Storage	Integer	Yes	No	Capacidade de armazenamento do nó de shard.	Valores válidos: 10 a 2.000. Unidade: GB. O valor deve seguir incrementos de 10 GB.
ReadonlyReplicas	Integer	No	No	Quantidade de nós somente leitura a serem criados.	Valores válidos: 1 a 5.

Sintaxe de Tags

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

Propriedades de Tags

Property	Type	Required	Editable	Description	Constraint
Key	String	Yes	No	Chave da tag.	A chave deve ter entre 1 e 128 caracteres e não pode conter `http://` ou `https://`. Não é permitido iniciar com `aliyun` ou `acs:`.
Value	String	No	No	Valor da tag.	O valor pode ter até 128 caracteres e não deve conter `http://` ou `https://`. Também não pode começar com `aliyun` ou `acs:`.

Valores de retorno

Fn::GetAtt

DBInstanceStatus: status da instância.
DBInstanceId: ID da instância.
OrderId: ID do pedido.
Arn: Alibaba Cloud Resource Name (ARN).

Exemplos

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ZoneId:
    Type: String
    AssociationProperty: ALIYUN::ECS::ZoneId
Resources:
  MongoDbShardingInstance:
    Type: ALIYUN::MONGODB::ShardingInstance
    Properties:
      ZoneId:
        Ref: ZoneId
      EngineVersion: '4.0'
      Mongos:
        - Class: dds.mongos.mid
        - Class: dds.mongos.mid
      ReplicaSet:
        - Class: dds.shard.mid
          Storage: 10
        - Class: dds.shard.mid
          Storage: 20
      ConfigServer:
        - Class: dds.cs.mid
          Storage: 20
      TDEStatus: false
Outputs:
  DBInstanceStatus:
    Description: Status of mongodb instance.
    Value:
      Fn::GetAtt:
        - MongoDbShardingInstance
        - DBInstanceStatus
  DBInstanceId:
    Description: The instance id of created mongodb instance.
    Value:
      Fn::GetAtt:
        - MongoDbShardingInstance
        - DBInstanceId
  OrderId:
    Description: Order Id of created instance.
    Value:
      Fn::GetAtt:
        - MongoDbShardingInstance
        - OrderId

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ZoneId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::ZoneId"
    }
  },
  "Resources": {
    "MongoDbShardingInstance": {
      "Type": "ALIYUN::MONGODB::ShardingInstance",
      "Properties": {
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "EngineVersion": "4.0",
        "Mongos": [
          {
            "Class": "dds.mongos.mid"
          },
          {
            "Class": "dds.mongos.mid"
          }
        ],
        "ReplicaSet": [
          {
            "Class": "dds.shard.mid",
            "Storage": 10
          },
          {
            "Class": "dds.shard.mid",
            "Storage": 20
          }
        ],
        "ConfigServer": [
          {
            "Class": "dds.cs.mid",
            "Storage": 20
          }
        ],
        "TDEStatus": false
      }
    }
  },
  "Outputs": {
    "DBInstanceStatus": {
      "Description": "Status of mongodb instance.",
      "Value": {
        "Fn::GetAtt": [
          "MongoDbShardingInstance",
          "DBInstanceStatus"
        ]
      }
    },
    "DBInstanceId": {
      "Description": "The instance id of created mongodb instance.",
      "Value": {
        "Fn::GetAtt": [
          "MongoDbShardingInstance",
          "DBInstanceId"
        ]
      }
    },
    "OrderId": {
      "Description": "Order Id of created instance.",
      "Value": {
        "Fn::GetAtt": [
          "MongoDbShardingInstance",
          "OrderId"
        ]
      }
    }
  }
}

Para consultar mais exemplos, acesse sharding-instance.yml.