Describes the available option groups¶

Description¶

Describes the available option groups.

Usage¶

rds_describe_option_groups(OptionGroupName, Filters, Marker, MaxRecords,
  EngineName, MajorEngineVersion)

Arguments¶

OptionGroupName

The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.
Filters

This parameter isn't currently supported.
Marker

An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
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.
EngineName

A filter to only include option groups associated with this database engine.

Valid Values:
- db2-ae
- db2-ce
- db2-se
- mariadb
- mysql
- oracle-ee
- oracle-ee-cdb
- oracle-se2
- oracle-se2-cdb
- postgres
- sqlserver-ee
- sqlserver-se
- sqlserver-ex
- sqlserver-web
MajorEngineVersion

Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

Value¶

A list with the following syntax:

list(
  OptionGroupsList = list(
    list(
      OptionGroupName = "string",
      OptionGroupDescription = "string",
      EngineName = "string",
      MajorEngineVersion = "string",
      Options = list(
        list(
          OptionName = "string",
          OptionDescription = "string",
          Persistent = TRUE|FALSE,
          Permanent = TRUE|FALSE,
          Port = 123,
          OptionVersion = "string",
          OptionSettings = list(
            list(
              Name = "string",
              Value = "string",
              DefaultValue = "string",
              Description = "string",
              ApplyType = "string",
              DataType = "string",
              AllowedValues = "string",
              IsModifiable = TRUE|FALSE,
              IsCollection = TRUE|FALSE
            )
          ),
          DBSecurityGroupMemberships = list(
            list(
              DBSecurityGroupName = "string",
              Status = "string"
            )
          ),
          VpcSecurityGroupMemberships = list(
            list(
              VpcSecurityGroupId = "string",
              Status = "string"
            )
          )
        )
      ),
      AllowsVpcAndNonVpcInstanceMemberships = TRUE|FALSE,
      VpcId = "string",
      OptionGroupArn = "string",
      SourceOptionGroup = "string",
      SourceAccountId = "string",
      CopyTimestamp = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  Marker = "string"
)

Request syntax¶

svc$describe_option_groups(
  OptionGroupName = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  Marker = "string",
  MaxRecords = 123,
  EngineName = "string",
  MajorEngineVersion = "string"
)

Examples¶

# This example lists information for all option groups for the specified
# DB engine.
svc$describe_option_groups(
  EngineName = "mysql",
  MajorEngineVersion = "5.6"
)