ALIYUN::RDS::ReadOnlyDBInstance - Resource Orchestration Service - Alibaba Cloud ドキュメントセンター

ALIYUN::RDS::ReadOnlyDBInstance は、読み取り専用ApsaraDB RDSインスタンスを作成するために使用されます。

構文

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

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Category	String	いいえ	いいえ	インスタンスエディション。	有効な値： Basic: ベーシックエディション。 HighAvailability (デフォルト): 高可用性エディション AlwaysOn: クラスタエディション
VPCId	String	いいえ	いいえ	読み取り専用インスタンスの仮想プライベートクラウド (VPC) ID。	なし。
DBInstanceDescription	String	いいえ	いいえ	インスタンスの説明。	インスタンスの説明は、2～256文字で、文字、数字、アンダースコア (_)、ハイフン (-) を使用できます。説明は文字で始める必要がありますが、`http://` または `https://` で始めることはできません。
Tags	Map	いいえ	はい	読み取り専用インスタンスのタグ。	タグはキーと値のペア形式です。例： `{"key1": "value1","key2": "value2", ... "key5": "value5"}` 最大 5 つのキーと値のペアを指定できます。タグキーは最大 64 文字で、`http://` または `https://` で始めることはできません。タグ値は最大 128 文字で、`aliyun`、`http://`、または `https://` で始めることはできません。
EngineVersion	String	はい	いいえ	データベースエンジンのバージョン。	読み取り専用インスタンスのデータベースエンジンバージョンは、プライマリインスタンスのデータベースエンジンバージョンと同じである必要があります。データベースエンジンが MySQL の場合の有効な値： 5.6 5.7 8.0 データベースエンジンが SQL Server の場合の有効な値：2017_ent
DBInstanceId	String	はい	いいえ	プライマリインスタンスの ID。	なし。
PayType	String	いいえ	いいえ	読み取り専用インスタンスの課金方法。	従量課金制のみがサポートされています。値を Postpaid に設定します。
ZoneId	String	はい	いいえ	読み取り専用インスタンスのゾーン ID。	DescribeRegions オペレーションを呼び出して、最新のゾーンリストをクエリできます。
ResourceGroupId	String	いいえ	いいえ	リソースグループの ID。	なし。
DBInstanceStorage	Integer	はい	はい	読み取り専用インスタンスのストレージ容量。	単位：GB。有効な値：5～3000。値は 5 の倍数である必要があります。バージョンが異なるインスタンスでは、値の範囲が異なります。詳細については、「プライマリ ApsaraDB RDS インスタンスタイプ」をご参照ください。
VSwitchId	String	いいえ	いいえ	読み取り専用インスタンスの vSwitch ID。	なし。
DBInstanceStorageType	String	いいえ	いいえ	読み取り専用インスタンスのストレージタイプ。	有効な値： local_ssd または ephemeral_ssd: ローカル SSD cloud_ssd: 標準 SSD cloud_essd: 拡張 SSD (ESSD) 説明読み取り専用 ApsaraDB RDS for MySQL インスタンスにはローカル SSD のみを使用でき、読み取り専用 ApsaraDB RDS for SQL Server インスタンスには標準 SSD または ESSD のみを使用できます。
DBInstanceClass	String	はい	はい	読み取り専用インスタンスのインスタンスタイプ。	詳細については、「プライマリ ApsaraDB RDS インスタンスタイプ」をご参照ください。プライマリインスタンスのインスタンスタイプ以上を指定することをお勧めします。読み取り専用インスタンスのインスタンスタイプがプライマリインスタンスのインスタンスタイプよりも低い場合、読み取り専用インスタンスでレイテンシの増加や負荷の増大などの問題が発生する可能性があります。
PrivateIpAddress	String	いいえ	いいえ	読み取り専用インスタンスのプライベート IP アドレス。	プライベート IP アドレスは、指定した vSwitch の IP アドレス範囲内である必要があります。システムは、VPCId と VSwitchId の値に基づいて、インスタンスにプライベート IP アドレスを自動的に割り当てます。
PeriodType	String	いいえ	いいえ	読み取り専用インスタンスのサブスクリプション期間の単位。	有効な値： Year Month
Period	Integer	いいえ	いいえ	読み取り専用インスタンスのサブスクリプション期間。	PeriodType が Year に設定されている場合の有効な値：1～3。 PeriodType が Month に設定されている場合の有効な値：1～9。
AutoRenew	Boolean	いいえ	いいえ	読み取り専用インスタンスの自動更新を有効にするかどうかを指定します。	このプロパティは、読み取り専用インスタンスがサブスクリプション課金方法を使用している場合にのみ有効になります。有効な値： true false (デフォルト) 説明 PeriodType を Month に設定した場合、自動更新サイクルは 1 か月です。 PeriodType を Year に設定した場合、自動更新サイクルは 1 年です。
TargetDedicatedHostIdForMaster	String	いいえ	いいえ	プライマリインスタンスが存在するホストの ID。このプロパティは、専用クラスタに読み取り専用インスタンスを作成する場合に有効になります。	なし。
DeletionProtection	Boolean	いいえ	いいえ	読み取り専用インスタンスのリリース保護機能を有効にするかどうかを指定します。	有効な値： true: false (デフォルト) 説明従量課金制で課金されるインスタンスに対して、リリース保護機能を有効にすることができます。
DedicatedHostGroupId	String	いいえ	いいえ	読み取り専用インスタンスが属する専用クラスタの ID。このプロパティは、専用クラスタに読み取り専用インスタンスを作成する場合に有効です。	なし。

戻り値

Fn::GetAtt

ConnectionString: 読み取り専用インスタンスの内部エンドポイント。
DBInstanceId: 読み取り専用インスタンスの ID。
Port: 読み取り専用インスタンスの内部ポート。

例

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DBInstanceId:
    Type: String
    Description: マスターインスタンスのID。
  ZoneId:
    Type: String
    Description: インスタンスのアベイラビリティーゾーンを作成して、アベイラビリティーゾーンが rds リソース仕様の作成をサポートしていることを確認します。
    AssociationProperty: ALIYUN::ECS::Instance::ZoneId
    Label: ゾーンID
  VPC:
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
    Type: String
    Description: コンソール - 仮想プライベートクラウドから (vpc-xxx) で始まる ID を検索してください
    Label: 既存の VPC インスタンス ID
  VSwitch:
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    Type: String
    Description: コンソール - 仮想プライベートクラウド - VSwitch から (vsw-xxx) で始まるビジネス VSwitch ID を検索してください
    Label: 既存の 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: インスタンスクラス
    Default: rds.mysql.s2.large
  DBInstanceStorage:
    Type: Number
    Description: MySQL: 5-1000, SQLServer: 10-1000, その他: 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: 作成されたデータベースインスタンスのインスタンスID。
    Value:
      Fn::GetAtt:
        - ReadOnlyDBInstance
        - DBInstanceId
  Port:
    Description: 作成された DB インスタンスのイントラネットポート。
    Value:
      Fn::GetAtt:
        - ReadOnlyDBInstance
        - Port
  ConnectionString:
    Description: イントラネットによる DB インスタンス接続 URL。
    Value:
      Fn::GetAtt:
        - ReadOnlyDBInstance
        - ConnectionString

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DBInstanceId": {
      "Type": "String",
      "Description": "マスターインスタンスの ID。" // マスターインスタンスのID
    },
    "ZoneId": {
      "Type": "String",
      "Description": "インスタンスのアベイラビリティーゾーンを作成して、アベイラビリティーゾーンがrdsリソース仕様の作成をサポートしていることを確認します。", // インスタンスのアベイラビリティーゾーンを作成して、アベイラビリティーゾーンがrdsリソース仕様の作成をサポートしていることを確認します
      "AssociationProperty": "ALIYUN::ECS::Instance::ZoneId",
      "Label": "ゾーン ID" // ゾーンID
    },
    "VPC": {
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "Type": "String",
      "Description": "コンソール - 仮想プライベートクラウドから (vpc-xxx) で始まる ID を検索してください", // コンソール - 仮想プライベートクラウドから (vpc-xxx) で始まる ID を検索してください
      "Label": "既存の VPC インスタンス ID" // 既存の VPC インスタンス ID
    },
    "VSwitch": {
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "Type": "String",
      "Description": "コンソール - 仮想プライベートクラウド - VSwitch から (vsw-xxx) で始まるビジネス VSwitch ID を検索してください", // コンソール - 仮想プライベートクラウド - VSwitch から (vsw-xxx) で始まるビジネス VSwitch ID を検索してください
      "Label": "既存の VSwitch ID", // 既存の 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", // MySQL: 5.5, 5.6, 5.7, 5.8, SQLServer: 2008r2, PostgreSQL: 9.4
      "Default": "5.6"
    },
    "DBInstanceClass": {
      "Type": "String",
      "Description": "インスタンスクラス", // インスタンスクラス
      "Default": "rds.mysql.s2.large"
    },
    "DBInstanceStorage": {
      "Type": "Number",
      "Description": "MySQL:5-1000, SQLServer: 10-1000, その他: 5-2000", // MySQL:5-1000, SQLServer: 10-1000, その他: 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": "作成されたデータベースインスタンスのインスタンス ID。", // 作成されたデータベースインスタンスのインスタンスID
      "Value": {
        "Fn::GetAtt": [
          "ReadOnlyDBInstance",
          "DBInstanceId"
        ]
      }
    },
    "Port": {
      "Description": "作成された DB インスタンスのイントラネットポート。", // 作成された DB インスタンスのイントラネットポート
      "Value": {
        "Fn::GetAtt": [
          "ReadOnlyDBInstance",
          "Port"
        ]
      }
    },
    "ConnectionString": {
      "Description": "イントラネットによる DB インスタンス接続 URL。", // イントラネットによる DB インスタンス接続 URL
      "Value": {
        "Fn::GetAtt": [
          "ReadOnlyDBInstance",
          "ConnectionString"
        ]
      }
    }
  }
}