Using IAM Credentials

You can configure the connector to authenticate your connection through IAM authentication using IAM credentials.

To configure IAM authentication using IAM:

  1. Set the IAM property to 1.
  2. If the ID and region of the Redshift server cluster are not already provided through the Server property, then do the following:
    1. Set the ClusterID property to the ID for the Redshift server cluster.
    2. Set the Region property to the region for the Redshift server cluster.
  3. Set the DbUser property to the ID that you want to designate to the Redshift user.
  4. If the ID you specified for the DbUser property does not already exist in your Redshift account, you must create it:
    1. Set the AutoCreate property to 1.
    2. Set the DbGroups property to the names of any user groups that you want the new DbUser to be added to, separated by commas.
    3. Optionally, to lowercase all DbGroups that are received from the identity provider, select the Force Lowercase check box.
  5. Optionally, set the EndpointUrl property to the endpoint used to communicate with the Redshift cluster.
  6. Optionally, set the StsEndpointUrl property to the endpoint used to communicate with the AWS Security Token Service (AWS STS).

  7. Optionally, set the VpcEndpointUrl property to the endpoint used to communicate with the Redshift cluster

  8. Optionally, set the AuthProfile property to the authentication profile you want to use to manage the connection settings.
  9. Set the AccessKeyID property to your Redshift access key ID.
  10. Set the SecretAccessKey property to your Redshift secret key.
  11. If you are using an IAM role, set the SessionToken property to your temporary session token.
  12. Optionally, set the group_federation property to 1 to enable group federation.