Class: AWSCDK::Cognito::UserPool

Inherits:
Resource
  • Object
show all
Includes:
IUserPool
Defined in:
cognito/user_pool.rb

Overview

Define a Cognito User Pool.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ UserPool

Returns a new instance of UserPool.

Parameters:



12
13
14
15
16
17
18
 
# File 'cognito/user_pool.rb', line 12

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::Cognito::UserPoolProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5Vc2VyUG9vbFByb3BzIn0=")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_user_pool_arn(scope, id, user_pool_arn) ⇒ AWSCDK::Cognito::IUserPool

Import an existing user pool based on its ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • user_pool_arn (String)

Returns:



55
56
57
58
59
60
 
# File 'cognito/user_pool.rb', line 55

def self.from_user_pool_arn(scope, id, user_pool_arn)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(user_pool_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "userPoolArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cognito.UserPool", "fromUserPoolArn", [scope, id, user_pool_arn])
end

.from_user_pool_id(scope, id, user_pool_id) ⇒ AWSCDK::Cognito::IUserPool

Import an existing user pool based on its id.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • user_pool_id (String)

Returns:



68
69
70
71
72
73
 
# File 'cognito/user_pool.rb', line 68

def self.from_user_pool_id(scope, id, user_pool_id)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(user_pool_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "userPoolId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cognito.UserPool", "fromUserPoolId", [scope, id, user_pool_id])
end

.jsii_overridable_methods ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'cognito/user_pool.rb', line 20

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :identity_providers => { kind: :property, name: "identityProviders", is_optional: false },
    :user_pool_arn => { kind: :property, name: "userPoolArn", is_optional: false },
    :user_pool_id => { kind: :property, name: "userPoolId", is_optional: false },
    :user_pool_provider_name => { kind: :property, name: "userPoolProviderName", is_optional: false },
    :user_pool_provider_url => { kind: :property, name: "userPoolProviderUrl", is_optional: false },
    :user_pool_ref => { kind: :property, name: "userPoolRef", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :add_client => { kind: :method, name: "addClient", is_optional: false },
    :add_domain => { kind: :method, name: "addDomain", is_optional: false },
    :add_group => { kind: :method, name: "addGroup", is_optional: false },
    :add_resource_server => { kind: :method, name: "addResourceServer", is_optional: false },
    :add_trigger => { kind: :method, name: "addTrigger", is_optional: false },
    :grant => { kind: :method, name: "grant", is_optional: false },
    :register_identity_provider => { kind: :method, name: "registerIdentityProvider", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


121
122
123
 
# File 'cognito/user_pool.rb', line 121

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.UserPool", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#add_client(id, options = nil) ⇒ AWSCDK::Cognito::UserPoolClient

Add a new app client to this user pool.

Parameters:

Returns:



262
263
264
265
266
267
 
# File 'cognito/user_pool.rb', line 262

def add_client(id, options = nil)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  options = options.is_a?(Hash) ? ::AWSCDK::Cognito::UserPoolClientOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5Vc2VyUG9vbENsaWVudE9wdGlvbnMifQ==")), "options") unless options.nil?
  jsii_call_method("addClient", [id, options])
end

#add_domain(id, options) ⇒ AWSCDK::Cognito::UserPoolDomain

Associate a domain to this user pool.

Parameters:

Returns:



274
275
276
277
278
279
 
# File 'cognito/user_pool.rb', line 274

def add_domain(id, options)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  options = options.is_a?(Hash) ? ::AWSCDK::Cognito::UserPoolDomainOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5Vc2VyUG9vbERvbWFpbk9wdGlvbnMifQ==")), "options")
  jsii_call_method("addDomain", [id, options])
end

#add_group(id, options) ⇒ AWSCDK::Cognito::UserPoolGroup

Add a new group to this user pool.

Parameters:

Returns:



286
287
288
289
290
291
 
# File 'cognito/user_pool.rb', line 286

def add_group(id, options)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  options = options.is_a?(Hash) ? ::AWSCDK::Cognito::UserPoolGroupOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5Vc2VyUG9vbEdyb3VwT3B0aW9ucyJ9")), "options")
  jsii_call_method("addGroup", [id, options])
end

#add_resource_server(id, options) ⇒ AWSCDK::Cognito::UserPoolResourceServer

Add a new resource server to this user pool.

Parameters:

Returns:



298
299
300
301
302
303
 
# File 'cognito/user_pool.rb', line 298

def add_resource_server(id, options)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  options = options.is_a?(Hash) ? ::AWSCDK::Cognito::UserPoolResourceServerOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5Vc2VyUG9vbFJlc291cmNlU2VydmVyT3B0aW9ucyJ9")), "options")
  jsii_call_method("addResourceServer", [id, options])
end

#add_trigger(operation, fn, lambda_version = nil) ⇒ void

This method returns an undefined value.

Add a lambda trigger to a user pool operation.

Parameters:

See Also:



312
313
314
315
316
317
 
# File 'cognito/user_pool.rb', line 312

def add_trigger(operation, fn, lambda_version = nil)
  Jsii::Type.check_type(operation, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5Vc2VyUG9vbE9wZXJhdGlvbiJ9")), "operation")
  Jsii::Type.check_type(fn, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbGFtYmRhLklGdW5jdGlvbiJ9")), "fn")
  Jsii::Type.check_type(lambda_version, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5MYW1iZGFWZXJzaW9uIn0=")), "lambdaVersion") unless lambda_version.nil?
  jsii_call_method("addTrigger", [operation, fn, lambda_version])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



200
201
202
203
 
# File 'cognito/user_pool.rb', line 200

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:



217
218
219
220
 
# File 'cognito/user_pool.rb', line 217

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



93
94
95
 
# File 'cognito/user_pool.rb', line 93

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


223
224
225
 
# File 'cognito/user_pool.rb', line 223

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


237
238
239
240
241
242
 
# File 'cognito/user_pool.rb', line 237

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


252
253
254
255
 
# File 'cognito/user_pool.rb', line 252

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#grant(grantee, *actions) ⇒ AWSCDK::IAM::Grant

[disable-awslint:no-grants].

Parameters:

Returns:



324
325
326
327
328
329
330
 
# File 'cognito/user_pool.rb', line 324

def grant(grantee, *actions)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  actions.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "actions[#{index}]")
  end
  jsii_call_method("grant", [grantee, *actions])
end

#identity_providers ⇒ Array<AWSCDK::Cognito::IUserPoolIdentityProvider>

Get all identity providers registered with this user pool.

Returns:



128
129
130
 
# File 'cognito/user_pool.rb', line 128

def identity_providers()
  jsii_get_property("identityProviders")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


78
79
80
 
# File 'cognito/user_pool.rb', line 78

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


107
108
109
 
# File 'cognito/user_pool.rb', line 107

def physical_name()
  jsii_get_property("physicalName")
end

#register_identity_provider(provider) ⇒ void

This method returns an undefined value.

Register an identity provider with this user pool.

Parameters:



336
337
338
339
 
# File 'cognito/user_pool.rb', line 336

def register_identity_provider(provider)
  Jsii::Type.check_type(provider, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jb2duaXRvLklVc2VyUG9vbElkZW50aXR5UHJvdmlkZXJSZWYifQ==")), "provider")
  jsii_call_method("registerIdentityProvider", [provider])
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



114
115
116
 
# File 'cognito/user_pool.rb', line 114

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


170
171
172
 
# File 'cognito/user_pool.rb', line 170

def to_string()
  jsii_call_method("toString", [])
end

#user_pool_arn ⇒ String

The ARN of the user pool.

Returns:

  • (String) 


135
136
137
 
# File 'cognito/user_pool.rb', line 135

def user_pool_arn()
  jsii_get_property("userPoolArn")
end

#user_pool_id ⇒ String

The physical ID of this user pool resource.

Returns:

  • (String) 


142
143
144
 
# File 'cognito/user_pool.rb', line 142

def user_pool_id()
  jsii_get_property("userPoolId")
end

#user_pool_provider_name ⇒ String

User pool provider name.

Returns:

  • (String) 


149
150
151
 
# File 'cognito/user_pool.rb', line 149

def user_pool_provider_name()
  jsii_get_property("userPoolProviderName")
end

#user_pool_provider_url ⇒ String

User pool provider URL.

Returns:

  • (String) 


156
157
158
 
# File 'cognito/user_pool.rb', line 156

def user_pool_provider_url()
  jsii_get_property("userPoolProviderUrl")
end

#user_pool_ref ⇒ AWSCDK::Interfaces::AWSCognito::UserPoolReference

A reference to a UserPool resource.

Returns:



163
164
165
 
# File 'cognito/user_pool.rb', line 163

def user_pool_ref()
  jsii_get_property("userPoolRef")
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


183
184
185
186
187
188
 
# File 'cognito/user_pool.rb', line 183

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end