AWS::Cognito::IdentityPool - AWS CloudFormation
構文プロパティ戻り値

AWS::Cognito::IdentityPool

AWS::Cognito::IdentityPool リソースによって Amazon Cognito ID プールが作成されます。

AWS CloudFormation から誤ってリソースを削除しないようにするには、DeletionPolicy 属性と UpdateReplacePolicy 属性を使用して、削除または置換時にリソースを保持します。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

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

プロパティ

AllowClassicFlow

基本 (Classic) 認証フローを有効にします。

必須: いいえ

タイプ: ブール値

Update requires: No interruption

AllowUnauthenticatedIdentities

ID プールが認証されていないログインをサポートするかどうかを指定します。

必須: はい

タイプ: ブール値

Update requires: No interruption

CognitoEvents

設定するイベント。

必須: いいえ

タイプ: Json

Update requires: No interruption

CognitoIdentityProviders

Amazon Cognito ユーザープールとそのクライアント ID。

必須: いいえ

タイプ: CognitoIdentityProvider のリスト

Update requires: No interruption

CognitoStreams

Amazon Cognito ストリームを設定するための設定オプション。

必須: いいえ

タイプ: CognitoStreams

Update requires: No interruption

DeveloperProviderName

Amazon Cognito がユーザーを参照するときに使用する「ドメイン」。この名前は、バックエンドと Amazon Cognito サービスがデベロッパープロバイダーについて通信できるようにするプレースホルダーとして機能します。DeveloperProviderName では、文字、ピリオド (.)、アンダースコア (_)、ダッシュ (-) を使用できます。

最小長: 1

最大長: 100

必須: いいえ

タイプ: 文字列

Update requires: No interruption

IdentityPoolName

Amazon Cognito ID プールの名前。

最小長: 1

最大長: 128

パターン: [\w\s+=,.@-]+

必須: いいえ

タイプ: 文字列

Update requires: No interruption

OpenIdConnectProviderARNs

OpenID の Amazon リソースネーム (ARN) はプロバイダーを接続します。

必須: いいえ

タイプ: 文字列のリスト

Update requires: No interruption

PushSync

ID プールに適用する設定オプション。

必須: いいえ

タイプ: PushSync

Update requires: No interruption

SamlProviderARNs

Security Assertion Markup Language (SAML) プロバイダーの Amazon リソースネーム (ARN)。

必須: いいえ

タイプ: 文字列のリスト

Update requires: No interruption

SupportedLoginProviders

プロバイダー名をプロバイダーのアプリ ID にマッピングするキーと値のペア。

必須: いいえ

タイプ: Json

Update requires: No interruption

戻り値

参照番号

us-east-2:0d01f4d7-1305-4408-b437-12345EXAMPLE などの、IdentityPoolId このリソースの論理 ID を組み込みの Ref 関数に渡すと、Ref は次を返します: 。

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

Fn::GetAtt

Fn::GetAtt 組み込み関数は、このタイプの指定された属性の値を返します。以下には、利用可能な属性とサンプル戻り値のリストが示されます。

Fn::GetAtt 組み込み関数の使用方法の詳細については、「Fn::GetAtt」を参照してください。

Name

文字列として返される Amazon Cognito ID プールの名前。