ALIYUN::REDIS::PrepayInstance を使用してサブスクリプションの Tair (Redis OSS-compatible) インスタンスを作成する - Resource Orchestration Service

ALIYUN::REDIS::PrepayInstance は、サブスクリプション ApsaraDB for Redis インスタンスを作成するために使用されます。

構文

  {
  "Type": "ALIYUN::REDIS::PrepayInstance",
  "Properties": {
    "VpcId": String,
    "EvictionPolicy": String,
    "Period": Integer,
    "ZoneId": String,
    "InstanceClass": String,
    "VpcPasswordFree": Boolean,
    "VSwitchId": String,
    "SecurityGroupId": String,
    "EngineVersion": String,
    "Password": String,
    "SSLEnabled": String,
    "InstanceName": String,
    "BackupPolicy": Map,
    "Tags": List,
    "InstanceMaintainTime": Map,
    "DeletionForce": Boolean,
    "AutoPay": Boolean,
    "Connections": Map,
    "AutoRenewDuration": Integer,
    "ProductType": String,
    "SecondaryZoneId": String,
    "ResourceGroupId": String,
    "PeriodUnit": String,
    "TairConfig": Map,
    "ShardCount": Integer,
    "ReadOnlyCount": Integer,
    "SubscriptionDeletionForce": Boolean,
    "NodeType": String,
    "DeletionProtection": Boolean
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
EngineVersion	String	いいえ	はい	インスタンスのデータベースエンジンバージョン。	有効な値: 2.8 説明このバージョンは使用できません。別のバージョンを使用してください。 4.0 5.0
VpcId	String	いいえ	いいえ	インスタンスの VPC ID。	なし。
EvictionPolicy	String	いいえ	いいえ	システムがデータをエビクトするポリシー。	有効な値: noeviction: システムはキーをエビクトせず、書き込み操作でエラーを返します。 allkeys-lru: システムは、最低使用頻度 (LRU) キーをエビクトします。 volatile-lru: システムは、有効期限 (TTL) が設定されているキーから LRU キーをエビクトします。 allkeys-random: システムはキーをランダムにエビクトします。 volatile-random: システムは、TTL が設定されているキーからキーをランダムにエビクトします。 volatile-ttl: システムは、TTL が設定されているキーから、TTL が最も短いキーをエビクトします。
Period	Integer	いいえ	いいえ	インスタンスの更新期間。	有効な値: 1、2、3、4、5、6、7、8、9、12、24、および 36。単位: 月。
ZoneId	String	いいえ	いいえ	インスタンスのゾーン ID。	VPC でインスタンスを作成する場合は、このプロパティを指定する必要があります。複数ゾーンにインスタンスを作成する場合は、DescribeZones オペレーションを呼び出して、サポートされているゾーンの ID をクエリできます。
InstanceClass	String	いいえ	はい	インスタンスの仕様。	詳細については、「インスタンスの仕様」をご参照ください。
VSwitchId	String	いいえ	いいえ	インスタンスの vSwitch ID。	なし。
SecurityGroupId	String	いいえ	はい	インスタンスが属するセキュリティグループの ID。	最大 10 個の ID を指定できます。複数の ID はコンマ (,) で区切ります。
VpcPasswordFree	Boolean	いいえ	いいえ	VPC 内のインスタンスでパスワードなしのアクセス機能を有効にするかどうかを指定します。	有効な値: true false (デフォルト)
Password	String	いいえ	はい	インスタンスへのアクセスに使用されるパスワード。	パスワードは 8～32 文字である必要があります。パスワードには、大文字、小文字、数字、特殊文字のうち、少なくとも 3 種類を含める必要があります。パスワードには、次の特殊文字を含めることができます: `! @ # $ % ^ & * ( ) _ + - =`
SSLEnabled	String	いいえ	はい	SSL 暗号化の状態。	有効な値: Disable: SSL 暗号化は無効になっています。 Enable: SSL 暗号化は有効になっています。 Update: SSL 証明書が更新されます。
SubscriptionDeletionForce	Boolean	いいえ	いいえ	このプロパティは、サブスクリプションインスタンスに対してのみ有効です。サブスクリプションインスタンスに対してこのプロパティを true に設定すると、インスタンスは強制的に削除される前に従量課金制に変更されます。サブスクリプションインスタンスに対してこのプロパティを false に設定すると、インスタンスは強制的に削除されません。このプロパティには追加料金が発生します。このプロパティを指定する際は注意してください。	なし。
InstanceName	String	いいえ	はい	インスタンス名。	名前は 2 ～ 128 文字の長さで、文字、数字、アンダースコア (_)、ハイフン (-)、ピリオド (.) を含めることができます。文字で始める必要があります。
BackupPolicy	Map	いいえ	はい	インスタンスのバックアップポリシー。	詳細については、「BackupPolicy プロパティ」をご参照ください。
Tags	List	いいえ	はい	インスタンスのタグ。	インスタンスには最大 20 個のタグを追加できます。詳細については、「Tags プロパティ」をご参照ください。
AutoPay	Boolean	いいえ	いいえ	自動支払いを有効にするかどうかを指定します。	有効な値: true false (デフォルト)
InstanceMaintainTime	Map	いいえ	はい	インスタンスのメンテナンスウィンドウ。	詳細については、「InstanceMaintainTime プロパティ」をご参照ください。
DeletionForce	Boolean	いいえ	はい	インスタンスがゴミ箱に移動されたときにインスタンスを削除するかどうかを指定します。	有効な値: true false (デフォルト)
Connections	Map	いいえ	はい	インスタンスのエンドポイント。	詳細については、「Connections プロパティ」をご参照ください。
AutoRenewDuration	Integer	いいえ	はい	インスタンスの自動更新期間。	有効な値: 1 ～ 12。単位: 月。インスタンスの有効期限が切れそうになると、システムはこのプロパティの値に基づいてインスタンスを自動的に更新します。
ProductType	String	いいえ	いいえ	インスタンスのエディション。	有効な値: Local: ローカルディスクをサポートする Community Edition インスタンス、またはローカルディスクを使用する拡張エディション (Tair) パフォーマンス拡張インスタンス Tair_rdb: クラウドディスクを使用する Tair パフォーマンス拡張インスタンス Tair_scm: Tair 永続メモリ最適化インスタンス Tair_essd: Tair ストレージ最適化インスタンス OnECS: クラウドディスクを使用する Community Edition インスタンス
SecondaryZoneId	String	いいえ	はい	インスタンスのセカンダリゾーン ID。	DescribeZones オペレーションを呼び出して、セカンダリゾーンの ID をクエリできます。説明このプロパティを指定すると、インスタンスのマスターノードとレプリカノードは異なるゾーンにデプロイされ、ディザスタリカバリはゾーンをまたいで実装されます。インスタンスはデータセンターの障害に耐えることができます。
ResourceGroupId	String	いいえ	はい	インスタンスのリソースグループ ID。	なし。
PeriodUnit	String	いいえ	いいえ	サブスクリプション期間の単位。	有効な値: Year Month
TairConfig	Map	いいえ	いいえ	インスタンスの Tair 構成。	詳細については、「TairConfig プロパティ」をご参照ください。
ShardCount	Integer	いいえ	いいえ	インスタンス内のデータシャードの数。	有効な値: 1 (デフォルト): 単一のデータシャードのみを含む標準アーキテクチャでインスタンスを作成できます。 2 ～ 32: 指定された数のデータシャードを含むクラスタアーキテクチャでインスタンスを作成できます。
ReadOnlyCount	Integer	いいえ	いいえ	プライマリゾーンの読み取りレプリカの数。	ReadOnlyCount は、クラウドネイティブ読み書き分離インスタンスにのみ適用されます。インスタンスがクラスタインスタンスの場合、上記のパラメーターはプライマリゾーンとセカンダリゾーンのシャードごとの読み取り専用レプリカの数を示します。
NodeType	String	いいえ	いいえ	インスタンスのノードタイプです。	有効な値: MASTER_SLAVE: 高可用性 (マスターレプリカ) STAND_ALONE: スタンドアロン double: マスターレプリカ single: スタンドアロン説明 MASTER_SLAVE 値と STAND_ALONE 値は、クラウドディスクを使用するインスタンスでサポートされています。 double 値と single 値は、ローカルディスクを使用するインスタンスでサポートされています。
削除保護	ブール値	いいえ	はい	削除保護機能を有効にするかどうかを指定します。	有効な値: true false

BackupPolicy 構文

"BackupPolicy": {
  "PreferredBackupPeriod": "String", // 優先バックアップ期間
  "PreferredBackupTime": "String", // 優先バックアップ時間
  "EnableBackupLog": "Integer" // バックアップログの有効化
}

BackupPolicy プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
PreferredBackupPeriod	String	はい	はい	システムがデータをバックアップする曜日です。	有効な値：月曜日火曜日水曜日木曜日金曜日土曜日日曜日
PreferredBackupTime	String	はい	はい	システムがデータをバックアップする時刻です。	時刻は ISO 8601 標準の `HH:mmZ-HH:mmZ` 形式で指定します。
EnableBackupLog	Integer	いいえ	はい	増分バックアップを有効にするかどうかを指定します。	有効な値： 1: 増分バックアップを有効にします。 0 (デフォルト): 増分バックアップを無効にします。

InstanceMaintainTime 構文

"InstanceMaintainTime": {
  "MaintainStartTime": "String", // メンテナンス開始時刻
  "MaintainEndTime": "String" // メンテナンス終了時刻
}

InstanceMaintainTime プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
MaintainStartTime	String	いいえ	いいえ	メンテナンスウィンドウの開始時刻。	時刻は ISO 8601 標準の `HH:mmZ` 形式で指定します。時刻は UTC である必要があります。たとえば、メンテナンスウィンドウを `22:00` (UTC+8) に開始する場合は、このプロパティを `14:00Z` に設定する必要があります。
MaintainEndTime	String	いいえ	いいえ	メンテナンスウィンドウの終了時刻。	時刻は ISO 8601 標準の `HH:mmZ` 形式で指定します。時刻は UTC である必要があります。たとえば、メンテナンスウィンドウを `23:00` (UTC+8) に終了する場合は、このプロパティを `15:00Z` に設定する必要があります。説明終了時刻は開始時刻の 1 時間後である必要があります。たとえば、MaintainStartTime を `17:00Z` に設定した場合、MaintainEndTime を `18:00Z` に設定する必要があります。

タグの構文

"Tags": [
  {
    "Key": String, // キー
    "Value": String // 値
  }
]

タグのプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
キー	文字列	はい	いいえ	タグのキー。	タグキーは、リージョン内の Alibaba Cloud アカウント内で一意である必要があります。
値	文字列	いいえ	いいえ	タグの値。	なし。

接続構文

"Connections": {
  "VpcPrivateConnection": "Map",
  "ClassicInnerConnection": "Map",
  "DirectConnection": "Map",
  "PublicConnection": "Map"
}

接続プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
VpcPrivateConnection	マップ	いいえ	はい	VPC エンドポイント。	詳細については、「VpcPrivateConnection プロパティ」をご参照ください。
ClassicInnerConnection	マップ	いいえ	はい	クラシックネットワークエンドポイント。	詳細については、「ClassicInnerConnection プロパティ」をご参照ください。
DirectConnection	マップ	いいえ	はい	直接接続モードの非公開エンドポイント。ビジネス要件に基づいて、直接接続モードの非公開エンドポイントを申請できます。	詳細については、「DirectConnection プロパティ」をご参照ください。
PublicConnection	マップ	いいえ	はい	パブリックエンドポイント。	詳細については、「PublicConnection プロパティ」をご参照ください。

VpcPrivateConnection 構文

"VpcPrivateConnection": {
  "ConnectionPort": Integer, // 接続ポート
  "ConnectionString": String // 接続文字列
}

VpcPrivateConnection プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ConnectionPort	Integer	はい	はい	ApsaraDB for Redis インスタンスがサービスを提供するために使用するポート番号。	有効な値：1024 ～ 65535。
ConnectionString	String	はい	はい	VPC エンドポイントのプレフィックス。	プレフィックスは 8 ～ 64 文字の長さで、小文字と数字を含めることができます。プレフィックスは小文字で始まる必要があります。

PublicConnection の構文

"PublicConnection": {
  "ConnectionPort": Integer, // 接続ポート
  "ConnectionString": String // 接続文字列
}

PublicConnection プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ConnectionPort	Integer	はい	はい	Tair (Redis OSS-compatible) インスタンスがサービスを提供するために使用するポート番号です。	有効な値：1024～65535。
ConnectionString	String	はい	はい	パブリックエンドポイントのプレフィックス。	プレフィックスは 8～64 文字で、小文字と数字を含めることができます。プレフィックスは小文字で始める必要があります。

DirectConnection の構文

"DirectConnection": {
  "ConnectionPort": Integer, // 接続ポート
  "ConnectionString": String // 接続文字列
}

DirectConnection プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ConnectionPort	Integer	はい	はい	ApsaraDB for Redis インスタンスがサービスを提供するために使用するポート番号。	有効な値: 1024 ～ 65535。
ConnectionString	String	はい	はい	直接接続モードの非公開エンドポイントのプレフィックス。	プレフィックスは 8 ～ 64 文字で、小文字と数字を含めることができます。プレフィックスは小文字で始まる必要があります。

ClassicInnerConnection 構文

"ClassicInnerConnection": {
  // 内部接続ポート
  "ConnectionPort": Integer,
  // 接続文字列
  "ConnectionString": String
}

ClassicInnerConnection プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ConnectionPort	Integer	はい	はい	Tair (Redis OSS-compatible) インスタンスがサービスを提供するポート番号。	有効な値：1024～65535。
ConnectionString	String	はい	はい	クラシックネットワークエンドポイントのプレフィックス。	プレフィックスは 8～64 文字で、小文字と数字を含めることができます。プレフィックスは小文字で始める必要があります。

TairConfig 構文

"BackupPolicy": {
  "Storage": "Integer", // ストレージ
  "StorageType": "String", // ストレージタイプ
  "ShardCount": "Integer" // シャード数
}

TairConfig プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Storage	Integer	いいえ	いいえ	クラウドディスクのストレージ容量。	ストレージ容量は、インスタンスタイプによって異なります。詳細については、「ESSD/SSD ベースのインスタンス」をご参照ください。
StorageType	String	いいえ	いいえ	ストレージタイプ。	有効な値: essd_pl0 essd_pl1 essd_pl2 essd_pl3
ShardCount	Integer	いいえ	いいえ	インスタンス内のデータシャードの数。	有効な値: 1 (デフォルト): 単一のデータシャードのみを含む標準アーキテクチャでインスタンスを作成できます。 2 から 32: 指定された数のデータシャードを含むクラスタアーキテクチャでインスタンスを作成できます。

戻り値

Fn::GetAtt

InstanceId: インスタンス ID。
OrderId: インスタンスの注文 ID。
ConnectionDomain: インスタンスへのアクセスに使用するエンドポイント。
Port: インスタンスへのアクセスに使用するポート番号。
InstanceName: インスタンス名。
InstanceClass: インスタンスの仕様。
VpcId: インスタンスの VPC ID。
Capacity: インスタンスのストレージ容量。
InstanceType: インスタンスのデータベースエンジンの種類。
ChargeType: インスタンスの課金方法。
PackageType: インスタンスのプランの種類。
Connections: インスタンスでサポートされる最大接続数。
ArchitectureType: インスタンスのアーキテクチャの種類。
NodeType: インスタンスのノードの種類。
HasRenewChangeOrder: 現在の Alibaba Cloud アカウント内に保留中の更新またはリソースのスケールアウト注文が存在するかどうかを示します。
ResourceGroupId: インスタンスのリソースグループ ID。
QPS: インスタンスのクエリ/秒 (QPS)。この値は、予想される最大 QPS です。
ZoneId: インスタンスのゾーン ID。
Bandwidth: インスタンスの帯域幅。単位: Mbit/s。
EngineVersion: インスタンスのデータベースエンジンバージョン。
NetworkType: インスタンスのネットワークタイプ。
VSwitchId: インスタンスの vSwitch ID。
PrivateIp: インスタンスのプライベート IP アドレス。
PublicConnectionString: インスタンスへのアクセスに使用するパブリックエンドポイントのプレフィックス。
VpcPrivateConnectionPort: VPC エンドポイントを使用してインスタンスにアクセスするために使用するポート番号。
ClassicInnerConnectionString: インスタンスへのアクセスに使用するクラシックネットワークエンドポイントのプレフィックス。
VpcPrivateConnectionString: インスタンスへのアクセスに使用する VPC エンドポイントのプレフィックス。
PublicConnectionPort: パブリックエンドポイントを使用してインスタンスにアクセスするために使用するポート番号。
DirectConnectionString: 直接接続モードでインスタンスにアクセスするために使用するプライベートエンドポイントのプレフィックス。
DirectConnectionPort: 直接接続モードでプライベートエンドポイントを使用してインスタンスにアクセスするために使用するポート番号。
ClassicInnerConnectionPort: クラシックネットワークエンドポイントを使用してインスタンスにアクセスするために使用するポート番号。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Description: Test Create Redis PrepayInstance  # Redis プリペイドインスタンスの作成テスト
Parameters:
  InstanceClass:
    Type: String
    Description: Instance Class # インスタンスクラス
  VpcName:
    Type: String
    Default: mytest
  VSwitchName:
    Type: String
    Default: mytest
  ZoneId:
    Type: String
    AssociationProperty: ALIYUN::ECS::Instance:ZoneId
  EngineVersion:
    Type: String
    Description: 'AllowedValues: 2.8, 4.0, 5.0'
    Default: '5.0'
Resources:
  Vpc:
    Type: ALIYUN::ECS::VPC
    Properties:
      VpcName:
        Ref: VpcName
      CidrBlock: 192.168.0.0/16
  VSwitch:
    DependsOn: Vpc
    Type: ALIYUN::ECS::VSwitch
    Properties:
      VpcId:
        Ref: Vpc
      VSwitchName:
        Ref: VSwitchName
      ZoneId:
        Ref: ZoneId
      CidrBlock: 192.168.10.0/24
  RedisPrepayInstance:
    Type: ALIYUN::REDIS::PrepayInstance
    Properties:
      InstanceClass:
        Ref: InstanceClass
      EngineVersion:
        Ref: EngineVersion
      VpcId:
        Ref: Vpc
      VSwitchId:
        Ref: VSwitch
Outputs:
  OrderId:
    Value:
      Fn::GetAtt:
        - RedisPrepayInstance
        - OrderId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": "Test Create Redis PrepayInstance", // Redis プリペイドインスタンスの作成テスト
  "Parameters": {
    "InstanceClass": {
      "Type": "String",
      "Description": "Instance Class" // インスタンスクラス
    },
    "VpcName": {
      "Type": "String",
      "Default": "mytest"
    },
    "VSwitchName": {
      "Type": "String",
      "Default": "mytest"
    },
    "ZoneId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::Instance:ZoneId"
    },
    "EngineVersion": {
      "Type": "String",
      "Description": "AllowedValues: 2.8, 4.0, 5.0",
      "Default": "5.0"
    }
  },
  "Resources": {
    "Vpc": {
      "Type": "ALIYUN::ECS::VPC",
      "Properties": {
        "VpcName": {
          "Ref": "VpcName"
        },
        "CidrBlock": "192.168.0.0/16"
      }
    },
    "VSwitch": {
      "DependsOn": "Vpc",
      "Type": "ALIYUN::ECS::VSwitch",
      "Properties": {
        "VpcId": {
          "Ref": "Vpc"
        },
        "VSwitchName": {
          "Ref": "VSwitchName"
        },
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "CidrBlock": "192.168.10.0/24"
      }
    },
    "RedisPrepayInstance": {
      "Type": "ALIYUN::REDIS::PrepayInstance",
      "Properties": {
        "InstanceClass": {
          "Ref": "InstanceClass"
        },
        "EngineVersion": {
          "Ref": "EngineVersion"
        },
        "VpcId": {
          "Ref": "Vpc"
        },
        "VSwitchId": {
          "Ref": "VSwitch"
        }
      }
    }
  },
  "Outputs": {
    "OrderId": {
      "Value": {
        "Fn::GetAtt": [
          "RedisPrepayInstance",
          "OrderId"
        ]
      }
    }
  }
}