Package com.pulumi.aws.cognito.outputs

Class GetUserPoolClientResult

  • public final class GetUserPoolClientResult
extends java.lang.Object

    • Method Detail

      • accessTokenValidity

        public java.lang.Integer accessTokenValidity()
        Returns:
        (Optional) Time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. This value will be overridden if you have entered a value in `tokenValidityUnits`.

      • allowedOauthFlows

        public java.util.List<java.lang.String> allowedOauthFlows()
        Returns:
        (Optional) List of allowed OAuth flows (code, implicit, client_credentials).

      • allowedOauthFlowsUserPoolClient

        public java.lang.Boolean allowedOauthFlowsUserPoolClient()
        Returns:
        (Optional) Whether the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.

      • allowedOauthScopes

        public java.util.List<java.lang.String> allowedOauthScopes()
        Returns:
        (Optional) List of allowed OAuth scopes (phone, email, openid, profile, and aws.cognito.signin.user.admin).

      • analyticsConfigurations

        public java.util.List<GetUserPoolClientAnalyticsConfiguration> analyticsConfigurations()
        Returns:
        (Optional) Configuration block for AWS End User Messaging analytics for collecting metrics for this user pool. Detailed below.

      • callbackUrls

        public java.util.List<java.lang.String> callbackUrls()
        Returns:
        (Optional) List of allowed callback URLs for the identity providers.

      • clientId

        public java.lang.String clientId()

      • clientSecret

        public java.lang.String clientSecret()
        Returns:
        Client secret of the user pool client.

      • defaultRedirectUri

        public java.lang.String defaultRedirectUri()
        Returns:
        (Optional) Default redirect URI. Must be in the list of callback URLs.

      • enablePropagateAdditionalUserContextData

        public java.lang.Boolean enablePropagateAdditionalUserContextData()

      • enableTokenRevocation

        public java.lang.Boolean enableTokenRevocation()
        Returns:
        (Optional) Enables or disables token revocation.

      • explicitAuthFlows

        public java.util.List<java.lang.String> explicitAuthFlows()
        Returns:
        (Optional) List of authentication flows (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).

      • generateSecret

        public java.lang.Boolean generateSecret()
        Returns:
        (Optional) Should an application secret be generated.

      • id

        public java.lang.String id()
        Returns:
        The provider-assigned unique ID for this managed resource.

      • idTokenValidity

        public java.lang.Integer idTokenValidity()
        Returns:
        (Optional) Time limit, between 5 minutes and 1 day, after which the ID token is no longer valid and cannot be used. This value will be overridden if you have entered a value in `tokenValidityUnits`.

      • logoutUrls

        public java.util.List<java.lang.String> logoutUrls()
        Returns:
        (Optional) List of allowed logout URLs for the identity providers.

      • name

        public java.lang.String name()

      • preventUserExistenceErrors

        public java.lang.String preventUserExistenceErrors()
        Returns:
        (Optional) Choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to `ENABLED` and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to `LEGACY`, those APIs will return a `UserNotFoundException` exception if the user does not exist in the user pool.

      • readAttributes

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

      • refreshTokenRotations

        public java.util.List<GetUserPoolClientRefreshTokenRotation> refreshTokenRotations()
        Returns:
        (Optional) A block that specifies the configuration of refresh token rotation. Detailed below.

      • refreshTokenValidity

        public java.lang.Integer refreshTokenValidity()
        Returns:
        (Optional) Time limit in days refresh tokens are valid for.

      • region

        public java.lang.String region()

      • supportedIdentityProviders

        public java.util.List<java.lang.String> supportedIdentityProviders()
        Returns:
        (Optional) List of provider names for the identity providers that are supported on this client. Uses the `providerName` attribute of `aws.cognito.IdentityProvider` resource(s), or the equivalent string(s).

      • tokenValidityUnits

        public java.util.List<GetUserPoolClientTokenValidityUnit> tokenValidityUnits()
        Returns:
        (Optional) Configuration block for units in which the validity times are represented in. Detailed below.

      • userPoolId

        public java.lang.String userPoolId()

      • writeAttributes

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