SchemaAttributeType

public struct SchemaAttributeType : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • The attribute data type.

    Declaration

    Swift

    public let attributeDataType: AttributeDataType?

  • 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 AdminUpdateUserAttributes but cannot be updated using UpdateUserAttributes.

    Declaration

    Swift

    public let developerOnlyAttribute: Bool?

  • 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

    Swift

    public let mutable: Bool?

  • A schema attribute of the name type.

    Declaration

    Swift

    public let name: String?

  • Specifies the constraints for an attribute of the number type.

    Declaration

    Swift

    public let numberAttributeConstraints: NumberAttributeConstraintsType?

  • 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

    Swift

    public let required: Bool?

  • Specifies the constraints for an attribute of the string type.

    Declaration

    Swift

    public let stringAttributeConstraints: StringAttributeConstraintsType?

  • Undocumented

    Declaration

    Swift

    public init(attributeDataType: AttributeDataType? = nil, developerOnlyAttribute: Bool? = nil, mutable: Bool? = nil, name: String? = nil, numberAttributeConstraints: NumberAttributeConstraintsType? = nil, required: Bool? = nil, stringAttributeConstraints: StringAttributeConstraintsType? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws