Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Bytepluscc Provider
  4. API Docs
  5. id
  6. UserPool
Viewing docs for bytepluscc v0.0.42
published on Monday, Jul 20, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.id.UserPool

bytepluscc logo
Viewing docs for bytepluscc v0.0.42
published on Monday, Jul 20, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    The user pool is the core identity directory resource in the ID service for managing users, login methods, and identity connections

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as bytepluscc from "@byteplus/pulumi-bytepluscc";

const example = new bytepluscc.id.UserPool("Example", {
    name: "禁用开关的用户池",
    description: "这是一个禁用开关的用户池",
    brand: {
        logo_uri: "https://example.com/logo.png",
        name: "测试品牌",
    },
    passwordSignInEnabled: false,
    smsAnonymousSignUpEnabled: false,
    emailPasswordlessSignInEnabled: false,
    selfSignUpEnabled: false,
    signInAttributes: [
        "preferred_username",
        "phone_number",
        "email",
    ],
    requiredSignUpAttributes: [
        "preferred_username",
        "phone_number",
        "email",
    ],
    projectName: "default",
    signUpAutoVerificationEnabled: false,
    selfAccountRecoveryEnabled: false,
    unconfirmedUserSignInEnabled: false,
    smsPasswordlessSignInEnabled: false,
    tags: [{
        key: "env",
        value: "test",
    }],
});

    import pulumi
import pulumi_bytepluscc as bytepluscc

example = bytepluscc.id.UserPool("Example",
    name="禁用开关的用户池",
    description="这是一个禁用开关的用户池",
    brand={
        "logo_uri": "https://example.com/logo.png",
        "name": "测试品牌",
    },
    password_sign_in_enabled=False,
    sms_anonymous_sign_up_enabled=False,
    email_passwordless_sign_in_enabled=False,
    self_sign_up_enabled=False,
    sign_in_attributes=[
        "preferred_username",
        "phone_number",
        "email",
    ],
    required_sign_up_attributes=[
        "preferred_username",
        "phone_number",
        "email",
    ],
    project_name="default",
    sign_up_auto_verification_enabled=False,
    self_account_recovery_enabled=False,
    unconfirmed_user_sign_in_enabled=False,
    sms_passwordless_sign_in_enabled=False,
    tags=[{
        "key": "env",
        "value": "test",
    }])

    package main

import (
	"github.com/byteplus-sdk/pulumi-bytepluscc/sdk/go/bytepluscc/id"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := id.NewUserPool(ctx, "Example", &id.UserPoolArgs{
			Name:        pulumi.String("禁用开关的用户池"),
			Description: pulumi.String("这是一个禁用开关的用户池"),
			Brand: &id.UserPoolBrandArgs{
				Logo_uri: "https://example.com/logo.png",
				Name:     pulumi.String("测试品牌"),
			},
			PasswordSignInEnabled:          pulumi.Bool(false),
			SmsAnonymousSignUpEnabled:      pulumi.Bool(false),
			EmailPasswordlessSignInEnabled: pulumi.Bool(false),
			SelfSignUpEnabled:              pulumi.Bool(false),
			SignInAttributes: pulumi.StringArray{
				pulumi.String("preferred_username"),
				pulumi.String("phone_number"),
				pulumi.String("email"),
			},
			RequiredSignUpAttributes: pulumi.StringArray{
				pulumi.String("preferred_username"),
				pulumi.String("phone_number"),
				pulumi.String("email"),
			},
			ProjectName:                   pulumi.String("default"),
			SignUpAutoVerificationEnabled: pulumi.Bool(false),
			SelfAccountRecoveryEnabled:    pulumi.Bool(false),
			UnconfirmedUserSignInEnabled:  pulumi.Bool(false),
			SmsPasswordlessSignInEnabled:  pulumi.Bool(false),
			Tags: id.UserPoolTagArray{
				&id.UserPoolTagArgs{
					Key:   pulumi.String("env"),
					Value: pulumi.String("test"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Bytepluscc = Byteplus.Pulumi.Bytepluscc;

return await Deployment.RunAsync(() => 
{
    var example = new Bytepluscc.Id.UserPool("Example", new()
    {
        Name = "禁用开关的用户池",
        Description = "这是一个禁用开关的用户池",
        Brand = new Bytepluscc.Id.Inputs.UserPoolBrandArgs
        {
            Logo_uri = "https://example.com/logo.png",
            Name = "测试品牌",
        },
        PasswordSignInEnabled = false,
        SmsAnonymousSignUpEnabled = false,
        EmailPasswordlessSignInEnabled = false,
        SelfSignUpEnabled = false,
        SignInAttributes = new[]
        {
            "preferred_username",
            "phone_number",
            "email",
        },
        RequiredSignUpAttributes = new[]
        {
            "preferred_username",
            "phone_number",
            "email",
        },
        ProjectName = "default",
        SignUpAutoVerificationEnabled = false,
        SelfAccountRecoveryEnabled = false,
        UnconfirmedUserSignInEnabled = false,
        SmsPasswordlessSignInEnabled = false,
        Tags = new[]
        {
            new Bytepluscc.Id.Inputs.UserPoolTagArgs
            {
                Key = "env",
                Value = "test",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.byteplus.bytepluscc.id.UserPool;
import com.byteplus.bytepluscc.id.UserPoolArgs;
import com.pulumi.bytepluscc.id.inputs.UserPoolBrandArgs;
import com.pulumi.bytepluscc.id.inputs.UserPoolTagArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new UserPool("example", UserPoolArgs.builder()
            .name("禁用开关的用户池")
            .description("这是一个禁用开关的用户池")
            .brand(UserPoolBrandArgs.builder()
                .logo_uri("https://example.com/logo.png")
                .name("测试品牌")
                .build())
            .passwordSignInEnabled(false)
            .smsAnonymousSignUpEnabled(false)
            .emailPasswordlessSignInEnabled(false)
            .selfSignUpEnabled(false)
            .signInAttributes(            
                "preferred_username",
                "phone_number",
                "email")
            .requiredSignUpAttributes(            
                "preferred_username",
                "phone_number",
                "email")
            .projectName("default")
            .signUpAutoVerificationEnabled(false)
            .selfAccountRecoveryEnabled(false)
            .unconfirmedUserSignInEnabled(false)
            .smsPasswordlessSignInEnabled(false)
            .tags(UserPoolTagArgs.builder()
                .key("env")
                .value("test")
                .build())
            .build());

    }
}

    resources:
  example:
    type: bytepluscc:id:UserPool
    name: Example
    properties:
      name: 禁用开关的用户池
      description: 这是一个禁用开关的用户池
      brand:
        logo_uri: https://example.com/logo.png
        name: 测试品牌
      passwordSignInEnabled: false
      smsAnonymousSignUpEnabled: false
      emailPasswordlessSignInEnabled: false
      selfSignUpEnabled: false
      signInAttributes:
        - preferred_username
        - phone_number
        - email
      requiredSignUpAttributes:
        - preferred_username
        - phone_number
        - email
      projectName: default
      signUpAutoVerificationEnabled: false
      selfAccountRecoveryEnabled: false
      unconfirmedUserSignInEnabled: false
      smsPasswordlessSignInEnabled: false
      tags:
        - key: env
          value: test

    pulumi {
  required_providers {
    bytepluscc = {
      source = "pulumi/bytepluscc"
    }
  }
}

resource "bytepluscc_id_userpool" "Example" {
  name        = "禁用开关的用户池"
  description = "这是一个禁用开关的用户池"
  brand = {
    logo_uri = "https://example.com/logo.png"
    name     = "测试品牌"
  }
  password_sign_in_enabled           = false
  sms_anonymous_sign_up_enabled      = false
  email_passwordless_sign_in_enabled = false
  self_sign_up_enabled               = false
  sign_in_attributes                 = ["preferred_username", "phone_number", "email"]
  required_sign_up_attributes        = ["preferred_username", "phone_number", "email"]
  project_name                       = "default"
  sign_up_auto_verification_enabled  = false
  self_account_recovery_enabled      = false
  unconfirmed_user_sign_in_enabled   = false
  sms_passwordless_sign_in_enabled   = false
  tags {
    key   = "env"
    value = "test"
  }
}

    Create UserPool Resource

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

    Constructor syntax

    new UserPool(name: string, args: UserPoolArgs, opts?: CustomResourceOptions);
    @overload
def UserPool(resource_name: str,
             args: UserPoolArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def UserPool(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             name: Optional[str] = None,
             required_sign_up_attributes: Optional[Sequence[str]] = None,
             self_sign_up_enabled: Optional[bool] = None,
             description: Optional[str] = None,
             password_sign_in_enabled: Optional[bool] = None,
             project_name: Optional[str] = None,
             brand: Optional[UserPoolBrandArgs] = None,
             self_account_recovery_enabled: Optional[bool] = None,
             email_passwordless_sign_in_enabled: Optional[bool] = None,
             sign_in_attributes: Optional[Sequence[str]] = None,
             sign_up_auto_verification_enabled: Optional[bool] = None,
             sms_anonymous_sign_up_enabled: Optional[bool] = None,
             sms_passwordless_sign_in_enabled: Optional[bool] = None,
             tags: Optional[Sequence[UserPoolTagArgs]] = None,
             unconfirmed_user_sign_in_enabled: Optional[bool] = None)
    func NewUserPool(ctx *Context, name string, args UserPoolArgs, opts ...ResourceOption) (*UserPool, error)
    public UserPool(string name, UserPoolArgs args, CustomResourceOptions? opts = null)
    public UserPool(String name, UserPoolArgs args)
public UserPool(String name, UserPoolArgs args, CustomResourceOptions options)

    type: bytepluscc:id:UserPool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "bytepluscc_id_user_pool" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args UserPoolArgs
    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 UserPoolArgs
    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 UserPoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserPoolArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var userPoolResource = new Bytepluscc.Id.UserPool("userPoolResource", new()
{
    Name = "string",
    RequiredSignUpAttributes = new[]
    {
        "string",
    },
    SelfSignUpEnabled = false,
    Description = "string",
    PasswordSignInEnabled = false,
    ProjectName = "string",
    Brand = new Bytepluscc.Id.Inputs.UserPoolBrandArgs
    {
        LogoUri = "string",
        Name = "string",
    },
    SelfAccountRecoveryEnabled = false,
    EmailPasswordlessSignInEnabled = false,
    SignInAttributes = new[]
    {
        "string",
    },
    SignUpAutoVerificationEnabled = false,
    SmsAnonymousSignUpEnabled = false,
    SmsPasswordlessSignInEnabled = false,
    Tags = new[]
    {
        new Bytepluscc.Id.Inputs.UserPoolTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    UnconfirmedUserSignInEnabled = false,
});

    example, err := id.NewUserPool(ctx, "userPoolResource", &id.UserPoolArgs{
	Name: pulumi.String("string"),
	RequiredSignUpAttributes: pulumi.StringArray{
		pulumi.String("string"),
	},
	SelfSignUpEnabled:     pulumi.Bool(false),
	Description:           pulumi.String("string"),
	PasswordSignInEnabled: pulumi.Bool(false),
	ProjectName:           pulumi.String("string"),
	Brand: &id.UserPoolBrandArgs{
		LogoUri: pulumi.String("string"),
		Name:    pulumi.String("string"),
	},
	SelfAccountRecoveryEnabled:     pulumi.Bool(false),
	EmailPasswordlessSignInEnabled: pulumi.Bool(false),
	SignInAttributes: pulumi.StringArray{
		pulumi.String("string"),
	},
	SignUpAutoVerificationEnabled: pulumi.Bool(false),
	SmsAnonymousSignUpEnabled:     pulumi.Bool(false),
	SmsPasswordlessSignInEnabled:  pulumi.Bool(false),
	Tags: id.UserPoolTagArray{
		&id.UserPoolTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	UnconfirmedUserSignInEnabled: pulumi.Bool(false),
})

    resource "bytepluscc_id_user_pool" "userPoolResource" {
  lifecycle {
    create_before_destroy = true
  }
  name                        = "string"
  required_sign_up_attributes = ["string"]
  self_sign_up_enabled        = false
  description                 = "string"
  password_sign_in_enabled    = false
  project_name                = "string"
  brand = {
    logo_uri = "string"
    name     = "string"
  }
  self_account_recovery_enabled      = false
  email_passwordless_sign_in_enabled = false
  sign_in_attributes                 = ["string"]
  sign_up_auto_verification_enabled  = false
  sms_anonymous_sign_up_enabled      = false
  sms_passwordless_sign_in_enabled   = false
  tags {
    key   = "string"
    value = "string"
  }
  unconfirmed_user_sign_in_enabled = false
}

    var userPoolResource = new UserPool("userPoolResource", UserPoolArgs.builder()
    .name("string")
    .requiredSignUpAttributes("string")
    .selfSignUpEnabled(false)
    .description("string")
    .passwordSignInEnabled(false)
    .projectName("string")
    .brand(UserPoolBrandArgs.builder()
        .logoUri("string")
        .name("string")
        .build())
    .selfAccountRecoveryEnabled(false)
    .emailPasswordlessSignInEnabled(false)
    .signInAttributes("string")
    .signUpAutoVerificationEnabled(false)
    .smsAnonymousSignUpEnabled(false)
    .smsPasswordlessSignInEnabled(false)
    .tags(UserPoolTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .unconfirmedUserSignInEnabled(false)
    .build());

    user_pool_resource = bytepluscc.id.UserPool("userPoolResource",
    name="string",
    required_sign_up_attributes=["string"],
    self_sign_up_enabled=False,
    description="string",
    password_sign_in_enabled=False,
    project_name="string",
    brand={
        "logo_uri": "string",
        "name": "string",
    },
    self_account_recovery_enabled=False,
    email_passwordless_sign_in_enabled=False,
    sign_in_attributes=["string"],
    sign_up_auto_verification_enabled=False,
    sms_anonymous_sign_up_enabled=False,
    sms_passwordless_sign_in_enabled=False,
    tags=[{
        "key": "string",
        "value": "string",
    }],
    unconfirmed_user_sign_in_enabled=False)

    const userPoolResource = new bytepluscc.id.UserPool("userPoolResource", {
    name: "string",
    requiredSignUpAttributes: ["string"],
    selfSignUpEnabled: false,
    description: "string",
    passwordSignInEnabled: false,
    projectName: "string",
    brand: {
        logoUri: "string",
        name: "string",
    },
    selfAccountRecoveryEnabled: false,
    emailPasswordlessSignInEnabled: false,
    signInAttributes: ["string"],
    signUpAutoVerificationEnabled: false,
    smsAnonymousSignUpEnabled: false,
    smsPasswordlessSignInEnabled: false,
    tags: [{
        key: "string",
        value: "string",
    }],
    unconfirmedUserSignInEnabled: false,
});

    type: bytepluscc:id:UserPool
properties:
    brand:
        logoUri: string
        name: string
    description: string
    emailPasswordlessSignInEnabled: false
    name: string
    passwordSignInEnabled: false
    projectName: string
    requiredSignUpAttributes:
        - string
    selfAccountRecoveryEnabled: false
    selfSignUpEnabled: false
    signInAttributes:
        - string
    signUpAutoVerificationEnabled: false
    smsAnonymousSignUpEnabled: false
    smsPasswordlessSignInEnabled: false
    tags:
        - key: string
          value: string
    unconfirmedUserSignInEnabled: false

    UserPool Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The UserPool resource accepts the following input properties:

    Name string
    User pool name
    Brand Byteplus.UserPoolBrand
    User pool brand display configuration
    Description string
    User pool description
    EmailPasswordlessSignInEnabled bool
    Email passwordless login enabled
    PasswordSignInEnabled bool
    Password login enabled
    ProjectName string
    Project name
    RequiredSignUpAttributes List<string>
    Required registration attribute list
    SelfAccountRecoveryEnabled bool
    Allow account self-recovery
    SelfSignUpEnabled bool
    Allow user self-registration
    SignInAttributes List<string>
    Supported login attribute list
    SignUpAutoVerificationEnabled bool
    Registration auto-validation enabled
    SmsAnonymousSignUpEnabled bool
    SMS anonymous registration enabled
    SmsPasswordlessSignInEnabled bool
    SMS passwordless login enabled
    Tags List<Byteplus.UserPoolTag>
    User pool tag list Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    UnconfirmedUserSignInEnabled bool
    Allow unconfirmed users to log in
    Name string
    User pool name
    Brand UserPoolBrandArgs
    User pool brand display configuration
    Description string
    User pool description
    EmailPasswordlessSignInEnabled bool
    Email passwordless login enabled
    PasswordSignInEnabled bool
    Password login enabled
    ProjectName string
    Project name
    RequiredSignUpAttributes []string
    Required registration attribute list
    SelfAccountRecoveryEnabled bool
    Allow account self-recovery
    SelfSignUpEnabled bool
    Allow user self-registration
    SignInAttributes []string
    Supported login attribute list
    SignUpAutoVerificationEnabled bool
    Registration auto-validation enabled
    SmsAnonymousSignUpEnabled bool
    SMS anonymous registration enabled
    SmsPasswordlessSignInEnabled bool
    SMS passwordless login enabled
    Tags []UserPoolTagArgs
    User pool tag list Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    UnconfirmedUserSignInEnabled bool
    Allow unconfirmed users to log in
    name string
    User pool name
    brand object
    User pool brand display configuration
    description string
    User pool description
    email_passwordless_sign_in_enabled bool
    Email passwordless login enabled
    password_sign_in_enabled bool
    Password login enabled
    project_name string
    Project name
    required_sign_up_attributes list(string)
    Required registration attribute list
    self_account_recovery_enabled bool
    Allow account self-recovery
    self_sign_up_enabled bool
    Allow user self-registration
    sign_in_attributes list(string)
    Supported login attribute list
    sign_up_auto_verification_enabled bool
    Registration auto-validation enabled
    sms_anonymous_sign_up_enabled bool
    SMS anonymous registration enabled
    sms_passwordless_sign_in_enabled bool
    SMS passwordless login enabled
    tags list(object)
    User pool tag list Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    unconfirmed_user_sign_in_enabled bool
    Allow unconfirmed users to log in
    name String
    User pool name
    brand UserPoolBrand
    User pool brand display configuration
    description String
    User pool description
    emailPasswordlessSignInEnabled Boolean
    Email passwordless login enabled
    passwordSignInEnabled Boolean
    Password login enabled
    projectName String
    Project name
    requiredSignUpAttributes List<String>
    Required registration attribute list
    selfAccountRecoveryEnabled Boolean
    Allow account self-recovery
    selfSignUpEnabled Boolean
    Allow user self-registration
    signInAttributes List<String>
    Supported login attribute list
    signUpAutoVerificationEnabled Boolean
    Registration auto-validation enabled
    smsAnonymousSignUpEnabled Boolean
    SMS anonymous registration enabled
    smsPasswordlessSignInEnabled Boolean
    SMS passwordless login enabled
    tags List<UserPoolTag>
    User pool tag list Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    unconfirmedUserSignInEnabled Boolean
    Allow unconfirmed users to log in
    name string
    User pool name
    brand UserPoolBrand
    User pool brand display configuration
    description string
    User pool description
    emailPasswordlessSignInEnabled boolean
    Email passwordless login enabled
    passwordSignInEnabled boolean
    Password login enabled
    projectName string
    Project name
    requiredSignUpAttributes string[]
    Required registration attribute list
    selfAccountRecoveryEnabled boolean
    Allow account self-recovery
    selfSignUpEnabled boolean
    Allow user self-registration
    signInAttributes string[]
    Supported login attribute list
    signUpAutoVerificationEnabled boolean
    Registration auto-validation enabled
    smsAnonymousSignUpEnabled boolean
    SMS anonymous registration enabled
    smsPasswordlessSignInEnabled boolean
    SMS passwordless login enabled
    tags UserPoolTag[]
    User pool tag list Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    unconfirmedUserSignInEnabled boolean
    Allow unconfirmed users to log in
    name str
    User pool name
    brand UserPoolBrandArgs
    User pool brand display configuration
    description str
    User pool description
    email_passwordless_sign_in_enabled bool
    Email passwordless login enabled
    password_sign_in_enabled bool
    Password login enabled
    project_name str
    Project name
    required_sign_up_attributes Sequence[str]
    Required registration attribute list
    self_account_recovery_enabled bool
    Allow account self-recovery
    self_sign_up_enabled bool
    Allow user self-registration
    sign_in_attributes Sequence[str]
    Supported login attribute list
    sign_up_auto_verification_enabled bool
    Registration auto-validation enabled
    sms_anonymous_sign_up_enabled bool
    SMS anonymous registration enabled
    sms_passwordless_sign_in_enabled bool
    SMS passwordless login enabled
    tags Sequence[UserPoolTagArgs]
    User pool tag list Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    unconfirmed_user_sign_in_enabled bool
    Allow unconfirmed users to log in
    name String
    User pool name
    brand Property Map
    User pool brand display configuration
    description String
    User pool description
    emailPasswordlessSignInEnabled Boolean
    Email passwordless login enabled
    passwordSignInEnabled Boolean
    Password login enabled
    projectName String
    Project name
    requiredSignUpAttributes List<String>
    Required registration attribute list
    selfAccountRecoveryEnabled Boolean
    Allow account self-recovery
    selfSignUpEnabled Boolean
    Allow user self-registration
    signInAttributes List<String>
    Supported login attribute list
    signUpAutoVerificationEnabled Boolean
    Registration auto-validation enabled
    smsAnonymousSignUpEnabled Boolean
    SMS anonymous registration enabled
    smsPasswordlessSignInEnabled Boolean
    SMS passwordless login enabled
    tags List<Property Map>
    User pool tag list Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    unconfirmedUserSignInEnabled Boolean
    Allow unconfirmed users to log in

    Outputs

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

    CreateTime string
    Creation time
    DiscoveryUrl string
    OpenID Connect discovery URL
    Domain string
    User pool access domain
    Enabled bool
    User pool enabled
    Id string
    The provider-assigned unique ID for this managed resource.
    IssuerUrl string
    Token issuer URL
    OauthLoginCallbackUrl string
    OAuth login callback URL
    OauthSignUpCallbackUrl string
    OAuth registration callback URL
    OidcLoginCallbackUrl string
    OIDC login callback URL
    OidcSignUpCallbackUrl string
    OIDC registration callback URL
    SamlLoginCallbackUrl string
    SAML login callback URL
    SamlSignUpCallbackUrl string
    SAML registration callback URL
    TokenSigningKeyUrl string
    Token signature public key URL
    TokenUrl string
    Token endpoint URL
    TotalClients int
    Total clients in user pool
    TotalConnections int
    Total connections and identity providers in user pool
    TotalUsers int
    Total users in user pool
    Trn string
    User pool TRN
    Uid string
    User pool unique identifier
    UpdateTime string
    Update time
    CreateTime string
    Creation time
    DiscoveryUrl string
    OpenID Connect discovery URL
    Domain string
    User pool access domain
    Enabled bool
    User pool enabled
    Id string
    The provider-assigned unique ID for this managed resource.
    IssuerUrl string
    Token issuer URL
    OauthLoginCallbackUrl string
    OAuth login callback URL
    OauthSignUpCallbackUrl string
    OAuth registration callback URL
    OidcLoginCallbackUrl string
    OIDC login callback URL
    OidcSignUpCallbackUrl string
    OIDC registration callback URL
    SamlLoginCallbackUrl string
    SAML login callback URL
    SamlSignUpCallbackUrl string
    SAML registration callback URL
    TokenSigningKeyUrl string
    Token signature public key URL
    TokenUrl string
    Token endpoint URL
    TotalClients int
    Total clients in user pool
    TotalConnections int
    Total connections and identity providers in user pool
    TotalUsers int
    Total users in user pool
    Trn string
    User pool TRN
    Uid string
    User pool unique identifier
    UpdateTime string
    Update time
    create_time string
    Creation time
    discovery_url string
    OpenID Connect discovery URL
    domain string
    User pool access domain
    enabled bool
    User pool enabled
    id string
    The provider-assigned unique ID for this managed resource.
    issuer_url string
    Token issuer URL
    oauth_login_callback_url string
    OAuth login callback URL
    oauth_sign_up_callback_url string
    OAuth registration callback URL
    oidc_login_callback_url string
    OIDC login callback URL
    oidc_sign_up_callback_url string
    OIDC registration callback URL
    saml_login_callback_url string
    SAML login callback URL
    saml_sign_up_callback_url string
    SAML registration callback URL
    token_signing_key_url string
    Token signature public key URL
    token_url string
    Token endpoint URL
    total_clients number
    Total clients in user pool
    total_connections number
    Total connections and identity providers in user pool
    total_users number
    Total users in user pool
    trn string
    User pool TRN
    uid string
    User pool unique identifier
    update_time string
    Update time
    createTime String
    Creation time
    discoveryUrl String
    OpenID Connect discovery URL
    domain String
    User pool access domain
    enabled Boolean
    User pool enabled
    id String
    The provider-assigned unique ID for this managed resource.
    issuerUrl String
    Token issuer URL
    oauthLoginCallbackUrl String
    OAuth login callback URL
    oauthSignUpCallbackUrl String
    OAuth registration callback URL
    oidcLoginCallbackUrl String
    OIDC login callback URL
    oidcSignUpCallbackUrl String
    OIDC registration callback URL
    samlLoginCallbackUrl String
    SAML login callback URL
    samlSignUpCallbackUrl String
    SAML registration callback URL
    tokenSigningKeyUrl String
    Token signature public key URL
    tokenUrl String
    Token endpoint URL
    totalClients Integer
    Total clients in user pool
    totalConnections Integer
    Total connections and identity providers in user pool
    totalUsers Integer
    Total users in user pool
    trn String
    User pool TRN
    uid String
    User pool unique identifier
    updateTime String
    Update time
    createTime string
    Creation time
    discoveryUrl string
    OpenID Connect discovery URL
    domain string
    User pool access domain
    enabled boolean
    User pool enabled
    id string
    The provider-assigned unique ID for this managed resource.
    issuerUrl string
    Token issuer URL
    oauthLoginCallbackUrl string
    OAuth login callback URL
    oauthSignUpCallbackUrl string
    OAuth registration callback URL
    oidcLoginCallbackUrl string
    OIDC login callback URL
    oidcSignUpCallbackUrl string
    OIDC registration callback URL
    samlLoginCallbackUrl string
    SAML login callback URL
    samlSignUpCallbackUrl string
    SAML registration callback URL
    tokenSigningKeyUrl string
    Token signature public key URL
    tokenUrl string
    Token endpoint URL
    totalClients number
    Total clients in user pool
    totalConnections number
    Total connections and identity providers in user pool
    totalUsers number
    Total users in user pool
    trn string
    User pool TRN
    uid string
    User pool unique identifier
    updateTime string
    Update time
    create_time str
    Creation time
    discovery_url str
    OpenID Connect discovery URL
    domain str
    User pool access domain
    enabled bool
    User pool enabled
    id str
    The provider-assigned unique ID for this managed resource.
    issuer_url str
    Token issuer URL
    oauth_login_callback_url str
    OAuth login callback URL
    oauth_sign_up_callback_url str
    OAuth registration callback URL
    oidc_login_callback_url str
    OIDC login callback URL
    oidc_sign_up_callback_url str
    OIDC registration callback URL
    saml_login_callback_url str
    SAML login callback URL
    saml_sign_up_callback_url str
    SAML registration callback URL
    token_signing_key_url str
    Token signature public key URL
    token_url str
    Token endpoint URL
    total_clients int
    Total clients in user pool
    total_connections int
    Total connections and identity providers in user pool
    total_users int
    Total users in user pool
    trn str
    User pool TRN
    uid str
    User pool unique identifier
    update_time str
    Update time
    createTime String
    Creation time
    discoveryUrl String
    OpenID Connect discovery URL
    domain String
    User pool access domain
    enabled Boolean
    User pool enabled
    id String
    The provider-assigned unique ID for this managed resource.
    issuerUrl String
    Token issuer URL
    oauthLoginCallbackUrl String
    OAuth login callback URL
    oauthSignUpCallbackUrl String
    OAuth registration callback URL
    oidcLoginCallbackUrl String
    OIDC login callback URL
    oidcSignUpCallbackUrl String
    OIDC registration callback URL
    samlLoginCallbackUrl String
    SAML login callback URL
    samlSignUpCallbackUrl String
    SAML registration callback URL
    tokenSigningKeyUrl String
    Token signature public key URL
    tokenUrl String
    Token endpoint URL
    totalClients Number
    Total clients in user pool
    totalConnections Number
    Total connections and identity providers in user pool
    totalUsers Number
    Total users in user pool
    trn String
    User pool TRN
    uid String
    User pool unique identifier
    updateTime String
    Update time

    Look up Existing UserPool Resource

    Get an existing UserPool resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: UserPoolState, opts?: CustomResourceOptions): UserPool
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        brand: Optional[UserPoolBrandArgs] = None,
        create_time: Optional[str] = None,
        description: Optional[str] = None,
        discovery_url: Optional[str] = None,
        domain: Optional[str] = None,
        email_passwordless_sign_in_enabled: Optional[bool] = None,
        enabled: Optional[bool] = None,
        issuer_url: Optional[str] = None,
        name: Optional[str] = None,
        oauth_login_callback_url: Optional[str] = None,
        oauth_sign_up_callback_url: Optional[str] = None,
        oidc_login_callback_url: Optional[str] = None,
        oidc_sign_up_callback_url: Optional[str] = None,
        password_sign_in_enabled: Optional[bool] = None,
        project_name: Optional[str] = None,
        required_sign_up_attributes: Optional[Sequence[str]] = None,
        saml_login_callback_url: Optional[str] = None,
        saml_sign_up_callback_url: Optional[str] = None,
        self_account_recovery_enabled: Optional[bool] = None,
        self_sign_up_enabled: Optional[bool] = None,
        sign_in_attributes: Optional[Sequence[str]] = None,
        sign_up_auto_verification_enabled: Optional[bool] = None,
        sms_anonymous_sign_up_enabled: Optional[bool] = None,
        sms_passwordless_sign_in_enabled: Optional[bool] = None,
        tags: Optional[Sequence[UserPoolTagArgs]] = None,
        token_signing_key_url: Optional[str] = None,
        token_url: Optional[str] = None,
        total_clients: Optional[int] = None,
        total_connections: Optional[int] = None,
        total_users: Optional[int] = None,
        trn: Optional[str] = None,
        uid: Optional[str] = None,
        unconfirmed_user_sign_in_enabled: Optional[bool] = None,
        update_time: Optional[str] = None) -> UserPool
    func GetUserPool(ctx *Context, name string, id IDInput, state *UserPoolState, opts ...ResourceOption) (*UserPool, error)
    public static UserPool Get(string name, Input<string> id, UserPoolState? state, CustomResourceOptions? opts = null)
    public static UserPool get(String name, Output<String> id, UserPoolState state, CustomResourceOptions options)
    resources:  _:    type: bytepluscc:id:UserPool    get:      id: ${id}
    import {
  to = bytepluscc_id_user_pool.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Brand Byteplus.UserPoolBrand
    User pool brand display configuration
    CreateTime string
    Creation time
    Description string
    User pool description
    DiscoveryUrl string
    OpenID Connect discovery URL
    Domain string
    User pool access domain
    EmailPasswordlessSignInEnabled bool
    Email passwordless login enabled
    Enabled bool
    User pool enabled
    IssuerUrl string
    Token issuer URL
    Name string
    User pool name
    OauthLoginCallbackUrl string
    OAuth login callback URL
    OauthSignUpCallbackUrl string
    OAuth registration callback URL
    OidcLoginCallbackUrl string
    OIDC login callback URL
    OidcSignUpCallbackUrl string
    OIDC registration callback URL
    PasswordSignInEnabled bool
    Password login enabled
    ProjectName string
    Project name
    RequiredSignUpAttributes List<string>
    Required registration attribute list
    SamlLoginCallbackUrl string
    SAML login callback URL
    SamlSignUpCallbackUrl string
    SAML registration callback URL
    SelfAccountRecoveryEnabled bool
    Allow account self-recovery
    SelfSignUpEnabled bool
    Allow user self-registration
    SignInAttributes List<string>
    Supported login attribute list
    SignUpAutoVerificationEnabled bool
    Registration auto-validation enabled
    SmsAnonymousSignUpEnabled bool
    SMS anonymous registration enabled
    SmsPasswordlessSignInEnabled bool
    SMS passwordless login enabled
    Tags List<Byteplus.UserPoolTag>
    User pool tag list Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    TokenSigningKeyUrl string
    Token signature public key URL
    TokenUrl string
    Token endpoint URL
    TotalClients int
    Total clients in user pool
    TotalConnections int
    Total connections and identity providers in user pool
    TotalUsers int
    Total users in user pool
    Trn string
    User pool TRN
    Uid string
    User pool unique identifier
    UnconfirmedUserSignInEnabled bool
    Allow unconfirmed users to log in
    UpdateTime string
    Update time
    Brand UserPoolBrandArgs
    User pool brand display configuration
    CreateTime string
    Creation time
    Description string
    User pool description
    DiscoveryUrl string
    OpenID Connect discovery URL
    Domain string
    User pool access domain
    EmailPasswordlessSignInEnabled bool
    Email passwordless login enabled
    Enabled bool
    User pool enabled
    IssuerUrl string
    Token issuer URL
    Name string
    User pool name
    OauthLoginCallbackUrl string
    OAuth login callback URL
    OauthSignUpCallbackUrl string
    OAuth registration callback URL
    OidcLoginCallbackUrl string
    OIDC login callback URL
    OidcSignUpCallbackUrl string
    OIDC registration callback URL
    PasswordSignInEnabled bool
    Password login enabled
    ProjectName string
    Project name
    RequiredSignUpAttributes []string
    Required registration attribute list
    SamlLoginCallbackUrl string
    SAML login callback URL
    SamlSignUpCallbackUrl string
    SAML registration callback URL
    SelfAccountRecoveryEnabled bool
    Allow account self-recovery
    SelfSignUpEnabled bool
    Allow user self-registration
    SignInAttributes []string
    Supported login attribute list
    SignUpAutoVerificationEnabled bool
    Registration auto-validation enabled
    SmsAnonymousSignUpEnabled bool
    SMS anonymous registration enabled
    SmsPasswordlessSignInEnabled bool
    SMS passwordless login enabled
    Tags []UserPoolTagArgs
    User pool tag list Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    TokenSigningKeyUrl string
    Token signature public key URL
    TokenUrl string
    Token endpoint URL
    TotalClients int
    Total clients in user pool
    TotalConnections int
    Total connections and identity providers in user pool
    TotalUsers int
    Total users in user pool
    Trn string
    User pool TRN
    Uid string
    User pool unique identifier
    UnconfirmedUserSignInEnabled bool
    Allow unconfirmed users to log in
    UpdateTime string
    Update time
    brand object
    User pool brand display configuration
    create_time string
    Creation time
    description string
    User pool description
    discovery_url string
    OpenID Connect discovery URL
    domain string
    User pool access domain
    email_passwordless_sign_in_enabled bool
    Email passwordless login enabled
    enabled bool
    User pool enabled
    issuer_url string
    Token issuer URL
    name string
    User pool name
    oauth_login_callback_url string
    OAuth login callback URL
    oauth_sign_up_callback_url string
    OAuth registration callback URL
    oidc_login_callback_url string
    OIDC login callback URL
    oidc_sign_up_callback_url string
    OIDC registration callback URL
    password_sign_in_enabled bool
    Password login enabled
    project_name string
    Project name
    required_sign_up_attributes list(string)
    Required registration attribute list
    saml_login_callback_url string
    SAML login callback URL
    saml_sign_up_callback_url string
    SAML registration callback URL
    self_account_recovery_enabled bool
    Allow account self-recovery
    self_sign_up_enabled bool
    Allow user self-registration
    sign_in_attributes list(string)
    Supported login attribute list
    sign_up_auto_verification_enabled bool
    Registration auto-validation enabled
    sms_anonymous_sign_up_enabled bool
    SMS anonymous registration enabled
    sms_passwordless_sign_in_enabled bool
    SMS passwordless login enabled
    tags list(object)
    User pool tag list Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    token_signing_key_url string
    Token signature public key URL
    token_url string
    Token endpoint URL
    total_clients number
    Total clients in user pool
    total_connections number
    Total connections and identity providers in user pool
    total_users number
    Total users in user pool
    trn string
    User pool TRN
    uid string
    User pool unique identifier
    unconfirmed_user_sign_in_enabled bool
    Allow unconfirmed users to log in
    update_time string
    Update time
    brand UserPoolBrand
    User pool brand display configuration
    createTime String
    Creation time
    description String
    User pool description
    discoveryUrl String
    OpenID Connect discovery URL
    domain String
    User pool access domain
    emailPasswordlessSignInEnabled Boolean
    Email passwordless login enabled
    enabled Boolean
    User pool enabled
    issuerUrl String
    Token issuer URL
    name String
    User pool name
    oauthLoginCallbackUrl String
    OAuth login callback URL
    oauthSignUpCallbackUrl String
    OAuth registration callback URL
    oidcLoginCallbackUrl String
    OIDC login callback URL
    oidcSignUpCallbackUrl String
    OIDC registration callback URL
    passwordSignInEnabled Boolean
    Password login enabled
    projectName String
    Project name
    requiredSignUpAttributes List<String>
    Required registration attribute list
    samlLoginCallbackUrl String
    SAML login callback URL
    samlSignUpCallbackUrl String
    SAML registration callback URL
    selfAccountRecoveryEnabled Boolean
    Allow account self-recovery
    selfSignUpEnabled Boolean
    Allow user self-registration
    signInAttributes List<String>
    Supported login attribute list
    signUpAutoVerificationEnabled Boolean
    Registration auto-validation enabled
    smsAnonymousSignUpEnabled Boolean
    SMS anonymous registration enabled
    smsPasswordlessSignInEnabled Boolean
    SMS passwordless login enabled
    tags List<UserPoolTag>
    User pool tag list Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    tokenSigningKeyUrl String
    Token signature public key URL
    tokenUrl String
    Token endpoint URL
    totalClients Integer
    Total clients in user pool
    totalConnections Integer
    Total connections and identity providers in user pool
    totalUsers Integer
    Total users in user pool
    trn String
    User pool TRN
    uid String
    User pool unique identifier
    unconfirmedUserSignInEnabled Boolean
    Allow unconfirmed users to log in
    updateTime String
    Update time
    brand UserPoolBrand
    User pool brand display configuration
    createTime string
    Creation time
    description string
    User pool description
    discoveryUrl string
    OpenID Connect discovery URL
    domain string
    User pool access domain
    emailPasswordlessSignInEnabled boolean
    Email passwordless login enabled
    enabled boolean
    User pool enabled
    issuerUrl string
    Token issuer URL
    name string
    User pool name
    oauthLoginCallbackUrl string
    OAuth login callback URL
    oauthSignUpCallbackUrl string
    OAuth registration callback URL
    oidcLoginCallbackUrl string
    OIDC login callback URL
    oidcSignUpCallbackUrl string
    OIDC registration callback URL
    passwordSignInEnabled boolean
    Password login enabled
    projectName string
    Project name
    requiredSignUpAttributes string[]
    Required registration attribute list
    samlLoginCallbackUrl string
    SAML login callback URL
    samlSignUpCallbackUrl string
    SAML registration callback URL
    selfAccountRecoveryEnabled boolean
    Allow account self-recovery
    selfSignUpEnabled boolean
    Allow user self-registration
    signInAttributes string[]
    Supported login attribute list
    signUpAutoVerificationEnabled boolean
    Registration auto-validation enabled
    smsAnonymousSignUpEnabled boolean
    SMS anonymous registration enabled
    smsPasswordlessSignInEnabled boolean
    SMS passwordless login enabled
    tags UserPoolTag[]
    User pool tag list Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    tokenSigningKeyUrl string
    Token signature public key URL
    tokenUrl string
    Token endpoint URL
    totalClients number
    Total clients in user pool
    totalConnections number
    Total connections and identity providers in user pool
    totalUsers number
    Total users in user pool
    trn string
    User pool TRN
    uid string
    User pool unique identifier
    unconfirmedUserSignInEnabled boolean
    Allow unconfirmed users to log in
    updateTime string
    Update time
    brand UserPoolBrandArgs
    User pool brand display configuration
    create_time str
    Creation time
    description str
    User pool description
    discovery_url str
    OpenID Connect discovery URL
    domain str
    User pool access domain
    email_passwordless_sign_in_enabled bool
    Email passwordless login enabled
    enabled bool
    User pool enabled
    issuer_url str
    Token issuer URL
    name str
    User pool name
    oauth_login_callback_url str
    OAuth login callback URL
    oauth_sign_up_callback_url str
    OAuth registration callback URL
    oidc_login_callback_url str
    OIDC login callback URL
    oidc_sign_up_callback_url str
    OIDC registration callback URL
    password_sign_in_enabled bool
    Password login enabled
    project_name str
    Project name
    required_sign_up_attributes Sequence[str]
    Required registration attribute list
    saml_login_callback_url str
    SAML login callback URL
    saml_sign_up_callback_url str
    SAML registration callback URL
    self_account_recovery_enabled bool
    Allow account self-recovery
    self_sign_up_enabled bool
    Allow user self-registration
    sign_in_attributes Sequence[str]
    Supported login attribute list
    sign_up_auto_verification_enabled bool
    Registration auto-validation enabled
    sms_anonymous_sign_up_enabled bool
    SMS anonymous registration enabled
    sms_passwordless_sign_in_enabled bool
    SMS passwordless login enabled
    tags Sequence[UserPoolTagArgs]
    User pool tag list Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    token_signing_key_url str
    Token signature public key URL
    token_url str
    Token endpoint URL
    total_clients int
    Total clients in user pool
    total_connections int
    Total connections and identity providers in user pool
    total_users int
    Total users in user pool
    trn str
    User pool TRN
    uid str
    User pool unique identifier
    unconfirmed_user_sign_in_enabled bool
    Allow unconfirmed users to log in
    update_time str
    Update time
    brand Property Map
    User pool brand display configuration
    createTime String
    Creation time
    description String
    User pool description
    discoveryUrl String
    OpenID Connect discovery URL
    domain String
    User pool access domain
    emailPasswordlessSignInEnabled Boolean
    Email passwordless login enabled
    enabled Boolean
    User pool enabled
    issuerUrl String
    Token issuer URL
    name String
    User pool name
    oauthLoginCallbackUrl String
    OAuth login callback URL
    oauthSignUpCallbackUrl String
    OAuth registration callback URL
    oidcLoginCallbackUrl String
    OIDC login callback URL
    oidcSignUpCallbackUrl String
    OIDC registration callback URL
    passwordSignInEnabled Boolean
    Password login enabled
    projectName String
    Project name
    requiredSignUpAttributes List<String>
    Required registration attribute list
    samlLoginCallbackUrl String
    SAML login callback URL
    samlSignUpCallbackUrl String
    SAML registration callback URL
    selfAccountRecoveryEnabled Boolean
    Allow account self-recovery
    selfSignUpEnabled Boolean
    Allow user self-registration
    signInAttributes List<String>
    Supported login attribute list
    signUpAutoVerificationEnabled Boolean
    Registration auto-validation enabled
    smsAnonymousSignUpEnabled Boolean
    SMS anonymous registration enabled
    smsPasswordlessSignInEnabled Boolean
    SMS passwordless login enabled
    tags List<Property Map>
    User pool tag list Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    tokenSigningKeyUrl String
    Token signature public key URL
    tokenUrl String
    Token endpoint URL
    totalClients Number
    Total clients in user pool
    totalConnections Number
    Total connections and identity providers in user pool
    totalUsers Number
    Total users in user pool
    trn String
    User pool TRN
    uid String
    User pool unique identifier
    unconfirmedUserSignInEnabled Boolean
    Allow unconfirmed users to log in
    updateTime String
    Update time

    Supporting Types

    UserPoolBrand, UserPoolBrandArgs

    LogoUri string
    Brand logo URL
    Name string
    Brand name
    LogoUri string
    Brand logo URL
    Name string
    Brand name
    logo_uri string
    Brand logo URL
    name string
    Brand name
    logoUri String
    Brand logo URL
    name String
    Brand name
    logoUri string
    Brand logo URL
    name string
    Brand name
    logo_uri str
    Brand logo URL
    name str
    Brand name
    logoUri String
    Brand logo URL
    name String
    Brand name

    UserPoolTag, UserPoolTagArgs

    Key string
    Tag key
    Value string
    Tag value
    Key string
    Tag key
    Value string
    Tag value
    key string
    Tag key
    value string
    Tag value
    key String
    Tag key
    value String
    Tag value
    key string
    Tag key
    value string
    Tag value
    key str
    Tag key
    value str
    Tag value
    key String
    Tag key
    value String
    Tag value

    Import

    $ pulumi import bytepluscc:id/userPool:UserPool example "uid"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.42
    published on Monday, Jul 20, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial