Deploy using CloudFormation template - Research Service Workbench on AWS

Deploy using CloudFormation template

Step 1: Launch the stack

Follow the step-by-step instructions in this section to configure and deploy the solution into your account.

Time to deploy: Approximately 15 minutes

  1. This AWS CloudFormation template can be used to deploy the Research Service Workbench on AWS stack.

    Sign in to the AWS Management Console and select the button to launch the Research Service Workbench on AWS AWS CloudFormation template.

  1. The template launches in the US East (N. Virginia) Region by default. To launch the solution in a different AWS Region, use the Region selector in the console navigation bar.

    Note

    This solution uses the Amazon Cognito service, which is not currently available in all AWS Regions. You must launch this solution in an AWS Region where Cognito is available. For the most current availability by Region, see the AWS Regional Services List.

  2. On the Create stack page, verify that the correct template URL is in the Amazon S3 URL text box and choose Next.

  3. On the Specify stack details page, assign a name to your solution stack. For information about naming character limitations, see IAM and STS Limits in the AWS Identity and Access Management User Guide.

  4. Under Parameters, review the parameters for this solution template and modify them as necessary. This solution uses the following default values.

Parameter Default Description
Cognito Domain Prefix Provide a string for your Cognito domain name prefix. Cognito domain names must be globally unique.
Domain name Use a custom domain owned by you. TLS certificates are generated at the time of application deployment.
Hosted Zone ID RouteĀ 53 Hosted Zone ID linked to your domain name.
Required Stack Name rsw-prod-release

Copy the value in the Stack name field.

Warning

Do not change this value.

VPC ID (optional) Enter an existing VPC ID for main account resources to use.
Subnet IDs (optional) Enter existing subnet IDs for main account resources to use. Enter the IDs as comma-separated values inside the brackets.
  1. Choose Next.

  2. On the Configure stack options page, choose Next.

  3. On the Review page, review and confirm the settings. Check the box acknowledging that the template will create AWS Identity and Access Management (IAM) resources.

  4. Choose Create stack to deploy the stack.

    You can view the status of the stack in the AWS CloudFormation console in the Status column. You should receive a CREATE_COMPLETE status in approximately 15 minutes.

Research Service Workbench on AWS has now successfully deployed to your main account. Copy the following output values from the Outputs section of the stack for the next step:

  • S3BucketArtifactsArnOutput

  • AccountHandlerLambdaRoleOutput

  • ApiLambdaRoleOutput

  • StatusHandlerLambdaRoleOutput

  • APIGatewayAPIEndpoint

  • DataSetsBucketName

Note

An Application Load Balancer was created in your main account with access logging disabled by default. To enable it, see Enable access logs for your Application Load Balancer.

Step 2: Deploy the hosting account

The solution must also be deployed in a second account known as the hosting account.