GETCLUSTERCREDENTIALSWITHIAM()`¶

About GetClusterCredentialsWithIAM¶

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.

Method Signature¶

METHODS /AWS1/IF_RSH~GETCLUSTERCREDENTIALSWITHIAM
  IMPORTING
    !IV_DBNAME TYPE /AWS1/RSHSTRING OPTIONAL
    !IV_CLUSTERIDENTIFIER TYPE /AWS1/RSHSTRING OPTIONAL
    !IV_DURATIONSECONDS TYPE /AWS1/RSHINTEGEROPTIONAL OPTIONAL
    !IV_CUSTOMDOMAINNAME TYPE /AWS1/RSHSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_rshclustextendedcreds
  RAISING
    /AWS1/CX_RSHCLUSTNOTFOUNDFAULT
    /AWS1/CX_RSHUNSUPPORTEDOPFAULT
    /AWS1/CX_RSHCLIENTEXC
    /AWS1/CX_RSHSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_dbname` `TYPE /AWS1/RSHSTRING` `/AWS1/RSHSTRING`¶

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.

`iv_clusteridentifier` `TYPE /AWS1/RSHSTRING` `/AWS1/RSHSTRING`¶

The unique identifier of the cluster that contains the database for which you are requesting credentials.

`iv_durationseconds` `TYPE /AWS1/RSHINTEGEROPTIONAL` `/AWS1/RSHINTEGEROPTIONAL`¶

The number of seconds until the returned temporary password expires.

Range: 900-3600. Default: 900.

`iv_customdomainname` `TYPE /AWS1/RSHSTRING` `/AWS1/RSHSTRING`¶

The custom domain name for the IAM message cluster credentials.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_rshclustextendedcreds` `/AWS1/CL_RSHCLUSTEXTENDEDCREDS`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->getclustercredentialswithiam(
  iv_clusteridentifier = |string|
  iv_customdomainname = |string|
  iv_dbname = |string|
  iv_durationseconds = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_dbuser( ).
  lv_sensitivestring = lo_result->get_dbpassword( ).
  lv_tstamp = lo_result->get_expiration( ).
  lv_tstamp = lo_result->get_nextrefreshtime( ).
ENDIF.

/AWS1/IF_RSH=>GETCLUSTERCREDENTIALSWITHIAM()¶