Package com.pulumi.aws.cognito

Class ManagedUserPoolClientArgs.Builder

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

    • Method Detail

      • accessTokenValidity

        public ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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

      • authSessionValidity

        public ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.Builder enablePropagateAdditionalUserContextData​(java.lang.Boolean enablePropagateAdditionalUserContextData)
        Parameters:
        enablePropagateAdditionalUserContextData - Enables the propagation of additional user context data.
        Returns:
        builder

      • enableTokenRevocation

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

      • enableTokenRevocation

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

      • explicitAuthFlows

        public ManagedUserPoolClientArgs.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, and ALLOW_REFRESH_TOKEN_AUTH.
        Returns:
        builder

      • explicitAuthFlows

        public ManagedUserPoolClientArgs.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, and ALLOW_REFRESH_TOKEN_AUTH.
        Returns:
        builder

      • explicitAuthFlows

        public ManagedUserPoolClientArgs.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, and ALLOW_REFRESH_TOKEN_AUTH.
        Returns:
        builder

      • idTokenValidity

        public ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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

      • namePattern

        public ManagedUserPoolClientArgs.Builder namePattern​(@Nullable
                                                     com.pulumi.core.Output<java.lang.String> namePattern)
        Parameters:
        namePattern - Regular expression that matches the name of the existing User Pool Client to be managed. It must only match one User Pool Client.
        Returns:
        builder

      • namePattern

        public ManagedUserPoolClientArgs.Builder namePattern​(java.lang.String namePattern)
        Parameters:
        namePattern - Regular expression that matches the name of the existing User Pool Client to be managed. It must only match one User Pool Client.
        Returns:
        builder

      • namePrefix

        public ManagedUserPoolClientArgs.Builder namePrefix​(@Nullable
                                                    com.pulumi.core.Output<java.lang.String> namePrefix)
        Parameters:
        namePrefix - String that matches the beginning of the name of the existing User Pool Client to be managed. It must match only one User Pool Client. The following arguments are optional:
        Returns:
        builder

      • namePrefix

        public ManagedUserPoolClientArgs.Builder namePrefix​(java.lang.String namePrefix)
        Parameters:
        namePrefix - String that matches the beginning of the name of the existing User Pool Client to be managed. It must match only one User Pool Client. The following arguments are optional:
        Returns:
        builder

      • preventUserExistenceErrors

        public ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.Builder readAttributes​(java.lang.String... readAttributes)
        Parameters:
        readAttributes - List of user pool attributes that the application client can read from.
        Returns:
        builder

      • refreshTokenValidity

        public ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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

      • userPoolId

        public ManagedUserPoolClientArgs.Builder userPoolId​(com.pulumi.core.Output<java.lang.String> userPoolId)
        Parameters:
        userPoolId - User pool that the client belongs to.
        Returns:
        builder

      • userPoolId

        public ManagedUserPoolClientArgs.Builder userPoolId​(java.lang.String userPoolId)
        Parameters:
        userPoolId - User pool that the client belongs to.
        Returns:
        builder

      • writeAttributes

        public ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.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 ManagedUserPoolClientArgs.Builder writeAttributes​(java.lang.String... writeAttributes)
        Parameters:
        writeAttributes - List of user pool attributes that the application client can write to.
        Returns:
        builder