Package com.pulumi.aws.cognito.inputs

Class ManagedUserPoolClientState.Builder

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

    • Method Detail

      • accessTokenValidity

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

      • clientSecret

        public ManagedUserPoolClientState.Builder clientSecret​(@Nullable
                                                       com.pulumi.core.Output<java.lang.String> clientSecret)
        Parameters:
        clientSecret - Client secret of the user pool client.
        Returns:
        builder

      • clientSecret

        public ManagedUserPoolClientState.Builder clientSecret​(java.lang.String clientSecret)
        Parameters:
        clientSecret - Client secret of the user pool client.
        Returns:
        builder

      • defaultRedirectUri

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

      • enableTokenRevocation

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

      • enableTokenRevocation

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

      • explicitAuthFlows

        public ManagedUserPoolClientState.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 ManagedUserPoolClientState.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 ManagedUserPoolClientState.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 ManagedUserPoolClientState.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 ManagedUserPoolClientState.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 ManagedUserPoolClientState.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 ManagedUserPoolClientState.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 ManagedUserPoolClientState.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 ManagedUserPoolClientState.Builder name​(@Nullable
                                               com.pulumi.core.Output<java.lang.String> name)
        Parameters:
        name - Name of the user pool client.
        Returns:
        builder

      • namePattern

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

      • refreshTokenValidity

        public ManagedUserPoolClientState.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 ManagedUserPoolClientState.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 ManagedUserPoolClientState.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 ManagedUserPoolClientState.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 ManagedUserPoolClientState.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 ManagedUserPoolClientState.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 ManagedUserPoolClientState.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 ManagedUserPoolClientState.Builder userPoolId​(@Nullable
                                                     com.pulumi.core.Output<java.lang.String> userPoolId)
        Parameters:
        userPoolId - User pool that the client belongs to.
        Returns:
        builder

      • userPoolId

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

      • writeAttributes

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