Class: AWSCDK::CognitoIdentitypool::IdentityPool

Inherits:
Resource
  • Object
show all
Includes:
IIdentityPool
Defined in:
cognito_identitypool/identity_pool.rb

Overview

Define a Cognito Identity Pool.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of IdentityPool.

Parameters:



12
13
14
15
16
17
18
 
# File 'cognito_identitypool/identity_pool.rb', line 12

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CognitoIdentitypool::IdentityPoolProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0b19pZGVudGl0eXBvb2wuSWRlbnRpdHlQb29sUHJvcHMifQ==")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_identity_pool_arn(scope, id, identity_pool_arn) ⇒ AWSCDK::CognitoIdentitypool::IIdentityPool

Import an existing Identity Pool from its ARN.

Parameters:

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

Returns:



50
51
52
53
54
55
 
# File 'cognito_identitypool/identity_pool.rb', line 50

def self.from_identity_pool_arn(scope, id, identity_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(identity_pool_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "identityPoolArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cognito_identitypool.IdentityPool", "fromIdentityPoolArn", [scope, id, identity_pool_arn])
end

.from_identity_pool_id(scope, id, identity_pool_id) ⇒ AWSCDK::CognitoIdentitypool::IIdentityPool

Import an existing Identity Pool from its ID.

Parameters:

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

Returns:



63
64
65
66
67
68
 
# File 'cognito_identitypool/identity_pool.rb', line 63

def self.from_identity_pool_id(scope, id, identity_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(identity_pool_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "identityPoolId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cognito_identitypool.IdentityPool", "fromIdentityPoolId", [scope, id, identity_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
 
# File 'cognito_identitypool/identity_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 },
    :authenticated_role => { kind: :property, name: "authenticatedRole", is_optional: false },
    :identity_pool_arn => { kind: :property, name: "identityPoolArn", is_optional: false },
    :identity_pool_id => { kind: :property, name: "identityPoolId", is_optional: false },
    :identity_pool_name => { kind: :property, name: "identityPoolName", is_optional: false },
    :identity_pool_ref => { kind: :property, name: "identityPoolRef", is_optional: false },
    :role_attachment => { kind: :property, name: "roleAttachment", is_optional: false },
    :unauthenticated_role => { kind: :property, name: "unauthenticatedRole", 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_user_pool_authentication => { kind: :method, name: "addUserPoolAuthentication", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


116
117
118
 
# File 'cognito_identitypool/identity_pool.rb', line 116

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

Instance Method Details

#add_user_pool_authentication(user_pool) ⇒ void

This method returns an undefined value.

Add a User Pool to the Identity Pool and configure the User Pool client to handle identities.

Parameters:



263
264
265
266
 
# File 'cognito_identitypool/identity_pool.rb', line 263

def add_user_pool_authentication(user_pool)
  Jsii::Type.check_type(user_pool, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0b19pZGVudGl0eXBvb2wuSVVzZXJQb29sQXV0aGVudGljYXRpb25Qcm92aWRlciJ9")), "userPool")
  jsii_call_method("addUserPoolAuthentication", [user_pool])
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:



202
203
204
205
 
# File 'cognito_identitypool/identity_pool.rb', line 202

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:



219
220
221
222
 
# File 'cognito_identitypool/identity_pool.rb', line 219

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

#authenticated_role ⇒ AWSCDK::IAM::IRole

Default Role for authenticated users.

Returns:



123
124
125
 
# File 'cognito_identitypool/identity_pool.rb', line 123

def authenticated_role()
  jsii_get_property("authenticatedRole")
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:



88
89
90
 
# File 'cognito_identitypool/identity_pool.rb', line 88

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


225
226
227
 
# File 'cognito_identitypool/identity_pool.rb', line 225

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) 


239
240
241
242
243
244
 
# File 'cognito_identitypool/identity_pool.rb', line 239

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) 


254
255
256
257
 
# File 'cognito_identitypool/identity_pool.rb', line 254

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

#identity_pool_arn ⇒ String

The ARN of the Identity Pool.

Returns:

  • (String) 


130
131
132
 
# File 'cognito_identitypool/identity_pool.rb', line 130

def identity_pool_arn()
  jsii_get_property("identityPoolArn")
end

#identity_pool_id ⇒ String

The ID of the Identity Pool in the format REGION:GUID.

Returns:

  • (String) 


137
138
139
 
# File 'cognito_identitypool/identity_pool.rb', line 137

def identity_pool_id()
  jsii_get_property("identityPoolId")
end

#identity_pool_name ⇒ String

The name of the Identity Pool.

Returns:

  • (String) 


144
145
146
 
# File 'cognito_identitypool/identity_pool.rb', line 144

def identity_pool_name()
  jsii_get_property("identityPoolName")
end

#identity_pool_ref ⇒ AWSCDK::Interfaces::AWSCognito::IdentityPoolReference

A reference to a IdentityPool resource.

Returns:



151
152
153
 
# File 'cognito_identitypool/identity_pool.rb', line 151

def identity_pool_ref()
  jsii_get_property("identityPoolRef")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


73
74
75
 
# File 'cognito_identitypool/identity_pool.rb', line 73

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) 


102
103
104
 
# File 'cognito_identitypool/identity_pool.rb', line 102

def physical_name()
  jsii_get_property("physicalName")
end

#role_attachment ⇒ AWSCDK::Cognito::CfnIdentityPoolRoleAttachment

Role Provider for the default Role for authenticated users.

Returns:



158
159
160
 
# File 'cognito_identitypool/identity_pool.rb', line 158

def role_attachment()
  jsii_get_property("roleAttachment")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



109
110
111
 
# File 'cognito_identitypool/identity_pool.rb', line 109

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


172
173
174
 
# File 'cognito_identitypool/identity_pool.rb', line 172

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

#unauthenticated_role ⇒ AWSCDK::IAM::IRole

Default Role for unauthenticated users.

Returns:



165
166
167
 
# File 'cognito_identitypool/identity_pool.rb', line 165

def unauthenticated_role()
  jsii_get_property("unauthenticatedRole")
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) 


185
186
187
188
189
190
 
# File 'cognito_identitypool/identity_pool.rb', line 185

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