Class: AWSCDK::Cognito::CfnUserPoolClientProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cognito/cfn_user_pool_client_props.rb

Overview

Properties for defining a CfnUserPoolClient.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(user_pool_id:, access_token_validity: nil, allowed_o_auth_flows: nil, allowed_o_auth_flows_user_pool_client: nil, allowed_o_auth_scopes: nil, analytics_configuration: nil, auth_session_validity: nil, callback_ur_ls: nil, client_name: nil, default_redirect_uri: nil, enable_propagate_additional_user_context_data: nil, enable_token_revocation: nil, explicit_auth_flows: nil, generate_secret: nil, id_token_validity: nil, logout_ur_ls: nil, prevent_user_existence_errors: nil, read_attributes: nil, refresh_token_rotation: nil, refresh_token_validity: nil, supported_identity_providers: nil, token_validity_units: nil, write_attributes: nil) ⇒ CfnUserPoolClientProps

Returns a new instance of CfnUserPoolClientProps.

Parameters:

  • user_pool_id (String, AWSCDK::Interfaces::AWSCognito::IUserPoolRef) —

    The ID of the user pool where you want to create an app client.

  • access_token_validity (Numeric, nil) (defaults to: nil) —

    The access token time limit.

  • allowed_o_auth_flows (Array<String>, nil) (defaults to: nil) —

    The OAuth grant types that you want your app client to generate for clients in managed login authentication.

  • allowed_o_auth_flows_user_pool_client (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Set to true to use OAuth 2.0 authorization server features in your app client.

  • allowed_o_auth_scopes (Array<String>, nil) (defaults to: nil) —

    The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app client to authorize access with.

  • analytics_configuration (AWSCDK::IResolvable, AWSCDK::Cognito::CfnUserPoolClient::AnalyticsConfigurationProperty, nil) (defaults to: nil) —

    The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.

  • auth_session_validity (Numeric, nil) (defaults to: nil) —

    Amazon Cognito creates a session token for each API request in an authentication flow.

  • callback_ur_ls (Array<String>, nil) (defaults to: nil) —

    A list of allowed redirect, or callback, URLs for managed login authentication.

  • client_name (String, nil) (defaults to: nil) —

    A friendly name for the app client that you want to create.

  • default_redirect_uri (String, nil) (defaults to: nil) —

    The default redirect URI.

  • enable_propagate_additional_user_context_data (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    When true , your application can include additional UserContextData in authentication requests.

  • enable_token_revocation (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Activates or deactivates token revocation.

  • explicit_auth_flows (Array<String>, nil) (defaults to: nil) —

    The authentication flows that you want your user pool client to support. 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.

  • generate_secret (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    When true , generates a client secret for the app client.

  • id_token_validity (Numeric, nil) (defaults to: nil) —

    The ID token time limit.

  • logout_ur_ls (Array<String>, nil) (defaults to: nil) —

    A list of allowed logout URLs for managed login authentication.

  • prevent_user_existence_errors (String, nil) (defaults to: nil) —

    Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool.

  • read_attributes (Array<String>, nil) (defaults to: nil) —

    The list of user attributes that you want your app client to have read access to.

  • refresh_token_rotation (AWSCDK::IResolvable, AWSCDK::Cognito::CfnUserPoolClient::RefreshTokenRotationProperty, nil) (defaults to: nil) —

    The configuration of your app client for refresh token rotation.

  • refresh_token_validity (Numeric, nil) (defaults to: nil) —

    The refresh token time limit.

  • supported_identity_providers (Array<String>, nil) (defaults to: nil) —

    A list of provider names for the identity providers (IdPs) that are supported on this client.

  • token_validity_units (AWSCDK::IResolvable, AWSCDK::Cognito::CfnUserPoolClient::TokenValidityUnitsProperty, nil) (defaults to: nil) —

    The units that validity times are represented in.

  • write_attributes (Array<String>, nil) (defaults to: nil) —

    The list of user attributes that you want your app client to have write access to.



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'cognito/cfn_user_pool_client_props.rb', line 32

def initialize(user_pool_id:, access_token_validity: nil, allowed_o_auth_flows: nil, allowed_o_auth_flows_user_pool_client: nil, allowed_o_auth_scopes: nil, analytics_configuration: nil, auth_session_validity: nil, callback_ur_ls: nil, client_name: nil, default_redirect_uri: nil, enable_propagate_additional_user_context_data: nil, enable_token_revocation: nil, explicit_auth_flows: nil, generate_secret: nil, id_token_validity: nil, logout_ur_ls: nil, prevent_user_existence_errors: nil, read_attributes: nil, refresh_token_rotation: nil, refresh_token_validity: nil, supported_identity_providers: nil, token_validity_units: nil, write_attributes: nil)
  @user_pool_id = user_pool_id
  Jsii::Type.check_type(@user_pool_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jb2duaXRvLklVc2VyUG9vbFJlZiJ9XX19")), "userPoolId")
  @access_token_validity = access_token_validity
  Jsii::Type.check_type(@access_token_validity, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "accessTokenValidity") unless @access_token_validity.nil?
  @allowed_o_auth_flows = allowed_o_auth_flows
  Jsii::Type.check_type(@allowed_o_auth_flows, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "allowedOAuthFlows") unless @allowed_o_auth_flows.nil?
  @allowed_o_auth_flows_user_pool_client = allowed_o_auth_flows_user_pool_client
  Jsii::Type.check_type(@allowed_o_auth_flows_user_pool_client, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "allowedOAuthFlowsUserPoolClient") unless @allowed_o_auth_flows_user_pool_client.nil?
  @allowed_o_auth_scopes = allowed_o_auth_scopes
  Jsii::Type.check_type(@allowed_o_auth_scopes, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "allowedOAuthScopes") unless @allowed_o_auth_scopes.nil?
  @analytics_configuration = analytics_configuration.is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPoolClient::AnalyticsConfigurationProperty.new(**analytics_configuration.transform_keys(&:to_sym)) : analytics_configuration
  Jsii::Type.check_type(@analytics_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmblVzZXJQb29sQ2xpZW50LkFuYWx5dGljc0NvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "analyticsConfiguration") unless @analytics_configuration.nil?
  @auth_session_validity = auth_session_validity
  Jsii::Type.check_type(@auth_session_validity, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "authSessionValidity") unless @auth_session_validity.nil?
  @callback_ur_ls = callback_ur_ls
  Jsii::Type.check_type(@callback_ur_ls, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "callbackUrLs") unless @callback_ur_ls.nil?
  @client_name = client_name
  Jsii::Type.check_type(@client_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clientName") unless @client_name.nil?
  @default_redirect_uri = default_redirect_uri
  Jsii::Type.check_type(@default_redirect_uri, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "defaultRedirectUri") unless @default_redirect_uri.nil?
  @enable_propagate_additional_user_context_data = enable_propagate_additional_user_context_data
  Jsii::Type.check_type(@enable_propagate_additional_user_context_data, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enablePropagateAdditionalUserContextData") unless @enable_propagate_additional_user_context_data.nil?
  @enable_token_revocation = enable_token_revocation
  Jsii::Type.check_type(@enable_token_revocation, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enableTokenRevocation") unless @enable_token_revocation.nil?
  @explicit_auth_flows = explicit_auth_flows
  Jsii::Type.check_type(@explicit_auth_flows, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "explicitAuthFlows") unless @explicit_auth_flows.nil?
  @generate_secret = generate_secret
  Jsii::Type.check_type(@generate_secret, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "generateSecret") unless @generate_secret.nil?
  @id_token_validity = id_token_validity
  Jsii::Type.check_type(@id_token_validity, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "idTokenValidity") unless @id_token_validity.nil?
  @logout_ur_ls = logout_ur_ls
  Jsii::Type.check_type(@logout_ur_ls, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "logoutUrLs") unless @logout_ur_ls.nil?
  @prevent_user_existence_errors = prevent_user_existence_errors
  Jsii::Type.check_type(@prevent_user_existence_errors, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "preventUserExistenceErrors") unless @prevent_user_existence_errors.nil?
  @read_attributes = read_attributes
  Jsii::Type.check_type(@read_attributes, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "readAttributes") unless @read_attributes.nil?
  @refresh_token_rotation = refresh_token_rotation.is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPoolClient::RefreshTokenRotationProperty.new(**refresh_token_rotation.transform_keys(&:to_sym)) : refresh_token_rotation
  Jsii::Type.check_type(@refresh_token_rotation, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmblVzZXJQb29sQ2xpZW50LlJlZnJlc2hUb2tlblJvdGF0aW9uUHJvcGVydHkifV19fQ==")), "refreshTokenRotation") unless @refresh_token_rotation.nil?
  @refresh_token_validity = refresh_token_validity
  Jsii::Type.check_type(@refresh_token_validity, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "refreshTokenValidity") unless @refresh_token_validity.nil?
  @supported_identity_providers = supported_identity_providers
  Jsii::Type.check_type(@supported_identity_providers, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "supportedIdentityProviders") unless @supported_identity_providers.nil?
  @token_validity_units = token_validity_units.is_a?(Hash) ? ::AWSCDK::Cognito::CfnUserPoolClient::TokenValidityUnitsProperty.new(**token_validity_units.transform_keys(&:to_sym)) : token_validity_units
  Jsii::Type.check_type(@token_validity_units, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmblVzZXJQb29sQ2xpZW50LlRva2VuVmFsaWRpdHlVbml0c1Byb3BlcnR5In1dfX0=")), "tokenValidityUnits") unless @token_validity_units.nil?
  @write_attributes = write_attributes
  Jsii::Type.check_type(@write_attributes, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "writeAttributes") unless @write_attributes.nil?
end

Instance Attribute Details

#access_token_validity ⇒ Numeric? (readonly)

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. Valid range is displayed below in seconds.

If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.

Returns:

  • (Numeric, nil)

See Also:



100
101
102
 
# File 'cognito/cfn_user_pool_client_props.rb', line 100

def access_token_validity
  @access_token_validity
end

#allowed_o_auth_flows ⇒ Array<String>? (readonly)

The OAuth grant types that you want your app client to generate for clients in managed login authentication.

To create an app client that generates client credentials grants, you must add client_credentials as the only allowed OAuth flow.

  • 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 the ID token when scopes like openid and profile are requested, directly to your user.
  • client_credentials - Issue the access token from the /oauth2/token endpoint directly to a non-person user, authorized by a combination of the client ID and client secret.

Returns:

  • (Array<String>, nil)

See Also:



111
112
113
 
# File 'cognito/cfn_user_pool_client_props.rb', line 111

def allowed_o_auth_flows
  @allowed_o_auth_flows
end

#allowed_o_auth_flows_user_pool_client ⇒ Boolean, ... (readonly)

Set to true to use OAuth 2.0 authorization server features in your app client.

This parameter must have a value of true before you can configure the following features in your app client.

  • CallBackURLs : Callback URLs.
  • LogoutURLs : Sign-out redirect URLs.
  • AllowedOAuthScopes : OAuth 2.0 scopes.
  • AllowedOAuthFlows : Support for authorization code, implicit, and client credentials OAuth 2.0 grants.

To use authorization server features, configure one of these features in the Amazon Cognito console or set AllowedOAuthFlowsUserPoolClient to true in a CreateUserPoolClient or UpdateUserPoolClient API request. If you don't set a value for AllowedOAuthFlowsUserPoolClient in a request with the AWS CLI or SDKs, it defaults to false . When false , only SDK-based API sign-in is permitted.

Returns:

See Also:



125
126
127
 
# File 'cognito/cfn_user_pool_client_props.rb', line 125

def allowed_o_auth_flows_user_pool_client
  @allowed_o_auth_flows_user_pool_client
end

#allowed_o_auth_scopes ⇒ Array<String>? (readonly)

The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app client to authorize access with.

Scopes govern access control to user pool self-service API operations, user data from the user_info endpoint, and third-party APIs. Scope values include phone , email , openid , and profile . The aws.cognito.signin.user.admin scope authorizes user self-service operations. Custom scopes with resource servers authorize access to external APIs.

Returns:

  • (Array<String>, nil)

See Also:



132
133
134
 
# File 'cognito/cfn_user_pool_client_props.rb', line 132

def allowed_o_auth_scopes
  @allowed_o_auth_scopes
end

#analytics_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

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 might not have access to analytics or might be configurable with campaigns in the US East (N. Virginia) Region. For more information, see Using Amazon Pinpoint analytics .

Returns:

See Also:



139
140
141
 
# File 'cognito/cfn_user_pool_client_props.rb', line 139

def analytics_configuration
  @analytics_configuration
end

#auth_session_validity ⇒ Numeric? (readonly)

Amazon Cognito creates a session token for each API request in an authentication flow.

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.

Returns:

  • (Numeric, nil)

See Also:



146
147
148
 
# File 'cognito/cfn_user_pool_client_props.rb', line 146

def auth_session_validity
  @auth_session_validity
end

#callback_ur_ls ⇒ Array<String>? (readonly)

A list of allowed redirect, or callback, URLs for managed login authentication.

These URLs are the paths where you want to send your users' browsers after they complete authentication with managed login or a third-party IdP. Typically, callback URLs are the home of an application that uses OAuth or OIDC libraries to process authentication outcomes.

A redirect URI must meet the following requirements:

  • Be an absolute URI.
  • Be registered with the authorization server. Amazon Cognito doesn't accept authorization requests with redirect_uri values that aren't in the list of CallbackURLs that you provide in this parameter.
  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint .

Amazon Cognito requires HTTPS over HTTP except for callback URLs to http://localhost , http://127.0.0.1 and http://[::1] . These callback URLs are for testing purposes only. You can specify custom TCP ports for your callback URLs.

App callback URLs such as myapp://example are also supported.

Returns:

  • (Array<String>, nil)

See Also:



165
166
167
 
# File 'cognito/cfn_user_pool_client_props.rb', line 165

def callback_ur_ls
  @callback_ur_ls
end

#client_name ⇒ String? (readonly)

A friendly name for the app client that you want to create.

Returns:

  • (String, nil)

See Also:



170
171
172
 
# File 'cognito/cfn_user_pool_client_props.rb', line 170

def client_name
  @client_name
end

#default_redirect_uri ⇒ String? (readonly)

The default redirect URI.

In app clients with one assigned IdP, replaces redirect_uri in authentication requests. Must be in the CallbackURLs list.

Returns:

  • (String, nil)

See Also:



177
178
179
 
# File 'cognito/cfn_user_pool_client_props.rb', line 177

def default_redirect_uri
  @default_redirect_uri
end

#enable_propagate_additional_user_context_data ⇒ Boolean, ... (readonly)

When true , your application can include additional UserContextData in authentication requests.

This data includes the IP address, and contributes to analysis by threat protection features. For more information about propagation of user context data, see Adding session data to API requests . If you don’t include this parameter, you can't send the source IP address to Amazon Cognito threat protection features. You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret.

Returns:

See Also:



184
185
186
 
# File 'cognito/cfn_user_pool_client_props.rb', line 184

def enable_propagate_additional_user_context_data
  @enable_propagate_additional_user_context_data
end

#enable_token_revocation ⇒ Boolean, ... (readonly)

Activates or deactivates token revocation.

If you don't include this parameter, token revocation is automatically activated for the new user pool client.

Returns:

See Also:



191
192
193
 
# File 'cognito/cfn_user_pool_client_props.rb', line 191

def enable_token_revocation
  @enable_token_revocation
end

#explicit_auth_flows ⇒ Array<String>? (readonly)

The authentication flows that you want your user pool client to support. 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 app client supports ALLOW_REFRESH_TOKEN_AUTH , ALLOW_USER_SRP_AUTH , and ALLOW_CUSTOM_AUTH .

The values for authentication flow options include the following.

  • ALLOW_USER_AUTH : Enable selection-based sign-in with USER_AUTH . This setting covers username-password, secure remote password (SRP), passwordless, and passkey authentication. This authentiation flow can do username-password and SRP authentication without other ExplicitAuthFlows permitting them. For example users can complete an SRP challenge through USER_AUTH without the flow USER_SRP_AUTH being active for the app client. This flow doesn't include CUSTOM_AUTH .

To activate this setting, your user pool must be in the Essentials tier or higher.

  • 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, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.
  • ALLOW_CUSTOM_AUTH : Enable 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.

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 .

Returns:

  • (Array<String>, nil)

See Also:



213
214
215
 
# File 'cognito/cfn_user_pool_client_props.rb', line 213

def explicit_auth_flows
  @explicit_auth_flows
end

#generate_secret ⇒ Boolean, ... (readonly)

When true , generates a client secret for the app client.

Client secrets are used with server-side and machine-to-machine applications. Client secrets are automatically generated; you can't specify a secret value. For more information, see App client types .

Returns:

See Also:



220
221
222
 
# File 'cognito/cfn_user_pool_client_props.rb', line 220

def generate_secret
  @generate_secret
end

#id_token_validity ⇒ Numeric? (readonly)

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 IdTokenValidity in an API request is hours. Valid range is displayed below in seconds.

If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.

Returns:

  • (Numeric, nil)

See Also:



234
235
236
 
# File 'cognito/cfn_user_pool_client_props.rb', line 234

def id_token_validity
  @id_token_validity
end

#logout_ur_ls ⇒ Array<String>? (readonly)

A list of allowed logout URLs for managed login authentication.

When you pass logout_uri and client_id parameters to /logout , Amazon Cognito signs out your user and redirects them to the logout URL. This parameter describes the URLs that you want to be the permitted targets of logout_uri . A typical use of these URLs is when a user selects "Sign out" and you redirect them to your public homepage. For more information, see Logout endpoint .

Returns:

  • (Array<String>, nil)

See Also:



241
242
243
 
# File 'cognito/cfn_user_pool_client_props.rb', line 241

def logout_ur_ls
  @logout_ur_ls
end

#prevent_user_existence_errors ⇒ String? (readonly)

Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool.

When set to ENABLED and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY , those APIs return a UserNotFoundException exception if the user doesn't exist in the user pool.

Valid values include:

  • ENABLED - This prevents user existence-related errors.
  • LEGACY - This represents the early behavior of Amazon Cognito where user existence related errors aren't prevented.

Defaults to LEGACY when you don't provide a value.

Returns:

  • (String, nil)

See Also:



255
256
257
 
# File 'cognito/cfn_user_pool_client_props.rb', line 255

def prevent_user_existence_errors
  @prevent_user_existence_errors
end

#read_attributes ⇒ Array<String>? (readonly)

The list of user attributes that you want your app client to have read access to.

After your user authenticates in your app, their access token authorizes them to read their own attribute value for any attribute in this list. An example of this kind of activity is when your user selects a link to view their profile information.

When you don't specify the ReadAttributes for your app client, your app can read the values of email_verified , phone_number_verified , and the Standard attributes of your user pool. When your user pool app client has read access to these default attributes, ReadAttributes doesn't return any information. Amazon Cognito only populates ReadAttributes in the API response if you have specified your own custom set of read attributes.

Returns:

  • (Array<String>, nil)

See Also:



264
265
266
 
# File 'cognito/cfn_user_pool_client_props.rb', line 264

def read_attributes
  @read_attributes
end

#refresh_token_rotation ⇒ AWSCDK::IResolvable, ... (readonly)

The configuration of your app client for refresh token rotation.

When enabled, your app client issues new ID, access, and refresh tokens when users renew their sessions with refresh tokens. When disabled, token refresh issues only ID and access tokens.

Returns:

See Also:



271
272
273
 
# File 'cognito/cfn_user_pool_client_props.rb', line 271

def refresh_token_rotation
  @refresh_token_rotation
end

#refresh_token_validity ⇒ Numeric? (readonly)

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. Valid range is displayed below in seconds.

If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.

Returns:

  • (Numeric, nil)

See Also:



286
287
288
 
# File 'cognito/cfn_user_pool_client_props.rb', line 286

def refresh_token_validity
  @refresh_token_validity
end

#supported_identity_providers ⇒ Array<String>? (readonly)

A list of provider names for the identity providers (IdPs) that are supported on this client.

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 .

This parameter sets the IdPs that managed login will display on the login page for your app client. The removal of COGNITO from this list doesn't prevent authentication operations for local users with the user pools API in an AWS SDK. The only way to prevent SDK-based authentication is to block access with a AWS WAF rule .

Returns:

  • (Array<String>, nil)

See Also:



295
296
297
 
# File 'cognito/cfn_user_pool_client_props.rb', line 295

def supported_identity_providers
  @supported_identity_providers
end

#token_validity_units ⇒ AWSCDK::IResolvable, ... (readonly)

The units that validity times are represented in.

The default unit for refresh tokens is days, and the default for ID and access tokens are hours.

Returns:

See Also:



302
303
304
 
# File 'cognito/cfn_user_pool_client_props.rb', line 302

def token_validity_units
  @token_validity_units
end

#user_pool_id ⇒ String, AWSCDK::Interfaces::AWSCognito::IUserPoolRef (readonly)

The ID of the user pool where you want to create an app client.

Returns:

See Also:



85
86
87
 
# File 'cognito/cfn_user_pool_client_props.rb', line 85

def user_pool_id
  @user_pool_id
end

#write_attributes ⇒ Array<String>? (readonly)

The list of user attributes that you want your app client to have write access to.

After your user authenticates in your app, their access token authorizes them to set or modify their own attribute value for any attribute in this list.

When you don't specify the WriteAttributes for your app client, your app can write the values of the Standard attributes of your user pool. When your user pool has write access to these default attributes, WriteAttributes doesn't return any information. Amazon Cognito only populates WriteAttributes in the API response if you have specified your own custom set of write attributes.

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 .

Returns:

  • (Array<String>, nil)

See Also:



313
314
315
 
# File 'cognito/cfn_user_pool_client_props.rb', line 313

def write_attributes
  @write_attributes
end

Class Method Details

.jsii_properties ⇒ Object 



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'cognito/cfn_user_pool_client_props.rb', line 315

def self.jsii_properties
  {
    :user_pool_id => "userPoolId",
    :access_token_validity => "accessTokenValidity",
    :allowed_o_auth_flows => "allowedOAuthFlows",
    :allowed_o_auth_flows_user_pool_client => "allowedOAuthFlowsUserPoolClient",
    :allowed_o_auth_scopes => "allowedOAuthScopes",
    :analytics_configuration => "analyticsConfiguration",
    :auth_session_validity => "authSessionValidity",
    :callback_ur_ls => "callbackUrLs",
    :client_name => "clientName",
    :default_redirect_uri => "defaultRedirectUri",
    :enable_propagate_additional_user_context_data => "enablePropagateAdditionalUserContextData",
    :enable_token_revocation => "enableTokenRevocation",
    :explicit_auth_flows => "explicitAuthFlows",
    :generate_secret => "generateSecret",
    :id_token_validity => "idTokenValidity",
    :logout_ur_ls => "logoutUrLs",
    :prevent_user_existence_errors => "preventUserExistenceErrors",
    :read_attributes => "readAttributes",
    :refresh_token_rotation => "refreshTokenRotation",
    :refresh_token_validity => "refreshTokenValidity",
    :supported_identity_providers => "supportedIdentityProviders",
    :token_validity_units => "tokenValidityUnits",
    :write_attributes => "writeAttributes",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'cognito/cfn_user_pool_client_props.rb', line 343

def to_jsii
  result = {}
  result.merge!({
    "userPoolId" => @user_pool_id,
    "accessTokenValidity" => @access_token_validity,
    "allowedOAuthFlows" => @allowed_o_auth_flows,
    "allowedOAuthFlowsUserPoolClient" => @allowed_o_auth_flows_user_pool_client,
    "allowedOAuthScopes" => @allowed_o_auth_scopes,
    "analyticsConfiguration" => @analytics_configuration,
    "authSessionValidity" => @auth_session_validity,
    "callbackUrLs" => @callback_ur_ls,
    "clientName" => @client_name,
    "defaultRedirectUri" => @default_redirect_uri,
    "enablePropagateAdditionalUserContextData" => @enable_propagate_additional_user_context_data,
    "enableTokenRevocation" => @enable_token_revocation,
    "explicitAuthFlows" => @explicit_auth_flows,
    "generateSecret" => @generate_secret,
    "idTokenValidity" => @id_token_validity,
    "logoutUrLs" => @logout_ur_ls,
    "preventUserExistenceErrors" => @prevent_user_existence_errors,
    "readAttributes" => @read_attributes,
    "refreshTokenRotation" => @refresh_token_rotation,
    "refreshTokenValidity" => @refresh_token_validity,
    "supportedIdentityProviders" => @supported_identity_providers,
    "tokenValidityUnits" => @token_validity_units,
    "writeAttributes" => @write_attributes,
  })
  result.compact
end