Class ClientAttributes
A set of attributes, useful to set Read and Write attributes.
Inheritance
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.AWS.Cognito.dll
Syntax (csharp)
public class ClientAttributes : DeputyBase
Syntax (vb)
Public Class ClientAttributes
Inherits DeputyBase
Remarks
ExampleMetadata: infused
Examples
var pool = new UserPool(this, "Pool");
var clientWriteAttributes = (new ClientAttributes()).WithStandardAttributes(new StandardAttributesMask { Fullname = true, Email = true }).WithCustomAttributes("favouritePizza", "favouriteBeverage");
var clientReadAttributes = clientWriteAttributes.WithStandardAttributes(new StandardAttributesMask { EmailVerified = true }).WithCustomAttributes("pointsEarned");
pool.AddClient("app-client", new UserPoolClientOptions {
// ...
ReadAttributes = clientReadAttributes,
WriteAttributes = clientWriteAttributes
});
Synopsis
Constructors
ClientAttributes() | Creates a ClientAttributes with the specified attributes. |
ClientAttributes(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
ClientAttributes(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Methods
Attributes() | The list of attributes represented by this ClientAttributes. |
WithCustomAttributes(String[]) | Creates a custom ClientAttributes with the specified attributes. |
WithStandardAttributes(IStandardAttributesMask) | Creates a custom ClientAttributes with the specified attributes. |
Constructors
ClientAttributes()
Creates a ClientAttributes with the specified attributes.
public ClientAttributes()
Remarks
Default: - a ClientAttributes object without any attributes
ClientAttributes(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected ClientAttributes(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
ClientAttributes(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected ClientAttributes(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Methods
Attributes()
The list of attributes represented by this ClientAttributes.
public virtual string[] Attributes()
Returns
System.String[]
WithCustomAttributes(String[])
Creates a custom ClientAttributes with the specified attributes.
public virtual ClientAttributes WithCustomAttributes(params string[] attributes)
Parameters
- attributes System.String[]
a list of custom attributes to add to the set.
Returns
WithStandardAttributes(IStandardAttributesMask)
Creates a custom ClientAttributes with the specified attributes.
public virtual ClientAttributes WithStandardAttributes(IStandardAttributesMask attributes)
Parameters
- attributes IStandardAttributesMask
a list of standard attributes to add to the set.
Returns