[ aws . rds ]

describe-engine-default-parameters

Description

Returns the default engine and system parameter information for the specified database engine.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

describe-engine-default-parameters is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: EngineDefaults.Parameters

Synopsis

  describe-engine-default-parameters
--db-parameter-group-family <value>
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--db-parameter-group-family (string)

The name of the DB parameter group family.

Valid Values:

• aurora5.6

• aurora-mysql5.7

• aurora-mysql8.0

• aurora-postgresql10

• aurora-postgresql11

• aurora-postgresql12

• aurora-postgresql13

• mariadb10.2

• mariadb10.3

• mariadb10.4

• mariadb10.5

• mariadb10.6

• mysql5.7

• mysql8.0

• postgres10

• postgres11

• postgres12

• postgres13

• postgres14

• sqlserver-ee-11.0

• sqlserver-ee-12.0

• sqlserver-ee-13.0

• sqlserver-ee-14.0

• sqlserver-ee-15.0

• sqlserver-ex-11.0

• sqlserver-ex-12.0

• sqlserver-ex-13.0

• sqlserver-ex-14.0

• sqlserver-ex-15.0

• sqlserver-se-11.0

• sqlserver-se-12.0

• sqlserver-se-13.0

• sqlserver-se-14.0

• sqlserver-se-15.0

• sqlserver-web-11.0

• sqlserver-web-12.0

• sqlserver-web-13.0

• sqlserver-web-14.0

• sqlserver-web-15.0

--filters (list)

This parameter isn’t currently supported.

(structure)

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

Note

Currently, wildcards are not supported in filters.

The following actions can be filtered:

• DescribeDBClusterBacktracks

• DescribeDBClusterEndpoints

• DescribeDBClusters

• DescribeDBInstances

• DescribePendingMaintenanceActions

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", ...]
  }
  ...
]

--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.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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.

Examples

To describe the default engine and system parameter information for the database engine

The following describe-engine-default-parameters example retrieves details for the default engine and system parameter information for MySQL 5.7 DB instances.

aws rds describe-engine-default-parameters \
    --db-parameter-group-family mysql5.7

Output:

{
    "EngineDefaults": {
        "Parameters": [
            {
                "ParameterName": "allow-suspicious-udfs",
                "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded",
                "Source": "engine-default",
                "ApplyType": "static",
                "DataType": "boolean",
                "AllowedValues": "0,1",
                "IsModifiable": false
            },
            ...some output truncated...
        ]
    }
}

For more information, see Working with DB Parameter Groups in the Amazon RDS User Guide.

Output

EngineDefaults -> (structure)

Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

DBParameterGroupFamily -> (string)

Specifies the name of the DB parameter group family that the engine default parameters apply to.

Marker -> (string)

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

Parameters -> (list)

Contains a list of engine default parameters.

(structure)

This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

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.

SupportedEngineModes -> (list)

The valid DB engine modes.

(string)