Create user-defined Amazon Glue connections
Note
All Amazon Glue connections created by users via the SQL extension UI are automatically tagged with the following:
-
UserProfile:user-profile-name -
AppType: "JL"
Those tags applied to the Amazon Glue connections created via the SQL extension UI serve two
purposes. The "UserProfile": tag
allows the identification of the specific user profile that created the Amazon Glue connection,
providing visibility into the user responsible for the connection. The user-profile-name"AppType":
"JL" tag categorizes the provenance of the connection, associating it with the
JupyterLab application. This allows these connections to be differentiated from those that
may have been created through other means, such as the Amazon CLI.
Prerequisites
Before creating a Amazon Glue connection using the SQL extension UI, ensure that you have completed the following tasks:
-
Have your administrator:
-
Enable the network communication between your Studio domain and the data sources to which you want to connect. To learn about the networking requirements, see Configure network access between Studio and data sources (for administrators).
-
Ensure that the necessary IAM permissions are set up for managing Amazon Glue connections and access to Secrets Manager. To learn about the required permissions, see Set up the IAM permissions to access the data sources (for administrators).
Note
Administrators can restrict user access to only the connections that were created by a user within the JupyterLab application. This can be done by configuring tag-based access control scoped down to the user profile.
-
-
Check the connection properties and instructions to create a secret for your data source in Create secrets for database access credentials in Secrets Manager.
User workflow
The following steps provide the user workflow when creating user connections:
-
Select the data source type: Upon choosing the Add new connection icon, a form opens, prompting the user to select the type of data source they want to connect to, such as Amazon Redshift, Athena, or Snowflake.
-
Provide connection properties: Based on the selected data source, the relevant connection properties are dynamically loaded. The form indicates which fields are mandatory or optional for the chosen data source. To learn about the available properties for your data source, see Connection parameters.
-
Select your Amazon Secrets Manager ARN: For Amazon Redshift and Snowflake data sources, the user is prompted to select the Amazon Secrets Manager ARN that stores sensitive information such as the username and password. To learn about the creation of a secret for your data source, see Create secrets for database access credentials in Secrets Manager.
-
Save your connection details: Upon clicking Create, the provided connection properties are saved as a Amazon Glue connection.
-
Test your connection: If the connection is successful, the associated databases and tables become visible in the explorer. If the connection fails, an error message is displayed, prompting the user to review and correct the connection details.
-
Familiarize with SQL extension features: To learn about the capabilities of the extension, see the SQL extension features and usage.
-
(Optional) Update or delete user-created connections: Provided that the user has been granted the necessary permissions, they can update or delete the connections they have created. To learn more about the required permissions, see User-defined connections required IAM permissions.