CfnUserPoolClientProps.Jsii$Proxy (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.amazon.awscdk.services.cognito.CfnUserPoolClientProps.Jsii$Proxy

All Implemented Interfaces:

CfnUserPoolClientProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnUserPoolClientProps
```
@Stability(value=Stable)
 @Internal
public static final class CfnUserPoolClientProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnUserPoolClientProps
```
An implementation for CfnUserPoolClientProps

Nested Class Summary
- Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
  software.amazon.jsii.JsiiObject.InitializationMode
- Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cognito.CfnUserPoolClientProps
  CfnUserPoolClientProps.Builder, CfnUserPoolClientProps.Jsii$Proxy

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Jsii$Proxy(CfnUserPoolClientProps.Builder builder)` Constructor that initializes the object based on literal property values passed by the `CfnUserPoolClientProps.Builder`.
`protected`	`Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)` Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.fasterxml.jackson.databind.JsonNode`	`$jsii$toJson()`
`boolean`	`equals(Object o)`
`Number`	`getAccessTokenValidity()` The access token time limit.
`List<String>`	`getAllowedOAuthFlows()` The allowed OAuth flows.
`Object`	`getAllowedOAuthFlowsUserPoolClient()` Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
`List<String>`	`getAllowedOAuthScopes()` The allowed OAuth scopes.
`Object`	`getAnalyticsConfiguration()` The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
`Number`	`getAuthSessionValidity()` `AWS::Cognito::UserPoolClient.AuthSessionValidity`.
`List<String>`	`getCallbackUrLs()` A list of allowed redirect (callback) URLs for the IdPs.
`String`	`getClientName()` The client name for the user pool client you would like to create.
`String`	`getDefaultRedirectUri()` The default redirect URI.
`Object`	`getEnablePropagateAdditionalUserContextData()` `AWS::Cognito::UserPoolClient.EnablePropagateAdditionalUserContextData`.
`Object`	`getEnableTokenRevocation()` Activates or deactivates token revocation.
`List<String>`	`getExplicitAuthFlows()` The authentication flows that are supported by the user pool clients.
`Object`	`getGenerateSecret()` Boolean to specify whether you want to generate a secret for the user pool client being created.
`Number`	`getIdTokenValidity()` The ID token time limit.
`List<String>`	`getLogoutUrLs()` A list of allowed logout URLs for the IdPs.
`String`	`getPreventUserExistenceErrors()` 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.
`List<String>`	`getReadAttributes()` The read attributes.
`Number`	`getRefreshTokenValidity()` The refresh token time limit.
`List<String>`	`getSupportedIdentityProviders()` A list of provider names for the IdPs that this client supports.
`Object`	`getTokenValidityUnits()` The units in which the validity times are represented.
`String`	`getUserPoolId()` The user pool ID for the user pool where you want to create a user pool client.
`List<String>`	`getWriteAttributes()` The user pool attributes that the app client can write to.
`int`	`hashCode()`

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.services.cognito.CfnUserPoolClientProps
builder

- Constructor Detail
  - Jsii$Proxy
```
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
```
    Constructor that initializes the object based on values retrieved from the JsiiObject.
    
    Parameters:
    
    objRef - Reference to the JSII managed object.
  - Jsii$Proxy
```
protected Jsii$Proxy(CfnUserPoolClientProps.Builder builder)
```
    Constructor that initializes the object based on literal property values passed by the CfnUserPoolClientProps.Builder.
- Method Detail
  - getUserPoolId
```
public final String getUserPoolId()
```
    Description copied from interface: CfnUserPoolClientProps
    
    The user pool ID for the user pool where you want to create a user pool client.
    
    Specified by:
    
    getUserPoolId in interface CfnUserPoolClientProps
  - getAccessTokenValidity
```
public final Number getAccessTokenValidity()
```
    Description copied from interface: CfnUserPoolClientProps
    
    The access token time limit.
    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.
    
    Specified by:
    
    getAccessTokenValidity in interface CfnUserPoolClientProps
  - getAllowedOAuthFlows
```
public final List<String> getAllowedOAuthFlows()
```
    Description copied from interface: CfnUserPoolClientProps
    The allowed OAuth flows.
    - code - Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint.
    - implicit - Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
    - client_credentials - Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID and client secret.
    Specified by:
    
    getAllowedOAuthFlows in interface CfnUserPoolClientProps
  - getAllowedOAuthFlowsUserPoolClient
```
public final Object getAllowedOAuthFlowsUserPoolClient()
```
    Description copied from interface: CfnUserPoolClientProps
    
    Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
    
    Specified by:
    
    getAllowedOAuthFlowsUserPoolClient in interface CfnUserPoolClientProps
  - getAllowedOAuthScopes
```
public final List<String> getAllowedOAuthScopes()
```
    Description copied from interface: CfnUserPoolClientProps
    
    The allowed OAuth scopes.
    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.
    
    Specified by:
    
    getAllowedOAuthScopes in interface CfnUserPoolClientProps
  - getAnalyticsConfiguration
```
public final Object getAnalyticsConfiguration()
```
    Description copied from interface: CfnUserPoolClientProps
    
    The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
    
    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.
    
    Specified by:
    
    getAnalyticsConfiguration in interface CfnUserPoolClientProps
  - getAuthSessionValidity
```
public final Number getAuthSessionValidity()
```
    Description copied from interface: CfnUserPoolClientProps
    
    `AWS::Cognito::UserPoolClient.AuthSessionValidity`.
    
    Specified by:
    
    getAuthSessionValidity in interface CfnUserPoolClientProps
  - getCallbackUrLs
```
public final List<String> getCallbackUrLs()
```
    Description copied from interface: CfnUserPoolClientProps
    A list of allowed redirect (callback) URLs for the IdPs.
    A redirect URI must:
    - Be an absolute URI.
    - Be registered with the authorization server.
    - Not include a fragment component.
    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.
    Specified by:
    
    getCallbackUrLs in interface CfnUserPoolClientProps
  - getClientName
```
public final String getClientName()
```
    Description copied from interface: CfnUserPoolClientProps
    
    The client name for the user pool client you would like to create.
    
    Specified by:
    
    getClientName in interface CfnUserPoolClientProps
  - getDefaultRedirectUri
```
public final String getDefaultRedirectUri()
```
    Description copied from interface: CfnUserPoolClientProps
    The default redirect URI. Must be in the `CallbackURLs` list.
    A redirect URI must:
    - Be an absolute URI.
    - Be registered with the authorization server.
    - Not include a fragment component.
    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.
    Specified by:
    
    getDefaultRedirectUri in interface CfnUserPoolClientProps
  - getEnablePropagateAdditionalUserContextData
```
public final Object getEnablePropagateAdditionalUserContextData()
```
    Description copied from interface: CfnUserPoolClientProps
    
    `AWS::Cognito::UserPoolClient.EnablePropagateAdditionalUserContextData`.
    
    Specified by:
    
    getEnablePropagateAdditionalUserContextData in interface CfnUserPoolClientProps
  - getEnableTokenRevocation
```
public final Object getEnableTokenRevocation()
```
    Description copied from interface: CfnUserPoolClientProps
    
    Activates or deactivates token revocation. For more information about revoking tokens, see [RevokeToken](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html) .
    If you don't include this parameter, token revocation is automatically activated for the new user pool client.
    
    Specified by:
    
    getEnableTokenRevocation in interface CfnUserPoolClientProps
  - getExplicitAuthFlows
```
public final List<String> getExplicitAuthFlows()
```
    Description copied from interface: CfnUserPoolClientProps
    The authentication flows that are supported by the user pool clients.
    Flow names without the ALLOW_ prefix are no longer supported, in favor of new names with the ALLOW_ prefix.
    
    Values with ALLOW_ prefix must be used only along with the ALLOW_ prefix.
    
    Valid values include:
    - ALLOW_ADMIN_USER_PASSWORD_AUTH : Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH . This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.
    - ALLOW_CUSTOM_AUTH : Enable AWS Lambda trigger based authentication.
    - ALLOW_USER_PASSWORD_AUTH : Enable user password-based authentication. In this flow, Amazon Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
    - ALLOW_USER_SRP_AUTH : Enable SRP-based authentication.
    - ALLOW_REFRESH_TOKEN_AUTH : Enable authflow to refresh tokens.
    If you don't specify a value for ExplicitAuthFlows , your app client activates the ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH authentication flows.
    Specified by:
    
    getExplicitAuthFlows in interface CfnUserPoolClientProps
  - getGenerateSecret
```
public final Object getGenerateSecret()
```
    Description copied from interface: CfnUserPoolClientProps
    
    Boolean to specify whether you want to generate a secret for the user pool client being created.
    
    Specified by:
    
    getGenerateSecret in interface CfnUserPoolClientProps
  - getIdTokenValidity
```
public final Number getIdTokenValidity()
```
    Description copied from interface: CfnUserPoolClientProps
    
    The ID token time limit.
    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 AccessTokenValidity in an API request is hours.
    
    Specified by:
    
    getIdTokenValidity in interface CfnUserPoolClientProps
  - getLogoutUrLs
```
public final List<String> getLogoutUrLs()
```
    Description copied from interface: CfnUserPoolClientProps
    
    A list of allowed logout URLs for the IdPs.
    
    Specified by:
    
    getLogoutUrLs in interface CfnUserPoolClientProps
  - getPreventUserExistenceErrors
```
public final String getPreventUserExistenceErrors()
```
    Description copied from interface: CfnUserPoolClientProps
    
    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.
    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.
    
    Specified by:
    
    getPreventUserExistenceErrors in interface CfnUserPoolClientProps
  - getReadAttributes
```
public final List<String> getReadAttributes()
```
    Description copied from interface: CfnUserPoolClientProps
    
    The read attributes.
    
    Specified by:
    
    getReadAttributes in interface CfnUserPoolClientProps
  - getRefreshTokenValidity
```
public final Number getRefreshTokenValidity()
```
    Description copied from interface: CfnUserPoolClientProps
    
    The refresh token time limit.
    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.
    
    Specified by:
    
    getRefreshTokenValidity in interface CfnUserPoolClientProps
  - getSupportedIdentityProviders
```
public final List<String> getSupportedIdentityProviders()
```
    Description copied from interface: CfnUserPoolClientProps
    
    A list of provider names for the IdPs that this client supports.
    The following are supported: COGNITO , Facebook , Google LoginWithAmazon , and the names of your own SAML and OIDC providers.
    
    Specified by:
    
    getSupportedIdentityProviders in interface CfnUserPoolClientProps
  - getTokenValidityUnits
```
public final Object getTokenValidityUnits()
```
    Description copied from interface: CfnUserPoolClientProps
    
    The units in which the validity times are represented.
    The default unit for RefreshToken is days, and default for ID and access tokens are hours.
    
    Specified by:
    
    getTokenValidityUnits in interface CfnUserPoolClientProps
  - getWriteAttributes
```
public final List<String> getWriteAttributes()
```
    Description copied from interface: CfnUserPoolClientProps
    
    The user pool attributes that the app client can write to.
    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 .
    
    Specified by:
    
    getWriteAttributes in interface CfnUserPoolClientProps
  - $jsii$toJson
```
@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
```
    Specified by:
    
    $jsii$toJson in interface software.amazon.jsii.JsiiSerializable
  - equals
```
public final boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class CfnUserPoolClientProps.Jsii$Proxy

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cognito.CfnUserPoolClientProps

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awscdk.services.cognito.CfnUserPoolClientProps

Constructor Detail

Jsii$Proxy

Jsii$Proxy

Method Detail

getUserPoolId

getAccessTokenValidity

getAllowedOAuthFlows

getAllowedOAuthFlowsUserPoolClient

getAllowedOAuthScopes

getAnalyticsConfiguration

getAuthSessionValidity

getCallbackUrLs

getClientName

getDefaultRedirectUri

getEnablePropagateAdditionalUserContextData

getEnableTokenRevocation

getExplicitAuthFlows

getGenerateSecret

getIdTokenValidity

getLogoutUrLs

getPreventUserExistenceErrors

getReadAttributes

getRefreshTokenValidity

getSupportedIdentityProviders

getTokenValidityUnits

getWriteAttributes

$jsii$toJson

equals

hashCode