AWS ドキュメント » AWS CloudFormation » ユーザーガイド » テンプレートリファレンス » AWS リソースプロパティタイプのリファレンス » AWS::Cognito::UserPoolClient

Filter View: All JSON YAML

AWS::Cognito::UserPoolClient

AWS::Cognito::UserPoolClient リソースによって、Amazon Cognito ユーザープールが作成されます。

構文

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

JSON

{
  "Type" : "AWS::Cognito::UserPoolClient",
  "Properties" : {
    "ClientName" : String,
    "ExplicitAuthFlows" : [ String, ... ],
    "GenerateSecret" : Boolean,
    "ReadAttributes" : [ String, ... ],
    "RefreshTokenValidity" : Integer,
    "UserPoolId" : String,
    "WriteAttributes" : [ String, ... ]
  }
}

YAML

Type: AWS::Cognito::UserPoolClient
Properties:
    ClientName: String,
    ExplicitAuthFlows: 
      - 文字列
    GenerateSecret: Boolean
    ReadAttributes: 
      - 文字列
    RefreshTokenValidity: Integer
    UserPoolId: String
    WriteAttributes: 
      - 文字列

プロパティ

ClientName

作成するユーザープールクライアントのクライアント名。

Required: No

Type: String

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

MinLength: 1

MaxLength: 128

ExplicitAuthFlows

明示的な認証フローは次のいずれかとなります。ADMIN_NO_SRP_AUTH または CUSTOM_AUTH_FLOW_ONLY。

Required: No

Type: 文字列のリスト

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

GenerateSecret

作成するユーザープールクライアントのシークレットを生成するかどうかを指定します。

Required: No

Type: Boolean

更新に伴う要件: 置換

ReadAttributes

読み取り属性。

Required: No

Type: 文字列のリスト

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

RefreshTokenValidity

リフレッシュトークンが有効ではなくなった後の制限時間 (日)。

Required: No

Type: Integer

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

UserPoolId

クライアントを作成するユーザープールのユーザープール ID。

Required: Yes

Type: String

更新に伴う要件: 置換

WriteAttributes

書き込み属性。

Required: No

Type: 文字列のリスト

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

戻り値

参照番号

このリソースの論理 ID が Ref 組み込み関数に提供されると、Ref により 1h57kf5cpq17m0eml12EXAMPLE のような Amazon Cognito ユーザープールクライアント ID が返されます。

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

Fn::GetAtt

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

ClientSecret

String としてのクライアントシークレット。

Name

String としてのユーザープールクライアントの名前。

Fn::GetAtt の使用の詳細については、「Fn::GetAtt」を参照してください。