ROS における Tair Redis インスタンスクラスタイプリファレンス - ROS

DATASOURCE::REDIS::InstanceClasses は、Tair（Redis OSS 互換）インスタンスタイプをクエリするために使用されます。

構文

{
  "Type": "DATASOURCE::REDIS::InstanceClasses",
  "Properties": {
    "OrderType": String,
    "ZoneId": String,
    "ResourceGroupId": String,
    "InstanceId": String,
    "InstanceChargeType": String,
    "NodeId": String,
    "ProductType": String,
    "AcceptLanguage": String,
    "Engine": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
OrderType	String	いいえ	はい	注文タイプ。	有効な値： BUY：リソースを購入するための注文を行います。 UPGRADE：インスタンス仕様をアップグレードするための注文を行います。 DOWNGRADE：インスタンス仕様をダウングレードするための注文を行います。
ZoneId	String	いいえ	はい	ゾーン ID。	DescribeZones オペレーションを呼び出して、サポートされているゾーンをクエリできます。詳細については、「DescribeZones」をご参照ください。
ResourceGroupId	String	いいえ	はい	リソースグループの ID。	なし。
InstanceId	String	いいえ	はい	インスタンス ID。	OrderType が UPGRADE または RENEW に設定されている場合は、このプロパティを指定する必要があります。
InstanceChargeType	String	いいえ	はい	課金方法。	有効な値： PrePaid：サブスクリプション PostPaid（デフォルト）：従量課金制
NodeId	String	いいえ	はい	データノードの ID。	DescribeLogicInstanceTopology オペレーションを呼び出して、データノード ID をクエリできます。詳細については、「DescribeLogicInstanceTopology」をご参照ください。説明このプロパティは、InstanceId が指定されており、指定されたインスタンスがクラスターアーキテクチャまたは読み取り/書き込み分割アーキテクチャを使用している場合に有効になります。
ProductType	String	いいえ	はい	製品タイプ。	有効な値： Local：ローカルディスクを使用する Community Edition インスタンス、またはローカルディスクを使用する Tair（Enterprise Edition）パフォーマンス強化インスタンス Tair_rdb：クラウドディスクを使用する Tair（Enterprise Edition）パフォーマンス強化インスタンス Tair_scm：Tair（Enterprise Edition）永続メモリ最適化インスタンス Tair_essd：Tair（Enterprise Edition）ストレージ最適化インスタンス OnECS：標準アーキテクチャとクラウドディスクを使用する Community Edition インスタンス
AcceptLanguage	String	いいえ	はい	戻り値が表示される言語。	有効な値： zh-CN（デフォルト）：中国語 en-US：英語
Engine	String	いいえ	はい	データベースエンジンのタイプ。	有効な値： Redis Memcache
RefreshOptions	String	いいえ	はい	スタックが更新されたときのデータソースリソースの更新ポリシー。	有効な値： Never（デフォルト）：スタックが更新されたときにデータソースリソースを更新しません。 Always：スタックが更新されたときにデータソースリソースを更新します。

戻り値 (Fn::GetAtt)

InstanceClassIds：インスタンスタイプ。
InstanceClasses：インスタンスタイプの詳細。

プロパティ	タイプ	説明	制約
InstanceClassIds	List	インスタンスタイプ。	なし。
InstanceClasses	List	インスタンスタイプの詳細。	なし。
ZoneId	String	ゾーン ID。	なし。
InstanceClass	String	インスタンスタイプ。	なし。
SupportedNodeType	List	ノードタイプ。	有効な値： single：スタンドアロン double：マスターレプリカ
ShardNumber	String	シャードの数。	なし。
Architecture	String	アーキテクチャ。	有効な値： standard：標準アーキテクチャ cluster：クラスターアーキテクチャ rwsplit：読み取り/書き込み分割アーキテクチャ
Version	String	データベースエンジンのバージョン。	なし。
SeriesType	String	シリーズ。	有効な値： enhanced_performance_type：パフォーマンス強化インスタンス hybrid_storage：ハイブリッドストレージインスタンス
EditionType	String	インスタンスのエディション。	有効な値： Community：Community Edition Enterprise：Tair (Enterprise Edition)
Engine	String	データベースエンジンのタイプ。	有効な値： Redis Memcache
Capacity	Number	メモリサイズ。	単位：MB。

例

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "OrderType": {
      "Type": "String",
      "Description": "注文タイプ。有効な値：\nBUY：インスタンスの購入に使用される注文。\nUPGRADE：インスタンスのアップグレードに使用される注文。\nDOWNGRADE：インスタンスのダウングレードに使用される注文。" // The order type. Valid values:\nBUY: the orders that are used to purchase instances.\nUPGRADE: the orders that are used to upgrade instances.\nDOWNGRADE: the orders that are used to downgrade instances.
    },
    "ZoneId": {
      "Type": "String",
      "Description": "クエリ対象の PolarDB リソースが存在するゾーンの ID。\n注記 DescribeRegions オペレーションを呼び出して、ゾーンに関する情報をクエリできます。" // The ID of the zone where PolarDB resources that you want to query reside.\nNote You can call the DescribeRegions operation to query information about zones.
    },
    "ResourceGroupId": {
      "Type": "String",
      "Description": "インスタンスの ID。\n注記 このパラメーターは、OrderType パラメーターが UPGRADE または RENEW に設定されている場合にのみ必須です。" // The ID of the instance.\n Note This parameter is required only if the OrderType parameter is set to UPGRADE or RENEW.
    },
    "InstanceId": {
      "Type": "String",
      "Description": "リソースグループの ID。ListResourceGroups オペレーションを呼び出して、リソースグループの ID をクエリできます。\n注記 リソース管理コンソールでリソースグループの ID をクエリすることもできます。詳細については、「リソースグループの基本情報の表示」をご参照ください。" // The ID of the resource group. You can call the ListResourceGroups operation to query the IDs of resource groups.\n Note You can also query the IDs of resource groups in the Resource Management console. For more information, see View basic information about a resource group.
    },
    "InstanceChargeType": {
      "Type": "String",
      "Description": "課金方法。有効な値：\nPrePaid：サブスクリプション\nPostPaid：従量課金制\n注記 デフォルト値：PrePaid。", // The billing method. Valid values:\nPrePaid: subscription\nPostPaid: pay-as-you-go\nNote Default value: PrePaid.
      "Default": "PrePaid"
    },
    "NodeId": {
      "Type": "String",
      "Description": "使用可能なインスタンスタイプをクエリするデータノードの ID。DescribeLogicInstanceTopology オペレーションを呼び出して、データノードの ID をクエリできます。番号記号（#）とそれに続くコンテンツを削除します。たとえば、r-bp10noxlhcoim2****-db-0 のみを保持します。\n注記 このパラメーターを設定する前に、InstanceId パラメーターをクラスターまたは読み取り/書き込み分割アーキテクチャのインスタンスの ID に設定する必要があります。" // The ID of the data node for which you want to query available instance types. You can call the DescribeLogicInstanceTopology operation to query the ID of the data node. Remove the number sign (#) and the content that follows the number sign. For example, retain only r-bp10noxlhcoim2****-db-0.\n Note Before you set this parameter, you must set the InstanceId parameter to the ID of an instance in the cluster or read/write splitting architecture.
    },
    "ProductType": {
      "Type": "String",
      "Description": "インスタンスのエディションまたはシリーズ。有効な値：\n Local：ApsaraDB for Redis Community Edition インスタンスまたは ApsaraDB for Redis Enhanced Edition (Tair) のパフォーマンス強化インスタンス\n Tair_scm：永続メモリ最適化インスタンス\n Tair_essd：ストレージ最適化インスタンス" // The edition or series of instances. Valid values:\n Local: ApsaraDB for Redis Community Edition instances or performance-enhanced instances of ApsaraDB for Redis Enhanced Edition (Tair)\n Tair_scm: persistent memory-optimized instances\n Tair_essd: storage-optimized instances
    },
    "AcceptLanguage": {
      "Type": "String",
      "Description": "戻り値の言語。有効な値：\n zh-CN：中国語。これはデフォルト値です。\n en-US：英語。" // The language of the return values. Valid values:\n zh-CN: Chinese. This is the default value.\n en-US: English.
    },
    "Engine": {
      "Type": "String",
      "Description": "エンジンのタイプ。有効な値：\nRedis\nMemcache" // The engine type. Valid values:\nRedis\nMemcache
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::REDIS::InstanceClasses",
      "Properties": {
        "OrderType": {
          "Ref": "OrderType"
        },
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "ResourceGroupId": {
          "Ref": "ResourceGroupId"
        },
        "InstanceId": {
          "Ref": "InstanceId"
        },
        "InstanceChargeType": {
          "Ref": "InstanceChargeType"
        },
        "NodeId": {
          "Ref": "NodeId"
        },
        "ProductType": {
          "Ref": "ProductType"
        },
        "AcceptLanguage": {
          "Ref": "AcceptLanguage"
        },
        "Engine": {
          "Ref": "Engine"
        }
      }
    }
  },
  "Outputs": {
    "InstanceClasses": {
      "Description": "インスタンスクラスのリスト。", // The list of instance classes.
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceClasses"
        ]
      }
    },
    "InstanceClassIds": {
      "Description": "DB インスタンスクラス ID のリスト。", // The list of db instance class ids.
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceClassIds"
        ]
      }
    }
  }
}

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AcceptLanguage:
    Description: "戻り値の言語。有効な値：\n zh-CN：中国語。これはデフォルト値です。\n en-US：英語。"  // The language of the return values. Valid values:\n zh-CN: Chinese. This is the default value.\n en-US: English.
    Type: String
  Engine:
    Description: 'エンジンのタイプ。有効な値：

      Redis

      Memcache' // The engine type. Valid values:\nRedis\nMemcache
    Type: String
  InstanceChargeType:
    Default: PrePaid
    Description: '課金方法。有効な値：

      PrePaid：サブスクリプション

      PostPaid：従量課金制

      注記 デフォルト値：PrePaid。' // The billing method. Valid values:\nPrePaid: subscription\nPostPaid: pay-as-you-go\nNote Default value: PrePaid.
    Type: String
  InstanceId:
    Description: "リソースグループの ID。ListResourceGroups オペレーションを呼び出して、リソースグループの ID をクエリできます。\n注記 リソース管理コンソールでリソースグループの ID をクエリすることもできます。詳細については、「リソースグループの基本情報の表示」をご参照ください。" // The ID of the resource group. You can call the ListResourceGroups operation to query the IDs of resource groups.\n Note You can also query the IDs of resource groups in the Resource Management console. For more information, see View basic information about a resource group.
    Type: String
  NodeId:
    Description: "使用可能なインスタンスタイプをクエリするデータノードの ID。DescribeLogicInstanceTopology オペレーションを呼び出して、データノードの ID をクエリできます。番号記号（#）とそれに続くコンテンツを削除します。たとえば、r-bp10noxlhcoim2****-db-0 のみを保持します。\n注記 このパラメーターを設定する前に、InstanceId パラメーターをクラスターまたは読み取り/書き込み分割アーキテクチャのインスタンスの ID に設定する必要があります。" // The ID of the data node for which you want to query available instance types. You can call the DescribeLogicInstanceTopology operation to query the ID of the data node. Remove the number sign (#) and the content that follows the number sign. For example, retain only r-bp10noxlhcoim2****-db-0.\n Note Before you set this parameter, you must set the InstanceId parameter to the ID of an instance in the cluster or read/write splitting architecture.
    Type: String
  OrderType:
    Description: '注文タイプ。有効な値：

      BUY：インスタンスの購入に使用される注文。

      UPGRADE：インスタンスのアップグレードに使用される注文。

      DOWNGRADE：インスタンスのダウングレードに使用される注文。' // The order type. Valid values:\nBUY: the orders that are used to purchase instances.\nUPGRADE: the orders that are used to upgrade instances.\nDOWNGRADE: the orders that are used to downgrade instances.
    Type: String
  ProductType:
    Description: "インスタンスのエディションまたはシリーズ。有効な値：\n Local：ApsaraDB for Redis Community Edition インスタンスまたは ApsaraDB for Redis Enhanced Edition (Tair) のパフォーマンス強化インスタンス\n Tair_scm：永続メモリ最適化インスタンス\n Tair_essd：ストレージ最適化インスタンス" // The edition or series of instances. Valid values:\n Local: ApsaraDB for Redis Community Edition instances or performance-enhanced instances of ApsaraDB for Redis Enhanced Edition (Tair)\n Tair_scm: persistent memory-optimized instances\n Tair_essd: storage-optimized instances
    Type: String
  ResourceGroupId:
    Description: "インスタンスの ID。\n注記 このパラメーターは、OrderType パラメーターが UPGRADE または RENEW に設定されている場合にのみ必須です。" // The ID of the instance.\n Note This parameter is required only if the OrderType parameter is set to UPGRADE or RENEW.
    Type: String
  ZoneId:
    Description: 'クエリ対象の PolarDB リソースが存在するゾーンの ID。

      注記 DescribeRegions オペレーションを呼び出して、ゾーンに関する情報をクエリできます。' // The ID of the zone where PolarDB resources that you want to query reside.\nNote You can call the DescribeRegions operation to query information about zones.
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      AcceptLanguage:
        Ref: AcceptLanguage
      Engine:
        Ref: Engine
      InstanceChargeType:
        Ref: InstanceChargeType
      InstanceId:
        Ref: InstanceId
      NodeId:
        Ref: NodeId
      OrderType:
        Ref: OrderType
      ProductType:
        Ref: ProductType
      ResourceGroupId:
        Ref: ResourceGroupId
      ZoneId:
        Ref: ZoneId
    Type: DATASOURCE::REDIS::InstanceClasses
Outputs:
  InstanceClassIds:
    Description: DB インスタンスクラス ID のリスト。 // The list of db instance class ids.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - InstanceClassIds
  InstanceClasses:
    Description: インスタンスクラスのリスト。 // The list of instance classes.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - InstanceClasses