AWS::Cognito::IdentityPool

AWS::Cognito::IdentityPool リソースは、Amazon Cognito ID プールを作成します。

トピック

構文
プロパティ
戻り値

構文

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

JSON


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

YAML


Type: AWS::Cognito::IdentityPool
Properties:
  IdentityPoolName: String
  AllowUnauthenticatedIdentities: Boolean
  DeveloperProviderName: String
  SupportedLoginProviders: 
    文字列: 文字列
  CognitoIdentityProviders: 
    - CognitoIdentityProvider
  SamlProviderARNs: 
    - 文字列
  OpenIdConnectProviderARNs: 
    - 文字列
  CognitoStreams: 
    - CognitoStreams
  PushSync: 
    - PushSync
  CognitoEvents: 
    文字列: 文字列

プロパティ

各プロパティの詳細 (制約や有効な値など) については、Amazon Cognito フェデレーティッドアイデンティティ API リファレンスの「CreateIdentityPool」を参照してください。

IdentityPoolName

Amazon Cognito ID プールの名前。

Required: No

Type: String

更新に伴う要件: 中断はありません。

MinLength: 1

MaxLength: 128

AllowUnauthenticatedIdentities

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

Required: Yes

Type: Boolean

更新に伴う要件: 中断はありません。

DeveloperProviderName

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

Required: No

Type: String

更新に伴う要件: 中断はありません。

MinLength: 1

MaxLength: 100

SupportedLoginProviders