software.amazon.awscdk.services.cognito

Class ClientAttributes

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cognito.ClientAttributes

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:44.575Z")
 @Stability(value=Stable)
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());
 

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

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
List<String>	attributes() The list of attributes represented by this ClientAttributes.
ClientAttributes	withCustomAttributes(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 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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

ClientAttributes

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

ClientAttributes

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

ClientAttributes

@Stability(value=Stable)
public ClientAttributes()

Creates a ClientAttributes with the specified attributes.

Default: - a ClientAttributes object without any attributes

Method Detail

attributes

@Stability(value=Stable)
 @NotNull
public List<String> attributes()

The list of attributes represented by this ClientAttributes.

withCustomAttributes

@Stability(value=Stable)
 @NotNull
public ClientAttributes withCustomAttributes(@NotNull
                                                                                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

@Stability(value=Stable)
 @NotNull
public ClientAttributes withStandardAttributes(@NotNull
                                                                                  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.