ALIYUN::RDS::PrepayDBInstance は、サブスクリプション ApsaraDB RDS インスタンスを作成するために使用されます。
構文
{
"Type": "ALIYUN::RDS::PrepayDBInstance",
"Properties": {
"DBMappings": List, // データベースマッピング
"CouponCode": String, // クーポンコード
"MasterUsername": String, // マスターユーザー名
"PeriodType": String, // 期間タイプ
"DBInstanceNetType": String, // データベースインスタンスのネットワークタイプ
"MasterUserType": String, // マスターユーザータイプ
"AutoRenew": Boolean, // 自動更新
"PreferredBackupTime": String, // 優先バックアップ時間
"PrivateIpAddress": String, // プライベートIPアドレス
"Engine": String, // エンジン
"MultiAZ": Boolean, // マルチAZ
"VpcId": String, // VPC ID
"ConnectionMode": String, // 接続モード
"ResourceGroupId": String, // リソースグループ ID
"VSwitchId": String, // VSwitch ID
"BackupRetentionPeriod": Number, // バックアップ保持期間
"Quantity": Number, // 数量
"CommodityCode": String, // 商品コード
"ZoneId": String, // ゾーン ID
"AutoPay": Boolean, // 自動支払い
"Port": Integer, // ポート
"ConnectionStringPrefix": String, // 接続文字列のプレフィックス
"SubscriptionDeletionForce": Boolean, // サブスクリプションの強制削除
"ConnectionStringType": String, // 接続文字列のタイプ
"EngineVersion": String, // エンジンバージョン
"DBInstanceClass": String, // データベースインスタンスクラス
"PreferredBackupPeriod": List, // 優先バックアップ期間
"DBInstanceStorage": Integer, // データベースインスタンスストレージ
"DBInstanceDescription": String, // データベースインスタンスの説明
"Tags": Map, // タグ
"Period": Number, // 期間
"MasterUserPassword": String, // マスターユーザーパスワード
"AllocatePublicConnection": Boolean, // パブリック接続の割り当て
"SlaveZoneIds": List, // スレーブゾーン ID
"TargetDedicatedHostIdForMaster": String, // マスターのターゲット専用ホスト ID
"RoleARN": String, // ロール ARN
"DBInstanceStorageType": String, // データベースインスタンスストレージタイプ
"Category": String, // カテゴリ
"DBParamGroupId": String, // DBパラメータグループ ID
"EncryptionKey": String, // 暗号鍵
"DBIsIgnoreCase": Integer, // 大文字と小文字を区別しない
"SecurityGroupId": String, // セキュリティグループ ID
"TargetDedicatedHostIdForLog": String, // ログのターゲット専用ホスト ID
"DBTimeZone": String, // DBタイムゾーン
"DedicatedHostGroupId": String, // 専用ホストグループ ID
"TargetDedicatedHostIdForSlave": String, // スレーブのターゲット専用ホスト ID
"MaintainTime": String, // メンテナンス時間
"SQLCollectorStatus": String, // SQLコレクタステータス
"SSLSetting": String, // SSL設定
"ArchiveBackupRetentionPeriod": Integer, // アーカイブバックアップ保持期間
"LogBackupRetentionPeriod": Integer, // ログバックアップ保持期間
"EnableBackupLog": Boolean, // バックアップログの有効化
"LogBackupLocalRetentionNumber": Integer, // ログバックアップローカル保持数
"ArchiveBackupKeepPolicy": String, // アーカイブバックアップ保持ポリシー
"LocalLogRetentionHours": Integer, // ローカルログ保持時間
"HighSpaceUsageProtection": String, // 高容量使用率保護
"CompressType": Integer, // 圧縮タイプ
"LogBackupFrequency": String, // ログバックアップ頻度
"BackupPolicyMode": String, // バックアップポリシーモード
"ArchiveBackupKeepCount": Integer, // アーカイブバックアップ保持数
"LocalLogRetentionSpace": Integer, // ローカルログ保持容量
"ReleasedKeepPolicy": String, // リリース済み保持ポリシー
"BackUpCategory": String, // バックアップカテゴリ
"ServerlessConfig": Map, // サーバーレス設定
"InstanceNetworkType": String, // インスタンスネットワークタイプ
"StorageAutoScale": String, // ストレージ自動スケーリング
"StorageUpperBound": Number, // ストレージ上限
"StorageThreshold": Number, // ストレージしきい値
"IoAccelerationEnabled": String, // I/Oアクセラレーション有効
"ColdDataEnabled": Boolean, // コールドデータ有効
"BurstingEnabled": Boolean, // バースト有効
"DeletionProtection": Boolean // 削除保護
}
}プロパティ
プロパティ | タイプ | 必須 | 編集可能 | 説明 | 制約 |
ResourceGroupId | String | いいえ | はい | リソースグループの ID。 | なし。 |
DBMappings | List | いいえ | いいえ | インスタンスに作成するデータベース。 | 詳細については、DBMappings プロパティをご参照ください。 |
CouponCode | String | いいえ | いいえ | クーポンコード。 | なし。 |
MasterUsername | String | いいえ | はい | インスタンスのデータベースアカウントの名前。 | 名前はグローバルに一意である必要があります。 2 ~ 16 文字の長さである必要があります。文字で始まり、文字または数字で終わる必要があります。文字、数字、およびアンダースコア (_) を含めることができます。 |
PeriodType | String | はい | いいえ | サブスクリプション期間の単位。 | 有効な値:
|
AutoUpgradeMinorVersion | String | いいえ | はい | インスタンスのマイナーバージョンアップグレード方法。 | 有効な値:
|
DBInstanceNetType | String | いいえ | いいえ | インスタンスのネットワーク接続タイプ。 | 有効な値:
|
MasterUserType | String | いいえ | いいえ | データベースアカウントのタイプ。 | 有効な値:
|
Port | Integer | いいえ | はい | インスタンスのポート。 | なし。 |
ConnectionStringPrefix | String | いいえ | はい | エンドポイントのプレフィックス。 | プレフィックスは 8 ~ 64 文字の長さである必要があり、文字、数字、およびハイフン (-) を含めることができます。 |
ConnectionStringType | String | いいえ | はい | エンドポイントタイプ。 | 有効な値:
|
PreferredBackupTime | String | いいえ | はい | バックアップ時間。 | HH:mmZ-HH:mmZ 形式で時間を指定します。 有効な値:00:00Z-01:00Z、01:00Z-02:00Z、02:00Z-03:00Z、03:00Z-04:00Z、04:00Z-05:00Z、05:00Z-06:00Z、06:00Z-07:00Z、07:00Z-08:00Z、08:00Z-09:00Z、09:00Z-10:00Z、10:00Z-11:00Z、11:00Z-12:00Z、12:00Z-13:00Z、13:00Z-14:00Z、14:00Z-15:00Z、15:00Z-16:00Z、16:00Z-17:00Z、17:00Z-18:00Z、18:00Z-19:00Z、19:00Z-20:00Z、20:00Z-21:00Z、21:00Z-22:00Z、22:00Z-23:00Z、および 23:00Z-24:00Z。 |
PrivateIpAddress | String | いいえ | いいえ | vSwitch に対応するプライベート IP アドレス。 | このプロパティを指定しない場合、システムは自動的にプライベート IP アドレスを割り当てます。 |
Engine | String | はい | いいえ | データベースエンジンのタイプ。 | 有効な値:
|
MultiAZ | Boolean | いいえ | いいえ | インスタンスをゾーンをまたいでデプロイするかどうかを指定します。 | 有効な値:
|
VpcId | String | いいえ | いいえ | 仮想プライベートクラウド (VPC) の ID。 | なし。 |
ConnectionMode | String | いいえ | いいえ | データベースの接続モード。 | 有効な値:
このプロパティを指定しない場合、システムはデフォルトで接続モードを割り当てます。 |
AutoRenew | Boolean | いいえ | いいえ | インスタンスの自動更新を有効にするかどうかを指定します。 | 有効な値:
|
VSwitchId | String | いいえ | いいえ | vSwitch ID。 | なし。 |
BackupRetentionPeriod | Number | いいえ | はい | バックアップデータを保持できる日数。 | なし。 |
Quantity | Number | いいえ | いいえ | 作成するインスタンスの数。 | 有効な値:1 ~ 99。 デフォルト値:1。 |
CommodityCode | String | はい | いいえ | 商品コード。 | 有効な値:
|
SubscriptionDeletionForce | Boolean | いいえ | いいえ | このプロパティは、サブスクリプションインスタンスに対してのみ有効です。サブスクリプションインスタンスに対してこのプロパティを true に設定すると、インスタンスが強制的に削除される前に、インスタンスは従量課金制に変更されます。サブスクリプションインスタンスに対してこのプロパティを false に設定すると、インスタンスは強制的に削除されません。このプロパティには追加料金が発生します。このプロパティを指定する際は注意してください。 | なし。 |
ZoneId | String | いいえ | いいえ | ゾーン ID。 | なし。 |
EngineVersion | String | はい | いいえ | データベースエンジンのバージョン。 | 有効な値:
|
DBInstanceClass | String | はい | はい | インスタンスタイプ。 | 例:rds.mys2.large、rds.mss1.large、rds.pg.s1.small など。 |
PreferredBackupPeriod | List | いいえ | はい | データをバックアップする曜日。 | 有効な値:
|
DBInstanceStorage | Integer | はい | はい | インスタンスのストレージ容量。 | 有効な値:
単位:GB。 説明 DBInstanceStorage の値は 5 GB 単位である必要があります。 |
DBInstanceDescription | String | いいえ | はい | インスタンスの説明。 | 説明は 2 ~ 256 文字の長さである必要があります。文字で始まり、 |
Tags | Map | いいえ | はい | タグ。 | なし。 |
Period | Number | はい | いいえ | サブスクリプション期間。 | 有効な値:
|
MasterUserPassword | String | いいえ | はい | インスタンスのデータベースアカウントのパスワード。 | パスワードは 8 ~ 32 文字の長さである必要があります。パスワードには、次の文字タイプのうち少なくとも 3 つが含まれている必要があります。大文字、小文字、数字、および特殊文字。次の特殊文字がサポートされています。 |
AllocatePublicConnection | Boolean | いいえ | いいえ | インスタンスのパブリックエンドポイントを申請するかどうかを指定します。 | 有効な値:
|
AutoPay | Boolean | いいえ | いいえ | 自動支払いを有効にするかどうかを指定します。 | 有効な値:
|
SlaveZoneIds | List | いいえ | いいえ | High-Availability Edition または Enterprise Edition インスタンスのセカンダリゾーン ID。 | 最大 2 つのセカンダリゾーンを指定できます。たとえば、このプロパティを プライマリゾーンまたはセカンダリゾーンごとに vSwitch を指定する必要があります。たとえば、ZoneId を システムにセカンダリゾーンを自動的に選択させる場合は、SlaveZoneIds を |
TargetDedicatedHostIdForMaster | String | いいえ | いいえ | 専用クラスタに作成するプライマリインスタンスのホスト ID。 | なし。 |
RoleARN | String | いいえ | いいえ | ロールの Alibaba Cloud リソースネーム (ARN)。ロールを使用して ApsaraDB RDS から Key Management Service (KMS) にアクセスできます。 | なし。 |
DBInstanceStorageType | String | いいえ | はい | インスタンスのストレージタイプ。 | 有効な値:
|
Category | String | いいえ | はい | インスタンスのエディション。 | 有効な値:
|
DBParamGroupId | String | いいえ | いいえ | パラメータテンプレートの ID。 | なし。 |
EncryptionKey | String | いいえ | いいえ | インスタンスが存在するリージョンでディスクの暗号化に使用されるキーの ID。 | KMS コンソールからキー ID を取得できます。また、キーを作成することもできます。 |
DBIsIgnoreCase | Integer | いいえ | いいえ | テーブル名の大文字と小文字を区別するかどうかを指定します。 | 有効な値:
|
SecurityGroupId | String | いいえ | はい | セキュリティグループの ID。 | インスタンスを最大 3 つのセキュリティグループに関連付けることができます。セキュリティグループ ID はコンマ (,) で区切ります。インスタンスをすべてのセキュリティグループから関連付け解除する場合は、このプロパティを空のままにします。 |
TargetDedicatedHostIdForLog | String | いいえ | いいえ | 専用クラスタに作成するロガーインスタンスのホスト ID。 | なし。 |
DBTimeZone | String | いいえ | いいえ | UTC タイムゾーン。 | 有効な値:-12:59 ~ +13:00。 デフォルトでは、このプロパティを指定しない場合、システムはインスタンスが存在するリージョンのデフォルトのタイムゾーンを使用します。 ローカル SSD が接続されているインスタンスを作成する場合、タイムゾーンに名前を付けることができます。 |
DedicatedHostGroupId | String | いいえ | いいえ | インスタンスを作成する専用クラスタの ID。 | なし。 |
TargetDedicatedHostIdForSlave | String | いいえ | いいえ | 専用クラスタに作成するセカンダリインスタンスのホスト ID。 | なし。 |
MaintainTime | String | いいえ | いいえ | インスタンスのメンテナンスウィンドウ。 | HH:mmZ-HH:mmZ 形式でメンテナンスウィンドウを指定します。 |
SQLCollectorStatus | String | いいえ | はい | SQL Explorer および Audit を有効にするかどうかを指定します。 | 有効な値:
|
SSLSetting | String | いいえ | いいえ | インスタンスの SSL 接続設定。 | 有効な値:
|
ArchiveBackupRetentionPeriod | Integer | いいえ | はい | アーカイブバックアップを保持する日数。 | なし。 |
LogBackupRetentionPeriod | Integer | いいえ | はい | ログバックアップを保持する日数。 | なし。 |
EnableBackupLog | Boolean | いいえ | はい | ログバックアップを有効にするかどうかを指定します。 | 有効な値:
|
LogBackupLocalRetentionNumber | Integer | いいえ | はい | 保持するローカルバイナリログの数。 | なし。 |
ArchiveBackupKeepPolicy | String | いいえ | はい | アーカイブバックアップを保持するサイクル。 | 有効な値:
ArchiveBackupKeepCount は、サイクル内で保持できるバックアップの数を決定します。デフォルトの数は 0 です。 説明 このプロパティは、BackupPolicyMode が DataBackupPolicy に設定されている場合に有効になります。 |
LocalLogRetentionHours | Integer | いいえ | はい | ローカルログバックアップを保持する時間数。 | なし。 |
HighSpaceUsageProtection | String | いいえ | はい | インスタンスの容量使用率が 80% を超えた場合、またはインスタンスの残りの容量が 5 GB 未満の場合に、バイナリログを強制的に削除するかどうかを指定します。 | 有効な値:
|
CompressType | Integer | いいえ | はい | バックアップデータを圧縮するために使用するメソッド。 | 有効な値:
|
LogBackupFrequency | String | いいえ | はい | ログをバックアップする頻度。 | このプロパティは、Engine が SQLServer に設定されている場合に利用可能です。 値を LogInterval に設定します。LogInterval の値は、システムが 30 分ごとにログをバックアップすることを指定します。 説明 LogBackupFrequency のデフォルト値は、PreferredBackupPeriod の値と同じです。 |
BackupPolicyMode | String | いいえ | はい | バックアップタイプ。 | 有効な値:
|
ArchiveBackupKeepCount | Integer | いいえ | はい | 保持するアーカイブバックアップの数。 | なし。 |
LocalLogRetentionSpace | Integer | いいえ | はい | インスタンス上のローカルログの最大容量使用率。 | なし。 |
ReleasedKeepPolicy | String | いいえ | はい | インスタンスがリリースされた場合にアーカイブバックアップを保持するために使用するポリシー。 | 有効な値:
|
BackUpCategory | String | いいえ | はい | バックアップインスタンスのエディション。 | 有効な値:
|
ServerlessConfig | Map | いいえ | いいえ | サーバーレスインスタンスの設定。 | 詳細については、ServerlessConfig プロパティをご参照ください。 |
InstanceNetworkType | String | いいえ | いいえ | インスタンスのネットワークタイプ。 | 有効な値:
説明 MySQL を実行し、クラウドディスクを使用するインスタンスの場合、このプロパティを VPC に設定する必要があります。 PostgreSQL または MariaDB を実行するインスタンスの場合、このプロパティを VPC に設定する必要があります。 SQL Server Basic または SQL Server Web を実行するインスタンスの場合、このプロパティを VPC または Classic に設定できます。他のタイプのインスタンスの場合、このプロパティを VPC に設定する必要があります。 |
StorageAutoScale | String | いいえ | いいえ | 自動ストレージ拡張を有効にするかどうかを指定します。 | このプロパティは、Engine が MySQL または PostgreSQL に設定されている場合にのみサポートされます。有効な値:
説明 インスタンスの作成後に ModifyDasInstanceConfig オペレーションを呼び出して、インスタンスの自動ストレージ拡張の設定を調整することもできます。詳細については、自動ストレージ拡張の設定をご参照ください。 |
StorageUpperBound | Number | いいえ | いいえ | 自動ストレージ拡張で許容される最大ストレージ容量。 | 自動ストレージ拡張によって、インスタンスのストレージ容量がこのプロパティの値を超えることはありません。単位:GB。 説明 値は 0 以上である必要があります。 StorageAutoScale が Enable に設定されている場合は、このプロパティを指定する必要があります。 |
StorageThreshold | Number | いいえ | いいえ | 自動ストレージ拡張がトリガーされるしきい値。単位:%。 | 有効な値:
説明 StorageAutoScale が Enable に設定されている場合は、このプロパティを指定する必要があります。 |
IoAccelerationEnabled | String | いいえ | いいえ | I/O アクセラレーションを有効にするかどうかを指定します。 | 有効な値:
|
ColdDataEnabled | Boolean | いいえ | いいえ | このプロパティは予約されています。 | なし。 |
BurstingEnabled | Boolean | いいえ | いいえ | I/O バーストを有効にするかどうかを指定します。 | 有効な値:
|
DeletionProtection | Boolean | いいえ | はい | 削除保護機能を有効にするかどうかを指定します。 | 有効な値:
|
ServerlessConfig 構文
"ServerlessConfig": {
"SwitchForce": Boolean, // 強制スケーリング
"MaxCapacity": Number, // 最大容量
"MinCapacity": Number, // 最小容量
"AutoPause": Boolean // 自動一時停止
}ServerlessConfig プロパティ
プロパティ | タイプ | 必須 | 編集可能 | 説明 | 制約 |
SwitchForce | Boolean | いいえ | いいえ | サーバーレスインスタンスの強制スケーリングを有効にするかどうかを指定します。 | 有効な値:
説明
|
MaxCapacity | Number | はい | いいえ | インスタンスの RCU スケーリングの最大値。 | 有効な値:0.5 ~ 8。 説明 このプロパティの値は、MinCapacity の値以上である必要があります。 |
MinCapacity | Number | はい | いいえ | インスタンスの RCU スケーリングの最小値。 | 有効な値:0.5 ~ 8。 説明 このプロパティの値は、MaxCapacity の値以下である必要があります。 |
AutoPause | Boolean | いいえ | いいえ | サーバーレスインスタンスの自動起動および一時停止機能を有効にするかどうかを指定します。 | 有効な値:
説明 この機能を有効にすると、インスタンスが 10 分以内に接続されない場合はインスタンスが一時停止され、インスタンスが接続されるとインスタンスが再開されます。 |
DBMappings 構文
"DBMappings": [
{
"DBDescription": String, // データベースの説明
"CharacterSetName": String, // 文字セット
"DBName": String // データベース名
}
]DBMappings プロパティ
プロパティ | タイプ | 必須 | 編集可能 | 説明 | 制約 |
DBDescription | String | いいえ | いいえ | データベースの説明。 | 説明は 2 ~ 256 文字の長さである必要があります。文字で始まり、 |
CharacterSetName | String | はい | いいえ | 文字セット。 | 有効な値:
|
DBName | String | はい | いいえ | データベース名。 | 名前はグローバルに一意である必要があります。 最大 64 文字の長さにすることができ、小文字、数字、およびアンダースコア (_) を含めることができます。小文字で始める必要があります。 |
戻り値
Fn::GetAtt
InnerPort: インスタンスのプライベートポート。
OrderId: 注文 ID。
PublicConnectionString: インスタンスのパブリックエンドポイント。
InnerIPAddress: インスタンスのプライベート IP アドレス。
DBInstanceId: インスタンス ID。
PublicIPAddress: インスタンスのパブリック IP アドレス。
PublicPort: インスタンスのパブリックポート。
InnerConnectionString: インスタンスのプライベートエンドポイント。
例
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
AllocatePublicConnection:
AllowedValues:
- 'True'
- 'true'
- 'False'
- 'false'
Description: true の場合、パブリック接続を自動的に割り当てます。
Type: Boolean
ArchiveBackupKeepCount:
Description: "保持できるアーカイブバックアップの数。デフォルト値:1。有効な値:\nArchiveBackupKeepPolicy パラメータが ByMonth に設定されている場合、このパラメータの値の範囲は 1 ~ 31 です。\nArchiveBackupKeepPolicy パラメータが ByWeek に設定されている場合、このパラメータの値の範囲は 1 ~ 7 です。\n注 ArchiveBackupKeepPolicy パラメータが KeepAll に設定されている場合は、このパラメータを指定する必要はありません。"
MaxValue: 31
MinValue: 1
Type: Number
ArchiveBackupKeepPolicy:
AllowedValues:
- ByMonth
- ByWeek
- KeepAll
Description: "アーカイブバックアップを保持する期間。指定された期間内に保持できるアーカイブバックアップの数は、ArchiveBackupKeepCount パラメータによって決定されます。\nデフォルト値:0。有効な値:\nByMonth \n ByWeek \n KeepAll"
Type: String
ArchiveBackupRetentionPeriod:
Description: "アーカイブバックアップを保持する日数。\nデフォルト値 0 は、バックアップアーカイブ機能を有効にしないことを指定します。有効な値:30 ~ 1095。"
MaxValue: 1095
MinValue: 30
Type: Number
AutoPay:
AllowedValues:
- 'True'
- 'true'
- 'False'
- 'false'
Default: true
Description: 自動支払い。デフォルトは true です。
Type: Boolean
AutoRenew:
AllowedValues:
- 'True'
- 'true'
- 'False'
- 'false'
Default: false
Description: プリペイドインスタンスを自動更新します。期間タイプが年単位の場合、年単位で更新され、それ以外の場合は月単位で更新されます。
Type: Boolean
BackUpCategory:
AllowedValues:
- Flash
- Standard
Description: "2 レベルのバックアップ機能を有効にするかどうかを指定します。この機能により、バックアップを数秒以内に完了できます。有効な値:\nFlash: 2 レベルのバックアップ機能を有効にすることを指定します。\nStandard: 2 レベルのバックアップ機能を無効にすることを指定します。"
Type: String
BackupPolicyMode:
AllowedValues:
- DataBackupPolicy
- LogBackupPolicy
Description: "バックアップタイプ、\nDataBackupPolicy: データバックアップ \nLogBackupPolicy: ログバックアップ"
Type: String
BackupRetentionPeriod:
Default: 7
Description: 'データバックアップの保持期間。値の範囲:7 ~ 730。デフォルト値は元の値です。注 BackupPolicyMode パラメータが LogBackupPolicy に設定されている場合、このパラメータは必須です。'
Type: Number
Category:
AllowedValues:
- Basic
- HighAvailability
- AlwaysOn
- Finance
Description: 'インスタンスのエディション。有効な値:
Basic: Basic Edition を使用することを指定します。
HighAvailability: High-Availability Edition を使用することを指定します。
AlwaysOn: Cluster Edition を使用することを指定します。
Finance: Enterprise Edition を使用することを指定します Type: String
CommodityCode:
AllowedValues:
- rds
- bards
- rords
Default: rds
Description: 注文の商品コード。
Type: String
CompressType:
Description: "バックアップの圧縮に使用する形式。有効な値:\n 1: zlib ツールを使用して、バックアップを .tar.gz ファイルに圧縮します。\n 4: QuickLZ ツールを使用して、バックアップを .xb.gz ファイルに圧縮します。\nこの圧縮形式は、インスタンスが MySQL 5.6 または 5.7 を実行している場合にのみサポートされます。\n個々のデータベースとテーブルを復元するために使用できます。\n 8: QuickLZ ツールを使用して、バックアップを .xb.gz ファイルに圧縮します。\nこの圧縮形式は、インスタンスが MySQL 8.0 を実行している場合にのみサポートされます。\n個々のデータベースまたはテーブルを復元するために使用することはできません。"
Type: Number
ConnectionMode:
Description: 'データベースインスタンスの接続モード。「Standard」モードと「Safe」モードをサポートします。デフォルトは RDS システムが割り当てます。'
Type: String
ConnectionStringPrefix:
AllowedPattern: '[a-zA-Z0-9-]{8,64}'
Description: "エンドポイントのプレフィックス。\nCurrentConnectionString パラメータ値のプレフィックスのみを変更できます。\nプレフィックスは 8 ~ 64 文字の長さである必要があり、文字、数字、およびハイフン (-) を含めることができます。"
Type: String
ConnectionStringType:
AllowedValues:
- Inner
- Public
Default: Inner
Description: 'インスタンスのエンドポイントタイプ。有効な値:Inner、Public'
Type: String
CouponCode:
Description: 注文のクーポンコード。
Type: String
DBInstanceClass:
Description: データベースインスタンスタイプ。RDS データベースインスタンスタイプのリファレンス(「rds.mys2.large」、「rds.mss1.large」、「rds.pg.s1.small」など)を参照してください
Type: String
DBInstanceDescription:
Description: 作成されたデータベースインスタンスの説明。
Type: String
DBInstanceNetType:
AllowedValues:
- Internet
- Intranet
Default: Intranet
Description: データベースインスタンスのネットタイプ。デフォルトは Intranet です。パブリックアクセスには Internet、プライベートアクセスには Intranet を使用します。
Type: String
DBInstanceStorage:
Description: データベースインスタンスのストレージサイズ。mysql は [5,1000] です。sql server 2008r2 は [10,1000]、sql server 2012/2012_web/2016-web は [20,1000] です。PostgreSQL と PPAS は [5,2000] です。5 GB ごとに増加し、単位は GB です
Type: Number
DBInstanceStorageType:
Description: 'インスタンスのストレージタイプ。有効な値:
local_ssd: ローカル SSD を使用することを指定します。これは推奨されるストレージタイプです。
cloud_ssd: 標準 SSD を使用することを指定します。
cloud_essd: 拡張 SSD を使用することを指定します。'
Type: String
DBIsIgnoreCase:
Description: 'テーブル名の大文字と小文字を区別するかどうかを指定します。有効な値:
1: テーブル名の大文字と小文字は区別されません。これはデフォルト値です。
0: テーブル名の大文字と小文字は区別されます。'
Type: Number
DBMappings:
Description: データベースインスタンスにアタッチするデータベースマッピング。
Type: Json
DBParamGroupId:
Description: インスタンスで使用されるパラメータテンプレートの ID。
Type: String
DBTimeZone:
Description: 'インスタンスの UTC タイムゾーン。有効な値:-12:00 ~ +12:00。タイムゾーンは +08:00 などの整数値である必要があります。+08:30 などの値は許可されていません。'
Type: String
DedicatedHostGroupId:
Description: ホストグループにインスタンスを作成する場合、インスタンスが属するホストグループの ID。
Type: String
EnableBackupLog:
AllowedValues:
- 'True'
- 'true'
- 'False'
- 'false'
Description: "ログバックアップ機能を有効にするかどうかを指定します。有効な値:\nTrue: ログバックアップ機能を有効にすることを指定します。\nFalse: ログバックアップ機能を無効にすることを指定します。\n注 BackupPolicyMode パラメータが LogBackupPolicy に設定されている場合、このパラメータは必須です。"
Type: Boolean
EncryptionKey:
Description: リージョン内の SSD 上のデータを暗号化するために使用される暗号鍵の ID。Key Management Service (KMS) コンソールで暗号鍵 ID を表示できます。暗号鍵を作成することもできます。
Type: String
Engine:
AllowedValues:
- MySQL
- SQLServer
- PostgreSQL
- PPAS
- MariaDB
Description: データベースインスタンスのエンジンの種類。現在は MySQL/SQLServer/PostgreSQL/PPAS/MariaDB をサポートしています。
Type: String
EngineVersion:
Description: '相対エンジンの種類のデータベースインスタンスバージョン。MySQL のサポート:5.5/5.6/5.7/8.0;
SQLServer: 2008r2/2012/2012_ent_ha/2012_std_ha/2012_web/2016_ent_ha/2016_std_ha/2016_web/2017_std_ha/2017_ent;
PostgreSQL: 9.4/10.0/11.0/12.0;
PPAS: 9.3/10.0;
MariaDB: 10.3.'
Type: String
HighSpaceUsageProtection:
AllowedValues:
- Enable
- Disable
Description: "インスタンスの容量使用率が 80% を超えた場合、または残りの容量が 5 GB 未満の場合に、ログバックアップファイルを強制的に削除するかどうかを指定します。有効な値:\n有効と無効。デフォルト値を保持できます。注 BackupPolicyMode パラメータが LogBackupPolicy に設定されている場合、このパラメータを指定する必要があります。"
Type: String
LocalLogRetentionHours:
Description: "インスタンスにログバックアップファイルを保持する時間数。\n有効な値:0 ~ 168。値 0 は、インスタンスにログバックアップファイルを保持しないことを指定します。\nデフォルト値を保持できます。注 BackupPolicyMode パラメータが LogBackupPolicy に設定されている場合、このパラメータを指定する必要があります。"
MaxValue: 168
MinValue: 0
Type: Number
LocalLogRetentionSpace:
Description: "インスタンスにログバックアップファイルを保存するために許可される最大容量の割合。\nログバックアップファイルの容量使用率がこの割合を超えると、容量使用率がこの割合を下回るまで、システムは以前のログバックアップファイルを削除します。有効な値:0 ~ 50。\nデフォルト値を保持できます。注 BackupPolicyMode パラメータが LogBackupPolicy に設定されている場合、このパラメータを指定する必要があります。"
MaxValue: 50
MinValue: 0
Type: Number
LogBackupFrequency:
Description: "ログをバックアップする頻度。有効な値:\n値 LogInterval は、30 分ごとにログをバックアップすることを指定します。\nこのパラメータのデフォルト値は、データバックアップの頻度と同じです。\n注 LogInterval 値は、インスタンスが SQL Server を実行している場合にのみサポートされます。"
Type: String
LogBackupLocalRetentionNumber:
Description: "インスタンスに保持できるログバックアップファイルの数。\nデフォルト値:60。有効な値:6 ~ 100。"
MaxValue: 100
MinValue: 6
Type: Number
LogBackupRetentionPeriod:
Description: "ログバックアップファイルを保持する日数。有効な値:7 ~ 730。ログバックアップの保持期間は、データバックアップの保持期間よりも長くすることはできません。注 ログバックアップ機能を有効にした場合、ログバックアップの保持期間を指定できます。これは、インスタンスが MySQL、PostgreSQL、または PPAS を実行している場合にのみ適用されます。"
MaxValue: 730
MinValue: 7
Type: Number
MaintainTime:
Description: メンテナンスが実行される期間。形式は HH:mmZ-HH:mmZ です。
Type: String
MasterUserPassword:
Description: 'データベースインスタンスのマスターパスワード。'
MaxLength: 32
MinLength: 8
Type: String
MasterUserType:
AllowedValues:
- Normal
- Super
- Sysadmin
Default: Normal
Description: "アカウントの権限タイプ。\nNormal: 共通権限。\nSuper: 高い権限。\nSysadmin: スーパー権限 (SA) (SQL Server でのみサポート)\nデフォルト値は Normal です。"
Type: String
MasterUsername:
Description: 'データベースインスタンスのマスターユーザー名。'
Type: String
MultiAZ:
AllowedValues:
- 'True'
- 'true'
- 'False'
- 'false'
Default: false
Description: 'データベースインスタンスがマルチ Availability Zone デプロイメントであるかどうかを指定します。'
Type: Boolean
Period:
Default: 1
Description: プリペイド期間。月単位の支払いを選択した場合、1 ~ 9 の範囲で指定できます。年単位の支払いを選択した場合、1 ~ 3 の範囲で指定できます。
MaxValue: 9
MinValue: 1
Type: Number
PeriodType:
AllowedValues:
- Month
- Year
Default: Month
Description: 作成されたインスタンスの課金期間。
Type: String
Port:
Description: データベースサービスのポート。
MaxValue: 65535
MinValue: 1
Type: Number
PreferredBackupPeriod:
Description: バックアップ期間。複数の値はコンマ (,) で区切ります。デフォルト値は元の値です。有効な値:月曜日 火曜日 水曜日 木曜日 金曜日 土曜日 日曜日 注 BackupPolicyMode パラメータが DataBackupPolicy に設定されている場合、このパラメータは必須です。
Type: CommaDelimitedList
PreferredBackupTime:
Description: 'バックアップタスクが実行される時刻。形式:yyyy-MM-ddZ-HH:mm:ssZ。注 BackupPolicyMode パラメータが DataBackupPolicy に設定されている場合、このパラメータは必須です。'
Type: String
PrivateIpAddress:
Description: 作成されたインスタンスのプライベート IP。
Type: String
Quantity:
Default: 1
Description: 作成されるインスタンスの数。デフォルトは 1、最大数は 99 です
MaxValue: 99
MinValue: 1
Type: Number
ReleasedKeepPolicy:
AllowedValues:
- Lastest
- All
Description: "インスタンスがリリースされた場合にアーカイブバックアップを保持するために使用されるポリシー。デフォルト値:なし。\n有効な値:\nLastest: 最後のアーカイブバックアップのみが保持されます。\nAll: すべてのアーカイブバックアップが保持されます。"
Type: String
ResourceGroupId:
Description: リソースグループ ID。
Type: String
RoleARN:
Description: Alibaba Cloud アカウントが KMS に接続するためにインスタンスのサービスアカウントに提供する Alibaba Cloud リソースネーム (ARN)。RAM コンソールから ARN をコピーできます。
Type: String
SQLCollectorStatus:
AllowedValues:
- Enable
- Disabled
Description: "SQL Explorer (SQL 監査) 機能を有効にするか無効にするかを指定します。\n有効な値:有効 | 無効。"
Type: String
SSLSetting:
AllowedValues:
- Disabled
- EnabledForPublicConnection
- EnabledForInnerConnection
Default: Disabled
Description: 'インスタンスの Secure Sockets Layer (SSL) リンク設定。有効な値:
無効:SSL を無効にします
EnabledForPublicConnection: パブリック接続アドレスは SSL 証明書によって保護されます。AllocatePublicConnection が true である必要があります。
EnabledForInnerConnection: プライベート接続アドレスは SSL 証明書によって保護されます。
デフォルト値は無効です。'
Type: String
SecurityGroupId:
Description: "ECS セキュリティグループの ID。\n各 RDS インスタンスは最大 3 つの ECS セキュリティグループに関連付けることができます。\nコンマ (,) で区切る必要があります。\nECS セキュリティグループを削除するには、このパラメータを空のままにします。\n"
Type: String
SlaveZoneIds:
Description: High-Availability Edition または Enterprise Edition インスタンスを作成するときに、スレーブゾーン ID のリストでスレーブゾーン ID を指定できます。一方、VSwitchId は対応する vswitch ID を順番にスレーブゾーンに渡す必要があります。たとえば、ZoneId = "zone-a" および SlaveZoneIds = ["zone-c", "zone-b"] の場合、VSwitchId は "vsw-zone-a,vsw-zone-c,vsw-zone-b" である必要があります。もちろん、自動割り当ても選択できます。たとえば、ZoneId = "zone-a" および SlaveZoneIds = ["Auto", "Auto"] の場合、VSwitchId は "vsw-zone-a,Auto,Auto" である必要があります。リストには最大 2 つのスレーブゾーン ID が含まれており、コンマで区切られます。
MaxLength: 2
Type: Json
Tags:
Description: 'インスタンスのタグ。
Key-Value の形式({"key1":"value1","key2":"value2", ... "key5":"value5"} など)でタグの情報を入力する必要があります。
最大 5 つのタグを指定できます。
キー
最大 64 文字の長さにすることができます。
aliyun で始めることはできません。
http:// または https:// で始めることはできません。
ヌル文字列にすることはできません。
値
最大 128 文字の長さにすることができます。
aliyun で始めることはできません。
http:// または https:// で始めることはできません。
ヌル文字列にすることができます。'
Type: Json
TargetDedicatedHostIdForLog:
Description: ホストグループにログインスタンスを作成する場合、インスタンスが属するホストの ID。
Type: String
TargetDedicatedHostIdForMaster:
Description: ホストグループにプライマリインスタンスを作成する場合、インスタンスが属するホストの ID。
Type: String
TargetDedicatedHostIdForSlave:
Description: ホストグループにセカンダリインスタンスを作成する場合、インスタンスが属するホストの ID。
Type: String
VSwitchId:
Description: 作成されたインスタンスの vSwitch ID。VPC ネットワークの場合、このプロパティは必須です。
Type: String
VpcId:
Description: 作成されたデータベースインスタンスの VPC ID。VPC ネットワークの場合、このプロパティは必須です。
Type: String
ZoneId:
Description: データベースインスタンスを作成するために選択されたゾーン。MultiAZ パラメータが true に設定されている場合、ZoneId パラメータを設定することはできません。
Type: String
Resources:
PrepayDBInstance:
Properties:
AllocatePublicConnection:
Ref: AllocatePublicConnection
ArchiveBackupKeepCount:
Ref: ArchiveBackupKeepCount
ArchiveBackupKeepPolicy:
Ref: ArchiveBackupKeepPolicy
ArchiveBackupRetentionPeriod:
Ref: ArchiveBackupRetentionPeriod
AutoPay:
Ref: AutoPay
AutoRenew:
Ref: AutoRenew
BackUpCategory:
Ref: BackUpCategory
BackupPolicyMode:
Ref: BackupPolicyMode
BackupRetentionPeriod:
Ref: BackupRetentionPeriod
Category:
Ref: Category
CommodityCode:
Ref: CommodityCode
CompressType:
Ref: CompressType
ConnectionMode:
Ref: ConnectionMode
ConnectionStringPrefix:
Ref: ConnectionStringPrefix
ConnectionStringType:
Ref: ConnectionStringType
CouponCode:
Ref: CouponCode
DBInstanceClass:
Ref: DBInstanceClass
DBInstanceDescription:
Ref: DBInstanceDescription
DBInstanceNetType:
Ref: DBInstanceNetType
DBInstanceStorage:
Ref: DBInstanceStorage
DBInstanceStorageType:
Ref: DBInstanceStorageType
DBIsIgnoreCase:
Ref: DBIsIgnoreCase
DBMappings:
Ref: DBMappings
DBParamGroupId:
Ref: DBParamGroupId
DBTimeZone:
Ref: DBTimeZone
DedicatedHostGroupId:
Ref: DedicatedHostGroupId
EnableBackupLog:
Ref: EnableBackupLog
EncryptionKey:
Ref: EncryptionKey
Engine:
Ref: Engine
EngineVersion:
Ref: EngineVersion
HighSpaceUsageProtection:
Ref: HighSpaceUsageProtection
LocalLogRetentionHours:
Ref: LocalLogRetentionHours
LocalLogRetentionSpace:
Ref: LocalLogRetentionSpace
LogBackupFrequency:
Ref: LogBackupFrequency
LogBackupLocalRetentionNumber:
Ref: LogBackupLocalRetentionNumber
LogBackupRetentionPeriod:
Ref: LogBackupRetentionPeriod
MaintainTime:
Ref: MaintainTime
MasterUserPassword:
Ref: MasterUserPassword
MasterUserType:
Ref: MasterUserType
MasterUsername:
Ref: MasterUsername
MultiAZ:
Ref: MultiAZ
Period:
Ref: Period
PeriodType:
Ref: PeriodType
Port:
Ref: Port
PreferredBackupPeriod:
Ref: PreferredBackupPeriod
PreferredBackupTime:
Ref: PreferredBackupTime
PrivateIpAddress:
Ref: PrivateIpAddress
Quantity:
Ref: Quantity
ReleasedKeepPolicy:
Ref: ReleasedKeepPolicy
ResourceGroupId:
Ref: ResourceGroupId
RoleARN:
Ref: RoleARN
SQLCollectorStatus:
Ref: SQLCollectorStatus
SSLSetting:
Ref: SSLSetting
SecurityGroupId:
Ref: SecurityGroupId
SlaveZoneIds:
Ref: SlaveZoneIds
Tags:
Ref: Tags
TargetDedicatedHostIdForLog:
Ref: TargetDedicatedHostIdForLog
TargetDedicatedHostIdForMaster:
Ref: TargetDedicatedHostIdForMaster
TargetDedicatedHostIdForSlave:
Ref: TargetDedicatedHostIdForSlave
VSwitchId:
Ref: VSwitchId
VpcId:
Ref: VpcId
ZoneId:
Ref: ZoneId
Type: ALIYUN::RDS::PrepayDBInstance
Outputs:
DBInstanceId:
Description: 作成されたデータベースインスタンスのインスタンス ID。
Value:
Fn::GetAtt:
- PrepayDBInstance
- DBInstanceId
InnerConnectionString:
Description: イントラネットによる DB インスタンス接続 URL。
Value:
Fn::GetAtt:
- PrepayDBInstance
- InnerConnectionString
InnerIPAddress:
Description: イントラネットの作成された DB インスタンスの IP アドレス。
Value:
Fn::GetAtt:
- PrepayDBInstance
- InnerIPAddress
InnerPort:
Description: 作成された DB インスタンスのイントラネットポート。
Value:
Fn::GetAtt:
- PrepayDBInstance
- InnerPort
OrderId:
Description: 作成されたインスタンスの注文 ID リスト。
Value:
Fn::GetAtt:
- PrepayDBInstance
- OrderId
PublicConnectionString:
Description: インターネットによる DB インスタンス接続 URL。
Value:
Fn::GetAtt:
- PrepayDBInstance
- PublicConnectionString
PublicIPAddress:
Description: インターネットの作成された DB インスタンスの IP アドレス。
Value:
Fn::GetAtt:
- PrepayDBInstance
- PublicIPAddress
PublicPort:
Description: 作成された DB インスタンスのインターネットポート。
Value:
Fn::GetAtt:
- PrepayDBInstance
- PublicPort{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"PeriodType": {
"Type": "String",
"Description": "作成されたインスタンスの課金期間。",
"AllowedValues": [
"Month",
"Year"
],
"Default": "Month"
},
"ResourceGroupId": {
"Type": "String",
"Description": "リソースグループ ID。"
},
"ArchiveBackupRetentionPeriod": {
"Type": "Number",
"Description": "アーカイブバックアップを保持する日数。\nデフォルト値 0 は、バックアップアーカイブ機能を有効にしないことを指定します。有効な値:30 ~ 1095。",
"MinValue": 30,
"MaxValue": 1095
},
"DBTimeZone": {
"Type": "String",
"Description": "インスタンスの UTC タイムゾーン。有効な値:-12:00 ~ +12:00。タイムゾーンは +08:00 などの整数値である必要があります。+08:30 などの値は許可されていません。"
},
"Port": {
"Type": "Number",
"Description": "データベースサービスのポート。",
"MinValue": 1,
"MaxValue": 65535
},
"ArchiveBackupKeepCount": {
"Type": "Number",
"Description": "保持できるアーカイブバックアップの数。デフォルト値:1。有効な値:\nArchiveBackupKeepPolicy パラメータが ByMonth に設定されている場合、このパラメータの値の範囲は 1 ~ 31 です。\nArchiveBackupKeepPolicy パラメータが ByWeek に設定されている場合、このパラメータの値の範囲は 1 ~ 7 です。\n注 ArchiveBackupKeepPolicy パラメータが KeepAll に設定されている場合は、このパラメータを指定する必要はありません。",
"MinValue": 1,
"MaxValue": 31
},
"LogBackupRetentionPeriod": {
"Type": "Number",
"Description": "ログバックアップファイルを保持する日数。有効な値:7 ~ 730。ログバックアップの保持期間は、データバックアップの保持期間よりも長くすることはできません。インスタンスが MySQL、PostgreSQL、または PPAS を実行している場合にのみ、ログバックアップ機能を有効にすると、ログバックアップの保持期間を指定できます。",
"MinValue": 7,
"MaxValue": 730
},
"DBInstanceStorage": {
"Type": "Number",
"Description": "データベースインスタンスのストレージサイズ。mysql は [5,1000] です。sql server 2008r2 は [10,1000]、sql server 2012/2012_web/2016-web は [20,1000] です。PostgreSQL と PPAS は [5,2000] です。5 GB ごとに増加し、単位は GB です"
},
"DBMappings": {
"Type": "Json",
"Description": "データベースインスタンスにアタッチするデータベースマッピング。"
},
"ConnectionStringPrefix": {
"Type": "String",
"Description": "エンドポイントのプレフィックス。\nCurrentConnectionString パラメータ値のプレフィックスのみを変更できます。\nプレフィックスは 8 ~ 64 文字の長さである必要があり、文字、数字、およびハイフン (-) を含めることができます。",
"AllowedPattern": "[a-zA-Z0-9-]{8,64}"
},
"MultiAZ": {
"Type": "Boolean",
"Description": "データベースインスタンスがマルチ Availability Zone デプロイメントであるかどうかを指定します。",
"AllowedValues": [
"True",
"true",
"False",
"false"
],
"Default": false
},
"Engine": {
"Type": "String",
"Description": "データベースインスタンスのエンジンの種類。現在は MySQL/SQLServer/PostgreSQL/PPAS/MariaDB をサポートしています。",
"AllowedValues": [
"MySQL",
"SQLServer",
"PostgreSQL",
"PPAS",
"MariaDB"
]
},
"Tags": {
"Type": "Json",
"Description": "インスタンスのタグ。\nKey-Value の形式({\"key1\":\"value1\",\"key2\":\"value2\", ... \"key5\":\"value5\"} など)でタグの情報を入力する必要があります。\n最大 5 つのタグを指定できます。\nキー\n最大 64 文字の長さにすることができます。\naliyun で始めることはできません。\nhttp:// または https:// で始めることはできません。\nヌル文字列にすることはできません。\n値\n最大 128 文字の長さにすることができます。\naliyun で始めることはできません。\nhttp:// または https:// で始めることはできません。\nヌル文字列にすることができます。"
},
"DBInstanceDescription": {
"Type": "String",
"Description": "作成されたデータベースインスタンスの説明。"
},
"TargetDedicatedHostIdForMaster": {
"Type": "String",
"Description": "ホストグループにプライマリインスタンスを作成する場合、インスタンスが属するホストの ID。"
},
"EngineVersion": {
"Type": "String",
"Description": "相対エンジンの種類のデータベースインスタンスバージョン。MySQL のサポート:5.5/5.6/5.7/8.0;\nSQLServer: 2008r2/2012/2012_ent_ha/2012_std_ha/2012_web/2016_ent_ha/2016_std_ha/2016_web/2017_std_ha/2017_ent;\nPostgreSQL: 9.4/10.0/11.0/12.0;\nPPAS: 9.3/10.0;\nMariaDB: 10.3."
},
"DBInstanceClass": {
"Type": "String",
"Description": "データベースインスタンスタイプ。「rds.mys2.large」、「rds.mss1.large」、「rds.pg.s1.small」などの RDS データベースインスタンスタイプのリファレンスを参照してください"
},
"ArchiveBackupKeepPolicy": {
"Type": "String",
"Description": "アーカイブバックアップを保持する期間。指定された期間内に保持できるアーカイブバックアップの数は ArchiveBackupKeepCount パラメータによって決定されます。\nデフォルト値:0。有効な値:\nByMonth \n ByWeek \n KeepAll",
"AllowedValues": [
"ByMonth",
"ByWeek",
"KeepAll"
]
},
"VSwitchId": {
"Type": "String",
"Description": "作成されたインスタンスの vSwitch ID。VPC ネットワークの場合、このプロパティは必須です。"
},
"BackupPolicyMode": {
"Type": "String",
"Description": "バックアップタイプ、\nDataBackupPolicy: データバックアップ \nLogBackupPolicy: ログバックアップ",
"AllowedValues": [
"DataBackupPolicy",
"LogBackupPolicy"
]
},
"Period": {
"Type": "Number",
"Description": "プリペイド期間。月単位の支払いを選択した場合、1 ~ 9 の範囲で指定できます。年単位の支払いを選択した場合、1 ~ 3 の範囲で指定できます。",
"MinValue": 1,
"MaxValue": 9,
"Default": 1
},
"LocalLogRetentionHours": {
"Type": "Number",
"Description": "インスタンスにログバックアップファイルを保持する時間数。\n有効な値:0 ~ 168。値 0 は、インスタンスにログバックアップファイルを保持しないことを指定します。\nデフォルト値を保持できます。注 BackupPolicyMode パラメータが LogBackupPolicy に設定されている場合、このパラメータを指定する必要があります。",
"MinValue": 0,
"MaxValue": 168
},
"HighSpaceUsageProtection": {
"Type": "String",
"Description": "インスタンスの容量使用率が 80% を超えた場合、または残りの容量が 5 GB 未満の場合に、ログバックアップファイルを強制的に削除するかどうかを指定します。有効な値:\n有効と無効。デフォルト値を保持できます。注 BackupPolicyMode パラメータが LogBackupPolicy に設定されている場合、このパラメータを指定する必要があります。",
"AllowedValues": [
"Enable",
"Disable"
]
},
"RoleARN": {
"Type": "String",
"Description": "Alibaba Cloud アカウントが KMS に接続するためにインスタンスのサービスアカウントに提供する Alibaba Cloud リソースネーム (ARN)。RAM コンソールから ARN をコピーできます。"
},
"MasterUserPassword": {
"Type": "String",
"Description": "データベースインスタンスのマスターパスワード。",
"MinLength": 8,
"MaxLength": 32
},
"VpcId": {
"Type": "String",
"Description": "作成されたデータベースインスタンスの VPC ID。VPC ネットワークの場合、このプロパティは必須です。"
},
"SSLSetting": {
"Type": "String",
"Description": "インスタンスの Secure Sockets Layer (SSL) リンク設定。有効な値:\n無効:SSL を無効にします\nEnabledForPublicConnection: パブリック接続アドレスは SSL 証明書によって保護されます。AllocatePublicConnection が true である必要があります。\nEnabledForInnerConnection: プライベート接続アドレスは SSL 証明書によって保護されます。\nデフォルト値は無効です。",
"AllowedValues": [
"Disabled",
"EnabledForPublicConnection",
"EnabledForInnerConnection"
],
"Default": "Disabled"
},
"MasterUsername": {
"Type": "String",
"Description": "データベースインスタンスのマスターユーザー名。"
},
"ConnectionMode": {
"Type": "String",
"Description": "データベースインスタンスの接続モード。「Standard」モードと「Safe」モードをサポートします。デフォルトは RDS システムが割り当てます。"
},
"LocalLogRetentionSpace": {
"Type": "Number",
"Description": "インスタンスにログバックアップファイルを保存するために許可される最大容量の割合。\nログバックアップファイルの容量使用率がこの割合を超えると、容量使用率がこの割合を下回るまで、システムは以前のログバックアップファイルを削除します。有効な値:0 ~ 50。\nデフォルト値を保持できます。注 BackupPolicyMode パラメータが LogBackupPolicy に設定されている場合、このパラメータを指定する必要があります。",
"MinValue": 0,
"MaxValue": 50
},
"Category": {
"Type": "String",
"Description": "インスタンスのエディション。有効な値:\nBasic: Basic Edition を使用することを指定します。\nHighAvailability: High-Availability Edition を使用することを指定します。\nAlwaysOn: Cluster Edition を使用することを指定します。\nFinance: Enterprise Edition を使用することを指定します。",
"AllowedValues": [
"Basic",
"HighAvailability",
"AlwaysOn",
"Finance"
]
},
"PrivateIpAddress": {
"Type": "String",
"Description": "作成されたインスタンスのプライベート IP。"
},
"TargetDedicatedHostIdForSlave": {
"Type": "String",
"Description": "ホストグループにセカンダリインスタンスを作成する場合、インスタンスが属するホストの ID。"
},
"DBInstanceNetType": {
"Type": "String",
"Description": "データベースインスタンスのネットタイプ。デフォルトは Intranet です。パブリックアクセスには Internet、プライベートアクセスには Intranet を使用します。",
"AllowedValues": [
"Internet",
"Intranet"
],
"Default": "Intranet"
},
"ReleasedKeepPolicy": {
"Type": "String",
"Description": "インスタンスがリリースされた場合にアーカイブバックアップを保持するために使用されるポリシー。デフォルト値:なし。\n有効な値:\nLastest: 最後のアーカイブバックアップのみが保持されます。\nAll: すべてのアーカイブバックアップが保持されます。",
"AllowedValues": [
"Lastest",
"All"
]
},
"DedicatedHostGroupId": {
"Type": "String",
"Description": "ホストグループにインスタンスを作成する場合、インスタンスが属するホストグループの ID。"
},
"AutoRenew": {
"Type": "Boolean",
"Description": "プリペイドインスタンスを自動更新します。期間タイプが年単位の場合、年単位で更新され、それ以外の場合は月単位で更新されます。",
"AllowedValues": [
"True",
"true",
"False",
"false"
],
"Default": false
},
"EncryptionKey": {
"Type": "String",
"Description": "リージョン内の SSD 上のデータを暗号化するために使用される暗号鍵の ID。Key Management Service (KMS) コンソールで暗号鍵 ID を表示できます。暗号鍵を作成することもできます。"
},
"PreferredBackupPeriod": {
"Type": "CommaDelimitedList",
"Description": "バックアップ期間。複数の値はコンマ (,) で区切ります。デフォルト値は元の値です。有効な値:月曜日 火曜日 水曜日 木曜日 金曜日 土曜日 日曜日 注 BackupPolicyMode パラメータが DataBackupPolicy に設定されている場合、このパラメータは必須です。"
},
"LogBackupLocalRetentionNumber": {
```
"Type": "Number",
"Description": "インスタンスに保持できるログバックアップファイルの数。\nデフォルト値:60。有効な値:6 ~ 100。",
"MinValue": 6,
"MaxValue": 100
},
"SlaveZoneIds": {
"Type": "Json",
"Description": "High-Availability Edition または Enterprise Edition インスタンスを作成するときに、スレーブゾーン ID のリストでスレーブゾーン ID を指定できます。一方、VSwitchId は対応する vswitch ID を順番にスレーブゾーンに渡す必要があります。たとえば、ZoneId = \"zone-a\" および SlaveZoneIds = [\"zone-c\", \"zone-b\"] の場合、VSwitchId は \"vsw-zone-a,vsw-zone-c,vsw-zone-b\" である必要があります。もちろん、自動割り当ても選択できます。たとえば、ZoneId = \"zone-a\" および SlaveZoneIds = [\"Auto\", \"Auto\"] の場合、VSwitchId は \"vsw-zone-a,Auto,Auto\" である必要があります。リストには最大 2 つのスレーブゾーン ID が含まれており、コンマで区切られます。",
"MaxLength": 2
},
"DBIsIgnoreCase": {
"Type": "Number",
"Description": "テーブル名の大文字と小文字を区別するかどうかを指定します。有効な値:\n1: テーブル名の大文字と小文字は区別されません。これはデフォルト値です。\n0: テーブル名の大文字と小文字は区別されます。"
},
"CommodityCode": {
"Type": "String",
"Description": "注文の商品コード。",
"AllowedValues": [
"rds",
"bards",
"rords"
],
"Default": "rds"
},
"MaintainTime": {
"Type": "String",
"Description": "メンテナンスが実行される期間。形式は HH:mmZ-HH:mmZ です。"
},
"DBParamGroupId": {
"Type": "String",
"Description": "インスタンスで使用されるパラメータテンプレートの ID。"
},
"ZoneId": {
"Type": "String",
"Description": "データベースインスタンスを作成するために選択されたゾーン。MultiAZ パラメータが true に設定されている場合、ZoneId パラメータを設定することはできません。"
},
"TargetDedicatedHostIdForLog": {
"Type": "String",
"Description": "ホストグループにログインスタンスを作成する場合、インスタンスが属するホストの ID。"
},
"AllocatePublicConnection": {
"Type": "Boolean",
"Description": "true の場合、パブリック接続を自動的に割り当てます。",
"AllowedValues": [
"True",
"true",
"False",
"false"
]
},
"PreferredBackupTime": {
"Type": "String",
"Description": "バックアップタスクが実行される時刻。形式:yyyy-MM-ddZ-HH:mm:ssZ。注 BackupPolicyMode パラメータが DataBackupPolicy に設定されている場合、このパラメータは必須です。"
},
"SecurityGroupId": {
"Type": "String",
"Description": "ECS セキュリティグループの ID。\n各 RDS インスタンスは最大 3 つの ECS セキュリティグループに関連付けることができます。\nコンマ (,) で区切る必要があります。\nECS セキュリティグループを削除するには、このパラメータを空のままにします。\n"
},
"Quantity": {
"Type": "Number",
"Description": "作成されるインスタンスの数。デフォルトは 1、最大数は 99 です",
"MinValue": 1,
"MaxValue": 99,
"Default": 1
},
"AutoPay": {
"Type": "Boolean",
"Description": "自動支払い。デフォルトは false です。",
"AllowedValues": [
"True",
"true",
"False",
"false"
],
"Default": true
},
"DBInstanceStorageType": {
"Type": "String",
"Description": "インスタンスのストレージタイプ。有効な値:\nlocal_ssd: ローカル SSD を使用することを指定します。これは推奨されるストレージタイプです。\ncloud_ssd: 標準 SSD を使用することを指定します。\ncloud_essd: 拡張 SSD を使用することを指定します。"
},
"BackUpCategory": {
"Type": "String",
"Description": "2 レベルのバックアップ機能を有効にするかどうかを指定します。この機能により、バックアップを数秒以内に完了できます。有効な値:\nFlash: 2 レベルのバックアップ機能を有効にすることを指定します。\nStandard: 2 レベルのバックアップ機能を無効にすることを指定します。",
"AllowedValues": [
"Flash",
"Standard"
]
},
"CompressType": {
"Type": "Number",
"Description": "バックアップの圧縮に使用する形式。有効な値:\n 1: zlib ツールを使用してバックアップを .tar.gz ファイルに圧縮します。\n 4: QuickLZ ツールを使用してバックアップを .xb.gz ファイルに圧縮します。\nこの圧縮形式は、インスタンスが MySQL 5.6 または 5.7 を実行している場合にのみサポートされます。\n個々のデータベースとテーブルを復元するために使用できます。\n 8: QuickLZ ツールを使用してバックアップを .xb.gz ファイルに圧縮します。\nこの圧縮形式は、インスタンスが MySQL 8.0 を実行している場合にのみサポートされます。\n個々のデータベースまたはテーブルを復元するために使用することはできません。"
},
"LogBackupFrequency": {
"Type": "String",
"Description": "ログをバックアップする頻度。有効な値:\n値 LogInterval は 30 分ごとにログをバックアップすることを指定します。\nこのパラメータのデフォルト値はデータバックアップ頻度と同じです。\n注:値 LogInterval は、インスタンスが SQL Server を実行している場合にのみサポートされます。"
},
"ConnectionStringType": {
"Type": "String",
"Description": "インスタンスのエンドポイントタイプ。有効な値:Inner、Public",
"AllowedValues": [
"Inner",
"Public"
],
"Default": "Inner"
},
"CouponCode": {
"Type": "String",
"Description": "注文のクーポンコード。"
},
"MasterUserType": {
"Type": "String",
"Description": "アカウントの権限タイプ。\nNormal: 共通権限。\nSuper: 高い権限。\nSysadmin: スーパー権限 (SA) (SQL Server でのみサポート)\nデフォルト値は Normal です。",
"AllowedValues": [
"Normal",
"Super",
"Sysadmin"
],
"Default": "Normal"
},
"EnableBackupLog": {
"Type": "Boolean",
"Description": "ログバックアップ機能を有効にするかどうかを指定します。有効な値:\nTrue: ログバックアップ機能を有効にすることを指定します。\nFalse: ログバックアップ機能を無効にすることを指定します。\n注:BackupPolicyMode パラメータが LogBackupPolicy に設定されている場合、このパラメータは必須です。",
"AllowedValues": [
"True",
"true",
"False",
"false"
]
},
"SQLCollectorStatus": {
"Type": "String",
"Description": "SQL Explorer (SQL 監査) 機能を有効または無効にするかを指定します。\n有効な値:有効 | 無効。",
"AllowedValues": [
"Enable",
"Disabled"
]
},
"BackupRetentionPeriod": {
"Type": "Number",
"Description": "データバックアップの保持期間。値の範囲:7 ~ 730。デフォルト値は元の値です。注:BackupPolicyMode パラメータが LogBackupPolicy に設定されている場合、このパラメータは必須です。",
"Default": 7
}
},
"Resources": {
"PrepayDBInstance": {
"Type": "ALIYUN::RDS::PrepayDBInstance",
"Properties": {
"PeriodType": {
"Ref": "PeriodType"
},
"ResourceGroupId": {
"Ref": "ResourceGroupId"
},
"ArchiveBackupRetentionPeriod": {
"Ref": "ArchiveBackupRetentionPeriod"
},
"DBTimeZone": {
"Ref": "DBTimeZone"
},
"Port": {
"Ref": "Port"
},
"ArchiveBackupKeepCount": {
"Ref": "ArchiveBackupKeepCount"
},
"LogBackupRetentionPeriod": {
"Ref": "LogBackupRetentionPeriod"
},
"DBInstanceStorage": {
"Ref": "DBInstanceStorage"
},
"DBMappings": {
"Ref": "DBMappings"
},
"ConnectionStringPrefix": {
"Ref": "ConnectionStringPrefix"
},
"MultiAZ": {
"Ref": "MultiAZ"
},
"Engine": {
"Ref": "Engine"
},
"Tags": {
"Ref": "Tags"
},
"DBInstanceDescription": {
"Ref": "DBInstanceDescription"
},
"TargetDedicatedHostIdForMaster": {
"Ref": "TargetDedicatedHostIdForMaster"
},
"EngineVersion": {
"Ref": "EngineVersion"
},
"DBInstanceClass": {
"Ref": "DBInstanceClass"
},
"ArchiveBackupKeepPolicy": {
"Ref": "ArchiveBackupKeepPolicy"
},
"VSwitchId": {
"Ref": "VSwitchId"
},
"BackupPolicyMode": {
"Ref": "BackupPolicyMode"
},
"Period": {
"Ref": "Period"
},
"LocalLogRetentionHours": {
"Ref": "LocalLogRetentionHours"
},
"HighSpaceUsageProtection": {
"Ref": "HighSpaceUsageProtection"
},
"RoleARN": {
"Ref": "RoleARN"
},
"MasterUserPassword": {
"Ref": "MasterUserPassword"
},
"VpcId": {
"Ref": "VpcId"
},
"SSLSetting": {
"Ref": "SSLSetting"
},
"MasterUsername": {
"Ref": "MasterUsername"
},
"ConnectionMode": {
"Ref": "ConnectionMode"
},
"LocalLogRetentionSpace": {
"Ref": "LocalLogRetentionSpace"
},
"Category": {
"Ref": "Category"
},
"PrivateIpAddress": {
"Ref": "PrivateIpAddress"
},
"TargetDedicatedHostIdForSlave": {
"Ref": "TargetDedicatedHostIdForSlave"
},
"DBInstanceNetType": {
"Ref": "DBInstanceNetType"
},
"ReleasedKeepPolicy": {
"Ref": "ReleasedKeepPolicy"
},
"DedicatedHostGroupId": {
"Ref": "DedicatedHostGroupId"
},
"AutoRenew": {
"Ref": "AutoRenew"
},
"EncryptionKey": {
"Ref": "EncryptionKey"
},
"PreferredBackupPeriod": {
"Ref": "PreferredBackupPeriod"
},
"LogBackupLocalRetentionNumber": {
"Ref": "LogBackupLocalRetentionNumber"
},
"SlaveZoneIds": {
"Ref": "SlaveZoneIds"
},
"DBIsIgnoreCase": {
"Ref": "DBIsIgnoreCase"
},
"CommodityCode": {
"Ref": "CommodityCode"
},
"MaintainTime": {
"Ref": "MaintainTime"
},
"DBParamGroupId": {
"Ref": "DBParamGroupId"
},
"ZoneId": {
"Ref": "ZoneId"
},
"TargetDedicatedHostIdForLog": {
"Ref": "TargetDedicatedHostIdForLog"
},
"AllocatePublicConnection": {
"Ref": "AllocatePublicConnection"
},
"PreferredBackupTime": {
"Ref": "PreferredBackupTime"
},
"SecurityGroupId": {
"Ref": "SecurityGroupId"
},
"Quantity": {
"Ref": "Quantity"
},
"AutoPay": {
"Ref": "AutoPay"
},
"DBInstanceStorageType": {
"Ref": "DBInstanceStorageType"
},
"BackUpCategory": {
"Ref": "BackUpCategory"
},
"CompressType": {
"Ref": "CompressType"
},
"LogBackupFrequency": {
"Ref": "LogBackupFrequency"
},
"ConnectionStringType": {
"Ref": "ConnectionStringType"
},
"CouponCode": {
"Ref": "CouponCode"
},
"MasterUserType": {
"Ref": "MasterUserType"
},
"EnableBackupLog": {
"Ref": "EnableBackupLog"
},
"SQLCollectorStatus": {
"Ref": "SQLCollectorStatus"
},
"BackupRetentionPeriod": {
"Ref": "BackupRetentionPeriod"
}
}
}
},
"Outputs": {
"InnerConnectionString": {
"Description": "イントラネットによる DB インスタンス接続 URL。",
"Value": {
"Fn::GetAtt": [
"PrepayDBInstance",
"InnerConnectionString"
]
}
},
"DBInstanceId": {
"Description": "作成されたデータベースインスタンスのインスタンス ID。",
"Value": {
"Fn::GetAtt": [
"PrepayDBInstance",
"DBInstanceId"
]
}
},
"InnerIPAddress": {
"Description": "イントラネットの作成された DB インスタンスの IP アドレス。",
"Value": {
"Fn::GetAtt": [
"PrepayDBInstance",
"InnerIPAddress"
]
}
},
"PublicConnectionString": {
"Description": "インターネットによる DB インスタンス接続 URL。",
"Value": {
"Fn::GetAtt": [
"PrepayDBInstance",
"PublicConnectionString"
]
}
},
"PublicIPAddress": {
"Description": "インターネットの作成された DB インスタンスの IP アドレス。",
"Value": {
"Fn::GetAtt": [
"PrepayDBInstance",
"PublicIPAddress"
]
}
},
"OrderId": {
"Description": "作成されたインスタンスの注文 ID リスト。",
"Value": {
"Fn::GetAtt": [
"PrepayDBInstance",
"OrderId"
]
}
},
"PublicPort": {
"Description": "作成された DB インスタンスのインターネットポート。",
"Value": {
"Fn::GetAtt": [
"PrepayDBInstance",
"PublicPort"
]
}
},
"InnerPort": {
"Description": "作成された DB インスタンスのイントラネットポート。",
"Value": {
"Fn::GetAtt": [
"PrepayDBInstance",
"InnerPort"
]
}
}
}
}