Package com.pulumi.aws.cognito

Class UserPoolClientArgs.Builder

  • Enclosing class:
    UserPoolClientArgs
    public static final class UserPoolClientArgs.Builder
extends java.lang.Object

    • Method Detail

      • accessTokenValidity

        public UserPoolClientArgs.Builder accessTokenValidity​(@Nullable
                                                      com.pulumi.core.Output<java.lang.Integer> accessTokenValidity)
        Parameters:
        accessTokenValidity - Time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. By default, the unit is hours. The unit can be overridden by a value in `token_validity_units.access_token`.
        Returns:
        builder

      • accessTokenValidity

        public UserPoolClientArgs.Builder accessTokenValidity​(java.lang.Integer accessTokenValidity)
        Parameters:
        accessTokenValidity - Time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. By default, the unit is hours. The unit can be overridden by a value in `token_validity_units.access_token`.
        Returns:
        builder

      • allowedOauthFlows

        public UserPoolClientArgs.Builder allowedOauthFlows​(@Nullable
                                                    com.pulumi.core.Output<java.util.List<java.lang.String>> allowedOauthFlows)
        Parameters:
        allowedOauthFlows - List of allowed OAuth flows, including `code`, `implicit`, and `clientCredentials`. `allowedOauthFlowsUserPoolClient` must be set to `true` before you can configure this option.
        Returns:
        builder

      • allowedOauthFlows

        public UserPoolClientArgs.Builder allowedOauthFlows​(java.util.List<java.lang.String> allowedOauthFlows)
        Parameters:
        allowedOauthFlows - List of allowed OAuth flows, including `code`, `implicit`, and `clientCredentials`. `allowedOauthFlowsUserPoolClient` must be set to `true` before you can configure this option.
        Returns:
        builder

      • allowedOauthFlows

        public UserPoolClientArgs.Builder allowedOauthFlows​(java.lang.String... allowedOauthFlows)
        Parameters:
        allowedOauthFlows - List of allowed OAuth flows, including `code`, `implicit`, and `clientCredentials`. `allowedOauthFlowsUserPoolClient` must be set to `true` before you can configure this option.
        Returns:
        builder

      • allowedOauthFlowsUserPoolClient

        public UserPoolClientArgs.Builder allowedOauthFlowsUserPoolClient​(@Nullable
                                                                  com.pulumi.core.Output<java.lang.Boolean> allowedOauthFlowsUserPoolClient)
        Parameters:
        allowedOauthFlowsUserPoolClient - Whether the client is allowed to use OAuth 2.0 features. `allowedOauthFlowsUserPoolClient` must be set to `true` before you can configure the following arguments: `callbackUrls`, `logoutUrls`, `allowedOauthScopes` and `allowedOauthFlows`.
        Returns:
        builder

      • allowedOauthFlowsUserPoolClient

        public UserPoolClientArgs.Builder allowedOauthFlowsUserPoolClient​(java.lang.Boolean allowedOauthFlowsUserPoolClient)
        Parameters:
        allowedOauthFlowsUserPoolClient - Whether the client is allowed to use OAuth 2.0 features. `allowedOauthFlowsUserPoolClient` must be set to `true` before you can configure the following arguments: `callbackUrls`, `logoutUrls`, `allowedOauthScopes` and `allowedOauthFlows`.
        Returns:
        builder

      • allowedOauthScopes

        public UserPoolClientArgs.Builder allowedOauthScopes​(@Nullable
                                                     com.pulumi.core.Output<java.util.List<java.lang.String>> allowedOauthScopes)
        Parameters:
        allowedOauthScopes - List of allowed OAuth scopes, including `phone`, `email`, `openid`, `profile`, and `aws.cognito.signin.user.admin`. `allowedOauthFlowsUserPoolClient` must be set to `true` before you can configure this option.
        Returns:
        builder

      • allowedOauthScopes

        public UserPoolClientArgs.Builder allowedOauthScopes​(java.util.List<java.lang.String> allowedOauthScopes)
        Parameters:
        allowedOauthScopes - List of allowed OAuth scopes, including `phone`, `email`, `openid`, `profile`, and `aws.cognito.signin.user.admin`. `allowedOauthFlowsUserPoolClient` must be set to `true` before you can configure this option.
        Returns:
        builder

      • allowedOauthScopes

        public UserPoolClientArgs.Builder allowedOauthScopes​(java.lang.String... allowedOauthScopes)
        Parameters:
        allowedOauthScopes - List of allowed OAuth scopes, including `phone`, `email`, `openid`, `profile`, and `aws.cognito.signin.user.admin`. `allowedOauthFlowsUserPoolClient` must be set to `true` before you can configure this option.
        Returns:
        builder

      • analyticsConfiguration

        public UserPoolClientArgs.Builder analyticsConfiguration​(@Nullable
                                                         com.pulumi.core.Output<UserPoolClientAnalyticsConfigurationArgs> analyticsConfiguration)
        Parameters:
        analyticsConfiguration - Configuration block for AWS End User Messaging analytics that collects metrics for this user pool. See details below.
        Returns:
        builder

      • authSessionValidity

        public UserPoolClientArgs.Builder authSessionValidity​(@Nullable
                                                      com.pulumi.core.Output<java.lang.Integer> authSessionValidity)
        Parameters:
        authSessionValidity - Duration, in minutes, of the session token created by Amazon Cognito for each API request in an authentication flow. The session token must be responded to by the native user of the user pool before it expires. Valid values for `authSessionValidity` are between `3` and `15`, with a default value of `3`.
        Returns:
        builder

      • authSessionValidity

        public UserPoolClientArgs.Builder authSessionValidity​(java.lang.Integer authSessionValidity)
        Parameters:
        authSessionValidity - Duration, in minutes, of the session token created by Amazon Cognito for each API request in an authentication flow. The session token must be responded to by the native user of the user pool before it expires. Valid values for `authSessionValidity` are between `3` and `15`, with a default value of `3`.
        Returns:
        builder

      • callbackUrls

        public UserPoolClientArgs.Builder callbackUrls​(@Nullable
                                               com.pulumi.core.Output<java.util.List<java.lang.String>> callbackUrls)
        Parameters:
        callbackUrls - List of allowed callback URLs for the identity providers. `allowedOauthFlowsUserPoolClient` must be set to `true` before you can configure this option.
        Returns:
        builder

      • callbackUrls

        public UserPoolClientArgs.Builder callbackUrls​(java.util.List<java.lang.String> callbackUrls)
        Parameters:
        callbackUrls - List of allowed callback URLs for the identity providers. `allowedOauthFlowsUserPoolClient` must be set to `true` before you can configure this option.
        Returns:
        builder

      • callbackUrls

        public UserPoolClientArgs.Builder callbackUrls​(java.lang.String... callbackUrls)
        Parameters:
        callbackUrls - List of allowed callback URLs for the identity providers. `allowedOauthFlowsUserPoolClient` must be set to `true` before you can configure this option.
        Returns:
        builder

      • defaultRedirectUri

        public UserPoolClientArgs.Builder defaultRedirectUri​(@Nullable
                                                     com.pulumi.core.Output<java.lang.String> defaultRedirectUri)
        Parameters:
        defaultRedirectUri - Default redirect URI and must be included in the list of callback URLs.
        Returns:
        builder

      • defaultRedirectUri

        public UserPoolClientArgs.Builder defaultRedirectUri​(java.lang.String defaultRedirectUri)
        Parameters:
        defaultRedirectUri - Default redirect URI and must be included in the list of callback URLs.
        Returns:
        builder

      • enablePropagateAdditionalUserContextData

        public UserPoolClientArgs.Builder enablePropagateAdditionalUserContextData​(@Nullable
                                                                           com.pulumi.core.Output<java.lang.Boolean> enablePropagateAdditionalUserContextData)
        Parameters:
        enablePropagateAdditionalUserContextData - Enables the propagation of additional user context data.
        Returns:
        builder

      • enablePropagateAdditionalUserContextData

        public UserPoolClientArgs.Builder enablePropagateAdditionalUserContextData​(java.lang.Boolean enablePropagateAdditionalUserContextData)
        Parameters:
        enablePropagateAdditionalUserContextData - Enables the propagation of additional user context data.
        Returns:
        builder

      • enableTokenRevocation

        public UserPoolClientArgs.Builder enableTokenRevocation​(@Nullable
                                                        com.pulumi.core.Output<java.lang.Boolean> enableTokenRevocation)
        Parameters:
        enableTokenRevocation - Enables or disables token revocation.
        Returns:
        builder

      • enableTokenRevocation

        public UserPoolClientArgs.Builder enableTokenRevocation​(java.lang.Boolean enableTokenRevocation)
        Parameters:
        enableTokenRevocation - Enables or disables token revocation.
        Returns:
        builder

      • explicitAuthFlows

        public UserPoolClientArgs.Builder explicitAuthFlows​(@Nullable
                                                    com.pulumi.core.Output<java.util.List<java.lang.String>> explicitAuthFlows)
        Parameters:
        explicitAuthFlows - List of authentication flows. The available options include `ADMIN_NO_SRP_AUTH`, `CUSTOM_AUTH_FLOW_ONLY`, `USER_PASSWORD_AUTH`, `ALLOW_ADMIN_USER_PASSWORD_AUTH`, `ALLOW_CUSTOM_AUTH`, `ALLOW_USER_PASSWORD_AUTH`, `ALLOW_USER_SRP_AUTH`, `ALLOW_REFRESH_TOKEN_AUTH`, and `ALLOW_USER_AUTH`.
        Returns:
        builder

      • explicitAuthFlows

        public UserPoolClientArgs.Builder explicitAuthFlows​(java.util.List<java.lang.String> explicitAuthFlows)
        Parameters:
        explicitAuthFlows - List of authentication flows. The available options include `ADMIN_NO_SRP_AUTH`, `CUSTOM_AUTH_FLOW_ONLY`, `USER_PASSWORD_AUTH`, `ALLOW_ADMIN_USER_PASSWORD_AUTH`, `ALLOW_CUSTOM_AUTH`, `ALLOW_USER_PASSWORD_AUTH`, `ALLOW_USER_SRP_AUTH`, `ALLOW_REFRESH_TOKEN_AUTH`, and `ALLOW_USER_AUTH`.
        Returns:
        builder

      • explicitAuthFlows

        public UserPoolClientArgs.Builder explicitAuthFlows​(java.lang.String... explicitAuthFlows)
        Parameters:
        explicitAuthFlows - List of authentication flows. The available options include `ADMIN_NO_SRP_AUTH`, `CUSTOM_AUTH_FLOW_ONLY`, `USER_PASSWORD_AUTH`, `ALLOW_ADMIN_USER_PASSWORD_AUTH`, `ALLOW_CUSTOM_AUTH`, `ALLOW_USER_PASSWORD_AUTH`, `ALLOW_USER_SRP_AUTH`, `ALLOW_REFRESH_TOKEN_AUTH`, and `ALLOW_USER_AUTH`.
        Returns:
        builder

      • generateSecret

        public UserPoolClientArgs.Builder generateSecret​(@Nullable
                                                 com.pulumi.core.Output<java.lang.Boolean> generateSecret)
        Parameters:
        generateSecret - Boolean flag indicating whether an application secret should be generated.
        Returns:
        builder

      • generateSecret

        public UserPoolClientArgs.Builder generateSecret​(java.lang.Boolean generateSecret)
        Parameters:
        generateSecret - Boolean flag indicating whether an application secret should be generated.
        Returns:
        builder

      • idTokenValidity

        public UserPoolClientArgs.Builder idTokenValidity​(@Nullable
                                                  com.pulumi.core.Output<java.lang.Integer> idTokenValidity)
        Parameters:
        idTokenValidity - Time limit, between 5 minutes and 1 day, after which the ID token is no longer valid and cannot be used. By default, the unit is hours. The unit can be overridden by a value in `token_validity_units.id_token`.
        Returns:
        builder

      • idTokenValidity

        public UserPoolClientArgs.Builder idTokenValidity​(java.lang.Integer idTokenValidity)
        Parameters:
        idTokenValidity - Time limit, between 5 minutes and 1 day, after which the ID token is no longer valid and cannot be used. By default, the unit is hours. The unit can be overridden by a value in `token_validity_units.id_token`.
        Returns:
        builder

      • logoutUrls

        public UserPoolClientArgs.Builder logoutUrls​(@Nullable
                                             com.pulumi.core.Output<java.util.List<java.lang.String>> logoutUrls)
        Parameters:
        logoutUrls - List of allowed logout URLs for the identity providers. `allowedOauthFlowsUserPoolClient` must be set to `true` before you can configure this option.
        Returns:
        builder

      • logoutUrls

        public UserPoolClientArgs.Builder logoutUrls​(java.util.List<java.lang.String> logoutUrls)
        Parameters:
        logoutUrls - List of allowed logout URLs for the identity providers. `allowedOauthFlowsUserPoolClient` must be set to `true` before you can configure this option.
        Returns:
        builder

      • logoutUrls

        public UserPoolClientArgs.Builder logoutUrls​(java.lang.String... logoutUrls)
        Parameters:
        logoutUrls - List of allowed logout URLs for the identity providers. `allowedOauthFlowsUserPoolClient` must be set to `true` before you can configure this option.
        Returns:
        builder

      • name

        public UserPoolClientArgs.Builder name​(@Nullable
                                       com.pulumi.core.Output<java.lang.String> name)
        Parameters:
        name - Name of the application client.
        Returns:
        builder

      • name

        public UserPoolClientArgs.Builder name​(java.lang.String name)
        Parameters:
        name - Name of the application client.
        Returns:
        builder

      • preventUserExistenceErrors

        public UserPoolClientArgs.Builder preventUserExistenceErrors​(@Nullable
                                                             com.pulumi.core.Output<java.lang.String> preventUserExistenceErrors)
        Parameters:
        preventUserExistenceErrors - Setting determines the errors and responses returned by Cognito APIs when a user does not exist in the user pool during authentication, account confirmation, and password recovery.
        Returns:
        builder

      • preventUserExistenceErrors

        public UserPoolClientArgs.Builder preventUserExistenceErrors​(java.lang.String preventUserExistenceErrors)
        Parameters:
        preventUserExistenceErrors - Setting determines the errors and responses returned by Cognito APIs when a user does not exist in the user pool during authentication, account confirmation, and password recovery.
        Returns:
        builder

      • readAttributes

        public UserPoolClientArgs.Builder readAttributes​(@Nullable
                                                 com.pulumi.core.Output<java.util.List<java.lang.String>> readAttributes)
        Parameters:
        readAttributes - List of user pool attributes that the application client can read from.
        Returns:
        builder

      • readAttributes

        public UserPoolClientArgs.Builder readAttributes​(java.util.List<java.lang.String> readAttributes)
        Parameters:
        readAttributes - List of user pool attributes that the application client can read from.
        Returns:
        builder

      • readAttributes

        public UserPoolClientArgs.Builder readAttributes​(java.lang.String... readAttributes)
        Parameters:
        readAttributes - List of user pool attributes that the application client can read from.
        Returns:
        builder

      • refreshTokenValidity

        public UserPoolClientArgs.Builder refreshTokenValidity​(@Nullable
                                                       com.pulumi.core.Output<java.lang.Integer> refreshTokenValidity)
        Parameters:
        refreshTokenValidity - Time limit, between 60 minutes and 10 years, after which the refresh token is no longer valid and cannot be used. By default, the unit is days. The unit can be overridden by a value in `token_validity_units.refresh_token`.
        Returns:
        builder

      • refreshTokenValidity

        public UserPoolClientArgs.Builder refreshTokenValidity​(java.lang.Integer refreshTokenValidity)
        Parameters:
        refreshTokenValidity - Time limit, between 60 minutes and 10 years, after which the refresh token is no longer valid and cannot be used. By default, the unit is days. The unit can be overridden by a value in `token_validity_units.refresh_token`.
        Returns:
        builder

      • region

        public UserPoolClientArgs.Builder region​(@Nullable
                                         com.pulumi.core.Output<java.lang.String> region)
        Parameters:
        region - Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
        Returns:
        builder

      • region

        public UserPoolClientArgs.Builder region​(java.lang.String region)
        Parameters:
        region - Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
        Returns:
        builder

      • supportedIdentityProviders

        public UserPoolClientArgs.Builder supportedIdentityProviders​(@Nullable
                                                             com.pulumi.core.Output<java.util.List<java.lang.String>> supportedIdentityProviders)
        Parameters:
        supportedIdentityProviders - List of provider names for the identity providers that are supported on this client. It uses the `providerName` attribute of the `aws.cognito.IdentityProvider` resource(s), or the equivalent string(s).
        Returns:
        builder

      • supportedIdentityProviders

        public UserPoolClientArgs.Builder supportedIdentityProviders​(java.util.List<java.lang.String> supportedIdentityProviders)
        Parameters:
        supportedIdentityProviders - List of provider names for the identity providers that are supported on this client. It uses the `providerName` attribute of the `aws.cognito.IdentityProvider` resource(s), or the equivalent string(s).
        Returns:
        builder

      • supportedIdentityProviders

        public UserPoolClientArgs.Builder supportedIdentityProviders​(java.lang.String... supportedIdentityProviders)
        Parameters:
        supportedIdentityProviders - List of provider names for the identity providers that are supported on this client. It uses the `providerName` attribute of the `aws.cognito.IdentityProvider` resource(s), or the equivalent string(s).
        Returns:
        builder

      • tokenValidityUnits

        public UserPoolClientArgs.Builder tokenValidityUnits​(@Nullable
                                                     com.pulumi.core.Output<UserPoolClientTokenValidityUnitsArgs> tokenValidityUnits)
        Parameters:
        tokenValidityUnits - Configuration block for representing the validity times in units. See details below. Detailed below.
        Returns:
        builder

      • userPoolId

        public UserPoolClientArgs.Builder userPoolId​(com.pulumi.core.Output<java.lang.String> userPoolId)
        Parameters:
        userPoolId - User pool the client belongs to. The following arguments are optional:
        Returns:
        builder

      • userPoolId

        public UserPoolClientArgs.Builder userPoolId​(java.lang.String userPoolId)
        Parameters:
        userPoolId - User pool the client belongs to. The following arguments are optional:
        Returns:
        builder

      • writeAttributes

        public UserPoolClientArgs.Builder writeAttributes​(@Nullable
                                                  com.pulumi.core.Output<java.util.List<java.lang.String>> writeAttributes)
        Parameters:
        writeAttributes - List of user pool attributes that the application client can write to.
        Returns:
        builder

      • writeAttributes

        public UserPoolClientArgs.Builder writeAttributes​(java.util.List<java.lang.String> writeAttributes)
        Parameters:
        writeAttributes - List of user pool attributes that the application client can write to.
        Returns:
        builder

      • writeAttributes

        public UserPoolClientArgs.Builder writeAttributes​(java.lang.String... writeAttributes)
        Parameters:
        writeAttributes - List of user pool attributes that the application client can write to.
        Returns:
        builder