Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Returns a database user name and temporary password with temporary authorization to log in to an Amazon Redshift database. The database user is mapped 1:1 to the source Identity and Access Management (IAM) identity. For more information about IAM identities, see IAM Identities (users, user groups, and roles) in the Amazon Web Services Identity and Access Management User Guide.
The Identity and Access Management (IAM) identity that runs this operation must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Using identity-based policies (IAM policies) in the Amazon Redshift Cluster Management Guide.
Synopsis
- data GetClusterCredentialsWithIAM = GetClusterCredentialsWithIAM' {}
- newGetClusterCredentialsWithIAM :: Text -> GetClusterCredentialsWithIAM
- getClusterCredentialsWithIAM_dbName :: Lens' GetClusterCredentialsWithIAM (Maybe Text)
- getClusterCredentialsWithIAM_durationSeconds :: Lens' GetClusterCredentialsWithIAM (Maybe Int)
- getClusterCredentialsWithIAM_clusterIdentifier :: Lens' GetClusterCredentialsWithIAM Text
- data GetClusterCredentialsWithIAMResponse = GetClusterCredentialsWithIAMResponse' {
- dbPassword :: Maybe (Sensitive Text)
- dbUser :: Maybe Text
- expiration :: Maybe ISO8601
- nextRefreshTime :: Maybe ISO8601
- httpStatus :: Int
- newGetClusterCredentialsWithIAMResponse :: Int -> GetClusterCredentialsWithIAMResponse
- getClusterCredentialsWithIAMResponse_dbPassword :: Lens' GetClusterCredentialsWithIAMResponse (Maybe Text)
- getClusterCredentialsWithIAMResponse_dbUser :: Lens' GetClusterCredentialsWithIAMResponse (Maybe Text)
- getClusterCredentialsWithIAMResponse_expiration :: Lens' GetClusterCredentialsWithIAMResponse (Maybe UTCTime)
- getClusterCredentialsWithIAMResponse_nextRefreshTime :: Lens' GetClusterCredentialsWithIAMResponse (Maybe UTCTime)
- getClusterCredentialsWithIAMResponse_httpStatus :: Lens' GetClusterCredentialsWithIAMResponse Int
Creating a Request
data GetClusterCredentialsWithIAM Source #
See: newGetClusterCredentialsWithIAM
smart constructor.
GetClusterCredentialsWithIAM' | |
|
Instances
newGetClusterCredentialsWithIAM Source #
Create a value of GetClusterCredentialsWithIAM
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetClusterCredentialsWithIAM
, getClusterCredentialsWithIAM_dbName
- The name of the database for which you are requesting credentials. If
the database name is specified, the IAM policy must allow access to the
resource dbname
for the specified database name. If the database name
is not specified, access to all databases is allowed.
$sel:durationSeconds:GetClusterCredentialsWithIAM'
, getClusterCredentialsWithIAM_durationSeconds
- The number of seconds until the returned temporary password expires.
Range: 900-3600. Default: 900.
GetClusterCredentialsWithIAM
, getClusterCredentialsWithIAM_clusterIdentifier
- The unique identifier of the cluster that contains the database for
which you are requesting credentials.
Request Lenses
getClusterCredentialsWithIAM_dbName :: Lens' GetClusterCredentialsWithIAM (Maybe Text) Source #
The name of the database for which you are requesting credentials. If
the database name is specified, the IAM policy must allow access to the
resource dbname
for the specified database name. If the database name
is not specified, access to all databases is allowed.
getClusterCredentialsWithIAM_durationSeconds :: Lens' GetClusterCredentialsWithIAM (Maybe Int) Source #
The number of seconds until the returned temporary password expires.
Range: 900-3600. Default: 900.
getClusterCredentialsWithIAM_clusterIdentifier :: Lens' GetClusterCredentialsWithIAM Text Source #
The unique identifier of the cluster that contains the database for which you are requesting credentials.
Destructuring the Response
data GetClusterCredentialsWithIAMResponse Source #
See: newGetClusterCredentialsWithIAMResponse
smart constructor.
GetClusterCredentialsWithIAMResponse' | |
|
Instances
newGetClusterCredentialsWithIAMResponse Source #
Create a value of GetClusterCredentialsWithIAMResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbPassword:GetClusterCredentialsWithIAMResponse'
, getClusterCredentialsWithIAMResponse_dbPassword
- A temporary password that you provide when you connect to a database.
$sel:dbUser:GetClusterCredentialsWithIAMResponse'
, getClusterCredentialsWithIAMResponse_dbUser
- A database user name that you provide when you connect to a database.
The database user is mapped 1:1 to the source IAM identity.
$sel:expiration:GetClusterCredentialsWithIAMResponse'
, getClusterCredentialsWithIAMResponse_expiration
- The time (UTC) when the temporary password expires. After this
timestamp, a log in with the temporary password fails.
$sel:nextRefreshTime:GetClusterCredentialsWithIAMResponse'
, getClusterCredentialsWithIAMResponse_nextRefreshTime
- Reserved for future use.
$sel:httpStatus:GetClusterCredentialsWithIAMResponse'
, getClusterCredentialsWithIAMResponse_httpStatus
- The response's http status code.
Response Lenses
getClusterCredentialsWithIAMResponse_dbPassword :: Lens' GetClusterCredentialsWithIAMResponse (Maybe Text) Source #
A temporary password that you provide when you connect to a database.
getClusterCredentialsWithIAMResponse_dbUser :: Lens' GetClusterCredentialsWithIAMResponse (Maybe Text) Source #
A database user name that you provide when you connect to a database. The database user is mapped 1:1 to the source IAM identity.
getClusterCredentialsWithIAMResponse_expiration :: Lens' GetClusterCredentialsWithIAMResponse (Maybe UTCTime) Source #
The time (UTC) when the temporary password expires. After this timestamp, a log in with the temporary password fails.
getClusterCredentialsWithIAMResponse_nextRefreshTime :: Lens' GetClusterCredentialsWithIAMResponse (Maybe UTCTime) Source #
Reserved for future use.
getClusterCredentialsWithIAMResponse_httpStatus :: Lens' GetClusterCredentialsWithIAMResponse Int Source #
The response's http status code.