AWS::Cognito::IdentityPoolRoleAttachment - AWS CloudFormation

AWS::Cognito::IdentityPoolRoleAttachment

AWS::Cognito::IdentityPoolRoleAttachment リソースは、Amazon Cognito ID プールのロール設定を管理します。

構文

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

JSON

{ "Type" : "AWS::Cognito::IdentityPoolRoleAttachment", "Properties" : { "IdentityPoolId" : String, "RoleMappings" : Json, "Roles" : Json } }

YAML

Type: AWS::Cognito::IdentityPoolRoleAttachment Properties: IdentityPoolId: String RoleMappings: Json Roles: Json

プロパティ

IdentityPoolId

REGION:GUID 形式のアイデンティティプール ID です。

必須: はい

タイプ: 文字列

Update requires: Replacement

RoleMappings

特定の ID プロバイダーのユーザーがロールにマッピングされる方法です。これは、RoleMapping オブジェクトマップへの文字列です。文字列は ID プロバイダーを識別します。たとえば、「graph.facebook.com」や「cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id」です。

IdentityProvider フィールドがこのオブジェクトで指定されていない場合、文字列は ID プロバイダー名として使用されます。

詳細については、「RoleMapping プロパティ」を参照してください。

必須: いいえ

タイプ: Json

Update requires: No interruption

Roles

このプールに関連付けられているロールのマップ。特定のロールで、キーは「認証されている」または「認証されていない」です。値はロール ARN です。

必須: いいえ

タイプ: Json

Update requires: No interruption

戻り値

参照番号

IdentityPoolRoleAttachment-EXAMPLEwnOR3n などの生成された ID このリソースの論理 ID を組み込みの Ref 関数に渡すと、Ref は次を返します: 。

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

ID プールのロールの設定

次の例では、ID プールのロールを設定します。「認証されている」ロールと「認証されていない」ロールを設定し、2 つの ID プロバイダーをそれらのロールにマッピングします。最初の ID プロバイダーは「graph.facebook.com」です。2 番目は、参照を使用して ID プロバイダー名を設定します。

JSON

{ "IdentityPoolRoleAttachment":{ "Type":"AWS::Cognito::IdentityPoolRoleAttachment", "Properties":{ "IdentityPoolId":{ "Ref":"IdentityPool" }, "Roles":{ "authenticated":{ "Fn::GetAtt":[ "AuthenticatedRole", "Arn" ] }, "unauthenticated":{ "Fn::GetAtt":[ "UnAuthenticatedRole", "Arn" ] } }, "RoleMappings":{ "graph.facebook.com":{ "IdentityProvider":"graph.facebook.com", "AmbiguousRoleResolution":"Deny", "Type":"Rules", "RulesConfiguration":{ "Rules":[ { "Claim":"sub", "MatchType":"Equals", "RoleARN":{ "Fn::GetAtt":[ "AuthenticatedRole", "Arn" ] }, "Value":"goodvalue" } ] } }, "userpool1":{ "IdentityProvider":{ "Ref":"CognitoUserPool" }, "AmbiguousRoleResolution":"Deny", "Type":"Rules", "RulesConfiguration":{ "Rules":[ { "Claim":"sub", "MatchType":"Equals", "RoleARN":{ "Fn::GetAtt":[ "AuthenticatedRole", "Arn" ] }, "Value":"goodvalue" } ] } } } } } }

YAML

IdentityPoolRoleAttachment: Type: AWS::Cognito::IdentityPoolRoleAttachment Properties: IdentityPoolId: !Ref IdentityPool Roles: "authenticated": !GetAtt AuthenticatedRole.Arn "unauthenticated": !GetAtt UnAuthenticatedRole.Arn RoleMappings: "graph.facebook.com": IdentityProvider: "graph.facebook.com" AmbiguousRoleResolution: Deny Type: Rules RulesConfiguration: Rules: - Claim: "sub" MatchType: "Equals" RoleARN: !GetAtt AuthenticatedRole.Arn Value: "goodvalue" "userpool1": IdentityProvider: !Ref CognitoUserPool AmbiguousRoleResolution: Deny Type: Rules RulesConfiguration: Rules: - Claim: "sub" MatchType: "Equals" RoleARN: !GetAtt AuthenticatedRole.Arn Value: "goodvalue"