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

AWS::Cognito::UserPoolUICustomizationAttachment

AWS::Cognito::UserPoolUICustomizationAttachment 资源设置用户池的内置应用程序 UI 的 UI 自定义信息。

您可以为单个客户端 (具有特定的 clientId) 或为所有客户端 (通过将 clientId 设置为 ALL) 指定应用程序 UI 自定义设置。如果您指定 ALL,则将对之前未设置 UI 自定义项的所有客户端使用默认配置。如果您为某个特定客户端指定了 UI 自定义设置,则该客户端将无法再回退到 ALL 配置。

注意

在创建此资源之前,您的用户池必须具有一个与之关联的域。可以在此用户池中创建 AWS::Cognito::UserPoolDomain 资源。

不支持从 AWS CloudFormation 中设置徽标图像。请使用 Amazon Cognito SetUICustomization API 操作设置图像。

语法

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

JSON

{ "Type" : "AWS::Cognito::UserPoolUICustomizationAttachment", "Properties" : { "ClientId" : String, "CSS" : String, "UserPoolId" : String } }

YAML

Type: AWS::Cognito::UserPoolUICustomizationAttachment Properties: ClientId: String CSS: String UserPoolId: String

属性

ClientId

客户端应用程序的客户端 ID。您可以为单个客户端(具有特定的 clientId)或所有客户端(通过将 clientId 设置为 ALL)指定 UI 自定义设置。

必需:是

类型:字符串

最低1

最高128

模式[\w+]+

Update requires: Replacement

CSS

UI 自定义项中的 CSS 值。

必需:否

类型:字符串

Update requires: No interruption

UserPoolId

用户池的用户池 ID。

必需:是

类型:字符串

最低1

最高55

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

Update requires: Replacement

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回 physicalResourceId,即“UserPoolUICustomizationAttachment-UserPoolId-ClientId”。例如:

{ "Ref": "UserPoolUICustomizationAttachment-us-east-1_FAKEPOOLID-2asc123fakeclientidajjulj6bh" }

对于 Amazon Cognito 用户池域 UserPoolUICustomizationAttachment-us-east-1_FAKEPOOLID-2asc123fakeclientidajjulj6bh,Ref 将返回 UI 自定义附件的名称。

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

示例

为用户池创建新的 UI 自定义附件

以下示例在引用的用户池和客户端中设置 UI 自定义设置。

JSON

{ "UserPoolUICustomization":{ "Type":"AWS::Cognito::UserPoolUICustomizationAttachment", "Properties":{ "UserPoolId":{ "Ref":"UserPool" }, "ClientId":{ "Ref":"Client" }, "CSS":".banner-customizable {\nbackground: linear-gradient(#9940B8, #C27BDB)\n}" } } }

YAML

UserPoolUICustomization: Type: AWS::Cognito::UserPoolUICustomizationAttachment Properties: UserPoolId: !Ref UserPool ClientId: !Ref Client CSS: ".banner-customizable { background: linear-gradient(#9940B8, #C27BDB) }"