AWS::Cognito::UserPool SchemaAttribute
SchemaAttribute
は、AWS::Cognito::UserPool リソースのプロパティであり、Amazon Cognito ユーザープールのスキーマ属性を定義します。
構文
AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。
JSON
{ "AttributeDataType" :
String
, "DeveloperOnlyAttribute" :Boolean
, "Mutable" :Boolean
, "Name" :String
, "NumberAttributeConstraints" :NumberAttributeConstraints
, "Required" :Boolean
, "StringAttributeConstraints" :StringAttributeConstraints
}
YAML
AttributeDataType:
String
DeveloperOnlyAttribute:Boolean
Mutable:Boolean
Name:String
NumberAttributeConstraints:NumberAttributeConstraints
Required:Boolean
StringAttributeConstraints:StringAttributeConstraints
プロパティ
AttributeDataType
-
属性のデータ型。
必須: いいえ
タイプ: 文字列
許可された値:
Boolean | DateTime | Number | String
Update requires: No interruption
DeveloperOnlyAttribute
-
属性タイプが開発者のみであるかを指定します。
必須: いいえ
タイプ: ブール値
Update requires: No interruption
Mutable
-
属性の値を変更できるかどうかを指定します。
ID プロバイダー属性にマッピングされたユーザープール属性の場合は、このパラメータを
true
に設定する必要があります。Amazon Cognito では、ユーザーが ID プロバイダーからアプリケーションにサインインすると、マッピングされた属性を更新します。属性が変更不可能である場合、Amazon Cognito は、その属性の更新試行時にエラーをスローします。詳細は、「ユーザープール用 ID プロバイダー 属性マッピングの特定」を参照してください。必須: いいえ
タイプ: ブール値
Update requires: No interruption
Name
-
名前型のスキーマ属性。
必須: いいえ
タイプ: 文字列
最小:
1
最大:
20
パターン:
[\p{L}\p{M}\p{S}\p{N}\p{P}]+
Update requires: No interruption
NumberAttributeConstraints
-
数値型の属性の制約を指定します。
必須: いいえ
タイプ: NumberAttributeConstraints
Update requires: No interruption
Required
-
ユーザープール属性が必要かどうかを指定します。属性が必須でユーザーが値を指定しない場合、登録またはサインインは失敗します。
必須: いいえ
タイプ: ブール値
Update requires: No interruption
StringAttributeConstraints
-
文字列型の属性の制約を指定します。
必須: いいえ
タイプ: StringAttributeConstraints
Update requires: No interruption