@aws-sdk/客户端-网络-防火墙

说明

JavaScript Network Firewall客户端的 AWS SDK 为Node.js, 浏览器和 React Industrial 服务.

这是防火墙网络的API参考. 此指南适用于需要的开发者 关于网络防火墙 API 动作、数据类型和错误的详细信息.

REST API 要求您处理连接细节, 如计算 签名、处理请求重试和错误处理。 供参考 关于使用 Amazon 网络服务 REST APIS, 请参见 亚马逊网络服务 APIs。 。 。 .

要查看可使用网络防火墙的亚马逊网络服务区域的完整列表,请参见 服务 终点和配额 输入 亚马逊网络服务概况 参考文献。 。 。 .

要使用 IPv4 REST API 端点访问网络防火墙 : https://network-firewall..amazonaws.com

要使用 Dualstack (IPv4 和 IPv6) REST API 端点访问网络防火墙 : https://network-firewall..aws.api

或者,您可以使用亚马逊网络服务 SDK 访问一个适合 您使用的编程语言或平台。 更多信息见 亚马逊网络服务 SDKs。 。 。 .

关于防火墙网络特征的说明,包括和逐步 关于如何通过防火墙网络控制台使用这些工具的指令,参见 网络防火墙开发者 指南。 。 。 .

防火墙网络是一个状态良好、管理良好、网络防火墙和入侵探测 为亚马逊虚拟私人云提供预防服务(Amazon VPC). 通过防火墙网络,您可以过滤流量 你VPC的周边。 包括过滤进出互联网的流量 网关,NAT网关,或超过VPN或直接连接. 网络防火墙使用兼容的规则 与Suricata,自由开源网络分析和威胁检测引擎. 网络防火墙支持Suricata版本8.0.3. 关于苏里卡塔的资料, 见 苏里卡塔网站 编辑 苏里卡塔用户指南。 。 。 .

您可以使用网络防火墙以多种方式监测和保护您的VPC流量. 以下是几个例子:

• 允许已知的亚马逊网络服务端点, 如亚马逊 S3 的域名或IP地址 封锁所有其他形式的交通.

• 使用已知不良域的自定义列表来限制您的域名类型 应用程序可以访问.

• 对进出你的VPC的交通进行深入检查.

• 使用状态协议检测来过滤像 HTTPS 这样的协议, 不管 已使用端口 .

要为您的 VPC 启用防火墙网络, 您要在 Amazon VPC 和 Amazon VPC 中执行步骤 防火墙网络. 关于使用Amazon VPC的信息,参见 亚马逊 VPC 用户指南。 。 。 .

要开始使用防火墙网络,请做以下操作:

1. (备选) 如果您还没有想要保护的 VPC , 请在 亚马逊VPC.

2. 在亚马逊 VPC中,在每一个可用区中,你想要有一个防火墙端点,创建一个 仅供防火墙网络使用的子网.

3. 在网络防火墙中,定义防火墙行为如下:

   1. 建立无国籍和状态的统治集团, 定义您想要的防火墙的网络流量过滤行为.

   2. 创建防火墙政策,使用您的规则组和 指定额外的默认流量过滤行为.

4. 在网络防火墙中,创建防火墙并指定您的新防火墙政策和 VPC子网. 网络防火墙在您每个子网中创建防火墙端点 指定在防火墙政策中定义的行为.

5. 在亚马逊VPC中,通过新的防火墙使用入侵路线增强路由流量 结束点.

在您的防火墙建立后, 您可以遵循 Amazon VPC 设置的先行步骤, 为新的可用区添加防火墙端点 防火墙子网定义. 您也可以在防火墙中使用的可用区域中添加端点, 也可以用于同一个 VPC 或针对另一个VPC,通过遵循亚马逊VPC设置的先行步骤,并将新的VPC子网定义为VPC端点协会.

安装

要安装此软件包, 请使用您最喜欢的软件包管理器的 CLI :

• npm install @aws-sdk/client-network-firewall
• yarn add @aws-sdk/client-network-firewall
• pnpm add @aws-sdk/client-network-firewall

开始

导入

AWS SDK由客户端和命令进行调制. 要发送请求,只需导入 NetworkFirewallClient 财务报告和审定财务报表 例如,您需要的命令 ListProxiesCommand数字 :

// ES5 example
const { NetworkFirewallClient, ListProxiesCommand } = require("@aws-sdk/client-network-firewall");

// ES6+ example
import { NetworkFirewallClient, ListProxiesCommand } from "@aws-sdk/client-network-firewall";

使用量

发出请求:

• 以配置(如证书,区域)为客户端提供证据.
  • 见 文件/中心 用于配置细节.
  • 见 @aws- sdk/ 配置 附加选项.
• 以输入参数证明命令 .
• 打电话 send 操作客户端,以输入方式提供命令对象.

const client = new NetworkFirewallClient({ region: "REGION" });

const params = { /** input parameters */ };
const command = new ListProxiesCommand(params);

自动/等待

我们建议使用 等待时 运算符等待通过发送操作返回的承诺如下:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

承诺

您还可以使用 承诺连锁。 。 。 .

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

合并客户端

归集客户端类别从同套件中导出,但没有"Client"后缀.

NetworkFirewall 扩展 NetworkFirewallClient 并额外支持所有操作,服务员, 和活人作为方法. 这种风格可能从JavaScript v2的AWS SDK中为您所熟悉.

如果你正在捆绑 AWS SDK, 我们建议只使用赤骨客户端(NetworkFirewallClient) (中文(简体) ). 更多详情见博客文章: javaScript 的 AWS SDK 模块包。 。 。 .

import { NetworkFirewall } from "@aws-sdk/client-network-firewall";

const client = new NetworkFirewall({ region: "REGION" });

// async/await.
try {
  const data = await client.listProxies(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listProxies(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks (not recommended).
client.listProxies(params, (err, data) => {
  // process err and data.
});

解决问题

当服务返回例外时,错误将包括例外信息, 以及响应元数据(如请求编号).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

另见 文档/错误。 。 。 .

获取帮助

请利用这些社区资源获得帮助. 我们使用 GitHub 问题来跟踪错误和特性请求,但处理它们的带宽有限.

• 访问 开发者指南 或者说 API 参考。 。 。 .
• 看看贴有标签的博客文章 aws-sdk-js aWS 开发者博客.
• 问个问题 叠叠流 并贴上标签 aws-sdk-js。 。 。 .
• 加入 AWS JavaScript 社区 发光。 。 。 .
• 如果你发现你发现了一个虫子,请 打开一个问题。 。 。 .

为了测试您在Node.js中通用的JavaScript代码,浏览器和反应本地环境, 拜访我们 代码样本 repo。 。 。 .

捐款

此客户端代码是自动生成的. 任何修改在下次修改时都会被覆盖 @aws-sdk/client-network-firewall 软件包正在更新. 为了帮助客户,你可以检查我们 生成客户端脚本。 。 。 .

许可证

此 SDK 分布于 Apache 许可证,2.0版本, (中文(简体) ), 更多信息见LICENSE.

客户端命令( 操作列表)