AWS CloudFormation
User Guide (API Version 2010-05-15)
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。请点击 Amazon AWS 入门,可查看中国地区的具体差异

AWS::Cognito::IdentityPool

AWS::Cognito::IdentityPool 资源创建一个 Amazon Cognito 身份池。

语法

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

JSON

{ "Type" : "AWS::Cognito::IdentityPool", "Properties" : { "IdentityPoolName" : String, "AllowUnauthenticatedIdentities" : Boolean, "DeveloperProviderName" : String, "SupportedLoginProviders" : { 字符串字符串, ... }, "CognitoIdentityProviders" : [ Amazon Cognito IdentityPool CognitoIdentityProvider ], "SamlProviderARNs" : [ String, ... ], "OpenIdConnectProviderARNs" : [ String, ... ], "CognitoStreams" : CognitoStreams, "PushSync" : PushSync, "CognitoEvents" : { 字符串字符串, ... } } }

YAML

Type: "AWS::Cognito::IdentityPool" Properties: IdentityPoolName: String AllowUnauthenticatedIdentities: Boolean DeveloperProviderName: String SupportedLoginProviders: 字符串字符串 CognitoIdentityProviders: - Amazon Cognito IdentityPool CognitoIdentityProvider SamlProviderARNs: - 字符串 OpenIdConnectProviderARNs: - 字符串 CognitoStreams: - CognitoStreams PushSync: - PushSync CognitoEvents: 字符串字符串

属性

IdentityPoolName

Amazon Cognito 身份池的名称。

Required: No

Type: String

更新要求无需中断

MinLength: 1

MaxLength: 128

AllowUnauthenticatedIdentities

指定身份池是否支持未进行身份验证的登录。

Required: Yes

Type: Boolean

更新要求无需中断

DeveloperProviderName

供 Amazon Cognito 引用您的用户的“域”。该名称用作占位符,以便您的后端与 Amazon Cognito 服务沟通开发人员提供商的相关信息。对于 DeveloperProviderName,您可以使用字母和句点 (.)、下划线 (_) 和短划线 (-)。

Required: No

Type: String

更新要求无需中断

MinLength: 1

MaxLength: 100

SupportedLoginProviders

将提供商名称映射到提供商应用程序 ID 的键值对。

Required: No

类型:字符串到字符串映射

更新要求无需中断

CognitoIdentityProviders

Amazon Cognito 用户池及其客户端 ID 的数组。

Required: No

类型Amazon Cognito IdentityPool CognitoIdentityProvider 数组。

更新要求无需中断

SamlProviderARNs

安全断言标记语言 (SAML) 提供商的 Amazon 资源名称 (ARN) 的列表。

Required: No

Type: List of String values

更新要求无需中断

OpenIdConnectProviderARNs

OpendID Connect 提供商的 ARN 的列表。

Required: No

Type: List of String values

更新要求无需中断

CognitoStreams

用于配置 Amazon Cognito 流的配置选项。

Required: No

类型Amazon Cognito IdentityPool CognitoStreams

更新要求无需中断

PushSync

要应用于身份池的配置选项。

Required: No

类型Amazon Cognito IdentityPool PushSync

更新要求无需中断

CognitoEvents

要配置的事件。

Required: No

类型:字符串到字符串映射

更新要求无需中断

返回值

Ref

如果向 Ref 内部函数提供此资源的逻辑 ID,Ref 将返回 IdentityPoolId,如 us-east-2:0d01f4d7-1305-4408-b437-12345EXAMPLE

有关使用 Ref 功能的更多信息,请参阅参考

Fn::GetAtt

Fn::GetAtt 返回一个此类型指定属性的值。以下为可用属性和示例返回值。

Name

Amazon Cognito 身份池的名称,以字符串形式返回。

有关使用 Fn::GetAtt 的更多信息,请参见 Fn::GetAtt

本页内容: