Describe Option Group Options
rds_describe_option_group_options | R Documentation |
Describes all available options for the specified engine¶
Description¶
Describes all available options for the specified engine.
Usage¶
rds_describe_option_group_options(EngineName, MajorEngineVersion,
Filters, MaxRecords, Marker)
Arguments¶
EngineName |
[required] The name of the engine to describe options for. Valid Values:
|
MajorEngineVersion |
If specified, filters the results to include only options for the specified major engine version. |
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 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
|
Value¶
A list with the following syntax:
list(
OptionGroupOptions = list(
list(
Name = "string",
Description = "string",
EngineName = "string",
MajorEngineVersion = "string",
MinimumRequiredMinorEngineVersion = "string",
PortRequired = TRUE|FALSE,
DefaultPort = 123,
OptionsDependedOn = list(
"string"
),
OptionsConflictsWith = list(
"string"
),
Persistent = TRUE|FALSE,
Permanent = TRUE|FALSE,
RequiresAutoMinorEngineVersionUpgrade = TRUE|FALSE,
VpcOnly = TRUE|FALSE,
SupportsOptionVersionDowngrade = TRUE|FALSE,
OptionGroupOptionSettings = list(
list(
SettingName = "string",
SettingDescription = "string",
DefaultValue = "string",
ApplyType = "string",
AllowedValues = "string",
IsModifiable = TRUE|FALSE,
IsRequired = TRUE|FALSE,
MinimumEngineVersionPerAllowedValue = list(
list(
AllowedValue = "string",
MinimumEngineVersion = "string"
)
)
)
),
OptionGroupOptionVersions = list(
list(
Version = "string",
IsDefault = TRUE|FALSE
)
),
CopyableCrossAccount = TRUE|FALSE
)
),
Marker = "string"
)
Request syntax¶
svc$describe_option_group_options(
EngineName = "string",
MajorEngineVersion = "string",
Filters = list(
list(
Name = "string",
Values = list(
"string"
)
)
),
MaxRecords = 123,
Marker = "string"
)
Examples¶
## Not run:
# This example lists information for all option group options for the
# specified DB engine.
svc$describe_option_group_options(
EngineName = "mysql",
MajorEngineVersion = "5.6"
)
## End(Not run)