Settings

• System Settings
• Display Settings
• Email Settings
• Cleaner Settings
• Subscription

System Settings

The Administrator has access to a wide range of advanced settings from the System Settings (1) menu on the left hand menu. This page will detail each of the following sections: 

• General Settings
• Lease Settings
• Terms of Service
• Advanced > Authentication Settings
• Advanced > Account Monitoring

General Settings

In the General Settings section, the Administrator can make the following configuration changes by clicking on the Update (1) button :

• System Version: Check if the Version of Sandbox Studio they are running is the latest by clicking on the Check for Updates. More details here: Monitor for updates
• Maintenance Mode: Set the application into Maintenance Mode. In maintenance mode, users cannot create leases. This is particularly interesting when you need to update Sandbox Studio for example.
• Deployment Mode: Development or Production. When in development, authorisation on API calls is not enforced.

Unless requested by the Sandox Studio team for support purpose, please avoid changing this value.

 

Lease Settings

In the Lease Settings section, the Administrator can make the following configuration changes by clicking on the Update (1) button:

• Requires Maximum Budget: If set to Yes, managers or administrators creating an account templates will have to set a maximum budget. In other words, this makes sure manager set a maximum budget when creating an account template.
• Maximum Budget: The maximum budget that an account template can have. Account templates won't be able to have budget higher than this value.
• Maximum Leases Per User: This setting limits the number of active leases a user can have at any point in time. 

Leases shared don't count towards this value

• Requires Maximum Duration: If set to Yes, managers or administrators creating an account templates will have to set a maximum duration. In other words, this makes sure manager set a maximum duration when creating an account template.
• Maximum Duration: The maximum duration that an account template can have. Account templates won't be able to have duration longer than this value.

Terms of Service

An Administrator may wish to get the users of their sandbox accounts to agree to certain Terms of Service before they access their sandbox environments.  An Administrator is able to edit these Terms of Service and also keep a record of previous versions that users agreed too. 

Within the Terms of Service page, the Administrator is able to view (1) the existing terms of service, Edit (2) the terms of service and view the version history (3) of previous versions of Terms of Service.

 

Authentication Settings

In the Authentication Settings section, the Administrator can make the following configuration changes by clicking on the Update button :

• Web App URL: The URL of the application (defaults to Cloud Front Distribution URL or custom domain)
• AWS Access Portal URL: The AWS Access Portal URL for IAM Identity Center SSO
• Session Duration: The duration of the session in minutes
• IDP Sign In URL: The IDP Sign In URL for IAM Identity Center SSO
• IDP Sign Out URL: The IDP Sign Out URL for IAM Identity Center SSO
• IDP Audience: The IDP Audience Identifier for IAM Identity Center SSO

Changing those settings may break your Sandbox Studio installation, please update carefully!

Account Monitoring

In the Account Monitoring section, the Administrator can trigger the following checks manually:

• Lease Monitoring: Active accounts i.e. accounts associated with a lease are checked hourly to determine if the budget or expiry date has been reached. However if you wish to check the current status - you can press the Start Lease Monitoring buttons to run a check immediately.
• Account Drift Monitoring: All AWS accounts are periodically checked to ensure they remain in sync with Sandbox Studio. This includes verifying their AWS Organisation Unit and permissions. Click on the Detect Drift to run this check immediately.

Display Settings

 

Please refer to UI Customisation for more details about Display Settings.

Email Settings

As an Administrator you have control over what and how notifications are sent. From the left hand menu, select Settings > Email Settings (1):

Two tabs are available:

2. Delivery Settings: Allows to configure how emails are sent, either through Amazon Simple Email Service (SES) or through a standard SMTP server.
3. Notifications: Allows to select what notifications are sent to users, managers or approvers. In the current version of Sandbox Studio, this settings applies for all users.

Delivery Settings

Configure SMTP server

Select SMTP Server Set the SMTP Server address SMTP Port SMTP Username SMTP Password Use TLS for authentication

Configure Simple Email Service (SES)

For SES to work, you need to have a verified identity in your SES environment in the Hub account. More details here: https://docs.aws.amazon.com/ses/latest/dg/verify-addresses-and-domains.html

This verified identity needs to:

• Be able to send e-mails from the "Email From" e-mail address
• Be able to send e-mails to the Sandbox Studio users

We recommend having a domain verified identity and have your environment out of the SES Sandbox. https://docs.aws.amazon.com/ses/latest/dg/request-production-access.html

Notifications

In the notification tab, you can select the notifications you want Sandbox Studio to send. Those notifications can be for leases lifecycle (Lease created, lease shared, ...), for events (Event created, event started, etc.) but also for administrative tasks (ie: account failed setup, or account failed cleanup) 

In this version of Sandbox Studio, the modifications on the notifications will apply for ALL users. eg: if you disable the notifications for leases, no user will receive notification for when leases are created.

Cleaner Settings

An Administrator is able to control and change the way that the AWS Accounts are cleaned/recycled at the end of a lease.  This is task is completed by an open-source tool called AWS Nuke.  However, in some instances an Administrator may wish to modify the way that the accounts are cleaned to preserve or delete certain resources.  This can be done through the Cleaner Settings (1) menu on the left hand menu.

 

1. AWS Nuke Binary URL: URL of the Linux aws-nuke binary used for account cleanup. This allows you to use the latest available AWS Nuke version as soon as it's released.
   

You can find the latest releases links here: https://github.com/ekristen/aws-nuke/releases

Distribution: Linux, AMD64

2. Max Failed Cleanup Attempts: In certain circumstances, AWS Nuke fails to cleanup resources from the first try. Sandbox Studio to retry on error. This setting help defines how many times it needs to retry.
3. Retry Wait Time: Time to wait between retries when cleanup fails.
4. Successful Attempts Required: Number of successful cleanup to execute before Sandbox Studio marks the cleanup as successful. In this example, Nuke will run 2 times and if both execution succeed, the account will be marked as successfully cleaned up.
5. Success Wait Time: The number of seconds to wait before rerunning a successful attempt
6. AWS Nuke Configuration

Refer to AWS Nuke documentation for more details. 

Subscription

On the Subscription page, an Administrator can view their Sandbox Studio current licensing entitlements and usage.

Subscription page

The Subscription page shows the current status of the licence, how many AWS accounts are allowed, the API key used to connect to Sandbox Studio for updates and the duration of the licence. 

• It is possible to add or edit the API Key - by clicking on the Update button. 

Account Usage

On the account usage page, the Administrator can view how many accounts are in use and what the maximum number of AWS accounts are allowed.