AWSCognitoIdentityProviderSchemaAttributeType

Objective-C

@interface AWSCognitoIdentityProviderSchemaAttributeType

Swift

class AWSCognitoIdentityProviderSchemaAttributeType

Contains information about the schema attribute.

  • The attribute data type.

    Declaration

    Objective-C

    @property (nonatomic) AWSCognitoIdentityProviderAttributeDataType attributeDataType;

    Swift

    var attributeDataType: AWSCognitoIdentityProviderAttributeDataType { get set }
  • We recommend that you use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using DeveloperOnlyAttribute.

    Specifies whether the attribute type is developer only. This attribute can only be modified by an administrator. Users will not be able to modify this attribute using their access token. For example, DeveloperOnlyAttribute can be modified using the API but cannot be updated using the API.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable developerOnlyAttribute;

    Swift

    var developerOnlyAttribute: NSNumber? { get set }
  • Specifies whether the value of the attribute can be changed.

    For any user pool attribute that’s mapped to an identity provider attribute, you must set this parameter to true. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable varying;

    Swift

    var varying: NSNumber? { get set }
  • A schema attribute of the name type.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable name;

    Swift

    var name: String? { get set }
  • Specifies the constraints for an attribute of the number type.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSCognitoIdentityProviderNumberAttributeConstraintsType *_Nullable numberAttributeConstraints;

    Swift

    var numberAttributeConstraints: AWSCognitoIdentityProviderNumberAttributeConstraintsType? { get set }
  • Specifies whether a user pool attribute is required. If the attribute is required and the user does not provide a value, registration or sign-in will fail.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable required;

    Swift

    var required: NSNumber? { get set }
  • Specifies the constraints for an attribute of the string type.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSCognitoIdentityProviderStringAttributeConstraintsType *_Nullable stringAttributeConstraints;

    Swift

    var stringAttributeConstraints: AWSCognitoIdentityProviderStringAttributeConstraintsType? { get set }