rds_describe_orderable_db_instance_options: Returns a list of orderable DB instance options for the specified engine

Description

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

Usage

rds_describe_orderable_db_instance_options(Engine, EngineVersion,
  DBInstanceClass, LicenseModel, AvailabilityZoneGroup, Vpc, Filters,
  MaxRecords, Marker)

Value

A list with the following syntax:

list(
  OrderableDBInstanceOptions = list(
    list(
      Engine = "string",
      EngineVersion = "string",
      DBInstanceClass = "string",
      LicenseModel = "string",
      AvailabilityZoneGroup = "string",
      AvailabilityZones = list(
        list(
          Name = "string"
        )
      ),
      MultiAZCapable = TRUE|FALSE,
      ReadReplicaCapable = TRUE|FALSE,
      Vpc = TRUE|FALSE,
      SupportsStorageEncryption = TRUE|FALSE,
      StorageType = "string",
      SupportsIops = TRUE|FALSE,
      SupportsEnhancedMonitoring = TRUE|FALSE,
      SupportsIAMDatabaseAuthentication = TRUE|FALSE,
      SupportsPerformanceInsights = TRUE|FALSE,
      MinStorageSize = 123,
      MaxStorageSize = 123,
      MinIopsPerDbInstance = 123,
      MaxIopsPerDbInstance = 123,
      MinIopsPerGib = 123.0,
      MaxIopsPerGib = 123.0,
      AvailableProcessorFeatures = list(
        list(
          Name = "string",
          DefaultValue = "string",
          AllowedValues = "string"
        )
      ),
      SupportedEngineModes = list(
        "string"
      ),
      SupportsStorageAutoscaling = TRUE|FALSE,
      SupportsKerberosAuthentication = TRUE|FALSE,
      OutpostCapable = TRUE|FALSE,
      SupportsGlobalDatabases = TRUE|FALSE
    )
  ),
  Marker = "string"
)

Arguments

Engine

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

EngineVersion

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

DBInstanceClass

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

LicenseModel

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

AvailabilityZoneGroup

The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.

Omit this parameter to show the available offerings in the specified AWS Region.

Vpc

A value that indicates whether to show only VPC or non-VPC offerings.

Filters

This parameter isn't 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 called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Marker

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

Request syntax

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