Working with gateways

To create a gateway:

1. Open the Amazon Backup console at https://console.amazonaws.cn/backup.

2. In the left navigation pane, under the External resources section, choose Gateways.

3. Choose Create gateway.

4. In the Set up gateway section, follow these instructions to download and deploy the OVF template.

Once the VMWare software is downloaded, complete the following steps:

1. In the Gateway connection section, type in the IP address of the gateway.

   1. To find this IP address, go to the vSphere Client.

   2. Select your gateway under the Summary tab.

   3. Copy the IP address and paste it in the Amazon Backup console text bar.

2. In the Gateway settings section,

   1. Type in a Gateway name.

   2. Verify the Amazon Region.

   3. Choose whether the endpoint is publicly accessible or hosted with your virtual private cloud (VPC).

   4. Depending on the endpoint chosen, enter the VPC endpoint DNS Name.

      For more information, see Create a VPC endpoint.

3. [Optional] In the Gateway tags section, you can assign tags by inputting the key and optional value. To add more than one tag, click Add another tag.

4. To complete the process, click Create gateway, which takes you to the gateway detail page.

Getting an activation key using local console

The following examples show you how to get an activation key using gateway host's local console

1. Log in to your virtual machine console.

2. From the Amazon Appliance Activation - Configuration main menu, select 0 to choose Get activation key

3. Select 2 Backup Gateway for gateway family option

4. Enter the Amazon Region where you want to activate your gateway

5. For network type, enter 1 for Public or 2 for VPC endpoint

6. For endpoint type, enter 1 for standard endpoint or 2 for dual-stack endpoint

   1. For dual-stack endpoint, select 1 for IPv4 or 2 for IPv6

7. Activation key will be populated automatically

1. Obtain activation key using curl commands or local console method

2. Create gateway using Amazon CLI, for more information, see CreateGateway in the Backup gateway API Reference.

   aws backup-gateway create-gateway \
                       --region region_code \
                       --activation-key activation_key \
                       --gateway-display-name gateway_name \
                       --gateway-type BACKUP_VM

3. Verify gateway appears in Amazon Backup console under External Resources → Gateways

To edit or delete a gateway:

1. In the left navigation pane, under the External resources section, choose Gateways.

2. In the Gateways section, choose a gateway by its Gateway name.

3. To edit the gateway name, choose Edit.

4. To delete the gateway, choose Delete, then choose Delete gateway.

   You cannot reactivate a deleted gateway. If you want to connect to the hypervisor again, follow the procedure in Creating a gateway .

5. To connect to a hypervisor, in the Connected hypervisor section, choose Connect.

   Each gateway connects to a single hypervisor. However, you can connect multiple gateways to the same hypervisor to increase the bandwidth between them beyond that of the first gateway.

6. To assign, edit, or manage tags, in the Tags section, choose Manage tags.

To view and edit the bandwidth rate limit schedule

1. Open the Amazon Backup console at https://console.amazonaws.cn/backup.

2. In the left navigation pane, choose Gateways. In the Gateways pane, gateways are displayed by name. Click the radio button adjacent to the gateway name you want to manage.

3. Once you select a radio button, the drop-down menu Action is available to click. Click Actions, then click Edit bandwidth rate limit schedule. The current schedule is displayed. By default, a new or unedited gateway has no defined bandwidth rate limits.

   Note

   You can also click Manage schedule in the gateway details page to navigate to the Edit bandwidth page.

4. (Optional) Choose Add interval to add a new configurable interval to the schedule. For each interval, input the following information:

   1. Days of week — Select the recurring day or days on which you want the interval to apply. When chosen, the days will display below the drop-down menu. You can remove them by clicking the X next to the day.

   2. Start time — Enter the start time for the bandwidth interval, using the HH:MM 24-hour format. Time is rendered in Universal Coordinated Time (UTC).

      Note: Your bandwidth-rate-limit interval begins at the start of the specified minute.

   3. End time — Enter the end time for the bandwidth interval, using the HH:MM 24-hour format. Time is rendered in Universal Coordinated Time (UTC).

      Important

      The bandwidth-rate-limit interval ends at the end of the minute specified. To schedule an interval that ends at the end of an hour, enter 59. To schedule consecutive continuous intervals, transitioning at the start of the hour, with no interruption between the intervals, enter 59 for the end minute of the first interval. Enter 00 for the start minute of the succeeding interval.

   4. Upload rate — Enter the upload rate limit, in megabits per second (Mbps). The minimum value is 102 megabytes per second (Mbps).

5. (Optional) Repeat the previous step as desired until your bandwidth rate-limit schedule is complete. If you need to delete an interval from your schedule, choose Remove.

   Important

   Bandwidth rate-limit intervals cannot overlap. The start time of an interval must occur after the end time of a preceding interval and before the start time of a following interval; its end time must occur before the start time of the following interval.

6. When you are finished, click the Save changes button.