AWS::Cognito::UserPoolResourceServer - AWS CloudFormation
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS::Cognito::UserPoolResourceServer

AWS::Cognito::UserPoolResourceServer 资源创建新的 OAuth2.0 资源服务器,并在其中定义自定义范围。

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

{ "Type" : "AWS::Cognito::UserPoolResourceServer", "Properties" : { "Identifier" : String, "Name" : String, "Scopes" : [ ResourceServerScopeType, ... ], "UserPoolId" : String } }

YAML

Type: AWS::Cognito::UserPoolResourceServer Properties: Identifier: String Name: String Scopes: - ResourceServerScopeType UserPoolId: String

属性

Identifier

资源服务器的唯一资源服务器标识符。这可能是资源服务器所在的 HTTPS 终端节点。例如:https://my-weather-api.example.com

必需:是

类型:字符串

最低1

最高256

模式[\x21\x23-\x5B\x5D-\x7E]+

Update requires: Replacement

Name

资源服务器的友好名称。

必需:是

类型:字符串

最低1

最高256

模式[\w\s+=,.@-]+

Update requires: No interruption

Scopes

范围。每个范围是一个映射,其中范围的键是 name,值是 description

必需:否

类型ResourceServerScopeType 的列表

最高100

Update requires: No interruption

UserPoolId

用户池的用户池 ID。

必需:是

类型:字符串

最低1

最高55

模式[\w-]+_[0-9a-zA-Z]+

Update requires: Replacement

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回 physicalResourceId,即资源服务器标识符“Identifier”。例如:

{ "Ref": "yourResourceServerIdentifier" }

对于 Amazon Cognito 资源服务器 yourResourceServerIdentifier,Ref 将返回该资源服务器的名称。

For more information about using the Ref function, see Ref.

示例

为用户池创建新的资源服务器

以下示例在引用的用户池中创建具有标识符“Identifier”的资源服务器“Name”。

JSON

{ "UserPoolResourceServer": { "Type": "AWS::Cognito::UserPoolResourceServer", "Properties": { "UserPoolId": { "Ref": "UserPool" }, "Identifier": "Identifier", "Name": "Name", "Scopes": [{ "ScopeName": "ScopeName1", "ScopeDescription": "description" }, { "ScopeName": "ScopeName2", "ScopeDescription": "description" }] } } }

YAML

UserPoolResourceServer: Type: AWS::Cognito::UserPoolResourceServer Properties: UserPoolId: !Ref UserPool Identifier: "Identifier" Name: "Name" Scopes: - ScopeName: "ScopeName1" ScopeDescription: "description" - ScopeName: "ScopeName2" ScopeDescription: "description"