Skip to content

Describe Orderable Db Instance Options

rds_describe_orderable_db_instance_options R Documentation

Describes the orderable DB instance options for a specified DB engine

Description

Describes the orderable DB instance options for a specified DB engine.

Usage

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

Arguments

Engine

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

Valid Values:

  • aurora-mysql

  • aurora-postgresql

  • custom-oracle-ee

  • custom-oracle-ee-cdb

  • custom-oracle-se2

  • custom-oracle-se2-cdb

  • db2-ae

  • db2-se

  • mariadb

  • mysql

  • oracle-ee

  • oracle-ee-cdb

  • oracle-se2

  • oracle-se2-cdb

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

EngineVersion

A filter to include only the available options for the specified engine version.

DBInstanceClass

A filter to include only the available options for the specified DB instance class.

LicenseModel

A filter to include only the available options for the specified license model.

RDS Custom supports only the BYOL licensing model.

AvailabilityZoneGroup

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

Omit this parameter to show the available options in the specified Amazon Web Services Region.

This setting doesn't apply to RDS Custom DB instances.

Vpc

Specifies whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings.

RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows 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 1000.

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.

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,
      SupportedActivityStreamModes = list(
        "string"
      ),
      SupportsGlobalDatabases = TRUE|FALSE,
      SupportsClusters = TRUE|FALSE,
      SupportedNetworkTypes = list(
        "string"
      ),
      SupportsStorageThroughput = TRUE|FALSE,
      MinStorageThroughputPerDbInstance = 123,
      MaxStorageThroughputPerDbInstance = 123,
      MinStorageThroughputPerIops = 123.0,
      MaxStorageThroughputPerIops = 123.0,
      SupportsDedicatedLogVolume = TRUE|FALSE
    )
  ),
  Marker = "string"
)

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"
)