Package software.amazon.awscdk.services.cognito

Class CfnUserPool.SchemaAttributeProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cognito.CfnUserPool.SchemaAttributeProperty.Jsii$Proxy

All Implemented Interfaces:

CfnUserPool.SchemaAttributeProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnUserPool.SchemaAttributeProperty

@Stability(Stable)
@Internal
public static final class CfnUserPool.SchemaAttributeProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnUserPool.SchemaAttributeProperty

An implementation for CfnUserPool.SchemaAttributeProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cognito.CfnUserPool.SchemaAttributeProperty

CfnUserPool.SchemaAttributeProperty.Builder, CfnUserPool.SchemaAttributeProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnUserPool.SchemaAttributeProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnUserPool.SchemaAttributeProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getAttributeDataType()	The data format of the values for your attribute.
final Object	getDeveloperOnlyAttribute()
final Object	getMutable()	Specifies whether the value of the attribute can be changed.
final String	getName()	The name of your user pool attribute.
final Object	getNumberAttributeConstraints()	Specifies the constraints for an attribute of the number type.
final Object	getRequired()	Specifies whether a user pool attribute is required.
final Object	getStringAttributeConstraints()	Specifies the constraints for an attribute of the string type.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnUserPool.SchemaAttributeProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnUserPool.SchemaAttributeProperty.Builder.

Method Details

getAttributeDataType

public final String getAttributeDataType()

Description copied from interface: CfnUserPool.SchemaAttributeProperty

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" .

Specified by:

getAttributeDataType in interface CfnUserPool.SchemaAttributeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-attributedatatype

getDeveloperOnlyAttribute

public final Object getDeveloperOnlyAttribute()

Description copied from interface: CfnUserPool.SchemaAttributeProperty

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.

Returns union: either Boolean or IResolvable

Specified by:

getDeveloperOnlyAttribute in interface CfnUserPool.SchemaAttributeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-developeronlyattribute

getMutable

public final Object getMutable()

Description copied from interface: CfnUserPool.SchemaAttributeProperty

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 .

Returns union: either Boolean or IResolvable

Specified by:

getMutable in interface CfnUserPool.SchemaAttributeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-mutable

getName

public final String getName()

Description copied from interface: CfnUserPool.SchemaAttributeProperty

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..

Specified by:

getName in interface CfnUserPool.SchemaAttributeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-name

getNumberAttributeConstraints

public final Object getNumberAttributeConstraints()

Description copied from interface: CfnUserPool.SchemaAttributeProperty

Specifies the constraints for an attribute of the number type.

Returns union: either IResolvable or CfnUserPool.NumberAttributeConstraintsProperty

Specified by:

getNumberAttributeConstraints in interface CfnUserPool.SchemaAttributeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-numberattributeconstraints

getRequired

public final Object getRequired()

Description copied from interface: CfnUserPool.SchemaAttributeProperty

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.

Returns union: either Boolean or IResolvable

Specified by:

getRequired in interface CfnUserPool.SchemaAttributeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-required

getStringAttributeConstraints

public final Object getStringAttributeConstraints()

Description copied from interface: CfnUserPool.SchemaAttributeProperty

Specifies the constraints for an attribute of the string type.

Returns union: either IResolvable or CfnUserPool.StringAttributeConstraintsProperty

Specified by:

getStringAttributeConstraints in interface CfnUserPool.SchemaAttributeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-stringattributeconstraints

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object