Class CfnUserPoolClient
A CloudFormation AWS::Cognito::UserPoolClient
.
Inherited Members
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.AWS.Cognito.dll
Syntax (csharp)
public class CfnUserPoolClient : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnUserPoolClient
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::Cognito::UserPoolClient
resource specifies an Amazon Cognito user pool client.
If you don't specify a value for a parameter, Amazon Cognito sets it to a default value.
CloudformationResource: AWS::Cognito::UserPoolClient
ExampleMetadata: lit=test/integ.cognito.lit.ts infused
Examples
using Amazon.CDK.AWS.Cognito;
using Amazon.CDK.AWS.EC2;
using Amazon.CDK.AWS.ElasticLoadBalancingV2;
using Amazon.CDK;
using Constructs;
using Amazon.CDK.AWS.ElasticLoadBalancingV2.Actions;
CognitoStack : Stack
{var lb = new ApplicationLoadBalancer(this, "LB", new ApplicationLoadBalancerProps {
Vpc = vpc,
InternetFacing = true
});
var userPool = new UserPool(this, "UserPool");
var userPoolClient = new UserPoolClient(this, "Client", new UserPoolClientProps {
UserPool = userPool,
// Required minimal configuration for use with an ELB
GenerateSecret = true,
AuthFlows = new AuthFlow {
UserPassword = true
},
OAuth = new OAuthSettings {
Flows = new OAuthFlows {
AuthorizationCodeGrant = true
},
Scopes = new [] { OAuthScope.EMAIL },
CallbackUrls = new [] { $"https://{lb.loadBalancerDnsName}/oauth2/idpresponse" }
}
});
var cfnClient = (CfnUserPoolClient)userPoolClient.Node.DefaultChild;
cfnClient.AddPropertyOverride("RefreshTokenValidity", 1);
cfnClient.AddPropertyOverride("SupportedIdentityProviders", new [] { "COGNITO" });
var userPoolDomain = new UserPoolDomain(this, "Domain", new UserPoolDomainProps {
UserPool = userPool,
CognitoDomain = new CognitoDomainOptions {
DomainPrefix = "test-cdk-prefix"
}
});
lb.AddListener("Listener", new BaseApplicationListenerProps {
Port = 443,
Certificates = new [] { certificate },
DefaultAction = new AuthenticateCognitoAction(new AuthenticateCognitoActionProps {
UserPool = userPool,
UserPoolClient = userPoolClient,
UserPoolDomain = userPoolDomain,
Next = ListenerAction.FixedResponse(200, new FixedResponseOptions {
ContentType = "text/plain",
MessageBody = "Authenticated"
})
})
});
new CfnOutput(this, "DNS", new CfnOutputProps {
Value = lb.LoadBalancerDnsName
});
var app = new App();
new CognitoStack(app, "integ-cognito");
app.Synth();
Synopsis
Constructors
CfnUserPoolClient(Construct, String, ICfnUserPoolClientProps) | Create a new |
CfnUserPoolClient(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnUserPoolClient(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AccessTokenValidity | The access token time limit. |
AllowedOAuthFlows | The allowed OAuth flows. |
AllowedOAuthFlowsUserPoolClient | Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools. |
AllowedOAuthScopes | The allowed OAuth scopes. |
AnalyticsConfiguration | The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. |
AttrClientSecret | |
AttrName | |
AuthSessionValidity | Amazon Cognito creates a session token for each API request in an authentication flow. |
CallbackUrLs | A list of allowed redirect (callback) URLs for the IdPs. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ClientName | The client name for the user pool client you would like to create. |
DefaultRedirectUri | The default redirect URI. Must be in the |
EnablePropagateAdditionalUserContextData | Activates the propagation of additional user context data. |
EnableTokenRevocation | Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken . |
ExplicitAuthFlows | The authentication flows that you want your user pool client to support. |
GenerateSecret | Boolean to specify whether you want to generate a secret for the user pool client being created. |
IdTokenValidity | The ID token time limit. |
LogoutUrLs | A list of allowed logout URLs for the IdPs. |
PreventUserExistenceErrors | Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. |
ReadAttributes | The read attributes. |
RefreshTokenValidity | The refresh token time limit. |
SupportedIdentityProviders | A list of provider names for the identity providers (IdPs) that are supported on this client. |
TokenValidityUnits | The units in which the validity times are represented. |
UserPoolId | The user pool ID for the user pool where you want to create a user pool client. |
WriteAttributes | The user pool attributes that the app client can write to. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnUserPoolClient(Construct, String, ICfnUserPoolClientProps)
Create a new AWS::Cognito::UserPoolClient
.
public CfnUserPoolClient(Construct scope, string id, ICfnUserPoolClientProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnUserPoolClientProps
- resource properties.
CfnUserPoolClient(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnUserPoolClient(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnUserPoolClient(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnUserPoolClient(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AccessTokenValidity
The access token time limit.
public virtual Nullable<double> AccessTokenValidity { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
After this limit expires, your user can't use their access token. To specify the time unit for AccessTokenValidity
as seconds
, minutes
, hours
, or days
, set a TokenValidityUnits
value in your API request.
For example, when you set AccessTokenValidity
to 10
and TokenValidityUnits
to hours
, your user can authorize access with their access token for 10 hours.
The default time unit for AccessTokenValidity
in an API request is hours.
AllowedOAuthFlows
The allowed OAuth flows.
public virtual string[] AllowedOAuthFlows { get; set; }
Property Value
System.String[]
Remarks
AllowedOAuthFlowsUserPoolClient
Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
public virtual object AllowedOAuthFlowsUserPoolClient { get; set; }
Property Value
System.Object
Remarks
AllowedOAuthScopes
The allowed OAuth scopes.
public virtual string[] AllowedOAuthScopes { get; set; }
Property Value
System.String[]
Remarks
Possible values provided by OAuth are phone
, email
, openid
, and profile
. Possible values provided by AWS are aws.cognito.signin.user.admin
. Custom scopes created in Resource Servers are also supported.
AnalyticsConfiguration
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
public virtual object AnalyticsConfiguration { get; set; }
Property Value
System.Object
Remarks
In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
AttrClientSecret
public virtual string AttrClientSecret { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ClientSecret
AttrName
public virtual string AttrName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Name
AuthSessionValidity
Amazon Cognito creates a session token for each API request in an authentication flow.
public virtual Nullable<double> AuthSessionValidity { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
AuthSessionValidity
is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.
CallbackUrLs
A list of allowed redirect (callback) URLs for the IdPs.
public virtual string[] CallbackUrLs { get; set; }
Property Value
System.String[]
Remarks
A redirect URI must:
See OAuth 2.0 - Redirection Endpoint .
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ClientName
The client name for the user pool client you would like to create.
public virtual string ClientName { get; set; }
Property Value
System.String
Remarks
DefaultRedirectUri
The default redirect URI. Must be in the CallbackURLs
list.
public virtual string DefaultRedirectUri { get; set; }
Property Value
System.String
Remarks
A redirect URI must:
See OAuth 2.0 - Redirection Endpoint .
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
EnablePropagateAdditionalUserContextData
Activates the propagation of additional user context data.
public virtual object EnablePropagateAdditionalUserContextData { get; set; }
Property Value
System.Object
Remarks
For more information about propagation of user context data, see Adding advanced security to a user pool . If you don’t include this parameter, you can't send device fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate EnablePropagateAdditionalUserContextData
in an app client that has a client secret.
EnableTokenRevocation
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken .
public virtual object EnableTokenRevocation { get; set; }
Property Value
System.Object
Remarks
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
ExplicitAuthFlows
The authentication flows that you want your user pool client to support.
public virtual string[] ExplicitAuthFlows { get; set; }
Property Value
System.String[]
Remarks
For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don't specify a value for ExplicitAuthFlows
, your user client supports ALLOW_REFRESH_TOKEN_AUTH
, ALLOW_USER_SRP_AUTH
, and ALLOW_CUSTOM_AUTH
.
Valid values include:
In some environments, you will see the values ADMIN_NO_SRP_AUTH
, CUSTOM_AUTH_FLOW_ONLY
, or USER_PASSWORD_AUTH
. You can't assign these legacy ExplicitAuthFlows
values to user pool clients at the same time as values that begin with ALLOW_
,
like ALLOW_USER_SRP_AUTH
.
GenerateSecret
Boolean to specify whether you want to generate a secret for the user pool client being created.
public virtual object GenerateSecret { get; set; }
Property Value
System.Object
Remarks
IdTokenValidity
The ID token time limit.
public virtual Nullable<double> IdTokenValidity { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
After this limit expires, your user can't use their ID token. To specify the time unit for IdTokenValidity
as seconds
, minutes
, hours
, or days
, set a TokenValidityUnits
value in your API request.
For example, when you set IdTokenValidity
as 10
and TokenValidityUnits
as hours
, your user can authenticate their session with their ID token for 10 hours.
The default time unit for IdTokenValidity
in an API request is hours.
LogoutUrLs
A list of allowed logout URLs for the IdPs.
public virtual string[] LogoutUrLs { get; set; }
Property Value
System.String[]
Remarks
PreventUserExistenceErrors
Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool.
public virtual string PreventUserExistenceErrors { get; set; }
Property Value
System.String
Remarks
When set to ENABLED
and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY
, those APIs will return a UserNotFoundException
exception if the user does not exist in the user pool.
ReadAttributes
The read attributes.
public virtual string[] ReadAttributes { get; set; }
Property Value
System.String[]
Remarks
RefreshTokenValidity
The refresh token time limit.
public virtual Nullable<double> RefreshTokenValidity { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
After this limit expires, your user can't use their refresh token. To specify the time unit for RefreshTokenValidity
as seconds
, minutes
, hours
, or days
, set a TokenValidityUnits
value in your API request.
For example, when you set RefreshTokenValidity
as 10
and TokenValidityUnits
as days
, your user can refresh their session and retrieve new access and ID tokens for 10 days.
The default time unit for RefreshTokenValidity
in an API request is days. You can't set RefreshTokenValidity
to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days.
SupportedIdentityProviders
A list of provider names for the identity providers (IdPs) that are supported on this client.
public virtual string[] SupportedIdentityProviders { get; set; }
Property Value
System.String[]
Remarks
The following are supported: COGNITO
, Facebook
, Google
, SignInWithApple
, and LoginWithAmazon
. You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example MySAMLIdP
or MyOIDCIdP
.
TokenValidityUnits
The units in which the validity times are represented.
public virtual object TokenValidityUnits { get; set; }
Property Value
System.Object
Remarks
The default unit for RefreshToken is days, and default for ID and access tokens are hours.
UserPoolId
The user pool ID for the user pool where you want to create a user pool client.
public virtual string UserPoolId { get; set; }
Property Value
System.String
Remarks
WriteAttributes
The user pool attributes that the app client can write to.
public virtual string[] WriteAttributes { get; set; }
Property Value
System.String[]
Remarks
If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool .
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>