Configure Authentication Method

Perform the following steps to configure AUTHN_METHOD.

The AUTHN_METHOD property determines which additional parameters are required for authentication. There are three different ways to configure the authentication method. To set it up, include the following property in the vars.dataserver.aws.yml file:

  1. ACCESS KEY:
    • If AUTHN_METHOD is set to ACCESS_KEY, both ACCESS_KEY and SECRET_KEY are mandatory and should be non-null values.
      YAML
      1
2
3
4
5
6
      DATASERVER_AWS_PROFILE_PROPERTIES:
- PROFILE_NAME: "aws_account1"
  PROFILE_PROPERTIES:
    - AUTHN_METHOD: "ACCESS_KEY"
    - ACCESS_KEY: "your-access-key"
    - SECRET_KEY: "your-secret-key"
  2. CUSTOM IAM:
    • If AUTHN_METHOD is set to CUSTOM_IAM, IAM_ARN is mandatory and should be a non-null value.
      YAML
      1
2
3
4
5
      DATASERVER_AWS_PROFILE_PROPERTIES:
- PROFILE_NAME: "aws_account1"
  PROFILE_PROPERTIES:
    - AUTHN_METHOD: "CUSTOM_IAM"
    - IAM_ARN: "arn:aws:iam::<account_id>:role/<role_name>"
  3. INSTANCE IAM:
    • If AUTHN_METHOD is set to INSTANCE_IAM, no additional parameters are required.
      YAML
      1
2
3
4
      DATASERVER_AWS_PROFILE_PROPERTIES:
- PROFILE_NAME: "aws_account1"
  PROFILE_PROPERTIES:
    - AUTHN_METHOD: "INSTANCE_IAM"
  4. Once the properties are configured, refer to the Privacera Manager Quickstart.

There are two different ways to configure the authentication method in PrivaceraCloud. Perform one of the following two methods:

  1. ACCESS KEY and SECRET KEY:

    • In PrivaceraCloud, navigate to Settings -> Applications.
    • On the Connected Applications screen, select S3.
    • Click the edit icon next to the Account Name, then go to Access Management -> BASIC tab.
    • Disable the Use IAM Role toggle button.
    • In the AWS Access Key field, enter your_access_key. In the AWS Secret Key field, enter your_secret_key.
    • Click the Test Connection button to verify the connection.
    • Once the connection is successful, click Save.

  2. IAM ROLE:

    • In PrivaceraCloud, navigate to Settings -> Applications.
    • On the Connected Applications screen, select S3.
    • Click the edit icon next to the Account Name, then go to Access Management -> BASIC tab.
    • Enable the Use IAM Role toggle button.
    • In the AWS IAM Role field, enter arn:aws:iam::<account_id>:role/<role_name>.
    • Click the Test Connection button to verify the connection.
    • Once the connection is successful, click Save.

When DataServer is deployed as a Runtime connector (managed by the Runtime Manager), the authentication method is configured per AWS profile from the connector UI:

  1. Open the DataServer connector and go to Access Control Configs → Connector Configs.
  2. In the left panel, select a profile under Common Properties, or select Add Profile to create one.
  3. Set the Auth Method for the profile:
    • 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.
  4. Select Save. The Runtime Manager redeploys the connector with the updated profile.