Struct aws_sdk_cognitoidentityprovider::types::builders::SchemaAttributeTypeBuilder

#[non_exhaustive]
pub struct SchemaAttributeTypeBuilder { /* private fields */ }

A builder for SchemaAttributeType.

Implementations

impl SchemaAttributeTypeBuilder

pub fn name(self, input: impl Into<String>) -> Self

The name of your user pool attribute. When you create or update a user pool, adding a schema attribute creates a custom or developer-only attribute. When you add an attribute with a Name value of MyAttribute, Amazon Cognito creates the custom attribute custom:MyAttribute. When DeveloperOnlyAttribute is true, Amazon Cognito creates your attribute as dev:MyAttribute. In an operation that describes a user pool, Amazon Cognito returns this value as value for standard attributes, custom:value for custom attributes, and dev:value for developer-only attributes..

pub fn set_name(self, input: Option<String>) -> Self

The name of your user pool attribute. When you create or update a user pool, adding a schema attribute creates a custom or developer-only attribute. When you add an attribute with a Name value of MyAttribute, Amazon Cognito creates the custom attribute custom:MyAttribute. When DeveloperOnlyAttribute is true, Amazon Cognito creates your attribute as dev:MyAttribute. In an operation that describes a user pool, Amazon Cognito returns this value as value for standard attributes, custom:value for custom attributes, and dev:value for developer-only attributes..

pub fn get_name(&self) -> &Option<String>

The name of your user pool attribute. When you create or update a user pool, adding a schema attribute creates a custom or developer-only attribute. When you add an attribute with a Name value of MyAttribute, Amazon Cognito creates the custom attribute custom:MyAttribute. When DeveloperOnlyAttribute is true, Amazon Cognito creates your attribute as dev:MyAttribute. In an operation that describes a user pool, Amazon Cognito returns this value as value for standard attributes, custom:value for custom attributes, and dev:value for developer-only attributes..

pub fn attribute_data_type(self, input: AttributeDataType) -> Self

The data format of the values for your attribute. When you choose an AttributeDataType, Amazon Cognito validates the input against the data type. A custom attribute value in your user's ID token is always a string, for example "custom:isMember" : "true" or "custom:YearsAsMember" : "12".

pub fn set_attribute_data_type(self, input: Option<AttributeDataType>) -> Self

The data format of the values for your attribute. When you choose an AttributeDataType, Amazon Cognito validates the input against the data type. A custom attribute value in your user's ID token is always a string, for example "custom:isMember" : "true" or "custom:YearsAsMember" : "12".

pub fn get_attribute_data_type(&self) -> &Option<AttributeDataType>

The data format of the values for your attribute. When you choose an AttributeDataType, Amazon Cognito validates the input against the data type. A custom attribute value in your user's ID token is always a string, for example "custom:isMember" : "true" or "custom:YearsAsMember" : "12".

pub fn developer_only_attribute(self, input: bool) -> Self

You should 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 won't be able to modify this attribute using their access token. For example, DeveloperOnlyAttribute can be modified using AdminUpdateUserAttributes but can't be updated using UpdateUserAttributes.

pub fn set_developer_only_attribute(self, input: Option<bool>) -> Self

You should 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 won't be able to modify this attribute using their access token. For example, DeveloperOnlyAttribute can be modified using AdminUpdateUserAttributes but can't be updated using UpdateUserAttributes.

pub fn get_developer_only_attribute(&self) -> &Option<bool>

You should 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 won't be able to modify this attribute using their access token. For example, DeveloperOnlyAttribute can be modified using AdminUpdateUserAttributes but can't be updated using UpdateUserAttributes.

pub fn mutable(self, input: bool) -> Self

Specifies whether the value of the attribute can be changed.

Any user pool attribute whose value you map from an IdP attribute must be mutable, with a parameter value of true. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. 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.

pub fn set_mutable(self, input: Option<bool>) -> Self

Specifies whether the value of the attribute can be changed.

Any user pool attribute whose value you map from an IdP attribute must be mutable, with a parameter value of true. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. 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.

pub fn get_mutable(&self) -> &Option<bool>

Specifies whether the value of the attribute can be changed.

Any user pool attribute whose value you map from an IdP attribute must be mutable, with a parameter value of true. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. 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.

pub fn required(self, input: bool) -> Self

Specifies whether a user pool attribute is required. If the attribute is required and the user doesn't provide a value, registration or sign-in will fail.

pub fn set_required(self, input: Option<bool>) -> Self

Specifies whether a user pool attribute is required. If the attribute is required and the user doesn't provide a value, registration or sign-in will fail.

pub fn get_required(&self) -> &Option<bool>

Specifies whether a user pool attribute is required. If the attribute is required and the user doesn't provide a value, registration or sign-in will fail.

pub fn number_attribute_constraints( self, input: NumberAttributeConstraintsType, ) -> Self

Specifies the constraints for an attribute of the number type.

pub fn set_number_attribute_constraints( self, input: Option<NumberAttributeConstraintsType>, ) -> Self

Specifies the constraints for an attribute of the number type.

pub fn get_number_attribute_constraints( &self, ) -> &Option<NumberAttributeConstraintsType>

Specifies the constraints for an attribute of the number type.

pub fn string_attribute_constraints( self, input: StringAttributeConstraintsType, ) -> Self

Specifies the constraints for an attribute of the string type.

pub fn set_string_attribute_constraints( self, input: Option<StringAttributeConstraintsType>, ) -> Self

Specifies the constraints for an attribute of the string type.

pub fn get_string_attribute_constraints( &self, ) -> &Option<StringAttributeConstraintsType>

Specifies the constraints for an attribute of the string type.

pub fn build(self) -> SchemaAttributeType

Consumes the builder and constructs a SchemaAttributeType.

Trait Implementations

impl Clone for SchemaAttributeTypeBuilder

fn clone(&self) -> SchemaAttributeTypeBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SchemaAttributeTypeBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SchemaAttributeTypeBuilder

fn default() -> SchemaAttributeTypeBuilder

Returns the “default value” for a type.

impl PartialEq for SchemaAttributeTypeBuilder

fn eq(&self, other: &SchemaAttributeTypeBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SchemaAttributeTypeBuilder