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
最小長: 1
最大長: 128
パターン:
[\w ]+
更新に伴う要件: 中断はありません。
AllowUnauthenticatedIdentities
-
ID プールが認証されていないログインをサポートするかどうかを指定します。
Required: Yes
Type: Boolean
更新に伴う要件: 中断はありません。
DeveloperProviderName
-
Amazon Cognito がユーザーを参照する「ドメイン」。この名前は、バックエンドと Amazon Cognito サービスがデベロッパープロバイダーについて通信できるようにするプレースホルダーとして機能します。
DeveloperProviderName
では、文字、ピリオド (.
)、アンダースコア (_
)、ダッシュ (-
) を使用できます。Required: No
Type: String
最小長: 1
最大長: 100
更新に伴う要件: 中断はありません。
SupportedLoginProviders
-
プロバイダー名をプロバイダーのアプリ ID にマッピングするキーと値のペア。
Required: No
タイプ: 文字列から文字列へのマッピング
更新に伴う要件: 中断はありません。
CognitoIdentityProviders
-
Amazon Cognito ユーザープールの配列とそのクライアント ID。
Required: No
タイプ: Amazon Cognito IdentityPool CognitoIdentityProvider の配列。
更新に伴う要件: 中断はありません。
SamlProviderARNs
-
Security Assertion Markup Language (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
-
ID プールに適用する設定オプション。
Required: No
タイプ: Amazon Cognito IdentityPool PushSync
更新に伴う要件: 中断はありません。
CognitoEvents
-
設定するイベント。
Required: No
タイプ: 文字列から文字列へのマッピング
更新に伴う要件: 中断はありません。
戻り値
参照番号
このリソースの論理 ID が Ref
組み込み関数に提供されると、Ref
により IdentityPoolId
のような us-east-2:0d01f4d7-1305-4408-b437-12345EXAMPLE
が返されます。
Ref
関数の使用方法の詳細については、「Ref」を参照してください。
Fn::GetAtt
Fn::GetAtt
は、このタイプの指定された属性の値を返します。以下には、利用可能な属性とサンプル戻り値のリストが示されます。
Name
-
文字列として返される Amazon Cognito ID プールの名前。
Fn::GetAtt
の使用の詳細については、「Fn::GetAtt」を参照してください。