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.
Returns a database user name and temporary password with temporary authorization to
log on 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 on. 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 Using
IAM Authentication to Generate Database User Credentials in the Amazon Redshift
Cluster Management Guide.
The Identity and Access Management (IAM) user or role that runs GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide.
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
permission.
If the DbName
parameter is specified, the IAM policy must allow access to the
resource dbname
for the specified database name.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginGetClusterCredentials and EndGetClusterCredentials.
Namespace: Amazon.Redshift
Assembly: AWSSDK.Redshift.dll
Version: 3.x.y.z
public virtual Task<GetClusterCredentialsResponse> GetClusterCredentialsAsync( GetClusterCredentialsRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the GetClusterCredentials service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Exception | Condition |
---|---|
ClusterNotFoundException | The ClusterIdentifier parameter does not refer to an existing cluster. |
UnsupportedOperationException | The requested operation isn't supported. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5