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

Amazonka.Redshift.GetClusterCredentialsWithIAM

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

data GetClusterCredentialsWithIAM Source #

See: newGetClusterCredentialsWithIAM smart constructor.

Constructors

GetClusterCredentialsWithIAM'

Fields

dbName :: Maybe Text
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.
durationSeconds :: Maybe Int
The number of seconds until the returned temporary password expires.
Range: 900-3600. Default: 900.
clusterIdentifier :: Text
The unique identifier of the cluster that contains the database for which you are requesting credentials.

Instances

Instances details

ToHeaders GetClusterCredentialsWithIAM Source #
Instance details Defined in Amazonka.Redshift.GetClusterCredentialsWithIAM Methods toHeaders :: GetClusterCredentialsWithIAM -> [Header] #
ToPath GetClusterCredentialsWithIAM Source #
Instance details Defined in Amazonka.Redshift.GetClusterCredentialsWithIAM Methods toPath :: GetClusterCredentialsWithIAM -> ByteString #
ToQuery GetClusterCredentialsWithIAM Source #
Instance details Defined in Amazonka.Redshift.GetClusterCredentialsWithIAM Methods toQuery :: GetClusterCredentialsWithIAM -> QueryString #
AWSRequest GetClusterCredentialsWithIAM Source #
Instance details Defined in Amazonka.Redshift.GetClusterCredentialsWithIAM Associated Types type AWSResponse GetClusterCredentialsWithIAM # Methods request :: (Service -> Service) -> GetClusterCredentialsWithIAM -> Request GetClusterCredentialsWithIAM # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetClusterCredentialsWithIAM -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetClusterCredentialsWithIAM))) #
Generic GetClusterCredentialsWithIAM Source #
Instance details Defined in Amazonka.Redshift.GetClusterCredentialsWithIAM Associated Types type Rep GetClusterCredentialsWithIAM :: Type -> Type # Methods from :: GetClusterCredentialsWithIAM -> Rep GetClusterCredentialsWithIAM x # to :: Rep GetClusterCredentialsWithIAM x -> GetClusterCredentialsWithIAM #
Read GetClusterCredentialsWithIAM Source #
Instance details Defined in Amazonka.Redshift.GetClusterCredentialsWithIAM Methods readsPrec :: Int -> ReadS GetClusterCredentialsWithIAM # readList :: ReadS [GetClusterCredentialsWithIAM] # readPrec :: ReadPrec GetClusterCredentialsWithIAM # readListPrec :: ReadPrec [GetClusterCredentialsWithIAM] #
Show GetClusterCredentialsWithIAM Source #
Instance details Defined in Amazonka.Redshift.GetClusterCredentialsWithIAM Methods showsPrec :: Int -> GetClusterCredentialsWithIAM -> ShowS # show :: GetClusterCredentialsWithIAM -> String # showList :: [GetClusterCredentialsWithIAM] -> ShowS #
NFData GetClusterCredentialsWithIAM Source #
Instance details Defined in Amazonka.Redshift.GetClusterCredentialsWithIAM Methods rnf :: GetClusterCredentialsWithIAM -> () #
Eq GetClusterCredentialsWithIAM Source #
Instance details Defined in Amazonka.Redshift.GetClusterCredentialsWithIAM Methods (==) :: GetClusterCredentialsWithIAM -> GetClusterCredentialsWithIAM -> Bool # (/=) :: GetClusterCredentialsWithIAM -> GetClusterCredentialsWithIAM -> Bool #
Hashable GetClusterCredentialsWithIAM Source #
Instance details Defined in Amazonka.Redshift.GetClusterCredentialsWithIAM Methods hashWithSalt :: Int -> GetClusterCredentialsWithIAM -> Int # hash :: GetClusterCredentialsWithIAM -> Int #
type AWSResponse GetClusterCredentialsWithIAM Source #
Instance details Defined in Amazonka.Redshift.GetClusterCredentialsWithIAM type AWSResponse GetClusterCredentialsWithIAM = GetClusterCredentialsWithIAMResponse
type Rep GetClusterCredentialsWithIAM Source #
Instance details Defined in Amazonka.Redshift.GetClusterCredentialsWithIAM type Rep GetClusterCredentialsWithIAM = D1 ('MetaData "GetClusterCredentialsWithIAM" "Amazonka.Redshift.GetClusterCredentialsWithIAM" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "GetClusterCredentialsWithIAM'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "durationSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "clusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetClusterCredentialsWithIAM Source #

Arguments

:: Text	`GetClusterCredentialsWithIAM`
-> GetClusterCredentialsWithIAM

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.

Constructors

GetClusterCredentialsWithIAMResponse'

Fields

dbPassword :: Maybe (Sensitive Text)
A temporary password that you provide when you connect to a database.
dbUser :: Maybe Text
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.
expiration :: Maybe ISO8601
The time (UTC) when the temporary password expires. After this timestamp, a log in with the temporary password fails.
nextRefreshTime :: Maybe ISO8601
Reserved for future use.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetClusterCredentialsWithIAMResponse Source #
Instance details Defined in Amazonka.Redshift.GetClusterCredentialsWithIAM Associated Types type Rep GetClusterCredentialsWithIAMResponse :: Type -> Type # Methods from :: GetClusterCredentialsWithIAMResponse -> Rep GetClusterCredentialsWithIAMResponse x # to :: Rep GetClusterCredentialsWithIAMResponse x -> GetClusterCredentialsWithIAMResponse #
Show GetClusterCredentialsWithIAMResponse Source #
Instance details Defined in Amazonka.Redshift.GetClusterCredentialsWithIAM Methods showsPrec :: Int -> GetClusterCredentialsWithIAMResponse -> ShowS # show :: GetClusterCredentialsWithIAMResponse -> String # showList :: [GetClusterCredentialsWithIAMResponse] -> ShowS #
NFData GetClusterCredentialsWithIAMResponse Source #
Instance details Defined in Amazonka.Redshift.GetClusterCredentialsWithIAM Methods rnf :: GetClusterCredentialsWithIAMResponse -> () #
Eq GetClusterCredentialsWithIAMResponse Source #
Instance details Defined in Amazonka.Redshift.GetClusterCredentialsWithIAM Methods (==) :: GetClusterCredentialsWithIAMResponse -> GetClusterCredentialsWithIAMResponse -> Bool # (/=) :: GetClusterCredentialsWithIAMResponse -> GetClusterCredentialsWithIAMResponse -> Bool #
type Rep GetClusterCredentialsWithIAMResponse Source #
Instance details Defined in Amazonka.Redshift.GetClusterCredentialsWithIAM type Rep GetClusterCredentialsWithIAMResponse = D1 ('MetaData "GetClusterCredentialsWithIAMResponse" "Amazonka.Redshift.GetClusterCredentialsWithIAM" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "GetClusterCredentialsWithIAMResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "dbUser") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "expiration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: (S1 ('MetaSel ('Just "nextRefreshTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetClusterCredentialsWithIAMResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetClusterCredentialsWithIAMResponse'`
-> GetClusterCredentialsWithIAMResponse

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.