DATASOURCE::REDIS::Instance による Tair インスタンス情報のクエリ - ROS

DATASOURCE::REDIS::Instance は、ApsaraDB for Redis インスタンスに関する情報をクエリするために使用されます。

構文

{
  "Type": "DATASOURCE::REDIS::Instance",
  "Properties": {
    "DBInstanceId": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

DBInstanceId

String

はい

インスタンスの ID。

なし。

RefreshOptions

String

いいえ

はい

スタックの更新時のデータソースリソースのリフレッシュポリシー。

有効な値:

Never (デフォルト): スタックの更新時にデータソースリソースをリフレッシュしません。
Always: スタックの更新時にデータソースリソースをリフレッシュします。

戻り値

Fn::GetAtt

SecurityIpGroupAttribute: IP アドレスホワイトリストの属性。
EndTime: インスタンスの有効期限。
ResourceGroupId: インスタンスが属するリソースグループの ID。
Config: インスタンスのパラメーター構成。
Port: インスタンスがサービスを提供するために使用するポート番号。
HasRenewChangeOrder: 未適用更新注文があるかどうかを示します。
SecurityIpGroupName: IP アドレスホワイトリストの名前。
ShardCount: クラスタインスタンスのデータシャードの数。
ConnectionDomain: インスタンスのプライベートエンドポイント。
MaintainEndTime: メンテナンスウィンドウの終了時刻。
Capacity: インスタンスの容量。
DBInstanceId: インスタンスの ID。
PrivateIp: インスタンスのプライベート IP アドレス。
Qps: クエリ/秒 (QPS)。
NetworkType: ネットワークタイプ。
PackageType: プランタイプ。
InstanceReleaseProtection: インスタンスのリリース保護機能。
Bandwidth: インスタンスの帯域幅。
PaymentType: 課金方法。
InstanceType: インスタンスのカテゴリ。
Tags: タグの詳細。
MaintainStartTime: メンテナンスウィンドウの開始時刻。
DBInstanceName: インスタンスの名前。
ReplacateId: 分散インスタンスの論理 ID。
ArchitectureType: アーキテクチャタイプ。
SecurityIps: IP アドレスホワイトリスト内の IP アドレス。
EngineVersion: インスタンスのデータベースエンジンのバージョン。
ZoneId: ゾーンの ID。
CloudType: インスタンスがクラウドボックスにある場合にのみ返されるプロパティ。
VSwitchId: vSwitch の ID。
SecurityGroupId: セキュリティグループの ID です。
CreateTime: インスタンスの作成時間。
ReadOnlyCount: 読み取り専用レプリカの数。このプロパティは、クラウドディスクを使用する読み書き分離インスタンスでのみ使用できます。
InstanceClass: インスタンスタイプ。
IsRds: インスタンスが ApsaraDB RDS によって管理されているかどうかを示します。
SecondaryZoneId: セカンダリゾーンの ID。
VpcId: VPC の ID。
VpcAuthMode: VPC の認証モード。
VpcCloudInstanceId: VPC 内のインスタンスの ID。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DBInstanceId:
    Description:
      en: Database instance id.
    Required: true
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      DBInstanceId:
        Ref: DBInstanceId
    Type: DATASOURCE::REDIS::Instance
Outputs:
  ArchitectureType:
    Description: アーキテクチャタイプ
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ArchitectureType
  Bandwidth:
    Description: 帯域幅
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Bandwidth
  Capacity:
    Description: 容量
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Capacity
  CloudType:
    Description: クラウドカテゴリ
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - CloudType
  Config:
    Description: 構成
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Config
  ConnectionDomain:
    Description: 接続ドメイン
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ConnectionDomain
  CreateTime:
    Description: 作成時間
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - CreateTime
  DBInstanceId:
    Description: データベースインスタンス ID
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DBInstanceId
  DBInstanceName:
    Description: インスタンス名
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DBInstanceName
  EndTime:
    Description: 終了時間
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - EndTime
  EngineVersion:
    Description: エンジンバージョン
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - EngineVersion
  HasRenewChangeOrder:
    Description: 未適用更新注文があるかどうか
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - HasRenewChangeOrder
  InstanceClass:
    Description: インスタンスクラス
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - InstanceClass
  InstanceReleaseProtection:
    Description: インスタンスリリース保護
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - InstanceReleaseProtection
  InstanceType:
    Description: インスタンスタイプ
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - InstanceType
  IsRds:
    Description: RDS かどうか
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - IsRds
  MaintainEndTime:
    Description: メンテナンス終了時間
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - MaintainEndTime
  MaintainStartTime:
    Description: メンテナンス開始時間
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - MaintainStartTime
  NetworkType:
    Description: ネットワークタイプ
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - NetworkType
  PackageType:
    Description: パッケー

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DBInstanceId": {
      "Type": "String",
      "Description": {
        "en": "データベースインスタンス ID。"
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::REDIS::Instance",
      "Properties": {
        "DBInstanceId": {
          "Ref": "DBInstanceId"
        }
      }
    }
  },
  "Outputs": {
    "SecurityIpGroupAttribute": {
      "Description": "セキュリティ IP グループ属性。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SecurityIpGroupAttribute"
        ]
      }
    },
    "EndTime": {
      "Description": "終了時刻。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EndTime"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "リソースグループ ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "Config": {
      "Description": "構成。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Config"
        ]
      }
    },
    "Port": {
      "Description": "ポート。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Port"
        ]
      }
    },
    "HasRenewChangeOrder": {
      "Description": "更新変更オーダーがあるかどうか。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "HasRenewChangeOrder"
        ]
      }
    },
    "SecurityIpGroupName": {
      "Description": "セキュリティ IP グループ名。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SecurityIpGroupName"
        ]
      }
    },
    "ShardCount": {
      "Description": "スライス数。このパラメーターは、クラウドディスク クラスタアーキテクチャ インスタンスの作成にのみ適用されます。このパラメーターを使用して、スライス数をカスタマイズできます。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ShardCount"
        ]
      }
    },
    "ConnectionDomain": {
      "Description": "接続ドメイン。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ConnectionDomain"
        ]
      }
    },
    "MaintainEndTime": {
      "Description": "メンテナンス終了時刻。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MaintainEndTime"
        ]
      }
    },
    "Capacity": {
      "Description": "容量。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Capacity"
        ]
      }
    },
    "DBInstanceId": {
      "Description": "データベースインスタンス ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstanceId"
        ]
      }
    },
    "PrivateIp": {
      "Description": "プライベート IP。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PrivateIp"
        ]
      }
    },
    "Qps": {
      "Description": "QPS。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Qps"
        ]
      }
    },
    "NetworkType": {
      "Description": "ネットワークタイプ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "NetworkType"
        ]
      }
    },
    "PackageType": {
      "Description": "パッケージタイプ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PackageType"
        ]
      }
    },
    "InstanceReleaseProtection": {
      "Description": "インスタンスリリース保護。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceReleaseProtection"
        ]
      }
    },
    "Bandwidth": {
      "Description": "帯域幅。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Bandwidth"
        ]
      }
    },
    "PaymentType": {
      "Description": "支払いタイプ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PaymentType"
        ]
      }
    },
    "InstanceType": {
      "Description": "インスタンスタイプ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceType"
        ]
      }
    },
    "Tags": {
      "Description": "タグ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    },
    "MaintainStartTime": {
      "Description": "メンテナンス開始時刻。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MaintainStartTime"
        ]
      }
    },
    "DBInstanceName": {
      "Description": "インスタンス名。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstanceName"
        ]
      }
    },
    "ReplacateId": {
      "Description": "複製 ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReplacateId"
        ]
      }
    },
    "ArchitectureType": {
      "Description": "アーキテクチャタイプ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ArchitectureType"
        ]
      }
    },
    "SecurityIps": {
      "Description": "セキュリティ IP。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SecurityIps"
        ]
      }
    },
    "EngineVersion": {
      "Description": "エンジンバージョン。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EngineVersion"
        ]
      }
    },
    "ZoneId": {
      "Description": "ゾーン ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ZoneId"
        ]
      }
    },
    "CloudType": {
      "Description": "クラウドカテゴリ。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CloudType"
        ]
      }
    },
    "VSwitchId": {
      "Description": "仮想スイッチ ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VSwitchId"
        ]
      }
    },
    "SecurityGroupId": {
      "Description": "セキュリティグループ ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SecurityGroupId"
        ]
      }
    },
    "CreateTime": {
      "Description": "作成時刻。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "ReadOnlyCount": {
      "Description": "読み取り専用ノードの数。このパラメーターは、クラウドディスクバージョンの読み取り/書き込み分離インスタンスの作成にのみ適用されます。このパラメーターを使用して、読み取り専用ノードの数をカスタマイズできます。有効な値：1～5。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ReadOnlyCount"
        ]
      }
    },
    "InstanceClass": {
      "Description": "インスタンスクラス。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceClass"
        ]
      }
    },
    "IsRds": {
      "Description": "RDS かどうか。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IsRds"
        ]
      }
    },
    "SecondaryZoneId": {
      "Description": "スタンバイゾーンの ID。[DescribeZones](~~ 94527 ~~) 操作を呼び出すことができます。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SecondaryZoneId"
        ]
      }
    },
    "VpcId": {
      "Description": "VPC ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VpcId"
        ]
      }
    },
    "VpcAuthMode": {
      "Description": "VPC 認証モード。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VpcAuthMode"
        ]
      }
    },
    "VpcCloudInstanceId": {
      "Description": "VPC クラウドインスタンス ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VpcCloudInstanceId"
        ]
      }
    }
  }
}