Setup for AWS S3¶
Configure¶
Perform following steps to configure Dataserver with AWS-S3:
-
SSH into the instance where Privacera Manager is installed.
-
Open the
vars.dataserver.aws.ymlfile. -
Modify the following properties:
YAML Data Plane Mode
- It is mandatory to set the
DATASERVER_D2P_MODE_ENABLEandDATASERVER_AWS_MULTI_ACCOUNT_PROFILE_ENABLEproperties to true to enable the DataServer for Data Plane mode.
- It is mandatory to set the
- Once the properties are configured, run the following commands:
Perform following steps to configure Dataserver with AWS-S3 in PrivaceraCloud:
- In PrivaceraCloud, navigate to Settings -> Applications.
- On the Applications screen, select S3 application under Available connections.
- Enter the application Name and Description, then click Save.
- You will see Privacera Access Management and Data Discovery with toggle buttons.
- Enable Privacera Access Management by toggling the button.
- Under the BASIC tab, enter the following:
- Profile Name: Enter a unique profile name for your application.
You can set up multiple AWS accounts. You can see the tabs with your application names in the File Explorer.
- AWS Account Setup:
- Without IAM Role:
- AWS Access Key: Enter the Access Key for the AWS account.
- AWS Secret Key: Enter the Secret Key for the AWS account.
- With IAM Role:
- AWS IAM Role: Enter the full ARN of the IAM Role.
- Without IAM Role:
- Click on the Test Connection button to verify the connection.
- On the ADVANCED tab, you can add custom properties if needed.
- Click on the Test Connection again to ensure the settings are correct, then click Save.
Perform the following steps to configure DataServer with AWS-S3 in a Runtime Manager deployment:
- Go to Settings → Runtime Plane, open your runtime plane, and add Dataserver from the Connector tab.
- On the Basic Info tab, enter a Name for the connector (for example,
dataserver-stage), optionally add a Description, then select Continue. - Go to Access Control Configs → Connector Configs.
- In the left panel, select a profile under Common Properties, or select Add Profile to create one. Add one AWS profile per account:
- Give the profile a unique Profile Name (for example,
aws_account1). - Set the Auth Method and its fields:
- Custom IAM Role — enter the IAM Role ARN to assume. For cross-account access, optionally set the External ID.
- Access Key — enter the Access Key ID and the Secret Access Key.
- Repeat for each additional account (for example,
aws_account2).
- Give the profile a unique Profile Name (for example,
- One profile shows the Default label. To change it, open another profile and select Set as default.
- Select Save. The Runtime Manager redeploys the connector with the updated profiles.
For the IAM trust that a Custom IAM Role profile needs on a runtime plane, see the Runtime tab in Prerequisites for AWS S3.
Each profile also shows the following fields. Keep the default values unless your setup needs a change.
| Field | Default | Description |
|---|---|---|
| Region | us-east-1 | AWS Region for this profile. |
| AWS Services | S3 | AWS services that this profile handles: S3, Athena, DynamoDB, Glue, Kinesis, or Lambda. |
| STS Role ARN | Empty | IAM role ARN that DataServer assumes to generate STS tokens for this profile, for the Databricks and signer flows. |
| STS Duration (seconds) | 3600 | How long the STS credentials issued for this profile are valid. |
| STS Expiry Buffer (seconds) | 60 | How many seconds before expiry DataServer refreshes the STS credentials. |
| STS Token Signing | true | Lets the signer generate STS tokens for this profile. Boto3 and native AWS SDK clients need it. |
| S3 Signed URL Expiry (ms) | 600000 | Expiry time of the S3 signed URLs generated for this profile. |
| S3 Client Execution Timeout (ms) | 60000 | Execution timeout of the S3 client for this profile. |
| S3 Requester Pays | false | Sends requester-pays headers on S3 requests for this profile. |
| Include User Info in Requests | false | Adds Privacera user information to outgoing AWS requests, for example to CloudWatch. |
| Ranger S3 Service Name | Empty | Ranger service that authorizes S3 requests for this profile. If empty, DataServer uses the default S3 service, privacera_s3. The named service must already exist. |
| Databricks Delta IAM Role ARN | Empty | IAM role ARN for the Databricks Delta use case on this profile. |
Enabling a service for the whole connector
The services a DataServer instance handles are set by the AWS Services field in Common Properties, not per profile. A request for a service that is not in the Common Properties list is rejected with a 404 and the message Service not enabled to handle <service> requests.; it is not proxied. DataServer also loads a Ranger plugin only for the services in that list.
To set a profile property that has no field in the form, open Additional Profile Properties in the profile and select Add property. Enter the key without the dataserver.aws.<profile-name>. prefix; the portal adds the prefix when you save. For example, enter use.regional.endpoint to set dataserver.aws.<profile-name>.use.regional.endpoint.
File Explorer on a Self-Managed runtime plane
On a Self-Managed runtime plane, File Explorer supports one namespace with one DataServer. Support for multiple namespaces and multiple DataServers is planned for a later release.
Validation¶
To validate AWS S3 configuration, one of the following approach can be followed:
- Prev topic: Prerequistes
- Next topic: Advanced Configuration