Skip to content

Returns a list of orderable instance options for the specified engine

Description

Returns a list of orderable instance options for the specified engine.

Usage

docdb_describe_orderable_db_instance_options(Engine, EngineVersion,
  DBInstanceClass, LicenseModel, Vpc, Filters, MaxRecords, Marker)

Arguments

  • Engine

    [required] The name of the engine to retrieve instance options for.

  • EngineVersion

    The engine version filter value. Specify this parameter to show only the available offerings that match the specified engine version.

  • DBInstanceClass

    The instance class filter value. Specify this parameter to show only the available offerings that match the specified instance class.

  • LicenseModel

    The license model filter value. Specify this parameter to show only the available offerings that match the specified license model.

  • Vpc

    The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

  • Filters

    This parameter is not currently supported.

  • MaxRecords

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: Minimum 20, maximum 100.

  • Marker

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Value

A list with the following syntax:

list(
  OrderableDBInstanceOptions = list(
    list(
      Engine = "string",
      EngineVersion = "string",
      DBInstanceClass = "string",
      LicenseModel = "string",
      AvailabilityZones = list(
        list(
          Name = "string"
        )
      ),
      Vpc = TRUE|FALSE,
      StorageType = "string"
    )
  ),
  Marker = "string"
)

Request syntax

svc$describe_orderable_db_instance_options(
  Engine = "string",
  EngineVersion = "string",
  DBInstanceClass = "string",
  LicenseModel = "string",
  Vpc = TRUE|FALSE,
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxRecords = 123,
  Marker = "string"
)