@aws-sdk/客户端-wafv2
说明
JavaScript WAFV2 节点客户端的AWS SDK,浏览器和React Industrial.
妇女论坛
这是最新版本的 妇女论坛 API, (英语), 2019年11月发布. 您访问此 API 所使用的实体名称, 如端点和命名空间,都添加了版本信息,如"V2"或 "v2",与上个版本相区别. 我们建议你们转移资源 这个版本,因为它有一些重大的改进.
如果在本次发布前使用WAF,则无法使用此WAFV2 API访问任何 你之前创造的WAF资源. WAF Classic support将于2025年9月30日结束.
关于WAF的信息,包括如何将你的WAF经典资源迁移到这个版本, 见 WAF 开发者指南。 。 。 .
WAF 是允许您监视 HTTP 和 HTTPS 的网络应用防火墙 被传送到受保护资源的请求。 被保护资源类型包括亚马逊 CloudFront 分布,亚马逊 API Gateway REST API,应用程序负载平衡器, AppSync GraphQL API, Amazon Cognitto用户池, App Runner 服务, Amplify 应用程序,以及 Amazon Web Services 验证访问实例. WAF还允许您控制您的内容访问, 保护亚马逊网络服务资源 WAF正在监控。 基于以下条件: 指定,例如请求来源于的 IP 地址或查询的值 字符串、 受保护资源响应请求, 请求内容或要求的内容, 一个 HTTP 403 状态代码 (禁止),或有自定义响应.
本API指南针对需要WAF API动作详细信息的开发者, 数据类型和错误。 关于世界农联特征和配置及使用指南的详细信息 WAF,见 WAF 开发者 指南。 。 。 .
您可以使用列表的终点拨打 WAF 终点和配额。 。 。 .
-
对于区域资源,您可以使用列表中的任何终点. 一个区域应用程序可以是一个应用程序负载平衡器(ALB),一个亚马逊API Gateway REST API,一个AppSync GraphQL API,一个亚马逊Cognitto用户池,一个App Runner服务,或者一个亚马逊网络服务验证访问实例.
-
对于 Amazon CloudFront 和 Amplify , 您必须使用 API 端点 US East (N. Virginia):我们东一.
或者,您可以使用亚马逊网络服务 SDK 访问一个适应于 您正在使用的编程语言或平台. 更多信息见 亚马逊网络服务 SDKs。 。 。 .
安装
要安装此软件包, 请使用您最喜欢的软件包管理器的 CLI :
npm install @aws-sdk/client-wafv2yarn add @aws-sdk/client-wafv2pnpm add @aws-sdk/client-wafv2
开始
导入
AWS SDK由客户端和命令进行调制.
要发送请求,只需导入 WAFV2Client 财务报告和审定财务报表
例如,您需要的命令 ListAPIKeysCommand数字 :
// ES5 example
const { WAFV2Client, ListAPIKeysCommand } = require("@aws-sdk/client-wafv2");
// ES6+ example
import { WAFV2Client, ListAPIKeysCommand } from "@aws-sdk/client-wafv2";
使用量
发出请求:
- 以配置(如证书,区域)为客户端提供证据.
- 见 文件/中心 用于配置细节.
- 见 @aws- sdk/ 配置 附加选项.
- 以输入参数证明命令 .
- 打电话
send操作客户端,以输入方式提供命令对象.
const client = new WAFV2Client({ region: "REGION" });
const params = { /** input parameters */ };
const command = new ListAPIKeysCommand(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"后缀.
WAFV2 扩展 WAFV2Client 并额外支持所有操作,服务员, 和活人作为方法.
这种风格可能从JavaScript v2的AWS SDK中为您所熟悉.
如果你正在捆绑 AWS SDK, 我们建议只使用赤骨客户端(WAFV2Client) (中文(简体) ).
更多详情见博客文章:
javaScript 的 AWS SDK 模块包。 。 。 .
import { WAFV2 } from "@aws-sdk/client-wafv2";
const client = new WAFV2({ region: "REGION" });
// async/await.
try {
const data = await client.listAPIKeys(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listAPIKeys(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks (not recommended).
client.listAPIKeys(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-jsaWS 开发者博客. - 问个问题 叠叠流 并贴上标签
aws-sdk-js。 。 。 . - 加入 AWS JavaScript 社区 发光。 。 。 .
- 如果你发现你发现了一个虫子,请 打开一个问题。 。 。 .
为了测试您在Node.js中通用的JavaScript代码,浏览器和反应本地环境, 拜访我们 代码样本 repo。 。 。 .
捐款
此客户端代码是自动生成的. 任何修改在下次修改时都会被覆盖 @aws-sdk/client-wafv2 软件包正在更新.
为了帮助客户,你可以检查我们 生成客户端脚本。 。 。 .
许可证
此 SDK 分布于 Apache 许可证,2.0版本, (中文(简体) ), 更多信息见LICENSE.