ALIYUN::MONGODB::Instance - Criar ou clonar instância de conjunto de réplicas do MongoDB | ROS - Resource Orchestration Service: Central de Documentação do Alibaba Cloud

Sintaxe

{
  "Type": "ALIYUN::MONGODB::Instance",
  "Properties": {
    "DatabaseNames": String,
    "VpcPasswordFree": Boolean,
    "ReadonlyReplicas": Integer,
    "BusinessInfo": String,
    "AccountPassword": String,
    "VpcId": String,
    "SecurityGroupId": String,
    "AutoRenew": Boolean,
    "ResourceGroupId": String,
    "VSwitchId": String,
    "StorageEngine": String,
    "SrcDBInstanceId": String,
    "ReplicationFactor": Integer,
    "ZoneId": String,
    "EngineVersion": String,
    "RestoreTime": String,
    "DBInstanceStorage": Integer,
    "DBInstanceDescription": String,
    "CouponNo": String,
    "Period": Integer,
    "SecurityIPArray": String,
    "ChargeType": String,
    "BackupId": String,
    "TDEStatus": Boolean,
    "DBInstanceClass": String,
    "Tags": List,
    "SecondaryZoneId": String,
    "HiddenZoneId": String,
    "StorageType": String,
    "PrivateConnections": Map,
    "ClusterId": String,
    "SrcRegion": String,
    "AuditPolicyOptions": Map,
    "DBInstanceReleaseProtection": Boolean,
    "SSLOptions": Map,
    "Encrypted": Boolean,
    "ProvisionedIops": Integer,
    "EncryptionKey": String,
    "RestoreType": Integer,
    "BackupPolicyOptions": Map
  }
}

Propriedades

Nome da propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrições
DBInstanceStorage	Integer	Sim	Sim	Capacidade de armazenamento.	Valores válidos: 10 a 3000. O valor deve ser múltiplo de 10. Unidade: GB.
DBInstanceClass	String	Sim	Sim	Tipo da instância.	Tipos de instância.
TDEStatus	Boolean	Não	Sim	Ativa a Transparent Data Encryption (TDE).	Valores válidos: true: Ativa a TDE. Nota A TDE não pode ser desativada após a ativação. false (padrão): Desativa a TDE.
SrcDBInstanceId	String	Não	Não	ID da instância de origem.	Obrigatório para clonagem. Use com BackupId ou RestoreTime.
DBInstanceDescription	String	Não	Não	Descrição da instância.	2 a 256 caracteres. Deve começar com uma letra ou caractere chinês. Permite letras, dígitos, caracteres chineses, sublinhados (_) e hifens (-).
SecurityIPArray	String	Não	Sim	Lista de permissões de endereços IP.	Separe os endereços com vírgulas (,). Cada endereço deve ser único. Máximo: 1.000. Formatos: 0.0.0.0/0, 10.23.XX.XX (endereço IP) ou 10.23.XX.XX/24 (bloco CIDR, comprimento de prefixo de 1 a 32). Padrão: 0.0.0.0/0 (todos os endereços IP).
ClusterId	String	Não	Não	ID do cluster dedicado.	Nenhuma
SrcRegion	String	Não	Não	Região da instância de origem.	Nota Parâmetro obrigatório quando RestoreType é definido como 2 ou 3.
AuditPolicyOptions	Map	Não	Sim	Configuração da política de auditoria.	Propriedades de AuditPolicyOptions.
DBInstanceReleaseProtection	Boolean	Não	Sim	Ativa a proteção contra liberação.	Valores válidos: true: Ativado. false: Desativado.
SSLOptions	Map	Não	Sim	Configuração de criptografia TLS/SSL.	Propriedades de SSLOptions.
Encrypted	Boolean	Não	Não	Ativa a criptografia de disco.	Nenhuma
ProvisionedIops	Integer	Não	Não	Desempenho provisionado.	Nenhuma
EncryptionKey	String	Não	Não	Chave KMS para criptografia de disco.	Nenhuma
RestoreType	Integer	Não	Não	Tipo de restauração da instância.	Valores válidos: 0: Restaura a instância a partir de um conjunto de backup especificado. 1: Restaura a instância para um ponto no tempo especificado. 2: Restaura uma instância liberada a partir de um conjunto de backup especificado. 3: Restaura a instância a partir de um conjunto de backup com redundância geográfica especificado.
BackupPolicyOptions	Map	Não	Sim	Configuração da política de backup.	Propriedades de BackupPolicyOptions.
ZoneId	String	Não	Não	ID da zona.	Para mais informações, consulte DescribeRegions. Se a instância estiver em uma VPC, o valor deste parâmetro deve corresponder à zona do vSwitch.
VpcPasswordFree	Boolean	Não	Não	Ativa o acesso sem senha via VPC.	Valores válidos: true: Ativa o acesso sem senha. false: Desativa o acesso sem senha.
VpcId	String	Não	Não	ID da VPC.	Nenhuma
SecurityGroupId	String	Não	Sim	ID do grupo de segurança.	Nenhuma
VSwitchId	String	Não	Não	ID do vSwitch.	Nenhuma
BackupId	String	Não	Não	ID do conjunto de backup.	Obrigatório para clonagem. Use com SrcDBInstanceId.
AccountPassword	String	Não	Sim	Senha da conta root.	6 a 32 caracteres. Permite letras, dígitos e os seguintes caracteres especiais: `!#$%^&*()_+-=`.
EngineVersion	String	Não	Não	Versão do mecanismo de banco de dados.	Valores válidos: 3.4 (padrão) 4.0 4.2 4.4 5.0
StorageEngine	String	Não	Não	Mecanismo de armazenamento.	Versões e mecanismos de armazenamento. Valores válidos: WiredTiger (padrão): Adequado para a maioria dos cenários. RocksDB: Ideal para cenários com muitas escritas e poucas leituras. TerarkDB: Recomendado para cenários com mais leituras do que escritas ou com escritas em lote e muitas leituras.
ReplicationFactor	Integer	Não	Sim	Número de nós no conjunto de réplicas.	Valores válidos: 3 (padrão) 5 7
DatabaseNames	String	Não	Não	Nome do banco de dados.	Nenhuma
ReadonlyReplicas	Integer	Não	Sim	Número de nós somente leitura.	Valores válidos: 1 a 5.
BusinessInfo	String	Não	Não	Informações comerciais.	Parâmetro adicional.
ResourceGroupId	String	Não	Sim	ID do grupo de recursos.	Nenhuma
AutoRenew	Boolean	Não	Não	Ativa a renovação automática.	Valores válidos: true: Ativa a renovação automática. false (padrão): Renovação manual necessária.
RestoreTime	String	Não	Não	Ponto de restauração para clonagem.	Formato: yyyy-MM-ddTHH:mm:ssZ (UTC). Obrigatório para clonagem. Use com SrcDBInstanceId e BackupId. Aceita pontos de restauração dos últimos 7 dias.
CouponNo	String	Não	Não	Código do cupom.	Padrão: youhuiquan_promotion_option_id_for_blank.
Period	Integer	Não	Sim	Duração da assinatura.	Unidade: mês. Valores válidos: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24 e 36. Valor padrão: 1. Aplica-se apenas quando ChargeType é PrePaid.
ChargeType	String	Não	Sim	Método de faturamento.	Valores válidos: PostPaid: Pagamento conforme o uso. PrePaid: Assinatura.
Tags	List	Não	Sim	Tags.	Limite de 20 tags. Propriedades de Tags.
SecondaryZoneId	String	Não	Não	Zona de implantação do nó secundário.	Valores válidos: cn-hangzhou-g: Hangzhou Zona G. cn-hangzhou-h: Hangzhou Zona H. cn-hangzhou-i: Hangzhou Zona I. cn-hongkong-b: Hong Kong (China) Zona B. cn-hongkong-c: Hong Kong (China) Zona C. cn-hongkong-d: Hong Kong (China) Zona D. cn-wulanchabu-a: Ulanqab Zona A. cn-wulanchabu-b: Ulanqab Zona B. cn-wulanchabu-c: Ulanqab Zona C. ap-southeast-1a: Singapura Zona A. ap-southeast-1b: Singapura Zona B. ap-southeast-1c: Singapura Zona C. ap-southeast-5a: Jacarta Zona A. ap-southeast-5b: Jacarta Zona B. ap-southeast-5c: Jacarta Zona C. eu-central-1a: Frankfurt Zona A. eu-central-1b: Frankfurt Zona B. eu-central-1c: Frankfurt Zona C. Nota Parâmetro disponível e obrigatório quando EngineVersion é 4.4 ou 5.0. O valor não pode ser igual a ZoneId ou HiddenZoneId.
HiddenZoneId	String	Não	Não	Zona de implantação do nó oculto.	Valores válidos: cn-hangzhou-g: Hangzhou Zona G. cn-hangzhou-h: Hangzhou Zona H. cn-hangzhou-i: Hangzhou Zona I. cn-hongkong-b: Hong Kong (China) Zona B. cn-hongkong-c: Hong Kong (China) Zona C. cn-hongkong-d: Hong Kong (China) Zona D. cn-wulanchabu-a: Ulanqab Zona A. cn-wulanchabu-b: Ulanqab Zona B. cn-wulanchabu-c: Ulanqab Zona C. ap-southeast-1a: Singapura Zona A. ap-southeast-1b: Singapura Zona B. ap-southeast-1c: Singapura Zona C. ap-southeast-5a: Jacarta Zona A. ap-southeast-5b: Jacarta Zona B. ap-southeast-5c: Jacarta Zona C. eu-central-1a: Frankfurt Zona A. eu-central-1b: Frankfurt Zona B. eu-central-1c: Frankfurt Zona C. Nota Parâmetro disponível e obrigatório quando EngineVersion é 4.4 ou 5.0. O valor não pode ser igual a ZoneId ou SecondaryZoneId.
StorageType	String	Não	Não	Classe de armazenamento.	Valores válidos: cloud_essd1: ESSD PL1. cloud_essd2: ESSD PL2. cloud_essd3: ESSD PL3. local_ssd: SSD Local.
PrivateConnections	Map	Não	Sim	Configurações da conexão privada.	Propriedades de PrivateConnections.

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:` nem 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:` nem conter `http://` ou `https://`.

Sintaxe de PrivateConnections

"PrivateConnections": 
  {
    "ReplicaConnections": List
  }

Propriedades de PrivateConnections

Nome da propriedade

Tipo

Obrigatório

Atualização permitida

Descrição

Restrições

ReplicaConnections

List

Sim

Informações de conexão dos nós de réplica.

Comprimento: 1-6.

Nota

Crie ou modifique as informações de conexão de um nó apenas na mesma ordem retornada pela operação DescribeDBInstanceAttribute.

Propriedades de ReplicaConnections.

Sintaxe de AuditPolicyOptions

"AuditPolicyOptions": 
  {
    "StoragePeriod": Integer,
    "AuditStatus": String,
    "AuditLogSwitchSource": String,
    "ServiceType": String
  }

Propriedades de AuditPolicyOptions

Nome da propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrições
AuditStatus	String	Sim	Sim	Status do log de auditoria.	Valores válidos: enable: Ativa o log de auditoria. disabled: Desativa o log de auditoria.
StoragePeriod	Integer	Não	Sim	Período de retenção dos logs de auditoria.	Valores válidos: 1 a 365. Padrão: 30. Unidade: dias.
AuditLogSwitchSource	String	Não	Sim	Origem da solicitação de log de auditoria.	Valor fixo: Console.
ServiceType	String	Não	Sim	Versão do log de auditoria.	Valores válidos: Trial: Versão de avaliação gratuita. Standard: Versão oficial. Nota Padrão: Trial. Desde 6 de janeiro de 2022, a edição oficial está disponível em várias regiões e a avaliação gratuita foi descontinuada. Defina como Standard.

Sintaxe de SSLOptions

"SSLOptions": 
  {
    "ForceEncryption": Integer,
    "SwitchMode": Integer,
    "SSLAction": String
  }

Propriedades de SSLOptions

Nome da propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrições
SSLAction	String	Sim	Sim	Operação a executar no recurso SSL.	Valores válidos: Open: Ativa a criptografia SSL. Close: Desativa a criptografia SSL. Update: Atualiza o certificado SSL.
ForceEncryption	Integer	Não	Sim	Ativa a criptografia SSL forçada nas conexões.	Valores válidos: 1: Força a criptografia SSL. 0: Não força a criptografia SSL.
SwitchMode	Integer	Não	Sim	Momento de aplicação das alterações de configuração SSL.	Valores válidos: 0: Modifica imediatamente. 1: Modifica durante a janela de O&M.

Sintaxe de BackupPolicyOptions

"SSLOptions": 
  {
    "CrossBackupType": String,
    "BackupInterval": Integer,
    "BackupRetentionPolicyOnClusterDeletion": Integer,
    "HighFrequencyBackupRetention": Integer,
    "BackupRetentionPeriod": Integer,
    "InstanceType": String,
    "LogBackupRetentionPeriod": Integer,
    "CrossRetentionValue": Integer,
    "CrossBackupPeriod": String,
    "PreferredBackupTime": String,
    "DestRegion": String,
    "CrossRetentionType": String,
    "EnableCrossLogBackup": Integer,
    "PreferredBackupPeriod": String,
    "PreserveOneEachHour": Boolean,
    "SnapshotBackupType": String,
    "CrossLogRetentionType": String,
    "CrossLogRetentionValue": Integer,
    "EnableBackupLog": Integer,
    "SrcRegion": String
  }

Propriedades de BackupPolicyOptions

Nome da propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrições
CrossBackupType	String	Não	Sim	Política de redundância geográfica.	Valores válidos: update: Modifica a política de redundância geográfica. delete: Exclui a política de redundância geográfica.
BackupInterval	Integer	Não	Sim	Frequência do backup de alta frequência.	Valores válidos: -1: Desativa o backup de alta frequência. 30: A cada 30 minutos. 60: A cada 1 hora. 120: A cada 2 horas. 180: A cada 3 horas. 240: A cada 4 horas. 360: A cada 6 horas. 480: A cada 8 horas. 720: A cada 12 horas.
BackupRetentionPolicyOnClusterDeletion	Integer	Não	Sim	Política de retenção de backup.	Valores válidos: 0: Exclui imediatamente todos os conjuntos de backup ao liberar a instância. 1: Cria automaticamente um backup ao liberar a instância e retém o conjunto de backup por longo prazo. 2: Cria automaticamente um backup ao liberar a instância e retém todos os conjuntos de backup do cluster por longo prazo. Backups de retenção de longo prazo.
HighFrequencyBackupRetention	Integer	Não	Sim	Período de retenção dos backups de alta frequência.	Especifique o parâmetro BackupInterval antes de usar este parâmetro. Retenção padrão: 1 dia. Unidade: dias.
BackupRetentionPeriod	Integer	Não	Sim	Período de retenção dos backups completos.	Nota Contas criadas antes de 10 de setembro de 2021 têm retenção padrão de 7 dias. Instâncias criadas após 10 de setembro de 2021 têm retenção padrão de 30 dias.
InstanceType	String	Não	Sim	Tipo da instância.	Valores válidos: replicate sharding Nota Obrigatório ao restaurar uma instância excluída. Obrigatório ao clonar uma instância a partir de backup com redundância geográfica.
LogBackupRetentionPeriod	Integer	Não	Sim	Período de retenção dos backups de log.	Padrão: 7. Valores válidos: 7 a 730. Unidade: dias.
CrossRetentionValue	Integer	Não	Sim	Período de retenção dos backups com redundância geográfica.	Valores válidos: 3 a 1825. Unidade: dias. Nota Obrigatório para backups com redundância geográfica. Obrigatório e aplicável apenas quando CrossRetentionType é delay.
CrossBackupPeriod	String	Não	Sim	Período de retenção de redundância geográfica	Valores válidos: Segunda-feira Terça-feira Quarta-feira Quinta-feira Sexta-feira Sábado Domingo Nota Obrigatório para backups com redundância geográfica. Separe vários valores com vírgulas (,). Em políticas de backup regulares, os dias definidos aqui devem ser um subconjunto dos dias em PreferredBackupPeriod.
PreferredBackupTime	String	Não	Sim	Horário de execução do backup.	Use o formato HH:mmZ-HH:mmZ em UTC. Nota O intervalo deve ser de 1 hora.
DestRegion	String	Não	Sim	Região de armazenamento do backup.	Nota Obrigatório para backups com redundância geográfica.
CrossRetentionType	String	Não	Sim	Política de retenção para backups com redundância geográfica.	Nota delay: Retém por um período determinado. never: Sem expiração.
EnableCrossLogBackup	Integer	Não	Sim	Ativa o backup de log entre regiões.	Nota Obrigatório para backups com redundância geográfica. 1: Ativar. Obrigatório para clusters fragmentados. Em conjuntos de réplicas, necessário apenas para ativar recuperação point-in-time entre regiões. 0: Desativar.
PreferredBackupPeriod	String	Não	Sim	Ciclo de backup.	Valores válidos: Segunda-feira. Terça-feira Quarta-feira Quinta-feira Sexta-feira: Sexta-feira. Sábado. Domingo Nota Separe vários valores com vírgulas (,).
PreserveOneEachHour	Boolean	Não	Sim	Ativa o backup esparso por hora.	Valores válidos: true: Se a frequência for em minutos, retém todos os snapshots da última hora. Para snapshots com mais de 1 hora (dentro de 24h), retém apenas o primeiro snapshot após a hora cheia. false: Retém todos os snapshots dentro do período de retenção de backup de alta frequência.
SnapshotBackupType	String	Não	Sim	Tipo de backup de snapshot.	Valores válidos: Flash: Backup em segundos. Standard: Backup regular (padrão).
CrossLogRetentionType	String	Não	Sim	Política de retenção para backups de log entre regiões.	Valores válidos: delay: Retém por um período determinado. never: Sem expiração.
CrossLogRetentionValue	Integer	Não	Sim	Período de retenção dos backups de log entre regiões.	Valores válidos: 3 a 1825. Deve ser menor ou igual a CrossRetentionValue. Unidade: dias.
EnableBackupLog	Integer	Não	Sim	Ativa o backup de log.	Valores válidos: 0: Desativar (padrão). 1: Ativar.
SrcRegion	String	Não	Sim	Região da instância.	Nota Obrigatório para restaurar instância excluída. Obrigatório para backups com redundância geográfica.

Sintaxe de ReplicaConnections

{
  "PrivateConnections": {
    "ReplicaConnections": [
      {
        "ConnectionString": String,
        "ConnectionPort": Integer
      }
    ]
  }
}

Propriedades de ReplicaConnections

Nome da propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrições
ConnectionString	String	Sim	Sim	Prefixo do endereço de conexão	Deve começar com letra minúscula e terminar com letra minúscula ou dígito. Composto por letras minúsculas, dígitos e hifens (-). Tamanho: 8 a 63 caracteres. Nota Especifique apenas o prefixo do endpoint. O restante não é modificável. Endpoints de nós primários, secundários e somente leitura são modificáveis em instâncias com SSDs locais ou ESSDs.
ConnectionPort	Integer	Não	Sim	Porta de conexão.	Valores válidos: 1000 a 65535. Nota Modificação de porta permitida apenas em instâncias com MongoDB 4.2+ e ESSDs.

Valores de retorno

Fn::GetAtt

OrderId: ID do pedido usado para criar a instância do MongoDB.
DBInstanceId: ID da instância do MongoDB. Globalmente único.
DBInstanceStatus: Status da instância do MongoDB.
ConnectionURI: URI de conexão.
ReplicaSetName: Nome do conjunto de réplicas.
Arn: Alibaba Cloud Resource Name (ARN) da instância.

Exemplos

ROSTemplateFormatVersion: '2015-09-01'
Description: Test MONGODB Instance
Parameters:
  VpcId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
  ZoneId:
    Type: String
    AssociationProperty: ALIYUN::ECS::ZoneId
  VSwitchId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    AssociationPropertyMetadata:
      ZoneId: ${ZoneId}
      VpcId: ${VpcId}
Resources:
  MongoDB:
    Type: ALIYUN::MONGODB::Instance
    Properties:
      DBInstanceClass: dds.mongo.mid
      DBInstanceStorage: 10
      ZoneId:
        Ref: ZoneId
      VpcId:
        Ref: VpcId
      VSwitchId:
        Ref: VSwitchId
Outputs: {}

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": "Test MONGODB Instance",
  "Parameters": {
    "VpcId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId"
    },
    "ZoneId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::ZoneId"
    },
    "VSwitchId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "AssociationPropertyMetadata": {
        "ZoneId": "${ZoneId}",
        "VpcId": "${VpcId}"
      }
    }
  },
  "Resources": {
    "MongoDB": {
      "Type": "ALIYUN::MONGODB::Instance",
      "Properties": {
        "DBInstanceClass": "dds.mongo.mid",
        "DBInstanceStorage": 10,
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "VpcId": {
          "Ref": "VpcId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        }
      }
    }
  },
  "Outputs": {
  }
}

Exemplo YAML no GitHub.