AWS::Cognito::UserPoolUICustomizationAttachment - AWS CloudFormation

AWS::Cognito::UserPoolUICustomizationAttachment

AWS::Cognito::UserPoolUICustomizationAttachment リソースは、ユーザープールの組み込みアプリ UI の UI のカスタマイズ情報を設定します。

単一のクライアント (clientId) またはすべてのクライアント (clientIdALL に設定) にアプリ 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

戻り値

参照番号

このリソースの論理 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) }"