docs(connection-parameters): add endpoint_url, auth_profile

Author: Brooke-white

README.rst

@@ -264,6 +264,8 @@ Connection Parameters
 +-----------------------------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------+----------+
 | app_name                          | str  | The name of the IdP application used for authentication                                                                                                                                                                                                                                                                                                               | None                 | No       |
 +-----------------------------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------+----------+
+| auth_profile                      | str  | The name of an Amazon Redshift Authentication profile having connection properties as JSON. See the RedshiftProperty class to learn how connection parameters should be named.                                                                                                                                                                                        | None                 | No       |
++-----------------------------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------+----------+
 | auto_create                       | bool | Indicates whether the user should be created if they do not exist                                                                                                                                                                                                                                                                                                     | FALSE                | No       |
 +-----------------------------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------+----------+
 | client_id                         | str  | The client id from Azure IdP                                                                                                                                                                                                                                                                                                                                          | None                 | No       |
@@ -282,6 +284,8 @@ Connection Parameters
 +-----------------------------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------+----------+
 | db_user                           | str  | The user ID to use with Amazon Redshift                                                                                                                                                                                                                                                                                                                               | None                 | No       |
 +-----------------------------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------+----------+
+| endpoint_url                      | str  | The Amazon Redshift endpoint url. This option is only used by AWS internal teams.                                                                                                                                                                                                                                                                                     | None                 | No       |
++-----------------------------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------+----------+
 | host                              | str  | The hostname of Amazon Redshift cluster                                                                                                                                                                                                                                                                                                                               | None                 | No       |
 +-----------------------------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------+----------+
 | iam                               | bool | If IAM Authentication is enabled                                                                                                                                                                                                                                                                                                                                      | FALSE                | No       |
@@ -330,6 +334,7 @@ Connection Parameters
 +-----------------------------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------+----------+
 | web_identity_token                | str  | The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider. This parameter is used by JwtCredentialsProvider. For this provider, this is a mandatory parameter.                                      | None                 | No       |
 +-----------------------------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------+----------+
+
 Supported Datatypes
 ~~~~~~~~~~~~~~~~~~~
 ``redshift_connector`` supports the following Amazon Redshift datatypes. ``redshift_connector`` will attempt to treat unsupported datatypes as strings.