Skip to content
AWS for Query.Farm

aws.docdb.describe_engine_default_cluster_parameters

Example SQL Queries

SELECT * FROM
aws.docdb.describe_engine_default_cluster_parameters
WHERE
"db_parameter_group_family" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
db_parameter_group_family Required Input Column

The name of the cluster parameter group family to return the engine parameter information for.

VARCHAR
filters Input Column

This parameter is not currently supported.

STRUCT(
    "name" VARCHAR,
    "values" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].name

The name of the filter. Filter names are case sensitive.

filters[].values[]
marker Input Column

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.

VARCHAR
max_records Input Column

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.

BIGINT
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
engine_defaults

Contains the result of a successful invocation of the DescribeEngineDefaultClusterParameters operation. 

STRUCT(
    "db_parameter_group_family" VARCHAR,
    "marker" VARCHAR,
    "parameters" STRUCT(
        "parameter_name" VARCHAR,
        "parameter_value" VARCHAR,
        "description" VARCHAR,
        "source" VARCHAR,
        "apply_type" VARCHAR,
        "data_type" VARCHAR,
        "allowed_values" VARCHAR,
        "is_modifiable" BOOLEAN,
        "minimum_engine_version" VARCHAR,
        "apply_method" VARCHAR
    )[]
)
Show child fields
engine_defaults.db_parameter_group_family

The name of the cluster parameter group family to return the engine parameter information for.

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

engine_defaults.parameters[]
Show child fields
engine_defaults.parameters[].allowed_values

Specifies the valid range of values for the parameter.

engine_defaults.parameters[].apply_method

Indicates when to apply parameter updates.

engine_defaults.parameters[].apply_type

Specifies the engine-specific parameters type.

engine_defaults.parameters[].data_type

Specifies the valid data type for the parameter.

engine_defaults.parameters[].description

Provides a description of the parameter.

engine_defaults.parameters[].is_modifiable

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

engine_defaults.parameters[].minimum_engine_version

The earliest engine version to which the parameter can apply.

engine_defaults.parameters[].parameter_name

Specifies the name of the parameter.

engine_defaults.parameters[].parameter_value

Specifies the value of the parameter.

engine_defaults.parameters[].source

Indicates the source of the parameter value.