Returns the default engine and system parameter information for the cluster database engine.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
describe-engine-default-cluster-parameters
--db-parameter-group-family <value>
[--filters <value>]
[--max-records <value>]
[--marker <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--db-parameter-group-family
(string)
The name of the cluster parameter group family to return the engine parameter information for.
--filters
(list)
This parameter is not currently supported.
(structure)
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
Name -> (string)
The name of the filter. Filter names are case sensitive.
Values -> (list)
One or more filter values. Filter values are case sensitive.
(string)
Shorthand Syntax:
Name=string,Values=string,string ...
JSON Syntax:
[
{
"Name": "string",
"Values": ["string", ...]
}
...
]
--max-records
(integer)
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
(string)
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
.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To describe the default engine and system parameter information for Amazon DocumentDB
The following describe-engine-default-cluster-parameters
example displays details for the default engine and system parameter information for the Amazon DocumentDB parameter group docdb3.6
.
aws docdb describe-engine-default-cluster-parameters \
--db-parameter-group-family docdb3.6
Output:
{
"EngineDefaults": {
"DBParameterGroupFamily": "docdb3.6",
"Parameters": [
{
"ApplyType": "dynamic",
"ParameterValue": "disabled",
"Description": "Enables auditing on cluster.",
"Source": "system",
"DataType": "string",
"MinimumEngineVersion": "3.6.0",
"AllowedValues": "enabled,disabled",
"ParameterName": "audit_logs",
"IsModifiable": true
},
{
"ApplyType": "static",
"ParameterValue": "enabled",
"Description": "Config to enable/disable TLS",
"Source": "system",
"DataType": "string",
"MinimumEngineVersion": "3.6.0",
"AllowedValues": "disabled,enabled",
"ParameterName": "tls",
"IsModifiable": true
},
{
"ApplyType": "dynamic",
"ParameterValue": "enabled",
"Description": "Enables TTL Monitoring",
"Source": "system",
"DataType": "string",
"MinimumEngineVersion": "3.6.0",
"AllowedValues": "disabled,enabled",
"ParameterName": "ttl_monitor",
"IsModifiable": true
}
]
}
}
For more information, see DescribeEngineDefaultClusterParameters in the Amazon DocumentDB Developer Guide.
EngineDefaults -> (structure)
Contains the result of a successful invocation of the
DescribeEngineDefaultClusterParameters
operation.DBParameterGroupFamily -> (string)
The name of the cluster parameter group family to return the engine parameter information for.
Marker -> (string)
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
.Parameters -> (list)
The parameters of a particular cluster parameter group family.
(structure)
Detailed information about an individual parameter.
ParameterName -> (string)
Specifies the name of the parameter.
ParameterValue -> (string)
Specifies the value of the parameter.
Description -> (string)
Provides a description of the parameter.
Source -> (string)
Indicates the source of the parameter value.
ApplyType -> (string)
Specifies the engine-specific parameters type.
DataType -> (string)
Specifies the valid data type for the parameter.
AllowedValues -> (string)
Specifies the valid range of values for the parameter.
IsModifiable -> (boolean)
Indicates whether (
true
) or not (false
) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.MinimumEngineVersion -> (string)
The earliest engine version to which the parameter can apply.
ApplyMethod -> (string)
Indicates when to apply parameter updates.