ALIYUN::MONGODB::Instance を使用して MongoDB レプリカセットインスタンスを作成またはクローンする - Resource Orchestration Service

ALIYUN::MONGODB::Instance タイプは、MongoDB レプリカセットインスタンスを作成またはクローンします。

構文

{
  "Type": "ALIYUN::MONGODB::Instance",
  "Properties": {
    "DatabaseNames": String,
    "VpcPasswordFree": Boolean,
    "ReadonlyReplicas": Integer,
    "BusinessInfo": String,
    "AccountPassword": String,
    "VpcId": String,
    "SecurityGroupId": String,
    "AutoRenew": Boolean,
    "ResourceGroupId": String,
    "VSwitchId": String,
    "StorageEngine": String,
    "SrcDBInstanceId": String,
    "ReplicationFactor": Integer,
    "ZoneId": String,
    "EngineVersion": String,
    "RestoreTime": String,
    "DBInstanceStorage": Integer,
    "DBInstanceDescription": String,
    "CouponNo": String,
    "Period": Integer,
    "SecurityIPArray": String,
    "ChargeType": String,
    "BackupId": String,
    "TDEStatus": Boolean,
    "DBInstanceClass": String,
    "Tags": List,
    "SecondaryZoneId": String,
    "HiddenZoneId": String,
    "StorageType": String,
    "PrivateConnections": Map,
    "ClusterId": String,
    "SrcRegion": String,
    "AuditPolicyOptions": Map,
    "DBInstanceReleaseProtection": Boolean,
    "SSLOptions": Map,
    "Encrypted": Boolean,
    "ProvisionedIops": Integer,
    "EncryptionKey": String,
    "RestoreType": Integer,
    "BackupPolicyOptions": Map
  }
}

プロパティ

プロパティ名	タイプ	必須	更新を許可	説明	制約
DBInstanceStorage	整数	はい	はい	データベースインスタンスのストレージ容量です。	有効な値：10 ～ 3000。値は 10 の倍数である必要があります。単位：GB。
DBInstanceClass	文字列	はい	はい	インスタンスタイプ。	詳細については、「インスタンスタイプ」をご参照ください。
TDEStatus	ブール値	いいえ	はい	TDE (透過的データ暗号化) を有効にするかどうかを指定します。	有効な値： true：TDE を有効にします。説明一度有効にすると、TDE は無効にできません。 false (デフォルト)：TDE を無効にします。
SrcDBInstanceId	文字列	いいえ	いいえ	ソースインスタンスの ID 。	このパラメーターは、インスタンスをクローンする場合にのみ指定します。BackupId または RestoreTime パラメーターと共に指定する必要があります。
DBInstanceDescription	文字列	いいえ	いいえ	インスタンスの説明。	説明は 2～256 文字である必要があります。漢字または英字で始まり、漢字、英字、数字、アンダースコア (_)、ハイフン (-) を含めることができます。
SecurityIPArray	文字列	いいえ	はい	インスタンスにアクセスできるホワイトリスト内の IP アドレスです。	複数の IP アドレスはコンマ (,) で区切ります。各 IP アドレスは一意である必要があります。最大 1,000 個の IP アドレスを指定できます。サポートされているフォーマットは、0.0.0.0/0、10.23.XX.XX (IP アドレス)、または 10.23.XX.XX/24 (CIDR ブロック) です。CIDR ブロックでは、/24 はプレフィックスが 24 ビット長であることを示します。プレフィックス長は 1～32 の範囲で指定できます。デフォルト値は 0.0.0.0/0 で、すべての IP アドレスがインスタンスにアクセスできることを示します。
ClusterId	String	いいえ	いいえ	専用クラスターの ID です。	なし
SrcRegion	String	いいえ	いいえ	ソースインスタンスのリージョンです。	説明このパラメーターは、RestoreType が 2 または 3 に設定されている場合に必須です。
AuditPolicyOptions	Map	いいえ	はい	監査ポリシーの構成です。	詳細については、「AuditPolicyOptions のプロパティセクション」をご参照ください。
DBInstanceReleaseProtection	Boolean	いいえ	はい	インスタンスのリリース保護を有効にするかどうかを指定します。	有効値： true：有効。 false：無効。
SSLOptions	Map	いいえ	はい	Transport Layer Security (TLS) と Secure Sockets Layer (SSL) の暗号化構成です。	詳細については、「SSLOptions のプロパティセクション」をご参照ください。
Encrypted	Boolean	いいえ	いいえ	ディスク暗号化を有効にするかどうかを指定します。	なし
ProvisionedIops	Integer	いいえ	いいえ	プロビジョニングされたパフォーマンスです。	なし
EncryptionKey	String	いいえ	いいえ	ディスク暗号化に使用される Key Management Service (KMS) キーです。	なし
RestoreType	Integer	いいえ	いいえ	バックアップからインスタンスを回復できます。	有効値： 0：指定されたバックアップセットからインスタンスを復元します。 1：インスタンスを指定されたポイントインタイムに復元します。 2：指定されたバックアップセットからリリースされたインスタンスを復元します。 3：指定された地理冗長バックアップセットからインスタンスを復元します。
BackupPolicyOptions	Map	いいえ	はい	バックアップポリシーの構成です。	詳細については、「BackupPolicyOptions のプロパティセクション」をご参照ください。
ZoneId	文字列	いいえ	いいえ	ゾーンの ID 。	詳細については、「DescribeRegions」をご参照ください。インスタンスが VPC 内にある場合、このパラメーターの値は vSwitch のゾーンと同じである必要があります。
VpcPasswordFree	ブール値	いいえ	いいえ	VPC 経由でインスタンスへのパスワードなしのアクセスを有効にするかどうかを指定します。	有効な値： true：パスワードなしのアクセスを有効にします。 false：パスワードなしのアクセスを無効にします。
VpcId	文字列	いいえ	いいえ	VPC の ID 。	なし
SecurityGroupId	文字列	いいえ	はい	セキュリティグループの ID 。	なし
VSwitchId	文字列	いいえ	いいえ	vSwitch の ID 。	なし
BackupId	文字列	いいえ	いいえ	バックアップセットの ID 。	このパラメーターは、インスタンスをクローンする場合にのみ指定します。SrcDBInstanceId パラメーターと共に指定する必要があります。
AccountPassword	文字列	いいえ	はい	ルートアカウントのパスワード。	パスワードは 6～32 文字である必要があります。英字、数字、および次の特殊文字を含めることができます：`!#$%^&*()_+-=`。
EngineVersion	文字列	いいえ	いいえ	データベースのバージョン番号です。	有効な値： 3.4 ( デフォルト ) 4.0 4.2 4.4 5.0
StorageEngine	文字列	いいえ	いいえ	ストレージエンジン。	ストレージエンジンとバージョンの詳細については、「バージョンとストレージエンジン」をご参照ください。有効な値： WiredTiger (デフォルト)：ほとんどのシナリオに適しています。 RocksDB：書き込みが多く、読み取りが少ないシナリオに適しています。 TerarkDB：書き込みよりも読み取りが多いシナリオ、またはバッチ書き込みと多くの読み取りがあるシナリオに適しています。
ReplicationFactor	整数	いいえ	はい	レプリカセット内のノード数です。	有効な値： 3 ( デフォルト ) 5 7
DatabaseNames	文字列	いいえ	いいえ	データベースの名前です。	なし
ReadonlyReplicas	整数	いいえ	はい	読み取り専用ノードの数。	有効な値：1 ～ 5。
BusinessInfo	文字列	いいえ	いいえ	ビジネス情報。	これは追加のパラメーターです。
ResourceGroupId	文字列	いいえ	はい	リソースグループの ID 。	なし
AutoRenew	ブール値	いいえ	いいえ	インスタンスの自動更新を有効にするかどうかを指定します。	有効な値： true：自動更新を有効にします。 false (デフォルト)：リソースは手動で更新する必要があります。
RestoreTime	文字列	いいえ	いいえ	インスタンスをクローンするときにデータを復元したいポイントインタイムです。	yyyy-MM-ddTHH:mm:ssZ 形式で時間を指定します。時間は UTC である必要があります。このパラメーターは、インスタンスをクローンする場合にのみ指定します。SrcDBInstanceId および BackupId パラメーターと共に指定する必要があります。過去 7 日以内のポイントインタイムを指定できます。
CouponNo	文字列	いいえ	いいえ	クーポンコード。	デフォルト値は youhuiquan_promotion_option_id_for_blank です。
Period	整数	いいえ	はい	インスタンスのサブスクリプション期間。	単位：月。有効な値：1、2、3、4、5、6、7、8、9、12、24、および 36。デフォルト値は 1 です。このパラメーターは、ChargeType が PrePaid に設定されている場合にのみ有効です。
ChargeType	文字列	いいえ	はい	インスタンスの課金方法。	有効な値： PostPaid：従量課金。 PrePaid：サブスクリプション。
Tags	リスト	いいえ	はい	タグ。	最大 20 個のタグを追加できます。詳細については、「Tags のプロパティセクション」をご参照ください。
SecondaryZoneId	文字列	いいえ	いいえ	セカンダリノードがデプロイされるゾーンです。	有効な値： cn-hangzhou-g：杭州ゾーン G。 cn-hangzhou-h：杭州ゾーン H。 cn-hangzhou-i：杭州ゾーン I。 cn-hongkong-b：香港 (中国) ゾーン B。 cn-hongkong-c：香港 (中国) ゾーン C。 cn-hongkong-d：香港 (中国) ゾーン D。 cn-wulanchabu-a：ウランチャブゾーン A。 cn-wulanchabu-b：ウランチャブゾーン B。 cn-wulanchabu-c：ウランチャブゾーン C。 ap-southeast-1a：シンガポールゾーン A。 ap-southeast-1b：シンガポールゾーン B。 ap-southeast-1c：シンガポールゾーン C。 ap-southeast-5a：ジャカルタゾーン A。 ap-southeast-5b：ジャカルタゾーン B。 ap-southeast-5c：ジャカルタゾーン C。 eu-central-1a：フランクフルトゾーン A。 eu-central-1b：フランクフルトゾーン B。 eu-central-1c：フランクフルトゾーン C。説明このパラメーターは、EngineVersion が 4.4 または 5.0 に設定されている場合に利用可能で、必須です。このパラメーターの値は、ZoneId または HiddenZoneId の値と同じにすることはできません。
HiddenZoneId	文字列	いいえ	いいえ	非表示ノードがデプロイされるゾーンです。	有効な値： cn-hangzhou-g：杭州ゾーン G。 cn-hangzhou-h：杭州ゾーン H。 cn-hangzhou-i：杭州ゾーン I。 cn-hongkong-b：香港 (中国) ゾーン B。 cn-hongkong-c：香港 (中国) ゾーン C。 cn-hongkong-d：香港 (中国) ゾーン D。 cn-wulanchabu-a：ウランチャブゾーン A。 cn-wulanchabu-b：ウランチャブゾーン B。 cn-wulanchabu-c：ウランチャブゾーン C。 ap-southeast-1a：シンガポールゾーン A。 ap-southeast-1b：シンガポールゾーン B。 ap-southeast-1c：シンガポールゾーン C。 ap-southeast-5a：ジャカルタゾーン A。 ap-southeast-5b：ジャカルタゾーン B。 ap-southeast-5c：ジャカルタゾーン C。 eu-central-1a：フランクフルトゾーン A。 eu-central-1b：フランクフルトゾーン B。 eu-central-1c：フランクフルトゾーン C。説明このパラメーターは、EngineVersion が 4.4 または 5.0 に設定されている場合に利用可能で、必須です。このパラメーターの値は、ZoneId または SecondaryZoneId の値と同じにすることはできません。
StorageType	文字列	いいえ	いいえ	ストレージクラスです。	有効な値： cloud_essd1：PL1 ESSD。 cloud_essd2：PL2 ESSD 。 cloud_essd3：PL3 ESSD 。 local_ssd：ローカル SSD。
PrivateConnections	マップ	いいえ	はい	プライベート接続の構成です。	詳細については、「PrivateConnections のプロパティセクション」をご参照ください。

タグの構文

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

タグのプロパティ

プロパティ名	タイプ	必須	更新を許可	説明	制約
Key	文字列	はい	いいえ	タグキーです。	キーは 1～128 文字である必要があります。`aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。
Value	文字列	いいえ	いいえ	タグ値です。	値は 0～128 文字である必要があります。`aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。

PrivateConnections 構文

"PrivateConnections": 
  {
    "ReplicaConnections": List // レプリカ接続
  }

PrivateConnections のプロパティ

プロパティ名

タイプ

必須

更新を許可

説明

制約

ReplicaConnections

リスト

はい

レプリカノードの接続情報です。

長さは 1～6 である必要があります。

説明

ノードの接続情報は、DescribeDBInstanceAttribute 操作を呼び出して接続情報を照会したのと同じ順序でのみ作成または変更できます。

詳細については、「ReplicaConnections のプロパティセクション」をご参照ください。

AuditPolicyOptions の構文

"AuditPolicyOptions": 
  {
    "StoragePeriod": Integer,
    "AuditStatus": String,
    "AuditLogSwitchSource": String,
    "ServiceType": String
  }

AuditPolicyOptions のプロパティ

プロパティ名	タイプ	必須	更新を許可	説明	制約
AuditStatus	String	はい	はい	監査ログのステータスです。	有効値： enable：監査ログを有効にします。 disabled：監査ログを無効にします。
StoragePeriod	Integer	いいえ	はい	監査ログの保持期間です。	有効値：1～365。デフォルト値は 30 です。単位：日。
AuditLogSwitchSource	String	いいえ	はい	監査ログリクエストのソースです。	値は Console です。
ServiceType	String	いいえ	はい	監査ログのバージョンです。	有効値： Trial：無料試用版。 Standard：正式版。説明デフォルト値は Trial です。2022 年 1 月 6 日以降、監査ログ機能の正式版がさまざまなリージョンで順次リリースされており、無料試用版は申請できなくなりました。このパラメーターを Standard に設定することを推奨します。

SSLOptions の構文

"SSLOptions": 
  {
    "ForceEncryption": Integer,
    "SwitchMode": Integer,
    "SSLAction": String
  }

SSLOptions のプロパティ

プロパティ名	タイプ	必須	更新を許可	説明	制約
SSLAction	String	はい	はい	SSL 機能に対して実行する操作です。	有効値： Open：SSL 暗号化を有効にします。 Close：SSL 暗号化を無効にします。 Update：SSL 証明書を更新します。
ForceEncryption	Integer	いいえ	はい	接続に対して SSL 暗号化を強制的に有効にするかどうかを指定します。	有効値： 1：SSL 暗号化を強制します。 0：SSL 暗号化を強制しません。
SwitchMode	Integer	いいえ	はい	MongoDB インスタンスの SSL 構成を変更する時間です。	有効値： 0：すぐに変更します。 1：O&M ウィンドウ内で変更します。

BackupPolicyOptions の構文

"SSLOptions": 
  {
    "CrossBackupType": String,
    "BackupInterval": Integer,
    "BackupRetentionPolicyOnClusterDeletion": Integer,
    "HighFrequencyBackupRetention": Integer,
    "BackupRetentionPeriod": Integer,
    "InstanceType": String,
    "LogBackupRetentionPeriod": Integer,
    "CrossRetentionValue": Integer,
    "CrossBackupPeriod": String,
    "PreferredBackupTime": String,
    "DestRegion": String,
    "CrossRetentionType": String,
    "EnableCrossLogBackup": Integer,
    "PreferredBackupPeriod": String,
    "PreserveOneEachHour": Boolean,
    "SnapshotBackupType": String,
    "CrossLogRetentionType": String,
    "CrossLogRetentionValue": Integer,
    "EnableBackupLog": Integer,
    "SrcRegion": String
  }

BackupPolicyOptions のプロパティ

プロパティ名	タイプ	必須	更新を許可	説明	制約
CrossBackupType	String	いいえ	はい	地理冗長ポリシーです。	有効値： update：地理冗長ポリシーを変更します。 delete：地理冗長ポリシーを削除します。
BackupInterval	Integer	いいえ	はい	高頻度バックアップの頻度です。	有効値： -1：高頻度バックアップを無効にします。 30：30 分ごと。 60：1 時間ごと。 120：2 時間ごと。 180：3 時間ごと。 240：4 時間ごと。 360：6 時間ごと。 480：8 時間ごと。 720：12 時間ごと。
BackupRetentionPolicyOnClusterDeletion	Integer	いいえ	はい	バックアップ保持ポリシーです。	有効値： 0：インスタンスがリリースされると、インスタンスのすべてのバックアップセットをすぐに削除します。 1：インスタンスがリリースされると自動的にバックアップを作成し、バックアップセットを長期間保持します。 2：インスタンスがリリースされると自動的にバックアップを作成し、クラスターのすべてのバックアップセットを長期間保持します。詳細については、「長期保持バックアップ」をご参照ください。
HighFrequencyBackupRetention	Integer	いいえ	はい	高頻度バックアップの保持期間です。	このパラメーターを使用する前に、BackupInterval パラメーターが指定されていることを確認してください。デフォルトの保持期間は 1 日です。単位：日。
BackupRetentionPeriod	Integer	いいえ	はい	完全バックアップの保持期間です。	説明 2021 年 9 月 10 日より前にアカウントを作成したユーザーの場合、デフォルトの保持期間は 7 日です。インスタンスが 2021 年 9 月 10 日以降に作成された場合、バックアップはデフォルトで 30 日間保持されます。
InstanceType	String	いいえ	はい	インスタンスタイプです。	有効値： replicate sharding 説明このパラメーターは、削除されたインスタンスを復元するときに必須です。このパラメーターは、地理冗長バックアップからインスタンスをクローンするときに必須です。
LogBackupRetentionPeriod	Integer	いいえ	はい	ログバックアップの保持期間です。	デフォルト値は 7 です。有効値：7～730。単位：日。
CrossRetentionValue	Integer	いいえ	はい	地理冗長バックアップの保持期間です。	有効値：3～1825。単位：日。説明このパラメーターは、地理冗長バックアップに必須です。このパラメーターは必須であり、CrossRetentionType が delay に設定されている場合にのみ有効になります。
CrossBackupPeriod	String	いいえ	はい	地理冗長保持期間	有効値： Monday Tuesday Wednesday Thursday Friday Saturday Sunday 説明このパラメーターは、地理冗長バックアップに必須です。複数の値はコンマ (,) で区切ります。定期的なバックアップポリシーを構成する場合、このパラメーターに指定された日は、PreferredBackupPeriod パラメーターに指定された日のサブセットである必要があります。
PreferredBackupTime	String	いいえ	はい	バックアップを実行する時間です。	時間は HH:mmZ-HH:mmZ 形式で指定します。時間は UTC である必要があります。説明時間範囲は 1 時間である必要があります。
DestRegion	String	いいえ	はい	バックアップが保存されるリージョンです。	説明このパラメーターは、地理冗長バックアップに必須です。
CrossRetentionType	String	いいえ	はい	地理冗長バックアップの保持ポリシーです。	説明 delay：一定期間保持します。 never：有効期限はありません。
EnableCrossLogBackup	Integer	いいえ	はい	クロスリージョンログバックアップを有効にするかどうかを指定します。	説明このパラメーターは、地理冗長バックアップに必須です。 1：有効。この値は、シャードクラスターインスタンスに必須です。レプリカセットインスタンスの場合、リージョンをまたいでポイントインタイムリカバリを有効にする場合にこの値が必要です。 0：無効。
PreferredBackupPeriod	String	いいえ	はい	バックアップサイクルです。	有効値： Monday Tuesday Wednesday Thursday Friday：金曜日。 Saturday Sunday 説明複数の値はコンマ (,) で区切ります。
PreserveOneEachHour	Boolean	いいえ	はい	1時間ごとのスパースバックアップを有効にするかどうかを指定します。	有効値： true：バックアップ頻度が分単位で測定される場合、過去 1 時間以内に作成されたすべてのスナップショットが保持されます。1 時間以上前、しかし過去 24 時間以内に作成されたスナップショットについては、正時以降に作成された最初のスナップショットのみが保持されます。 false：すべてのスナップショットは、高頻度バックアップの保持期間内に保持されます。
SnapshotBackupType	String	いいえ	はい	スナップショットバックアップのタイプです。	有効値： Flash：数秒以内のバックアップ。 Standard：通常のバックアップ (デフォルト)。
CrossLogRetentionType	String	いいえ	はい	クロスリージョンログバックアップの保持ポリシーです。	有効値： delay：一定期間保持します。 never：有効期限はありません。
CrossLogRetentionValue	Integer	いいえ	はい	クロスリージョンログバックアップの保持期間です。	有効値：3～1825。値は CrossRetentionValue の値以下である必要があります。単位：日。
EnableBackupLog	Integer	いいえ	はい	ログバックアップを有効にするかどうかを指定します。	有効値： 0：無効 (デフォルト)。 1. 開く。
SrcRegion	String	いいえ	はい	インスタンスのリージョンです。	説明このパラメーターは、削除されたインスタンスを復元する場合に必須です。このパラメーターは、地理冗長バックアップに必須です。

ReplicaConnections 構文

{
  "PrivateConnections": {
    "ReplicaConnections": [
      {
        "ConnectionString": String, // 接続文字列
        "ConnectionPort": Integer // 接続ポート
      }
    ]
  }
}

ReplicaConnections プロパティ

プロパティ名	タイプ	必須	更新を許可	説明	制約
ConnectionString	文字列	はい	はい	接続アドレスプレフィックス	プレフィックスは小文字で始まり、小文字または数字で終わる必要があります。小文字、数字、およびハイフン（ - ）で構成する必要があります。長さは 8 ～ 63 文字である必要があります。説明エンドポイントのプレフィックスのみを指定します。エンドポイントの残りの部分は変更できません。ローカル SSD または ESSD を使用するインスタンスのプライマリ、セカンダリ、および読み取り専用ノードのエンドポイントを変更できます。
ConnectionPort	Integer	いいえ	はい	接続ポートです。	有効値：1000～65535。説明ポートは、MongoDB 4.2 以降を実行し、ESSD を使用するインスタンスに対してのみ変更できます。

戻り値

Fn::GetAtt

OrderId：MongoDB インスタンスの作成に使用された注文の ID です。
DBInstanceId：MongoDB インスタンスの ID です。ID はグローバルに一意です。
DBInstanceStatus：MongoDB インスタンスのステータスです。
ConnectionURI：接続 URI です。
ReplicaSetName：レプリカセットの名前です。
Arn：インスタンスの Alibaba Cloud リソース名 (ARN) です。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Description: Test MONGODB Instance
Parameters:
  VpcId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
  ZoneId:
    Type: String
    AssociationProperty: ALIYUN::ECS::ZoneId
  VSwitchId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    AssociationPropertyMetadata:
      ZoneId: ${ZoneId}
      VpcId: ${VpcId}
Resources:
  MongoDB:
    Type: ALIYUN::MONGODB::Instance
    Properties:
      DBInstanceClass: dds.mongo.mid
      DBInstanceStorage: 10
      ZoneId:
        Ref: ZoneId
      VpcId:
        Ref: VpcId
      VSwitchId:
        Ref: VSwitchId
Outputs: {}

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Description": "Test MONGODB Instance", // MongoDB インスタンステスト
  "Parameters": {
    "VpcId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId"
    },
    "ZoneId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::ZoneId"
    },
    "VSwitchId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "AssociationPropertyMetadata": {
        "ZoneId": "${ZoneId}",
        "VpcId": "${VpcId}"
      }
    }
  },
  "Resources": {
    "MongoDB": {
      "Type": "ALIYUN::MONGODB::Instance",
      "Properties": {
        "DBInstanceClass": "dds.mongo.mid",
        "DBInstanceStorage": 10,
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "VpcId": {
          "Ref": "VpcId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        }
      }
    }
  },
  "Outputs": {
  }
}

詳細については、「YAML の例」をご参照ください。