java.lang.Object
- com.pulumi.aws.cognito.outputs.GetUserPoolResult

public final class GetUserPoolResult
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class GetUserPoolResult.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`java.util.List<GetUserPoolAccountRecoverySetting>`	`accountRecoverySettings()`
`java.util.List<GetUserPoolAdminCreateUserConfig>`	`adminCreateUserConfigs()`
`java.lang.String`	`arn()`
`java.util.List<java.lang.String>`	`autoVerifiedAttributes()`
`static GetUserPoolResult.Builder`	`builder()`
`static GetUserPoolResult.Builder`	`builder(GetUserPoolResult defaults)`
`java.lang.String`	`creationDate()`
`java.lang.String`	`customDomain()`
`java.lang.String`	`deletionProtection()`
`java.util.List<GetUserPoolDeviceConfiguration>`	`deviceConfigurations()`
`java.lang.String`	`domain()`
`java.util.List<GetUserPoolEmailConfiguration>`	`emailConfigurations()`
`java.lang.Integer`	`estimatedNumberOfUsers()`
`java.lang.String`	`id()`
`java.util.List<GetUserPoolLambdaConfig>`	`lambdaConfigs()`
`java.lang.String`	`lastModifiedDate()`
`java.lang.String`	`mfaConfiguration()`
`java.lang.String`	`name()`
`java.lang.String`	`region()`
`java.util.List<GetUserPoolSchemaAttribute>`	`schemaAttributes()`
`java.lang.String`	`smsAuthenticationMessage()`
`java.lang.String`	`smsConfigurationFailure()`
`java.lang.String`	`smsVerificationMessage()`
`java.util.Map<java.lang.String,java.lang.String>`	`tags()`
`java.util.List<java.lang.String>`	`usernameAttributes()`
`java.util.List<GetUserPoolUserPoolAddOn>`	`userPoolAddOns()`
`java.lang.String`	`userPoolId()`
`java.util.Map<java.lang.String,java.lang.String>`	`userPoolTags()`	Deprecated. Use the attribute "tags" instead

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - accountRecoverySettings
```
public java.util.List<GetUserPoolAccountRecoverySetting> accountRecoverySettings()
```
  - adminCreateUserConfigs
```
public java.util.List<GetUserPoolAdminCreateUserConfig> adminCreateUserConfigs()
```
  - arn
```
public java.lang.String arn()
```
    Returns:
    
    ARN of the User Pool. * accountRecoverySetting - The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email. * adminCreateUserConfig - The configuration for AdminCreateUser requests.
  - autoVerifiedAttributes
```
public java.util.List<java.lang.String> autoVerifiedAttributes()
```
    Returns:
    
    The attributes that are auto-verified in a user pool.
  - creationDate
```
public java.lang.String creationDate()
```
    Returns:
    
    The date and time, in ISO 8601 format, when the item was created.
  - customDomain
```
public java.lang.String customDomain()
```
    Returns:
    
    A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. An example of a custom domain name might be auth.example.com.
  - deletionProtection
```
public java.lang.String deletionProtection()
```
    Returns:
    
    When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature. * deviceConfiguration - The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
  - deviceConfigurations
```
public java.util.List<GetUserPoolDeviceConfiguration> deviceConfigurations()
```
  - domain
```
public java.lang.String domain()
```
    Returns:
    
    The domain prefix, if the user pool has a domain associated with it. * emailConfiguration - The email configuration of your user pool. The email configuration type sets your preferred sending method, AWS Region, and sender for messages from your user pool.
  - emailConfigurations
```
public java.util.List<GetUserPoolEmailConfiguration> emailConfigurations()
```
  - estimatedNumberOfUsers
```
public java.lang.Integer estimatedNumberOfUsers()
```
    Returns:
    
    A number estimating the size of the user pool. * lambdaConfig - The AWS Lambda triggers associated with the user pool.
  - id
```
public java.lang.String id()
```
  - lambdaConfigs
```
public java.util.List<GetUserPoolLambdaConfig> lambdaConfigs()
```
  - lastModifiedDate
```
public java.lang.String lastModifiedDate()
```
    Returns:
    
    The date and time, in ISO 8601 format, when the item was modified.
  - mfaConfiguration
```
public java.lang.String mfaConfiguration()
```
    Returns:
    
    Can be one of the following values: `OFF` | `ON` | `OPTIONAL`
  - name
```
public java.lang.String name()
```
    Returns:
    
    - Name of the attribute.
  - region
```
public java.lang.String region()
```
  - schemaAttributes
```
public java.util.List<GetUserPoolSchemaAttribute> schemaAttributes()
```
  - smsAuthenticationMessage
```
public java.lang.String smsAuthenticationMessage()
```
    Returns:
    
    The contents of the SMS authentication message.
  - smsConfigurationFailure
```
public java.lang.String smsConfigurationFailure()
```
    Returns:
    
    The reason why the SMS configuration can't send the messages to your users.
  - smsVerificationMessage
```
public java.lang.String smsVerificationMessage()
```
    Returns:
    
    The contents of the SMS authentication message.
  - tags
```
public java.util.Map<java.lang.String,java.lang.String> tags()
```
    Returns:
    
    Map of tags assigned to the resource. * userPoolAddOns - The user pool add-ons configuration.
  - userPoolAddOns
```
public java.util.List<GetUserPoolUserPoolAddOn> userPoolAddOns()
```
  - userPoolId
```
public java.lang.String userPoolId()
```
  - userPoolTags
```
@Deprecated
public java.util.Map<java.lang.String,java.lang.String> userPoolTags()
```
    Deprecated.
    Use the attribute "tags" instead
    
    Returns:
    
    (Deprecated) Map of tags assigned to the resource.
  - usernameAttributes
```
public java.util.List<java.lang.String> usernameAttributes()
```
    Returns:
    
    Specifies whether a user can use an email address or phone number as a username when they sign up.
  - builder
```
public static GetUserPoolResult.Builder builder()
```
  - builder
```
public static GetUserPoolResult.Builder builder(GetUserPoolResult defaults)
```

Class GetUserPoolResult

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

accountRecoverySettings

adminCreateUserConfigs

arn

autoVerifiedAttributes

creationDate

customDomain

deletionProtection

deviceConfigurations

domain

emailConfigurations

estimatedNumberOfUsers

id

lambdaConfigs

lastModifiedDate

mfaConfiguration

name

region

schemaAttributes

smsAuthenticationMessage

smsConfigurationFailure

smsVerificationMessage

tags

userPoolAddOns

userPoolId

userPoolTags

usernameAttributes

builder

builder