1. Packages
  2. AWS Native
  3. API Docs
  4. cognito
  5. UserPoolClient

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

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

aws-native.cognito.UserPoolClient

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

    Resource Type definition for AWS::Cognito::UserPoolClient

    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:

    Outputs

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

    ClientId string
    ClientSecret string
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    ClientId string
    ClientSecret string
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    clientId String
    clientSecret String
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    clientId string
    clientSecret string
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    client_id str
    client_secret str
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    clientId String
    clientSecret String
    id String
    The provider-assigned unique ID for this managed resource.
    name String

    Supporting Types

    UserPoolClientAnalyticsConfiguration, UserPoolClientAnalyticsConfigurationArgs

    UserPoolClientTokenValidityUnits, UserPoolClientTokenValidityUnitsArgs

    AccessToken string
    IdToken string
    RefreshToken string
    AccessToken string
    IdToken string
    RefreshToken string
    accessToken String
    idToken String
    refreshToken String
    accessToken string
    idToken string
    refreshToken string
    accessToken String
    idToken String
    refreshToken String

    Package Details

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

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

    AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi