Struct AddCustomAttributesInput

#[non_exhaustive]
pub struct AddCustomAttributesInput {
    pub user_pool_id: Option<String>,
    pub custom_attributes: Option<Vec<SchemaAttributeType>>,
}

Represents the request to add custom attributes.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

user_pool_id: Option<String>

The ID of the user pool where you want to add custom attributes.

custom_attributes: Option<Vec<SchemaAttributeType>>

An array of custom attribute names and other properties. Sets the following characteristics:

AttributeDataType

The expected data type. Can be a string, a number, a date and time, or a boolean.

Mutable

If true, you can grant app clients write access to the attribute value. If false, the attribute value can only be set up on sign-up or administrator creation of users.

Name

The attribute name. For an attribute like custom:myAttribute, enter myAttribute for this field.

Required

When true, users who sign up or are created must set a value for the attribute.

NumberAttributeConstraints

The minimum and maximum length of accepted values for a Number-type attribute.

StringAttributeConstraints

The minimum and maximum length of accepted values for a String-type attribute.

DeveloperOnlyAttribute

This legacy option creates an attribute with a dev: prefix. You can only set the value of a developer-only attribute with administrative IAM credentials.

Implementations

impl AddCustomAttributesInput

pub fn user_pool_id(&self) -> Option<&str>

The ID of the user pool where you want to add custom attributes.

pub fn custom_attributes(&self) -> &[SchemaAttributeType]

An array of custom attribute names and other properties. Sets the following characteristics:

AttributeDataType

The expected data type. Can be a string, a number, a date and time, or a boolean.

Mutable

If true, you can grant app clients write access to the attribute value. If false, the attribute value can only be set up on sign-up or administrator creation of users.

Name

The attribute name. For an attribute like custom:myAttribute, enter myAttribute for this field.

Required

When true, users who sign up or are created must set a value for the attribute.

NumberAttributeConstraints

The minimum and maximum length of accepted values for a Number-type attribute.

StringAttributeConstraints

The minimum and maximum length of accepted values for a String-type attribute.

DeveloperOnlyAttribute

This legacy option creates an attribute with a dev: prefix. You can only set the value of a developer-only attribute with administrative IAM credentials.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .custom_attributes.is_none().

impl AddCustomAttributesInput

pub fn builder() -> AddCustomAttributesInputBuilder

Creates a new builder-style object to manufacture AddCustomAttributesInput.

Trait Implementations

impl Clone for AddCustomAttributesInput

fn clone(&self) -> AddCustomAttributesInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AddCustomAttributesInput

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

Formats the value using the given formatter.

impl PartialEq for AddCustomAttributesInput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for AddCustomAttributesInput