AWS Native v0.105.0, May 2 24

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.cognito.getUserPoolClient

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi

pulumi/pulumi-aws-native

Using getUserPoolClient

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getUserPoolClient(args: GetUserPoolClientArgs, opts?: InvokeOptions): Promise<GetUserPoolClientResult>
function getUserPoolClientOutput(args: GetUserPoolClientOutputArgs, opts?: InvokeOptions): Output<GetUserPoolClientResult>

def get_user_pool_client(client_id: Optional[str] = None,
                         user_pool_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetUserPoolClientResult
def get_user_pool_client_output(client_id: Optional[pulumi.Input[str]] = None,
                         user_pool_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetUserPoolClientResult]

func LookupUserPoolClient(ctx *Context, args *LookupUserPoolClientArgs, opts ...InvokeOption) (*LookupUserPoolClientResult, error)
func LookupUserPoolClientOutput(ctx *Context, args *LookupUserPoolClientOutputArgs, opts ...InvokeOption) LookupUserPoolClientResultOutput

> Note: This function is named LookupUserPoolClient in the Go SDK.

public static class GetUserPoolClient 
{
    public static Task<GetUserPoolClientResult> InvokeAsync(GetUserPoolClientArgs args, InvokeOptions? opts = null)
    public static Output<GetUserPoolClientResult> Invoke(GetUserPoolClientInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetUserPoolClientResult> getUserPoolClient(GetUserPoolClientArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:cognito:getUserPoolClient
  arguments:
    # arguments dictionary

The following arguments are supported:

ClientId string
UserPoolId string

ClientId string
UserPoolId string

clientId String
userPoolId String

clientId string
userPoolId string

client_id str
user_pool_id str

clientId String
userPoolId String

getUserPoolClient Result

The following output properties are available:

AccessTokenValidity int
AllowedOAuthFlows List<string>
AllowedOAuthFlowsUserPoolClient bool
AllowedOAuthScopes List<string>
AnalyticsConfiguration Pulumi.AwsNative.Cognito.Outputs.UserPoolClientAnalyticsConfiguration
AuthSessionValidity int
CallbackUrls List<string>
ClientId string
ClientName string
ClientSecret string
DefaultRedirectUri string
EnablePropagateAdditionalUserContextData bool
EnableTokenRevocation bool
ExplicitAuthFlows List<string>
IdTokenValidity int
LogoutUrls List<string>
Name string
PreventUserExistenceErrors string
ReadAttributes List<string>
RefreshTokenValidity int
SupportedIdentityProviders List<string>
TokenValidityUnits Pulumi.AwsNative.Cognito.Outputs.UserPoolClientTokenValidityUnits
WriteAttributes List<string>

AccessTokenValidity int
AllowedOAuthFlows []string
AllowedOAuthFlowsUserPoolClient bool
AllowedOAuthScopes []string
AnalyticsConfiguration UserPoolClientAnalyticsConfiguration
AuthSessionValidity int
CallbackUrls []string
ClientId string
ClientName string
ClientSecret string
DefaultRedirectUri string
EnablePropagateAdditionalUserContextData bool
EnableTokenRevocation bool
ExplicitAuthFlows []string
IdTokenValidity int
LogoutUrls []string
Name string
PreventUserExistenceErrors string
ReadAttributes []string
RefreshTokenValidity int
SupportedIdentityProviders []string
TokenValidityUnits UserPoolClientTokenValidityUnits
WriteAttributes []string

accessTokenValidity Integer
allowedOAuthFlows List<String>
allowedOAuthFlowsUserPoolClient Boolean
allowedOAuthScopes List<String>
analyticsConfiguration UserPoolClientAnalyticsConfiguration
authSessionValidity Integer
callbackUrls List<String>
clientId String
clientName String
clientSecret String
defaultRedirectUri String
enablePropagateAdditionalUserContextData Boolean
enableTokenRevocation Boolean
explicitAuthFlows List<String>
idTokenValidity Integer
logoutUrls List<String>
name String
preventUserExistenceErrors String
readAttributes List<String>
refreshTokenValidity Integer
supportedIdentityProviders List<String>
tokenValidityUnits UserPoolClientTokenValidityUnits
writeAttributes List<String>

accessTokenValidity number
allowedOAuthFlows string[]
allowedOAuthFlowsUserPoolClient boolean
allowedOAuthScopes string[]
analyticsConfiguration UserPoolClientAnalyticsConfiguration
authSessionValidity number
callbackUrls string[]
clientId string
clientName string
clientSecret string
defaultRedirectUri string
enablePropagateAdditionalUserContextData boolean
enableTokenRevocation boolean
explicitAuthFlows string[]
idTokenValidity number
logoutUrls string[]
name string
preventUserExistenceErrors string
readAttributes string[]
refreshTokenValidity number
supportedIdentityProviders string[]
tokenValidityUnits UserPoolClientTokenValidityUnits
writeAttributes string[]

access_token_validity int
allowed_o_auth_flows Sequence[str]
allowed_o_auth_flows_user_pool_client bool
allowed_o_auth_scopes Sequence[str]
analytics_configuration UserPoolClientAnalyticsConfiguration
auth_session_validity int
callback_urls Sequence[str]
client_id str
client_name str
client_secret str
default_redirect_uri str
enable_propagate_additional_user_context_data bool
enable_token_revocation bool
explicit_auth_flows Sequence[str]
id_token_validity int
logout_urls Sequence[str]
name str
prevent_user_existence_errors str
read_attributes Sequence[str]
refresh_token_validity int
supported_identity_providers Sequence[str]
token_validity_units UserPoolClientTokenValidityUnits
write_attributes Sequence[str]

accessTokenValidity Number
allowedOAuthFlows List<String>
allowedOAuthFlowsUserPoolClient Boolean
allowedOAuthScopes List<String>
analyticsConfiguration Property Map
authSessionValidity Number
callbackUrls List<String>
clientId String
clientName String
clientSecret String
defaultRedirectUri String
enablePropagateAdditionalUserContextData Boolean
enableTokenRevocation Boolean
explicitAuthFlows List<String>
idTokenValidity Number
logoutUrls List<String>
name String
preventUserExistenceErrors String
readAttributes List<String>
refreshTokenValidity Number
supportedIdentityProviders List<String>
tokenValidityUnits Property Map
writeAttributes List<String>

Supporting Types

UserPoolClientAnalyticsConfiguration

ApplicationArn string
ApplicationId string
ExternalId string
RoleArn string
UserDataShared bool

ApplicationArn string
ApplicationId string
ExternalId string
RoleArn string
UserDataShared bool

applicationArn String
applicationId String
externalId String
roleArn String
userDataShared Boolean

applicationArn string
applicationId string
externalId string
roleArn string
userDataShared boolean

application_arn str
application_id str
external_id str
role_arn str
user_data_shared bool

applicationArn String
applicationId String
externalId String
roleArn String
userDataShared Boolean

UserPoolClientTokenValidityUnits

AccessToken string
IdToken string
RefreshToken string

AccessToken string
IdToken string
RefreshToken string

accessToken String
idToken String
refreshToken String

accessToken string
idToken string
refreshToken string

access_token str
id_token str
refresh_token str

accessToken String
idToken String
refreshToken String

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.cognito.getUserPoolClient

On this page

On this page

Using getUserPoolClient

getUserPoolClient Result

Supporting Types

UserPoolClientAnalyticsConfiguration

UserPoolClientTokenValidityUnits

Package Details

On this page

On this page