AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the DescribeClusterParameters operation. Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.

You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user.

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Redshift.AmazonRedshiftRequest
      Amazon.Redshift.Model.DescribeClusterParametersRequest

Namespace: Amazon.Redshift.Model
Assembly: AWSSDK.Redshift.dll
Version: 3.x.y.z

Syntax

C#
public class DescribeClusterParametersRequest : AmazonRedshiftRequest
         IAmazonWebServiceRequest

The DescribeClusterParametersRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property Marker System.String

Gets and sets the property Marker.

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, AWS 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.

Public Property MaxRecords System.Int32

Gets and sets the property 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.

Public Property ParameterGroupName System.String

Gets and sets the property ParameterGroupName.

The name of a cluster parameter group for which to return details.

Public Property Source System.String

Gets and sets the property Source.

The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.

Default: All parameter types returned.

Valid Values: user | engine-default

Examples

This example retrieves the parameters for the named parameter group.

To get the parameters for a parameter group


var response = client.DescribeClusterParameters(new DescribeClusterParametersRequest 
{
    ParameterGroupName = "myclusterparametergroup"
});

List parameters = response.Parameters;

            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms