Skip to main content

Pre-Requisites

Install Requirements

note

This is specific to Self Hosted deployments. For Sath hosted connectors, these requirements are already in place.

  • You need to install Helm version 3 or above.
  • You can use Kubernetes cluster (1.26 or above) to install the connector

Connection Requirements

Below is needed to connect to AWS

  • An active AWS EC2 instance - For reconciliation and provisioning
  • A service account (user) with required permissions
  • Customer/inline policy to manage each AWS account
  • Generate Access Key and Secret Access Key
info

You need to login as an admin to your AWS instance in order to setup the service account.

Create Service Account

To create an IAM user in the AWS account, perform the following steps:

  1. Go to IAM > Users > Add User
  2. Perform the following steps to add a user in the Add User page:
    1. In the Set user details section, enter the user name (sign-in name for AWS).
    2. In the Select AWS access type section, under Access type, select Programmatic access checkboxes.
    3. To manually enter the user password, select Custom password.
    4. Select the Require password reset checkbox and then select Next: Permissions.
  3. From the Add User page, select Set Permissions and click Next: Tags without making any change.
  4. From the Add tags (optional) page, click Next: Review and review all details used for creating the user and then click on Create user. You will receive a success message on the screen after you creating the user.
  5. Click Close

Create Inline Policy

info

Inline policy documentation for AWS connector is coming soon.

Generate AWS access key and Secret Access Key

  1. Go to IAM > Users and Click on Service account for which keys will be generated
  2. Select Create access key from Access Keys section
  3. Select option Application running outside AWS and click Next
  4. Add Description tag value (optional) and click Create access key

This will generate both keys. Copy the values and store for adding to the configuration file.

Permissions

Below are the list of permissions required to be provided to the service account.

ActionPermission Needed
Create User AccountCreateUser
GetUser
Update AccountUpdateUser
TagUser
Delete AccountGetUser
DeleteUser
GetLoginProfile
DeleteLoginProfile
ListAccessKeys
DeleteAccessKey
ListSigningCertificates
DeleteSigningCertificate
ListSSHPublicKeys
DeleteSSHPublicKey
ListServiceSpecificCredentials
DeleteServiceSpecificCredential
ListMFADevices
DeactivateMFADevice
ListVirtualMFADevices
DeleteVirtualMFADevice
ListUserPolicies
DeleteUserPolicy
ListAttachedUserPolicies
GetPolicy
DetachUserPolicy
ListGroupsForUser
GetGroup
ListAttachedGroupPolicies
RemoveUserFromGroup
GetSSHPublicKey
Add Entitlement to AccountAttachUserPolicy
AddUserToGroup
Remove Entitlement from AccountDetachUserPolicy
RemoveUserFromGroup
Fetch Account (with Tags)GetAccountAuthorizationDetails
GetUser
Fetch Entitlement (with Tags)ListPolicies
GetPolicy
ListGroups
GetGroup
Fetch Entitlement of AccountsListGroupsForUser
GetGroup
ListAttachedGroupPolicies
ListAttachedUserPolicies
GetPolicy
Disable/Enable AccountSame as Update Account