什么是 aws-cognito-idp-userpool-domain?
在使用 Amazon Cognito 用户池时,您可以使用自己的域名来定制和调整用户池的登录和注册界面。aws-cognito-idp-userpool-domain
npm 包是一个 Node.js 模块,用于与 AWS Cognito 用户池自定义域名进行交互,它提供了创建、删除以及引用用户池自定义域名等功能,使操作更加方便。
安装 aws-cognito-idp-userpool-domain
aws-cognito-idp-userpool-domain
可以通过 npm 进行安装,在命令行中键入以下命令进行安装:
--- ------- -------------------------------
使用 aws-cognito-idp-userpool-domain
要使用 aws-cognito-idp-userpool-domain
npm 包,您需要先获取 AWS Cognito 用户池的管理员凭证。若还没有管理员凭证,可以从 AWS 管理控制台进行创建。
所有的函数均返回一个包含一个 Promise
的对象,如果操作成功,Promise
的状态会变为 resolved
,失败则为 rejected
。以下是一些可用的函数和例子:
createDomain(params)
createDomain
函数用于创建一个 AWS Cognito 用户池的自定义域名。params
是一个需包含以下内容的对象:
Domain
: 自定义域名的名称。UserPoolId
: 用户池的唯一 ID(字符串)。CertificateArn
: SSL 证书的 Amazon 资源名称(ARN)。SubDomain
: CNAME 记录的别名。
----- --- - ------------------- ----- - ------------------------------- ------- - - ---- ----- - ------------ - - ------------------------------------------- ------------------- ------- ----------- --- ----- ------- - --- --------- ----------- ------------ --- -------------- ----------- -------------------- --------------- ----------------------- ------- ------------ ---------- ------- -- -------------- -- -------------------- ------------ -- --------------------
deleteDomain(params)
deleteDomain
函数用于删除 AWS Cognito 用户池的自定义域名。params
是一个包含以下内容的对象:
Domain
: 自定义域名的名称。UserPoolId
: 用户池的唯一 ID(字符串)。
----- --- - ------------------- ----- - ------------------------------- ------- - - ---- ----- - ------------ - - ------------------------------------------- ------------------- ------- ----------- --- ----- ------- - --- --------- ----------- ------------ --- -------------- ----------- -------------------- ------- ------------ -- -------------- -- -------------------- ------------ -- --------------------
describeDomain(params)
describeDomain
函数用于获取 AWS Cognito 用户池的自定义域名的详细信息。params
是一个包含以下内容的对象:
Domain
: 自定义域名的名称。UserPoolId
: 用户池的唯一 ID(字符串)。
----- --- - ------------------- ----- - ------------------------------- ------- - - ---- ----- - -------------- - - ------------------------------------------- ------------------- ------- ----------- --- ----- ------- - --- --------- ----------- ------------ --- ---------------- ----------- -------------------- ------- ------------ -- -------------- -- -------------------- ------------ -- --------------------
总结
以上就是 aws-cognito-idp-userpool-domain
这个 npm 包的使用方法和说明。对于使用 AWS Cognito 用户池进行身份验证的应用程序,使用自定义域名可以提供更好的用户体验和更好的品牌认可度。aws-cognito-idp-userpool-domain
的出现,大大方便了与 AWS Cognito 用户池自定义域名进行交互的操作,我们在实际开发中可以更加得心应手。
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/600668ecd9381d61a3540c86