Describe Default Cluster Parameters

redshift_describe_default_cluster_parameters

R Documentation

Returns a list of parameter settings for the specified parameter group family¶

Description¶

Returns a list of parameter settings for the specified parameter group family.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Usage¶

redshift_describe_default_cluster_parameters(ParameterGroupFamily,
  MaxRecords, Marker)

Arguments¶

ParameterGroupFamily

[required] The name of the cluster parameter group family.

MaxRecords

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

Marker

An optional parameter that specifies the starting point to return a set of response records. When the results of a describe_default_cluster_parameters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Value¶

A list with the following syntax:

list(
  DefaultClusterParameters = list(
    ParameterGroupFamily = "string",
    Marker = "string",
    Parameters = list(
      list(
        ParameterName = "string",
        ParameterValue = "string",
        Description = "string",
        Source = "string",
        DataType = "string",
        AllowedValues = "string",
        ApplyType = "static"|"dynamic",
        IsModifiable = TRUE|FALSE,
        MinimumEngineVersion = "string"
      )
    )
  )
)

Request syntax¶

svc$describe_default_cluster_parameters(
  ParameterGroupFamily = "string",
  MaxRecords = 123,
  Marker = "string"
)