aws-native.cognito.UserPoolClient

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

Create UserPoolClient Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new UserPoolClient(name: string, args: UserPoolClientArgs, opts?: CustomResourceOptions);

@overload
def UserPoolClient(resource_name: str,
                   args: UserPoolClientArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def UserPoolClient(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   user_pool_id: Optional[str] = None,
                   enable_token_revocation: Optional[bool] = None,
                   auth_session_validity: Optional[int] = None,
                   explicit_auth_flows: Optional[Sequence[str]] = None,
                   id_token_validity: Optional[int] = None,
                   generate_secret: Optional[bool] = None,
                   callback_urls: Optional[Sequence[str]] = None,
                   client_name: Optional[str] = None,
                   default_redirect_uri: Optional[str] = None,
                   enable_propagate_additional_user_context_data: Optional[bool] = None,
                   access_token_validity: Optional[int] = None,
                   allowed_o_auth_scopes: Optional[Sequence[str]] = None,
                   allowed_o_auth_flows_user_pool_client: Optional[bool] = None,
                   analytics_configuration: Optional[UserPoolClientAnalyticsConfigurationArgs] = None,
                   logout_urls: Optional[Sequence[str]] = None,
                   prevent_user_existence_errors: Optional[str] = None,
                   read_attributes: Optional[Sequence[str]] = None,
                   refresh_token_validity: Optional[int] = None,
                   supported_identity_providers: Optional[Sequence[str]] = None,
                   token_validity_units: Optional[UserPoolClientTokenValidityUnitsArgs] = None,
                   allowed_o_auth_flows: Optional[Sequence[str]] = None,
                   write_attributes: Optional[Sequence[str]] = None)

func NewUserPoolClient(ctx *Context, name string, args UserPoolClientArgs, opts ...ResourceOption) (*UserPoolClient, error)

public UserPoolClient(string name, UserPoolClientArgs args, CustomResourceOptions? opts = null)

public UserPoolClient(String name, UserPoolClientArgs args)
public UserPoolClient(String name, UserPoolClientArgs args, CustomResourceOptions options)

type: aws-native:cognito:UserPoolClient
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args UserPoolClientArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args UserPoolClientArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args UserPoolClientArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args UserPoolClientArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args UserPoolClientArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Example

The following reference example uses placeholder values for all input properties.

Coming soon!

Coming soon!

Coming soon!

Coming soon!

const userPoolClientResource = new aws_native.cognito.UserPoolClient("userPoolClientResource", {
    userPoolId: "string",
    enableTokenRevocation: false,
    authSessionValidity: 0,
    explicitAuthFlows: ["string"],
    idTokenValidity: 0,
    generateSecret: false,
    callbackUrls: ["string"],
    clientName: "string",
    defaultRedirectUri: "string",
    enablePropagateAdditionalUserContextData: false,
    accessTokenValidity: 0,
    allowedOAuthScopes: ["string"],
    allowedOAuthFlowsUserPoolClient: false,
    analyticsConfiguration: {
        applicationArn: "string",
        applicationId: "string",
        externalId: "string",
        roleArn: "string",
        userDataShared: false,
    },
    logoutUrls: ["string"],
    preventUserExistenceErrors: "string",
    readAttributes: ["string"],
    refreshTokenValidity: 0,
    supportedIdentityProviders: ["string"],
    tokenValidityUnits: {
        accessToken: "string",
        idToken: "string",
        refreshToken: "string",
    },
    allowedOAuthFlows: ["string"],
    writeAttributes: ["string"],
});

Coming soon!

UserPoolClient Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The UserPoolClient resource accepts the following input properties:

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

UserPoolId string
AccessTokenValidity int
AllowedOAuthFlows []string
AllowedOAuthFlowsUserPoolClient bool
AllowedOAuthScopes []string
AnalyticsConfiguration UserPoolClientAnalyticsConfigurationArgs
AuthSessionValidity int
CallbackUrls []string
ClientName string
DefaultRedirectUri string
EnablePropagateAdditionalUserContextData bool
EnableTokenRevocation bool
ExplicitAuthFlows []string
GenerateSecret bool
IdTokenValidity int
LogoutUrls []string
PreventUserExistenceErrors string
ReadAttributes []string
RefreshTokenValidity int
SupportedIdentityProviders []string
TokenValidityUnits UserPoolClientTokenValidityUnitsArgs
WriteAttributes []string

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

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

user_pool_id str
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 UserPoolClientAnalyticsConfigurationArgs
auth_session_validity int
callback_urls Sequence[str]
client_name str
default_redirect_uri str
enable_propagate_additional_user_context_data bool
enable_token_revocation bool
explicit_auth_flows Sequence[str]
generate_secret bool
id_token_validity int
logout_urls Sequence[str]
prevent_user_existence_errors str
read_attributes Sequence[str]
refresh_token_validity int
supported_identity_providers Sequence[str]
token_validity_units UserPoolClientTokenValidityUnitsArgs
write_attributes Sequence[str]

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

Outputs

All input properties are implicitly available as output properties. Additionally, the UserPoolClient resource produces the following output properties: