Package com.pulumi.aws.cognito

Class UserPoolClientArgs

  • public final class UserPoolClientArgs
extends com.pulumi.resources.ResourceArgs

    • Method Detail

      • accessTokenValidity

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> accessTokenValidity()
        Returns:
        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`.

      • allowedOauthFlows

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

      • allowedOauthFlowsUserPoolClient

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> allowedOauthFlowsUserPoolClient()
        Returns:
        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`.

      • allowedOauthScopes

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> allowedOauthScopes()
        Returns:
        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.

      • analyticsConfiguration

        public java.util.Optional<com.pulumi.core.Output<UserPoolClientAnalyticsConfigurationArgs>> analyticsConfiguration()
        Returns:
        Configuration block for AWS End User Messaging analytics that collects metrics for this user pool. See details below.

      • authSessionValidity

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> authSessionValidity()
        Returns:
        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`.

      • callbackUrls

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

      • defaultRedirectUri

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> defaultRedirectUri()
        Returns:
        Default redirect URI and must be included in the list of callback URLs.

      • enablePropagateAdditionalUserContextData

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enablePropagateAdditionalUserContextData()
        Returns:
        Enables the propagation of additional user context data.

      • enableTokenRevocation

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enableTokenRevocation()
        Returns:
        Enables or disables token revocation.

      • explicitAuthFlows

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> explicitAuthFlows()
        Returns:
        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`.

      • generateSecret

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> generateSecret()
        Returns:
        Boolean flag indicating whether an application secret should be generated.

      • idTokenValidity

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> idTokenValidity()
        Returns:
        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`.

      • logoutUrls

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

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        Name of the application client.

      • preventUserExistenceErrors

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> preventUserExistenceErrors()
        Returns:
        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.

      • readAttributes

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> readAttributes()
        Returns:
        List of user pool attributes that the application client can read from.

      • refreshTokenRotation

        public java.util.Optional<com.pulumi.core.Output<UserPoolClientRefreshTokenRotationArgs>> refreshTokenRotation()
        Returns:
        A block that specifies the configuration of refresh token rotation. Detailed below.

      • refreshTokenValidity

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> refreshTokenValidity()
        Returns:
        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`.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        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.

      • supportedIdentityProviders

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> supportedIdentityProviders()
        Returns:
        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).

      • tokenValidityUnits

        public java.util.Optional<com.pulumi.core.Output<UserPoolClientTokenValidityUnitsArgs>> tokenValidityUnits()
        Returns:
        Configuration block for representing the validity times in units. See details below. Detailed below.

      • userPoolId

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

      • writeAttributes

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> writeAttributes()
        Returns:
        List of user pool attributes that the application client can write to.