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 GetClusterCredentials operation. Returns a database user name and temporary password with temporary authorization to log in to an Amazon Redshift database. The action returns the database user name prefixed with IAM: if AutoCreate is False or IAMA: if AutoCreate is True. You can optionally specify one or more database user groups that the user will join at log in. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more information, see Generating IAM Database User Credentials in the Amazon Redshift Cluster Management Guide.

The IAM user or role that executes GetClusterCredentials must have an IAM policy attached that allows the redshift:GetClusterCredentials action with access to the dbuser resource on the cluster. The user name specified for dbuser in the IAM policy and the user name specified for the DbUser parameter must match.

If the DbGroups parameter is specified, the IAM policy must allow the redshift:JoinGroup action with access to the listed dbgroups.

In addition, if the AutoCreate parameter is set to True, then the policy must include the redshift:CreateClusterUser privilege.

If the DbName parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.

Inheritance Hierarchy

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

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

Syntax

C#
public class GetClusterCredentialsRequest : AmazonRedshiftRequest
         IAmazonWebServiceRequest

The GetClusterCredentialsRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AutoCreate System.Boolean

Gets and sets the property AutoCreate.

Create a database user with the name specified for DbUser if one does not exist.

Public Property ClusterIdentifier System.String

Gets and sets the property ClusterIdentifier.

The unique identifier of the cluster that contains the database for which your are requesting credentials. This parameter is case sensitive.

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

Gets and sets the property DbGroups.

A list of the names of existing database groups that DbUser will join for the current session. If not specified, the new user is added only to PUBLIC.

Public Property DbName System.String

Gets and sets the property DbName.

The name of a database that DbUser is authorized to log on to. If DbName is not specified, DbUser can log in to any existing database.

Constraints:

  • Must be 1 to 64 alphanumeric characters or hyphens

  • Must contain only lowercase letters.

  • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Public Property DbUser System.String

Gets and sets the property DbUser.

The name of a database user. If a user name matching DbUser exists in the database, the temporary user credentials have the same permissions as the existing user. If DbUser doesn't exist in the database and Autocreate is True, a new user is created using the value for DbUser with PUBLIC permissions. If a database user matching the value for DbUser doesn't exist and Autocreate is False, then the command succeeds but the connection attempt will fail because the user doesn't exist in the database.

For more information, see CREATE USER in the Amazon Redshift Database Developer Guide.

Constraints:

  • Must be 1 to 128 alphanumeric characters or hyphens

  • Must contain only lowercase letters.

  • First character must be a letter.

  • Must not contain a colon ( : ) or slash ( / ).

  • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Public Property DurationSeconds System.Int32

Gets and sets the property DurationSeconds.

The number of seconds until the returned temporary password expires.

Constraint: minimum 900, maximum 3600.

Default: 900

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