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

Filter View: All JSON YAML

Amazon Cognito UserPool SchemaAttribute

SchemaAttribute は AWS::Cognito::UserPool リソースのプロパティで、Amazon Cognito ユーザープールのスキーマ属性を定義します。

構文

JSON

{
  "AttributeDataType" : String,
  "DeveloperOnlyAttribute" : Boolean,
  "Mutable" : Boolean,
  "Name" : String,
  "NumberAttributeConstraints" : NumberAttributeConstraintsType,
  "StringAttributeConstraints" : StringAttributeConstraintsType,
  "Required" : Boolean
}

YAML

AttributeDataType: String
DeveloperOnlyAttribute: Boolean
Mutable: Boolean
Name: String
NumberAttributeConstraints:
  NumberAttributeConstraints
StringAttributeConstraints:
  StringAttributeConstraints
Required: Boolean

プロパティ

AttributeDataType

属性のデータ型。次のいずれかを指定できます。String、Number、DateTime、または Boolean。

Type: String

Required: No

DeveloperOnlyAttribute

属性タイプが開発者のみであるかを指定します。

Type: Boolean

Required: No

Mutable

作成後に属性を変更できるかどうかを指定します。True はミュータブルを意味し、False はイミュータブルを意味します。

Type: Boolean

Required: No

Name

名前型のスキーマ属性。

Type: String

Required: No

NumberAttributeConstraints

数値型の属性の制約を指定します。

Type: Amazon Cognito UserPool NumberAttributeConstraints

Required: No

StringAttributeConstraints

文字列型の属性の制約を指定します。

Type: Amazon Cognito UserPool StringAttributeConstraints

Required: No

Required

ユーザープール属性が必要かどうかを指定します。属性が必須でユーザーが値を指定しない場合、登録またはサインインは失敗します。

Type: Boolean

Required: No