ALIYUN::RDS::ReadOnlyDBInstance - Resource Orchestration Service: Central de Documentação do Alibaba Cloud

O recurso ALIYUN::RDS::ReadOnlyDBInstance cria uma instância somente leitura do ApsaraDB RDS.

Sintaxe

{
  "Type": "ALIYUN::RDS::ReadOnlyDBInstance",
  "Properties": {
    "Category": String,
    "VPCId": String,
    "DBInstanceDescription": String,
    "Tags": Map,
    "EngineVersion": String,
    "DBInstanceId": String,
    "PayType": String,
    "ZoneId": String,
    "ResourceGroupId": String,
    "DBInstanceStorage": Integer,
    "VSwitchId": String,
    "DBInstanceStorageType": String,
    "DBInstanceClass": String,
    "PrivateIpAddress": String,
    "PeriodType": String,
    "Period": Integer,
    "AutoRenew": Boolean,
    "TargetDedicatedHostIdForMaster": String,
    "DeletionProtection": Boolean,
    "DedicatedHostGroupId": String
  }
}

Propriedades

Propriedade	Tipo	Obrigatória	Editável	Descrição	Restrição
Category	String	Não	Não	Edição da instância.	Valores válidos: Basic: Basic Edition. HighAvailability (padrão): High-availability Edition. AlwaysOn: Cluster Edition.
VPCId	String	Não	Não	ID da VPC da instância somente leitura.	Nenhuma.
DBInstanceDescription	String	Não	Não	Descrição da instância.	A descrição deve ter de 2 a 256 caracteres e pode conter letras, dígitos, sublinhados (_) e hifens (-). Deve começar com uma letra, mas não pode iniciar com `http://` ou `https://`.
Tags	Map	Não	Sim	Tags da instância somente leitura.	As tags seguem o formato de par chave-valor. Exemplo: `{"key1": "value1","key2": "value2", ... "key5": "value5"}` Especifique até cinco pares chave-valor. A chave da tag pode ter até 64 caracteres e não pode começar com `http://` ou `https://`. O valor da tag pode ter até 128 caracteres e não pode começar com `aliyun`, `http://` ou `https://`.
EngineVersion	String	Sim	Não	Versão do mecanismo de banco de dados.	A versão do mecanismo da instância somente leitura deve ser igual à da instância primária. Valores válidos para MySQL: 5.6 5.7 8.0 Valor válido para SQL Server: 2017_ent
DBInstanceId	String	Sim	Não	ID da instância primária.	Nenhuma.
PayType	String	Não	Não	Método de faturamento da instância somente leitura.	Somente o método pagamento conforme o uso é compatível. Defina o valor como Postpaid.
ZoneId	String	Sim	Não	ID da zona da instância somente leitura.	Chame a operação DescribeRegions para consultar a lista de zonas mais recente.
ResourceGroupId	String	Não	Não	ID do grupo de recursos.	Nenhuma.
DBInstanceStorage	Integer	Sim	Sim	Capacidade de armazenamento da instância somente leitura.	Unidade: GB. Valores válidos: 5 a 3000. O valor deve ser múltiplo de 5. Instâncias de versões diferentes possuem faixas de valores distintas. Para mais informações, consulte Tipos de instância primária do ApsaraDB RDS.
VSwitchId	String	Não	Não	ID do vSwitch da instância somente leitura.	Nenhuma.
DBInstanceStorageType	String	Não	Não	Tipo de armazenamento da instância somente leitura.	Valores válidos: local_ssd ou ephemeral_ssd: SSD local. cloud_ssd: SSD padrão. cloud_essd: Enhanced SSD (ESSD). Nota Instâncias somente leitura do ApsaraDB RDS for MySQL aceitam apenas SSDs locais. Instâncias somente leitura do ApsaraDB RDS for SQL Server utilizam exclusivamente SSDs padrão ou ESSDs.
DBInstanceClass	String	Sim	Sim	Tipo da instância somente leitura.	Para mais detalhes, consulte Tipos de instância primária do ApsaraDB RDS. Recomendamos especificar um tipo de instância superior ou igual ao da instância primária. Se o tipo da instância somente leitura for inferior, ela poderá apresentar problemas como alta latência e sobrecarga.
PrivateIpAddress	String	Não	Não	Endereço IP privado da instância somente leitura.	O endereço IP privado deve estar dentro do intervalo de endereços IP do vSwitch especificado. O sistema atribui automaticamente um endereço IP privado à instância com base nos valores de VPCId e VSwitchId.
PeriodType	String	Não	Não	Unidade da duração da assinatura da instância somente leitura.	Valores válidos: Year Month
Period	Integer	Não	Não	Duração da assinatura da instância somente leitura.	Valores válidos quando PeriodType é Year: 1 a 3. Valores válidos quando PeriodType é Month: 1 a 9.
AutoRenew	Boolean	Não	Não	Define se a renovação automática será ativada para a instância somente leitura.	Esta propriedade só tem efeito quando a instância utiliza o método de faturamento por assinatura. Valores válidos: true false (padrão) Nota Se você definir PeriodType como Month, o ciclo de renovação automática será de um mês. Se você definir PeriodType como Year, o ciclo de renovação automática será de um ano.
TargetDedicatedHostIdForMaster	String	Não	Não	ID do host onde a instância primária reside. Esta propriedade entra em vigor ao criar a instância somente leitura em um cluster dedicado.	Nenhuma.
DeletionProtection	Boolean	Não	Não	Define se a proteção contra exclusão será ativada para a instância somente leitura.	Valores válidos: true: false (padrão) Nota É possível ativar a proteção contra exclusão para instâncias faturadas pelo modelo de pagamento conforme o uso.
DedicatedHostGroupId	String	Não	Não	ID do cluster dedicado ao qual a instância somente leitura pertence. Esta propriedade é válida na criação da instância somente leitura dentro de um cluster dedicado.	Nenhuma.

Valores de retorno

Fn::GetAtt

ConnectionString: endpoint interno da instância somente leitura.
DBInstanceId: ID da instância somente leitura.
Port: porta interna da instância somente leitura.

Exemplos

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DBInstanceId:
    Type: String
    Description: The ID of the master instance.
  ZoneId:
    Type: String
    Description: Create an Availability Zone for an instance to ensure that the Availability Zone supports the creation of rds resource specifications.
    AssociationProperty: ALIYUN::ECS::Instance::ZoneId
    Label: Zone ID
  VPC:
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
    Type: String
    Description: Please search the ID starts with (vpc-xxx)from console-Virtual Private Cloud
    Label: Existing VPC Instance ID
  VSwitch:
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    Type: String
    Description: Please search the business VSwitch ID starts with(vsw-xxx)from console-Virtual Private Cloud-VSwitches
    Label: Existing VSwitch ID
    AssociationPropertyMetadata:
      VpcId: VPC
      ZoneId: ZoneId
  EngineVersion:
    Type: String
    Description: 'MySQL: 5.5, 5.6, 5.7, 5.8, SQLServer: 2008r2, PostgreSQL: 9.4'
    Default: '5.6'
  DBInstanceClass:
    Type: String
    Description: Instance Class
    Default: rds.mysql.s2.large
  DBInstanceStorage:
    Type: Number
    Description: MySQL: 5-1000, SQLServer: 10-1000, others: 5-2000
    Default: 40
Resources:
  ReadOnlyDBInstance:
    Type: ALIYUN::RDS::ReadOnlyDBInstance
    DependsOn: RDSInstance
    Properties:
      VPCId:
        Ref: VPC
      DBInstanceId:
        Ref: DBInstanceId
      ZoneId:
        Ref: ZoneId
      DBInstanceStorage:
        Ref: DBInstanceStorage
      VSwitchId:
        Ref: VSwitch
      EngineVersion:
        Ref: EngineVersion
      DBInstanceClass:
        Ref: DBInstanceClass
Outputs:
  DBInstanceId:
    Description: The instance id of created database instance.
    Value:
      Fn::GetAtt:
        - ReadOnlyDBInstance
        - DBInstanceId
  Port:
    Description: Intranet port of created DB instance.
    Value:
      Fn::GetAtt:
        - ReadOnlyDBInstance
        - Port
  ConnectionString:
    Description: DB instance connection url by Intranet.
    Value:
      Fn::GetAtt:
        - ReadOnlyDBInstance
        - ConnectionString

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DBInstanceId": {
      "Type": "String",
      "Description": "The ID of the master instance."
    },
    "ZoneId": {
      "Type": "String",
      "Description": "Create an Availability Zone for an instance to ensure that the Availability Zone supports the creation of rds resource specifications.",
      "AssociationProperty": "ALIYUN::ECS::Instance::ZoneId",
      "Label": "Zone ID"
    },
    "VPC": {
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "Type": "String",
      "Description": "Please search the ID starts with (vpc-xxx)from console-Virtual Private Cloud",
      "Label": "Existing VPC Instance ID"
    },
    "VSwitch": {
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "Type": "String",
      "Description": "Please search the business VSwitch ID starts with(vsw-xxx)from console-Virtual Private Cloud-VSwitches",
      "Label": "Existing VSwitch ID",
      "AssociationPropertyMetadata": {
        "VpcId": "VPC",
        "ZoneId": "ZoneId"
      }
    },
    "EngineVersion": {
      "Type": "String",
      "Description": "MySQL: 5.5, 5.6, 5.7, 5.8, SQLServer: 2008r2, PostgreSQL: 9.4",
      "Default": "5.6"
    },
    "DBInstanceClass": {
      "Type": "String",
      "Description": "Instance Class",
      "Default": "rds.mysql.s2.large"
    },
    "DBInstanceStorage": {
      "Type": "Number",
      "Description": "MySQL:5-1000, SQLServer: 10-1000, others: 5-2000",
      "Default": 40
    }
  },
  "Resources": {
    "ReadOnlyDBInstance": {
      "Type": "ALIYUN::RDS::ReadOnlyDBInstance",
      "DependsOn": "RDSInstance",
      "Properties": {
        "VPCId": {
          "Ref": "VPC"
        },
        "DBInstanceId": {
          "Ref": "DBInstanceId"
        },
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "DBInstanceStorage": {
          "Ref": "DBInstanceStorage"
        },
        "VSwitchId": {
          "Ref": "VSwitch"
        },
        "EngineVersion": {
          "Ref": "EngineVersion"
        },
        "DBInstanceClass": {
          "Ref": "DBInstanceClass"
        }
      }
    }
  },
  "Outputs": {
    "DBInstanceId": {
      "Description": "The instance id of created database instance.",
      "Value": {
        "Fn::GetAtt": [
          "ReadOnlyDBInstance",
          "DBInstanceId"
        ]
      }
    },
    "Port": {
      "Description": "Intranet port of created DB instance.",
      "Value": {
        "Fn::GetAtt": [
          "ReadOnlyDBInstance",
          "Port"
        ]
      }
    },
    "ConnectionString": {
      "Description": "DB instance connection url by Intranet.",
      "Value": {
        "Fn::GetAtt": [
          "ReadOnlyDBInstance",
          "ConnectionString"
        ]
      }
    }
  }
}