Package software.amazon.awscdk.services.cognito

Interface CustomAttributeConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CustomAttributeConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:44.010Z")
@Stability(Stable)
public interface CustomAttributeConfig
extends software.amazon.jsii.JsiiSerializable

Configuration that will be fed into CloudFormation for any custom attribute type.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 CustomAttributeConfig customAttributeConfig = CustomAttributeConfig.builder()
         .dataType("dataType")
         // the properties below are optional
         .mutable(false)
         .numberConstraints(NumberAttributeConstraints.builder()
                 .max(123)
                 .min(123)
                 .build())
         .stringConstraints(StringAttributeConstraints.builder()
                 .maxLen(123)
                 .minLen(123)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CustomAttributeConfig.Builder	A builder for CustomAttributeConfig
static final class	CustomAttributeConfig.Jsii$Proxy	An implementation for CustomAttributeConfig

Method Summary

Modifier and Type	Method	Description
static CustomAttributeConfig.Builder	builder()
String	getDataType()	The data type of the custom attribute.
default Boolean	getMutable()	Specifies whether the value of the attribute can be changed.
default NumberAttributeConstraints	getNumberConstraints()	The constraints for a custom attribute of the 'Number' data type.
default StringAttributeConstraints	getStringConstraints()	The constraints for a custom attribute of 'String' data type.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataType

@Stability(Stable)
@NotNull
String getDataType()

The data type of the custom attribute.

See Also:

• https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SchemaAttributeType.html#CognitoUserPools-Type-SchemaAttributeType-AttributeDataType

getMutable

@Stability(Stable)
@Nullable
default Boolean getMutable()

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.

Default: false

getNumberConstraints

@Stability(Stable)
@Nullable
default NumberAttributeConstraints getNumberConstraints()

The constraints for a custom attribute of the 'Number' data type.

Default: - None.

getStringConstraints

@Stability(Stable)
@Nullable
default StringAttributeConstraints getStringConstraints()

The constraints for a custom attribute of 'String' data type.

Default: - None.

builder

@Stability(Stable)
static CustomAttributeConfig.Builder builder()

Returns:

a CustomAttributeConfig.Builder of CustomAttributeConfig