awswrangler.data_api.rds.connect¶
- awswrangler.data_api.rds.connect(resource_arn: str, database: str, secret_arn: str = '', boto3_session: Session | None = None, **kwargs: Any) RdsDataApi¶
Create a RDS Data API connection.
- Parameters:
resource_arn (
str) – ARN for the RDS resource.database (
str) – Target database name.secret_arn (
str) – The ARN for the secret to be used for authentication.boto3_session (
Session|None) – The default boto3 session will be used if boto3_session isNone.**kwargs (
Any) – Any additional kwargs are passed to the underlying RdsDataApi class.
- Return type:
- Returns:
A RdsDataApi connection instance that can be used with wr.rds.data_api.read_sql_query.