Class: Aws::CognitoIdentityProvider::Types::UserPoolDescriptionType

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::UserPoolDescriptionType

Defined in:

gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

A short description of a user pool.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_date ⇒ Time

  The date and time when the item was created.

• #id ⇒ String

  The user pool ID.

• #lambda_config ⇒ Types::LambdaConfigType

  A collection of user pool Lambda triggers.

• #last_modified_date ⇒ Time

  The date and time when the item was modified.

• #name ⇒ String

  The user pool name.

• #replica_regions ⇒ Array<String>

  A list of Amazon Web Services Regions where replicas of this user pool exist.

• #status ⇒ String

  The user pool status.

Instance Attribute Details

#creation_date ⇒ Time

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

Returns:

• (Time)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 14633

class UserPoolDescriptionType < Struct.new(
  :id,
  :name,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :replica_regions)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The user pool ID.

Returns:

• (String)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 14633

class UserPoolDescriptionType < Struct.new(
  :id,
  :name,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :replica_regions)
  SENSITIVE = []
  include Aws::Structure
end

#lambda_config ⇒ Types::LambdaConfigType

A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of user pool operations. Triggers can modify the outcome of the operations that invoked them.

Returns:

• (Types::LambdaConfigType)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 14633

class UserPoolDescriptionType < Struct.new(
  :id,
  :name,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :replica_regions)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_date ⇒ Time

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

Returns:

• (Time)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 14633

class UserPoolDescriptionType < Struct.new(
  :id,
  :name,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :replica_regions)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The user pool name.

Returns:

• (String)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 14633

class UserPoolDescriptionType < Struct.new(
  :id,
  :name,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :replica_regions)
  SENSITIVE = []
  include Aws::Structure
end

#replica_regions ⇒ Array<String>

A list of Amazon Web Services Regions where replicas of this user pool exist.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 14633

class UserPoolDescriptionType < Struct.new(
  :id,
  :name,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :replica_regions)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The user pool status.

Returns:

• (String)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 14633

class UserPoolDescriptionType < Struct.new(
  :id,
  :name,
  :lambda_config,
  :status,
  :last_modified_date,
  :creation_date,
  :replica_regions)
  SENSITIVE = []
  include Aws::Structure
end