software.amazon.awscdk.services.cognito

Class ClientAttributes

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cognito.ClientAttributes

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-07-06T20:02:54.349Z")
public class ClientAttributes
extends software.amazon.jsii.JsiiObject

A set of attributes, useful to set Read and Write attributes.

Example:

 UserPool pool = new UserPool(this, "Pool");
 ClientAttributes clientWriteAttributes = (new ClientAttributes()).withStandardAttributes(StandardAttributesMask.builder().fullname(true).email(true).build()).withCustomAttributes("favouritePizza", "favouriteBeverage");
 ClientAttributes clientReadAttributes = clientWriteAttributes.withStandardAttributes(StandardAttributesMask.builder().emailVerified(true).build()).withCustomAttributes("pointsEarned");
 pool.addClient("app-client", UserPoolClientOptions.builder()
         // ...
         .readAttributes(clientReadAttributes)
         .writeAttributes(clientWriteAttributes)
         .build());
 

Constructor Summary

Constructors

Modifier	Constructor and Description
	ClientAttributes() Creates a ClientAttributes with the specified attributes.
protected	ClientAttributes(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ClientAttributes(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	attributes() The list of attributes represented by this ClientAttributes.
ClientAttributes	withCustomAttributes(java.lang.String... attributes) Creates a custom ClientAttributes with the specified attributes.
ClientAttributes	withStandardAttributes(StandardAttributesMask attributes) Creates a custom ClientAttributes with the specified attributes.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientAttributes

protected ClientAttributes(software.amazon.jsii.JsiiObjectRef objRef)

ClientAttributes

protected ClientAttributes(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ClientAttributes

public ClientAttributes()

Creates a ClientAttributes with the specified attributes.

Default: - a ClientAttributes object without any attributes

Method Detail

attributes

public java.util.List<java.lang.String> attributes()

The list of attributes represented by this ClientAttributes.

withCustomAttributes

public ClientAttributes withCustomAttributes(java.lang.String... attributes)

Creates a custom ClientAttributes with the specified attributes.

Parameters:

attributes - a list of custom attributes to add to the set. This parameter is required.

withStandardAttributes

public ClientAttributes withStandardAttributes(StandardAttributesMask attributes)

Creates a custom ClientAttributes with the specified attributes.

Parameters:

attributes - a list of standard attributes to add to the set. This parameter is required.