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 DescribeClusterParameterGroups operation. Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.

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

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all parameter groups that have any combination of those values are returned.

If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.

Inheritance Hierarchy

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

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

Syntax

C#
public class DescribeClusterParameterGroupsRequest : AmazonRedshiftRequest
         IAmazonWebServiceRequest

The DescribeClusterParameterGroupsRequest 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 DescribeClusterParameterGroups 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 specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.

Public Property TagKeys System.Collections.Generic.List<System.String>

Gets and sets the property TagKeys.

A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.

Public Property TagValues System.Collections.Generic.List<System.String>

Gets and sets the property TagValues.

A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.

Examples

This example returns a description of all cluster parameter groups for the account, with column headers.

To get a description of cluster parameter groups


var response = client.DescribeClusterParameterGroups(new DescribeClusterParameterGroupsRequest 
{
    Marker = "",
    MaxRecords = 123,
    ParameterGroupName = "",
    TagKeys = new List {
                    
    },
    TagValues = new List {
                    
    }
});

List parameterGroups = response.ParameterGroups;

            

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