Skip to content

Commit 39b5a5e

Browse files
Update synchronize-aws-gateway-apis.md
1 parent 2a28c48 commit 39b5a5e

1 file changed

Lines changed: 23 additions & 18 deletions

File tree

articles/api-center/synchronize-aws-gateway-apis.md

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Integrate an Amazon API Gateway to Azure API Center for automatic s
44
author: dlepow
55
ms.service: azure-api-center
66
ms.topic: how-to
7-
ms.date: 06/02/2025
7+
ms.date: 01/21/2026
88
ms.author: danlep
99
ms.custom:
1010
- devx-track-azurecli
@@ -24,9 +24,9 @@ Integrating Amazon API Gateway as an API source for your API center enables cont
2424

2525
When you integrate an Amazon API Gateway as an API source, the following happens:
2626

27-
1. APIs, and optionally API definitions (specs), from the API Gateway are added to the API center inventory.
27+
1. The API center inventory adds APIs, and optionally API definitions (specs), from the API Gateway.
2828
1. You configure an [environment](key-concepts.md#environment) of type *Amazon API Gateway* in the API center.
29-
1. An associated [deployment](key-concepts.md#deployment) is created for each synchronized API definition.
29+
1. You create an associated [deployment](key-concepts.md#deployment) for each synchronized API definition.
3030

3131
Synchronization is one-way from Amazon API Gateway to your Azure API center, meaning API updates in the API center aren't synchronized back to Amazon API Gateway.
3232

@@ -42,9 +42,9 @@ Synchronization is one-way from Amazon API Gateway to your Azure API center, mea
4242

4343
## Prerequisites
4444

45-
* An API center in your Azure subscription. If you haven't created one, see [Quickstart: Create your API center](set-up-api-center.md).
45+
* An API center in your Azure subscription. If you didn't create one, see [Quickstart: Create your API center](set-up-api-center.md).
4646

47-
* An Azure key vault. If you need to create one, see [Quickstart: Create a key vault using the Azure portal](/azure/key-vault/general/quick-create-portal). To add or manage secrets in the key vault, at least the **Key Vault Secrets Officer** role or equivalent permissions are required.
47+
* An Azure key vault. If you need to create one, see [Quickstart: Create a key vault using the Azure portal](/azure/key-vault/general/quick-create-portal). To add or manage secrets in the key vault, you need at least the **Key Vault Secrets Officer** role or equivalent permissions.
4848

4949
* An [Amazon API Gateway](https://docs.aws.amazon.com/apigateway/).
5050

@@ -56,22 +56,22 @@ Synchronization is one-way from Amazon API Gateway to your Azure API center, mea
5656
[!INCLUDE [install-apic-extension](includes/install-apic-extension.md)]
5757

5858
> [!NOTE]
59-
> Azure CLI command examples in this article can run in PowerShell or a bash shell. Where needed because of different variable syntax, separate command examples are provided for the two shells.
59+
> You can run Azure CLI command examples in this article in PowerShell or a bash shell. Where needed because of different variable syntax, separate command examples are provided for the two shells.
6060
6161
## Create IAM user access keys
6262

6363
To authenticate your API center to Amazon API Gateway, you need access keys for an AWS IAM user.
6464

65-
To generate the required access key ID and secret key using the AWS Management Console, see [Create an access key for yourself](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-key-self-managed.html#Using_CreateAccessKey) in the AWS documentation.
65+
To generate the required access key ID and secret key by using the AWS Management Console, see [Create an access key for yourself](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-key-self-managed.html#Using_CreateAccessKey) in the AWS documentation.
6666

6767
Save your access keys in a safe location. You'll store them in Azure Key Vault in the next steps.
6868

6969
> [!CAUTION]
70-
> Access keys are long-term credentials, and you should manage them as securely as you would a password. Learn more about [securing access keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/securing_access-keys.html)
70+
> Access keys are long-term credentials. Manage them as securely as you would a password. Learn more about [securing access keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/securing_access-keys.html)
7171
7272
## Store IAM user access keys in Azure Key Vault
7373

74-
Manually upload and securely store the two IAM user access keys in Azure Key Vault using the configuration recommended in the following table. For more information, see [Quickstart: Set and retrieve a secret from Azure Key Vault using the Azure portal](/azure/key-vault/secrets/quick-create-portal).
74+
Manually upload and securely store the two IAM user access keys in Azure Key Vault by using the configuration recommended in the following table. For more information, see [Quickstart: Set and retrieve a secret from Azure Key Vault using the Azure portal](/azure/key-vault/secrets/quick-create-portal).
7575

7676

7777
| AWS secret | Upload options | Name | Secret value |
@@ -81,7 +81,7 @@ Manually upload and securely store the two IAM user access keys in Azure Key Vau
8181

8282
:::image type="content" source="media/synchronize-aws-gateway-apis/key-vault-secrets.png" alt-text="Screenshot of secrets list in Azure Key Vault in the portal.":::
8383

84-
Take note of the **Secret identifier** of each secret, a URI similar to `https://<key-vault-name>.vault.azure.net/secrets/<secret-name>`. You'll use these identifiers in the next steps.
84+
Take note of the **Secret identifier** of each secret, a URI similar to `https://<key-vault-name>.vault.azure.net/secrets/<secret-name>`. You use these identifiers in the next steps.
8585

8686

8787
[!INCLUDE [enable-managed-identity](includes/enable-managed-identity.md)]
@@ -93,19 +93,19 @@ Take note of the **Secret identifier** of each secret, a URI similar to `https:/
9393

9494
## Integrate an Amazon API Gateway
9595

96-
You can integrate an Amazon API Gateway using the portal or the Azure CLI.
96+
You can integrate an Amazon API Gateway by using the portal or the Azure CLI.
9797

9898
#### [Portal](#tab/portal)
99-
1. In the [portal](https://portal.azure.com), navigate to your API center.
99+
1. In the [portal](https://portal.azure.com), go to your API center.
100100
1. Under **Platforms**, select **Integrations**.
101101
1. Select **+ New integration** > **From Amazon API Gateway**.
102-
1. In the **Integrate your Amazon API Gateway Service** page:
103-
1. For the **AWS access key** and **AWS secret access key**, click **Select** and select the subscription, key vault, secret that you stored.
104-
1. Select the **AWS region** where the Amazon API Gateway is deployed.
102+
1. In **Integrate your Amazon API Gateway Service**:
103+
1. For the **AWS access key** and **AWS secret access key**, select **Select** and choose the subscription, key vault, and secret that you stored.
104+
1. Select the **AWS region** where you deployed the Amazon API Gateway.
105105
1. In **Integration details**, enter an identifier.
106106
1. In **Environment details**, enter an **Environment title** (name), **Environment type**, and optional **Description**.
107107
1. In **API Details**:
108-
1. Select a **Lifecycle** for the synchronized APIs. (You can update this value for the APIs after they're added to your API center.)
108+
1. Select a **Lifecycle** for the synchronized APIs. (You can update this value for the APIs after you add them to your API center.)
109109
1. Optionally, select whether to include API definitions with the synchronized APIs.
110110
1. Select **Create**.
111111

@@ -116,9 +116,14 @@ You can integrate an Amazon API Gateway using the portal or the Azure CLI.
116116

117117
Run the [az apic integration create aws](/cli/azure/apic/integration/create#az-apic-integration-create-aws) (preview) command to integrate an Amazon API Gateway to your API center.
118118

119+
> [!NOTE]
120+
>
121+
> * This command is only available in the preview version of the APIC extension.
122+
> * Install the new preview version before using this command.
123+
119124
* Provide the names of the resource group, API center, and integration.
120125

121-
* Provide the Key Vault secret identifiers for the AWS access key and secret access key, and the AWS region where the Amazon API Gateway is deployed.
126+
* Provide the Key Vault secret identifiers for the AWS access key and secret access key, and the AWS region where you deployed the Amazon API Gateway.
122127

123128
```azurecli
124129
az apic integration create aws \
@@ -131,7 +136,7 @@ az apic integration create aws \
131136
```
132137
---
133138

134-
The environment is added in your API center. The Amazon API Gateway APIs are imported to the API center inventory.
139+
The environment is added to your API center. The Amazon API Gateway APIs are imported to the API center inventory.
135140

136141
[!INCLUDE [delete-api-integration](includes/delete-api-integration.md)]
137142

0 commit comments

Comments
 (0)