Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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 AWS Identity and Access Management (IAM)user or role that executes 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
privilege.
If the DbName
parameter is specified, the IAM policy must allow access to the resource dbname
for the specified database name.
- getClusterCredentials :: Text -> Text -> GetClusterCredentials
- data GetClusterCredentials
- gccDBGroups :: Lens' GetClusterCredentials [Text]
- gccDurationSeconds :: Lens' GetClusterCredentials (Maybe Int)
- gccAutoCreate :: Lens' GetClusterCredentials (Maybe Bool)
- gccDBName :: Lens' GetClusterCredentials (Maybe Text)
- gccDBUser :: Lens' GetClusterCredentials Text
- gccClusterIdentifier :: Lens' GetClusterCredentials Text
- getClusterCredentialsResponse :: Int -> GetClusterCredentialsResponse
- data GetClusterCredentialsResponse
- gccrsDBUser :: Lens' GetClusterCredentialsResponse (Maybe Text)
- gccrsExpiration :: Lens' GetClusterCredentialsResponse (Maybe UTCTime)
- gccrsDBPassword :: Lens' GetClusterCredentialsResponse (Maybe Text)
- gccrsResponseStatus :: Lens' GetClusterCredentialsResponse Int
Creating a Request
getClusterCredentials Source #
Creates a value of GetClusterCredentials
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gccDBGroups
- A list of the names of existing database groups that the user named inDbUser
will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC. Database group name constraints * Must be 1 to 64 alphanumeric characters or hyphens * Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. * 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 <http:docs.aws.amazon.comredshiftlatestdg/r_pg_keywords.html Reserved Words> in the Amazon Redshift Database Developer Guide.gccDurationSeconds
- The number of seconds until the returned temporary password expires. Constraint: minimum 900, maximum 3600. Default: 900gccAutoCreate
- Create a database user with the name specified for the user named inDbUser
if one does not exist.gccDBName
- The name of a database thatDbUser
is authorized to log on to. IfDbName
is not specified,DbUser
can log on to any existing database. Constraints: * Must be 1 to 64 alphanumeric characters or hyphens * Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. * 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 <http:docs.aws.amazon.comredshiftlatestdg/r_pg_keywords.html Reserved Words> in the Amazon Redshift Database Developer Guide.gccDBUser
- The name of a database user. If a user name matchingDbUser
exists in the database, the temporary user credentials have the same permissions as the existing user. IfDbUser
doesn't exist in the database andAutocreate
isTrue
, a new user is created using the value forDbUser
with PUBLIC permissions. If a database user matching the value forDbUser
doesn't exist andAutocreate
isFalse
, 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 64 alphanumeric characters or hyphens. The user name can't bePUBLIC
. * Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. * 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 <http:docs.aws.amazon.comredshiftlatestdg/r_pg_keywords.html Reserved Words> in the Amazon Redshift Database Developer Guide.gccClusterIdentifier
- The unique identifier of the cluster that contains the database for which your are requesting credentials. This parameter is case sensitive.
data GetClusterCredentials Source #
The request parameters to get cluster credentials.
See: getClusterCredentials
smart constructor.
Request Lenses
gccDBGroups :: Lens' GetClusterCredentials [Text] Source #
A list of the names of existing database groups that the user named in DbUser
will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC. Database group name constraints * Must be 1 to 64 alphanumeric characters or hyphens * Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. * 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 <http:docs.aws.amazon.comredshiftlatestdg/r_pg_keywords.html Reserved Words> in the Amazon Redshift Database Developer Guide.
gccDurationSeconds :: Lens' GetClusterCredentials (Maybe Int) Source #
The number of seconds until the returned temporary password expires. Constraint: minimum 900, maximum 3600. Default: 900
gccAutoCreate :: Lens' GetClusterCredentials (Maybe Bool) Source #
Create a database user with the name specified for the user named in DbUser
if one does not exist.
gccDBName :: Lens' GetClusterCredentials (Maybe Text) Source #
The name of a database that DbUser
is authorized to log on to. If DbName
is not specified, DbUser
can log on to any existing database. Constraints: * Must be 1 to 64 alphanumeric characters or hyphens * Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. * 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 <http:docs.aws.amazon.comredshiftlatestdg/r_pg_keywords.html Reserved Words> in the Amazon Redshift Database Developer Guide.
gccDBUser :: Lens' GetClusterCredentials Text Source #
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 64 alphanumeric characters or hyphens. The user name can't be PUBLIC
. * Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. * 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 <http:docs.aws.amazon.comredshiftlatestdg/r_pg_keywords.html Reserved Words> in the Amazon Redshift Database Developer Guide.
gccClusterIdentifier :: Lens' GetClusterCredentials Text Source #
The unique identifier of the cluster that contains the database for which your are requesting credentials. This parameter is case sensitive.
Destructuring the Response
getClusterCredentialsResponse Source #
Creates a value of GetClusterCredentialsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gccrsDBUser
- A database user name that is authorized to log on to the databaseDbName
using the passwordDbPassword
. If the specified DbUser exists in the database, the new user name has the same database privileges as the the user named in DbUser. By default, the user is added to PUBLIC. If theDbGroups
parameter is specifed,DbUser
is added to the listed groups for any sessions created using these credentials.gccrsExpiration
- The date and time the password inDbPassword
expires.gccrsDBPassword
- A temporary password that authorizes the user name returned byDbUser
to log on to the databaseDbName
.gccrsResponseStatus
- -- | The response status code.
data GetClusterCredentialsResponse Source #
Temporary credentials with authorization to log on to an Amazon Redshift database.
See: getClusterCredentialsResponse
smart constructor.
Response Lenses
gccrsDBUser :: Lens' GetClusterCredentialsResponse (Maybe Text) Source #
A database user name that is authorized to log on to the database DbName
using the password DbPassword
. If the specified DbUser exists in the database, the new user name has the same database privileges as the the user named in DbUser. By default, the user is added to PUBLIC. If the DbGroups
parameter is specifed, DbUser
is added to the listed groups for any sessions created using these credentials.
gccrsExpiration :: Lens' GetClusterCredentialsResponse (Maybe UTCTime) Source #
The date and time the password in DbPassword
expires.
gccrsDBPassword :: Lens' GetClusterCredentialsResponse (Maybe Text) Source #
A temporary password that authorizes the user name returned by DbUser
to log on to the database DbName
.
gccrsResponseStatus :: Lens' GetClusterCredentialsResponse Int Source #
- - | The response status code.