Class UserPoolClientState

Inheritance

System.Object

InputArgs

ResourceArgs

UserPoolClientState

Inherited Members

ResourceArgs.Empty

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Cognito

Assembly: Pulumi.Aws.dll

Syntax

public sealed class UserPoolClientState : ResourceArgs

Constructors

UserPoolClientState()

Declaration

public UserPoolClientState()

Properties

AllowedOauthFlows

List of allowed OAuth flows (code, implicit, client_credentials).

Declaration

public InputList<string> AllowedOauthFlows { get; set; }

Property Value

Type	Description
InputList<System.String>

AllowedOauthFlowsUserPoolClient

Whether the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.

Declaration

public Input<bool> AllowedOauthFlowsUserPoolClient { get; set; }

Property Value

Type	Description
Input<System.Boolean>

AllowedOauthScopes

List of allowed OAuth scopes (phone, email, openid, profile, and aws.cognito.signin.user.admin).

Declaration

public InputList<string> AllowedOauthScopes { get; set; }

Property Value

Type	Description
InputList<System.String>

AnalyticsConfiguration

The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.

Declaration

public Input<UserPoolClientAnalyticsConfigurationGetArgs> AnalyticsConfiguration { get; set; }

Property Value

Type	Description
Input<UserPoolClientAnalyticsConfigurationGetArgs>

CallbackUrls

List of allowed callback URLs for the identity providers.

Declaration

public InputList<string> CallbackUrls { get; set; }

Property Value

Type	Description
InputList<System.String>

ClientSecret

The client secret of the user pool client.

Declaration

public Input<string> ClientSecret { get; set; }

Property Value

Type	Description
Input<System.String>

DefaultRedirectUri

The default redirect URI. Must be in the list of callback URLs.

Declaration

public Input<string> DefaultRedirectUri { get; set; }

Property Value

Type	Description
Input<System.String>

ExplicitAuthFlows

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).

Declaration

public InputList<string> ExplicitAuthFlows { get; set; }

Property Value

Type	Description
InputList<System.String>

GenerateSecret

Should an application secret be generated.

Declaration

public Input<bool> GenerateSecret { get; set; }

Property Value

Type	Description
Input<System.Boolean>

LogoutUrls

List of allowed logout URLs for the identity providers.

Declaration

public InputList<string> LogoutUrls { get; set; }

Property Value

Type	Description
InputList<System.String>

Name

The name of the application client.

Declaration

public Input<string> Name { get; set; }

Property Value

Type	Description
Input<System.String>

PreventUserExistenceErrors

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.

Declaration

public Input<string> PreventUserExistenceErrors { get; set; }

Property Value

Type	Description
Input<System.String>

ReadAttributes

List of user pool attributes the application client can read from.

Declaration

public InputList<string> ReadAttributes { get; set; }

Property Value

Type	Description
InputList<System.String>

RefreshTokenValidity

The time limit in days refresh tokens are valid for.

Declaration

public Input<int> RefreshTokenValidity { get; set; }

Property Value

Type	Description
Input<System.Int32>

SupportedIdentityProviders

List of provider names for the identity providers that are supported on this client.

Declaration

public InputList<string> SupportedIdentityProviders { get; set; }

Property Value

Type	Description
InputList<System.String>

UserPoolId

The user pool the client belongs to.

Declaration

public Input<string> UserPoolId { get; set; }

Property Value

Type	Description
Input<System.String>

WriteAttributes

List of user pool attributes the application client can write to.

Declaration

public InputList<string> WriteAttributes { get; set; }

Property Value

Type	Description
InputList<System.String>