ALIYUN::REDIS::Instance を使用して Tair (Redis OSS-compatible) インスタンスを作成する - Resource Orchestration Service

ALIYUN::REDIS::Instance は、ApsaraDB for Redis インスタンスを作成するために使用されます。

構文

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

プロパティ

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

BackupPolicy 構文

"BackupPolicy": {
  "PreferredBackupPeriod": "String",
  "PreferredBackupTime": "String",
  "EnableBackupLog": "Integer"
}

BackupPolicy プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
PreferredBackupPeriod	String	はい	はい	システムがデータをバックアップする曜日。	有効な値： Monday Tuesday Wednesday Thursday Friday Saturday Sunday
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 でなければなりません。たとえば、メンテナンスウィンドウを 01:00:00（UTC + 08:00）に開始する場合は、このプロパティを `17:00Z` に設定します。
MaintainEndTime	String	いいえ	いいえ	メンテナンスウィンドウの終了時刻。	ISO 8601 標準の `HH:mmZ` 形式で時刻を指定します。時刻は UTC でなければなりません。たとえば、メンテナンスウィンドウを 02:00:00（UTC + 08:00）に終了する場合は、このプロパティを `18:00Z` に設定します。説明終了時刻は、開始時刻の 1 時間後である必要があります。たとえば、MaintainStartTime を `17:00Z` に設定する場合は、MaintainEndTime を `18:00Z` に設定します。

Tags 構文

"Tags": [
  {
    "Key": String,
    "Value": String
  }
]

Tags プロパティ

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

Connections 構文

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

Connections プロパティ

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

VpcPrivateConnection 構文

"VpcPrivateConnection": {
  "ConnectionPort": Integer,
  "ConnectionString": String
}

VpcPrivateConnection プロパティ

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

PublicConnection 構文

"PublicConnection": {
  "ConnectionPort": Integer,
  "ConnectionString": String
}

PublicConnection プロパティ

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

DirectConnection 構文

"DirectConnection": {
  "ConnectionPort": Integer,
  "ConnectionString": String
}

DirectConnection プロパティ

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

ClassicInnerConnection 構文

"ClassicInnerConnection": {
  "ConnectionPort": Integer,
  "ConnectionString": String
}

ClassicInnerConnection プロパティ

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

TairConfig 構文

"TairConfig": {
  "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: インスタンスの 1 秒あたりのクエリ数 (QPS)。この値は、予想される最大 QPS です。
ZoneId: インスタンスのゾーン ID。
Bandwidth: インスタンスの帯域幅。単位: Mbit/秒。
EngineVersion: データベースエンジンのバージョン。
NetworkType: インスタンスのネットワークタイプ。
VSwitchId: インスタンスの vSwitch ID。
PrivateIp: インスタンスのプライベート IP アドレス。
PublicConnectionString: インスタンスへのアクセスに使用するパブリックエンドポイントのプレフィックス。
VpcPrivateConnectionPort: VPC エンドポイントを使用してインスタンスにアクセスするために使用されるポート番号。
ClassicInnerConnectionString: インスタンスへのアクセスに使用するクラシックネットワークエンドポイントのプレフィックス。
VpcPrivateConnectionString: インスタンスへのアクセスに使用する VPC エンドポイントのプレフィックス。
PublicConnectionPort: パブリックエンドポイントを使用してインスタンスにアクセスするために使用されるポート番号。
DirectConnectionString: 直接接続モードでインスタンスにアクセスするために使用されるプライベートエンドポイントのプレフィックス。
DirectConnectionPort: 直接接続モードでプライベートエンドポイントを使用してインスタンスにアクセスするために使用されるポート番号。
ClassicInnerConnectionPort: クラシックネットワークエンドポイントを使用してインスタンスにアクセスするために使用されるポート番号。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Description: {}
Parameters:
  VpcId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
  ZoneId:
    Type: String
    Description:
      en: Before you create an instance, confirm that the Availability Zone supports the specifications of Redis resources.
    AssociationProperty: ALIYUN::ECS::Instance:ZoneId
    Label:
      en: Zone ID
  VSwitchId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    AssociationPropertyMetadata:
      VpcId: ${VpcId}
      ZoneId: ${ZoneId}
Resources:
  RedisInstance:
    Type: ALIYUN::REDIS::Instance
    Properties:
      VpcId:
        Ref: VpcId
      VSwitchId:
        Ref: VSwitchId
      InstanceClass: redis.master.small.default
      EvictionPolicy: noeviction
      ZoneId:
        Ref: ZoneId
      InstanceName: DefaultRedis
      Password: Admin@123!
Outputs:
  InstanceId:
    Value:
      Fn::GetAtt:
        - RedisInstance
        - InstanceId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": {
  },
  "Parameters": {
    "VpcId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId"
    },
    "ZoneId": {
      "Type": "String",
      "Description": {
        "en": "Before you create an instance, confirm that the Availability Zone supports the specifications of Redis resources."
      },
      "AssociationProperty": "ALIYUN::ECS::Instance:ZoneId",
      "Label": {
        "en": "Zone ID",
      }
    },
    "VSwitchId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "AssociationPropertyMetadata": {
        "VpcId": "${VpcId}",
        "ZoneId": "${ZoneId}"
      }
    }
  },
  "Resources": {
    "RedisInstance": {
      "Type": "ALIYUN::REDIS::Instance",
      "Properties": {
        "VpcId": {
          "Ref": "VpcId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "InstanceClass": "redis.master.small.default",
        "EvictionPolicy": "noeviction",
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "InstanceName": "DefaultRedis",
        "Password": "Admin@123!"
      }
    }
  },
  "Outputs": {
    "InstanceId": {
      "Value": {
        "Fn::GetAtt": [
          "RedisInstance",
          "InstanceId"
        ]
      }
    }
  }
}

その他の例については、instance.yml をご覧ください。例では、ALIYUN::REDIS::Instance、ALIYUN::REDIS::Whitelist、ALIYUN::REDIS::Account のリソースタイプが使用されています。