ALIYUN::MONGODB::ServerlessInstance - - Alibaba Cloud ドキュメントセンター

ALIYUN::MONGODB::ServerlessInstance は、ApsaraDB for MongoDB (Serverless) インスタンスを作成するために使用されます。

構文

{
  "Type": "ALIYUN::MONGODB::ServerlessInstance",
  "Properties": {
    "EngineVersion": String,
    "ZoneId": String,
    "ResourceGroupId": String,
    "AutoRenew": Boolean,
    "VSwitchId": String,
    "PeriodPriceType": String,
    "Period": Integer,
    "SecurityIPArray": String,
    "StorageEngine": String,
    "AccountPassword": String,
    "VpcId": String,
    "ChargeType": String,
    "NetworkType": String,
    "DBInstanceStorage": Integer,
    "DBInstanceDescription": String,
    "TDEStatus": Boolean
    "Tags": List
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
EngineVersion	String	いいえ	いいえ	インスタンスのエンジンバージョン。	値を 4.2 に設定します。
ZoneId	String	いいえ	いいえ	ゾーンの ID。	なし
ResourceGroupId	String	いいえ	はい	リソースグループの ID。	なし
AutoRenew	Boolean	いいえ	いいえ	インスタンスの自動更新を有効にするかどうかを指定します。	デフォルト値: false。有効な値: true: インスタンスの自動更新を有効にします。 false: インスタンスの自動更新を有効にしません。
VSwitchId	String	いいえ	いいえ	vSwitch の ID。	なし
PeriodPriceType	String	いいえ	いいえ	請求サイクルの単位。	有効な値: Day Month
Period	Integer	いいえ	いいえ	インスタンスのサブスクリプション期間。	PeriodPriceType を Day に設定した場合の有効な値: 1、7、および 14。 PeriodPriceType を Month に設定した場合の有効な値: 1、2、3、4、5、6、7、8、9、12、24、36、および 60。単位: 月。
SecurityIPArray	String	いいえ	いいえ	インスタンスのホワイトリスト内の IP アドレス。	複数の IP アドレスをコンマ (,) で区切ります。各 IP アドレスはホワイトリスト内で一意である必要があります。ホワイトリストには最大 1,000 個の IP アドレスを含めることができます。 10.23.XX.XX などの IP アドレスと、10.23.XX.XX/24 などの CIDR ブロックを入力できます。/24 は、CIDR ブロックのプレフィックスの長さが 24 ビットであることを示します。24 は、1 から 32 までの値に置き換えることができます。パーセント記号 (%) または 0.0.0.0/0 を入力することもできます。説明パーセント記号 (%) または 0.0.0.0/0 を入力すると、すべての IP アドレスがインスタンスにアクセスできます。これにより、インスタンスにセキュリティリスクが生じる可能性があります。注意して進めてください。
StorageEngine	String	いいえ	いいえ	インスタンスで使用されるストレージエンジン。	値を WiredTiger に設定します。ストレージエンジンと MongoDB バージョンについての詳細は、MongoDB のバージョンとストレージエンジンをご参照ください。
AccountPassword	String	いいえ	はい	データベースへの接続に使用されるパスワード。	パスワードは 8 ～ 32 文字の長さでなければなりません。パスワードには、大文字、小文字、数字、特殊文字のうち少なくとも 3 種類の文字が含まれている必要があります。特殊文字には、`! # $ % ^ \ & * ( ) _ + - =` が含まれます。説明 ApsaraDB for MongoDB (Serverless) インスタンスは、デフォルトのデータベースログオンアカウントを提供します。アカウントを変更することはできませんが、アカウントのパスワードを変更することはできます。
VpcId	String	いいえ	いいえ	仮想プライベートクラウド (VPC) の ID。	なし
ChargeType	String	いいえ	いいえ	インスタンスの課金方式。	値を PrePaid に設定します。
NetworkType	String	いいえ	いいえ	インスタンスのネットワークタイプ。ApsaraDB for MongoDB (Serverless) インスタンスのネットワークタイプは VPC でなければなりません。	値を VPC に設定します。
DBInstanceStorage	Integer	はい	いいえ	インスタンスのストレージ容量。	有効な値: 1 ～ 10。単位: GB。
DBInstanceDescription	String	いいえ	いいえ	インスタンスの説明。	説明は 2 ～ 256 文字の長さで、文字、数字、アンダースコア (_)、ハイフン (-) を使用できます。説明は文字で始める必要があります。
TDEStatus	Boolean	いいえ	はい	透過的データ暗号化 (TDE) を有効にするかどうかを指定します。	デフォルト値: false。有効な値: true: TDE を有効にします。説明 TDE を有効にした後、無効にすることはできません。 false: TDE を有効にしません。
Tags	List	いいえ	はい	インスタンスのタグ。	最大 20 個のタグを追加できます。詳細については、タグのプロパティをご参照ください。

タグの構文

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

タグのプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Key	String	はい	いいえ	タグキー。	タグキーは 1 ～ 128 文字の長さで、`http://` または `https://` を含めることはできません。タグキーは `acs:` または `aliyun` で始めることはできません。
Value	String	いいえ	いいえ	タグ値。	タグ値は 0 ～ 128 文字の長さで、`http://` または `https://` を含めることはできません。タグ値は `acs:` または `aliyun` で始めることはできません。

戻り値

Fn::GetAtt

DBInstanceStatus: インスタンスのステータス。
DBInstanceId: インスタンスの ID。
ConnectionURI: インスタンスの接続文字列。
OrderId: 注文の ID。

例

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "TDEStatus": {
      "Type": "Boolean",
      "Description": "透過的データ暗号化 (TDE) を有効にするかどうかを指定します。有効な値:\ntrue: TDE を有効にする\nfalse: TDE を無効にする (デフォルト)\n注: TDE を有効にした後、無効にすることはできません。", // 翻訳済み
      "AllowedValues": [
        "True",
        "true",
        "False",
        "false"
      ]
    },
    "EngineVersion": {
      "Type": "String",
      "Description": "データベースインスタンスのバージョン。 4.2 をサポート", // 翻訳済み
      "Default": "4.2"
    },
    "ZoneId": {
      "Type": "String",
      "Description": "インスタンスを作成するゾーン。 VpcId と VSwitchId が指定されている場合、ZoneId は必須であり、VSwitch は同じゾーンにある必要があります。" // 翻訳済み

    },
    "ResourceGroupId": {
      "Type": "String",
      "Description": "リソースグループの ID。" // 翻訳済み
    },
    "VSwitchId": {
      "Type": "String",
      "Description": "MongoDB インスタンスを作成する vSwitch ID。" // 翻訳済み
    },
    "AutoRenew": {
      "Type": "Boolean",
      "Description": "インスタンスの自動更新が有効になっているかどうかを示します。有効な値:true: 自動更新が有効になっています。false: 自動更新が有効になっていません。インスタンスを手動で更新する必要があります。デフォルト値: false。", // 翻訳済み
      "AllowedValues": [
        "True",
        "true",
        "False",
        "false"
      ]
    },
    "Period": {
      "Type": "Number",
      "Description": "インスタンスのサブスクリプション期間。デフォルト単位: 月。有効な値: [1~9]、12、24、36。デフォルトは 1。", // 翻訳済み
      "AllowedValues": [
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        12,
        24,
        36
      ],
      "Default": 1
    },
    "SecurityIPArray": {
      "Type": "String",
      "Description": "追加または削除するセキュリティ IP。" // 翻訳済み
    },
    "StorageEngine": {
      "Type": "String",
      "Description": "データベースストレージエンジン。 WiredTiger をサポート", // 翻訳済み
      "AllowedValues": [
        "WiredTiger"
      ],
      "Default": "WiredTiger"
    },
    "AccountPassword": {
      "Type": "String",
      "Description": "ルートアカウントのパスワード。文字、数字、またはアンダースコアで構成され、長さは 6 ～ 32 ビットです。" // 翻訳済み
    },
    "VpcId": {
      "Type": "String",
      "Description": "MongoDB インスタンスを作成する VPC ID。" // 翻訳済み
    },
    "ChargeType": {
      "Type": "String",
      "Description": "インスタンスの課金方式。値:PostPaid:従量課金制。PrePaid: サブスクリプション。デフォルト値: PostPaid", // 翻訳済み
      "AllowedValues": [
        "Subscription",
        "PrePaid",
        "PrePay",
        "Prepaid",
        "PayAsYouGo",
        "PostPaid",
        "PayOnDemand",
        "Postpaid"
      ],
      "Default": "PostPaid"
    },
    "NetworkType": {
      "Type": "String",
      "Description": "インスタンスネットワークタイプ。 'CLASSIC' と 'VPC' のみをサポートし、デフォルトは 'CLASSIC' です。", // 翻訳済み
      "AllowedValues": [
        "CLASSIC",
        "VPC"
      ]
    },
    "DBInstanceStorage": {
      "Type": "Number",
      "Description": "データベースインスタンスのストレージサイズ。 MongoDB は [1,10] で、1 GB ごとに増加します。単位は GB です。" // 翻訳済み
    },
    "PeriodPriceType": {
      "Type": "String",
      "Description": "作成されたインスタンスの課金期間。", // 翻訳済み
      "AllowedValues": [
        "Day",
        "Month"
      ]
    },
    "DBInstanceDescription": {
      "Type": "String",
      "Description": "作成されたデータベースインスタンスの説明。", // 翻訳済み
    },
    "Tags": {
      "Type": "Json",
      "Description": "インスタンスに添付するタグ。インスタンスの作成中に最大 20 個のタグをサポートします。各タグには Key と Value の 2 つのプロパティがあり、Key は必須です。", // 翻訳済み
      "MaxLength": 20
    }
  },
  "Resources": {
    "MongoDbServerlessInstance": {
      "Type": "ALIYUN::MONGODB::ServerlessInstance",
      "Properties": {
        "TDEStatus": {
          "Ref": "TDEStatus"
        },
        "EngineVersion": {
          "Ref": "EngineVersion"
        },
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "ResourceGroupId": {
          "Ref": "ResourceGroupId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "AutoRenew": {
          "Ref": "AutoRenew"
        },
        "Period": {
          "Ref": "Period"
        },
        "SecurityIPArray": {
          "Ref": "SecurityIPArray"
        },
        "StorageEngine": {
          "Ref": "StorageEngine"
        },
        "AccountPassword": {
          "Ref": "AccountPassword"
        },
        "VpcId": {
          "Ref": "VpcId"
        },
        "ChargeType": {
          "Ref": "ChargeType"
        },
        "NetworkType": {
          "Ref": "NetworkType"
        },
        "DBInstanceStorage": {
          "Ref": "DBInstanceStorage"
        },
        "PeriodPriceType": {
          "Ref": "PeriodPriceType"
        },
        "DBInstanceDescription": {
          "Ref": "DBInstanceDescription"
        },
        "Tags": {
          "Ref": "Tags"
        }
      }
    }
  },
  "Outputs": {
    "DBInstanceStatus": {
      "Description": "MongoDB インスタンスのステータス。", // 翻訳済み
      "Value": {
        "Fn::GetAtt": [
          "MongoDbServerlessInstance",
          "DBInstanceStatus"
        ]
      }
    },
    "DBInstanceId": {
      "Description": "作成された MongoDB インスタンスのインスタンス ID。", // 翻訳済み
      "Value": {
        "Fn::GetAtt": [
          "MongoDbServerlessInstance",
          "DBInstanceId"
        ]
      }
    },
    "ConnectionURI": {
      "Description": "接続 URI。", // 翻訳済み
      "Value": {
        "Fn::GetAtt": [
          "MongoDbServerlessInstance",
          "ConnectionURI"
        ]
      }
    },
    "OrderId": {
      "Description": "作成されたインスタンスの注文 ID。", // 翻訳済み
      "Value": {
        "Fn::GetAtt": [
          "MongoDbServerlessInstance",
          "OrderId"
        ]
      }
    }
  }
}

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AccountPassword:
    Description: ルートアカウントのパスワード。文字、数字、またはアンダースコアで構成され、長さは 6 ～ 32 ビットです。
    Type: String
  AutoRenew:
    AllowedValues:
    - 'True'
    - 'true'
    - 'False'
    - 'false'
    Description: 'インスタンスの自動更新が有効になっているかどうかを示します。有効な値:true: 自動更新が有効になっています。false: 自動更新が有効になっていません。インスタンスを手動で更新する必要があります。デフォルト値: false。'
    Type: Boolean
  ChargeType:
    AllowedValues:
    - Subscription
    - PrePaid
    - PrePay
    - Prepaid
    - PayAsYouGo
    - PostPaid
    - PayOnDemand
    - Postpaid
    Default: PostPaid
    Description: 'インスタンスの課金方式。値:PostPaid:従量課金制。PrePaid: サブスクリプション。デフォルト値: PostPaid'
    Type: String
  DBInstanceDescription:
    Description: 作成されたデータベースインスタンスの説明。
    Type: String
  DBInstanceStorage:
    Description: データベースインスタンスのストレージサイズ。 MongoDB は [1,10] で、1 GB ごとに増加します。単位は GB です。
    Type: Number
  EngineVersion:
    Default: '4.2'
    Description: データベースインスタンスのバージョン。 4.2 をサポート
    Type: String
  NetworkType:
    AllowedValues:
    - CLASSIC
    - VPC
    Description: インスタンスネットワークタイプ。 'CLASSIC' と 'VPC' のみをサポートし、デフォルトは 'CLASSIC' です。
    Type: String
  Period:
    AllowedValues:
    - 1
    - 2
    - 3
    - 4
    - 5
    - 6
    - 7
    - 8
    - 9
    - 12
    - 24
    - 36
    Default: 1
    Description: 'インスタンスのサブスクリプション期間。デフォルト単位: 月。有効な値: [1~9]、12、24、36。デフォルトは 1。'
    Type: Number
  PeriodPriceType:
    AllowedValues:
    - Day
    - Month
    Description: 作成されたインスタンスの課金期間。
    Type: String
  ResourceGroupId:
    Description: リソースグループの ID。
    Type: String
  SecurityIPArray:
    Description: 追加または削除するセキュリティ IP。
    Type: String
  StorageEngine:
    AllowedValues:
    - WiredTiger
    Default: WiredTiger
    Description: データベースストレージエンジン。 WiredTiger をサポート
    Type: String
  TDEStatus:
    AllowedValues:
    - 'True'
    - 'true'
    - 'False'
    - 'false'
    Description: '透過的データ暗号化 (TDE) を有効にするかどうかを指定します。有効な値:

      true: TDE を有効にする

      false: TDE を無効にする (デフォルト)

      注: TDE を有効にした後、無効にすることはできません。'
    Type: Boolean
  Tags:
    Description: インスタンスに添付するタグ。インスタンスの作成中に最大 20 個のタグをサポートします。各タグには Key と Value の 2 つのプロパティがあり、Key は必須です。
    MaxLength: 20
    Type: Json
  VSwitchId:
    Description: MongoDB インスタンスを作成する vSwitch ID。
    Type: String
  VpcId:
    Description: MongoDB インスタンスを作成する VPC ID。
    Type: String
  ZoneId:
    Description: インスタンスを作成するゾーン。 VpcId と VSwitchId が指定されている場合、ZoneId は必須であり、VSwitch は同じゾーンにある必要があります。
    Type: String
Resources:
  MongoDbServerlessInstance:
    Properties:
      AccountPassword:
        Ref: AccountPassword
      AutoRenew:
        Ref: AutoRenew
      ChargeType:
        Ref: ChargeType
      DBInstanceDescription:
        Ref: DBInstanceDescription
      DBInstanceStorage:
        Ref: DBInstanceStorage
      EngineVersion:
        Ref: EngineVersion
      NetworkType:
        Ref: NetworkType
      Period:
        Ref: Period
      PeriodPriceType:
        Ref: PeriodPriceType
      ResourceGroupId:
        Ref: ResourceGroupId
      SecurityIPArray:
        Ref: SecurityIPArray
      StorageEngine:
        Ref: StorageEngine
      TDEStatus:
        Ref: TDEStatus
      Tags:
        Ref: Tags
      VSwitchId:
        Ref: VSwitchId
      VpcId:
        Ref: VpcId
      ZoneId:
        Ref: ZoneId
    Type: ALIYUN::MONGODB::ServerlessInstance
Outputs:
  ConnectionURI:
    Description: 接続 URI。
    Value:
      Fn::GetAtt:
      - MongoDbServerlessInstance
      - ConnectionURI
  DBInstanceId:
    Description: 作成された MongoDB インスタンスのインスタンス ID。
    Value:
      Fn::GetAtt:
      - MongoDbServerlessInstance
      - DBInstanceId
  DBInstanceStatus:
    Description: MongoDB インスタンスのステータス。
    Value:
      Fn::GetAtt:
      - MongoDbServerlessInstance
      - DBInstanceStatus
  OrderId:
    Description: 作成されたインスタンスの注文 ID。
    Value:
      Fn::GetAtt:
      - MongoDbServerlessInstance
      - OrderId

その他の例については、ServerlessInstance.json および ServerlessInstance.yml をご覧ください。