Package 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.98.0 (build 00b106d)", date="2024-05-17T05:10:07.762Z") @Stability(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
    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
    Description
    List<String>
    attributes()
    The list of attributes represented by this ClientAttributes.
    ClientAttributes
    withCustomAttributes(@NotNull 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 Details

    • ClientAttributes

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

    • ClientAttributes

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

    • ClientAttributes

      @Stability(Stable) public ClientAttributes()
      Creates a ClientAttributes with the specified attributes.

      Default: - a ClientAttributes object without any attributes

  • Method Details

    • attributes

      @Stability(Stable) @NotNull public List<String> attributes()
      The list of attributes represented by this ClientAttributes.

    • withCustomAttributes

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