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 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.
Namespace: Amazon.Redshift.Model
Assembly: AWSSDK.Redshift.dll
Version: 3.x.y.z
public class GetClusterCredentialsRequest : AmazonRedshiftRequest IAmazonWebServiceRequest
The GetClusterCredentialsRequest type exposes the following members
Name | Description | |
---|---|---|
GetClusterCredentialsRequest() |
Name | Type | Description | |
---|---|---|---|
AutoCreate | System.Boolean |
Gets and sets the property AutoCreate.
Create a database user with the name specified for the user named in |
|
ClusterIdentifier | System.String |
Gets and sets the property ClusterIdentifier. The unique identifier of the cluster that contains the database for which you are requesting credentials. This parameter is case sensitive. |
|
CustomDomainName | System.String |
Gets and sets the property CustomDomainName. The custom domain name for the cluster credentials. |
|
DbGroups | System.Collections.Generic.List<System.String> |
Gets and sets the property DbGroups.
A list of the names of existing database groups that the user named in Database group name constraints
|
|
DbName | System.String |
Gets and sets the property DbName.
The name of a database that Constraints:
|
|
DbUser | System.String |
Gets and sets the property DbUser.
The name of a database user. If a user name matching For more information, see CREATE USER in the Amazon Redshift Database Developer Guide. Constraints:
|
|
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 |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5