On-boarding
On-boarding¶
This page describes the process of on-boarding a new connector onto the Amazon Yojaka product. The on-boarding a connector requires you to perform a series of steps documented below and reach out to the Amazon Yojaka programme team to complete the on-boarding process once these steps are completed.
Amazon Web Services Setup¶
Amazon Yojaka is built on the Amazon Web Services (AWS) platform and requires you to on-board your connector service on that platform.
Note
The AWS resources that you create in this step are offered at no additional charge. You will only be charged for any non-Amazon Yojaka resources that you create in your AWS account.
Setup Instructions¶
Create an AWS account - You need to create a unique AWS account for your connector service. Instructions for creating and activating your AWS account can be found here
Create an AWS IAM user - Sign-in to your newly created and activated AWS account and create an AWS IAM user. Instructions for creating an AWS IAM user are available here
Tip
While creating credentials for the user, ensure that you enable programmatic access for the user.
Manage your AWS IAM user’s access keys securely. Best practices for managing AWS access keys can be found here.
On-board With Us¶
Once you have completed the AWS setup, reach out to the the Amazon Yojaka programme team via email at smartconnect-support@amazon.com and provide us with the following information.
AWS account ID - This is the ID of your newly created AWS account. Instructions for finding your account id are available here.
AWS IAM user ARN - This is the ARN of your newly created AWS IAM user. You will find the IAM user’s ARN by navigating to the newly created user in the AWS IAM console.
Tip
Click here to learn more about AWS IAM ARNs.
Connector Name - Any name by which you would like us to refer to your connector.
Contact Information - Provide us with your contact information including email addresses, phone numbers, etc. We will use this to reach out to you about any important information about the product. We would also use this to reach out to you in case we face any issues with your connector.
Post On-boarding Steps¶
Once on-boarding of your connector with Amazon Yojaka has been completed, the Amazon Yojaka programme team will provide you with an AWS IAM role that has been specifically created for your connector. You will be provided with two AWS IAM roles - one to use with the Amazon Yojaka sandbox and one to use with the Amazon Yojaka production system.
AWS IAM Policy¶
To enable your connector application to invoke Amazon Yojaka’s APIs, you need to attach a custom AWS IAM policy to the AWS IAM user you created above. Follow the steps below to setup this AWS IAM Policy.
Open the AWS console for the AWS account that you created during the connector on-boarding step.
Navigate to the AWS IAM console by selecting the Services select list and choosing IAM in the list of available services.
In the menu options on the left side, click on Users.
Click on the user name of the user you created for your connector during the on-boarding step.
On the Permissions tab, click on the Add inline policy link.
On the Create policy page, select the JSON tab.
Paste the JSON given below into the JSON editor after replacing the right AWS region and Amazon Yojaka AWS account for the stage/region that you are working with (refer to the table above).
{ "Version": "2012-10-17", "Statement": { "Effect": "Allow", "Action": "sts:AssumeRole", "Resource": "<ARN of the AWS IAM role provided by the Amazon Yojaka team>" } }
Click on the Review policy button.
In the Name field, provide the name AmazonYojakaAssumeRolePolicy.
Click the Create policy button.
Warning
Note that it might take a few minutes for any AWS IAM policy changes to take effect. If invoking any Amazon Yojaka API fails immediately after creating the AmazonYojakaAssumeRolePolicy policy, retry the same operation after a few minutes.
On this page
