Class: AWSCDK::Cognito::CfnIdentityPool

Inherits:
AWSCDK::CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSCognito::IIdentityPoolRef
Defined in:
cognito/cfn_identity_pool.rb

Overview

The AWS::Cognito::IdentityPool resource creates an Amazon Cognito identity pool.

To avoid deleting the resource accidentally from CloudFormation , use DeletionPolicy Attribute and the UpdateReplacePolicy Attribute to retain the resource on deletion or replacement.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnIdentityPool

Create a new AWS::Cognito::IdentityPool.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::Cognito::CfnIdentityPoolProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'cognito/cfn_identity_pool.rb', line 20

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Cognito::CfnIdentityPoolProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5DZm5JZGVudGl0eVBvb2xQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_identity_pool(resource) ⇒ String

Parameters:

Returns:

  • (String) 


86
87
88
89
 
# File 'cognito/cfn_identity_pool.rb', line 86

def self.arn_for_identity_pool(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jb2duaXRvLklJZGVudGl0eVBvb2xSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cognito.CfnIdentityPool", "arnForIdentityPool", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


206
207
208
 
# File 'cognito/cfn_identity_pool.rb', line 206

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

.from_identity_pool_id(scope, id, identity_pool_id) ⇒ AWSCDK::Interfaces::AWSCognito::IIdentityPoolRef

Creates a new IIdentityPoolRef from a identityPoolId.

Parameters:

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

Returns:



97
98
99
100
101
102
 
# File 'cognito/cfn_identity_pool.rb', line 97

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.CfnIdentityPool", "fromIdentityPoolId", [scope, id, identity_pool_id])
end

.is_cfn_identity_pool(x) ⇒ Boolean

Checks whether the given object is a CfnIdentityPool.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


108
109
110
111
 
# File 'cognito/cfn_identity_pool.rb', line 108

def self.is_cfn_identity_pool(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cognito.CfnIdentityPool", "isCfnIdentityPool", [x])
end

.jsii_overridable_methods ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'cognito/cfn_identity_pool.rb', line 28

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_name => { kind: :property, name: "attrName", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :identity_pool_ref => { kind: :property, name: "identityPoolRef", is_optional: false },
    :allow_unauthenticated_identities => { kind: :property, name: "allowUnauthenticatedIdentities", is_optional: false },
    :cognito_events => { kind: :property, name: "cognitoEvents", is_optional: false },
    :supported_login_providers => { kind: :property, name: "supportedLoginProviders", is_optional: false },
    :allow_classic_flow => { kind: :property, name: "allowClassicFlow", is_optional: true },
    :cognito_identity_providers => { kind: :property, name: "cognitoIdentityProviders", is_optional: true },
    :cognito_streams => { kind: :property, name: "cognitoStreams", is_optional: true },
    :developer_provider_name => { kind: :property, name: "developerProviderName", is_optional: true },
    :identity_pool_name => { kind: :property, name: "identityPoolName", is_optional: true },
    :identity_pool_tags => { kind: :property, name: "identityPoolTags", is_optional: true },
    :open_id_connect_provider_arns => { kind: :property, name: "openIdConnectProviderArns", is_optional: true },
    :push_sync => { kind: :property, name: "pushSync", is_optional: true },
    :saml_provider_arns => { kind: :property, name: "samlProviderArns", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", 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 },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



419
420
421
422
 
# File 'cognito/cfn_identity_pool.rb', line 419

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



431
432
433
434
 
# File 'cognito/cfn_identity_pool.rb', line 431

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



441
442
443
444
 
# File 'cognito/cfn_identity_pool.rb', line 441

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



452
453
454
455
456
 
# File 'cognito/cfn_identity_pool.rb', line 452

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


509
510
511
512
513
 
# File 'cognito/cfn_identity_pool.rb', line 509

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



519
520
521
522
 
# File 'cognito/cfn_identity_pool.rb', line 519

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



531
532
533
534
535
 
# File 'cognito/cfn_identity_pool.rb', line 531

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#allow_classic_flow ⇒ Boolean, ...

Enables the Basic (Classic) authentication flow.

Returns:



275
276
277
 
# File 'cognito/cfn_identity_pool.rb', line 275

def allow_classic_flow()
  jsii_get_property("allowClassicFlow")
end

#allow_classic_flow=(value) ⇒ Object 



279
280
281
282
 
# File 'cognito/cfn_identity_pool.rb', line 279

def allow_classic_flow=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "allowClassicFlow") unless value.nil?
  jsii_set_property("allowClassicFlow", value)
end

#allow_unauthenticated_identities ⇒ Boolean, AWSCDK::IResolvable

Specifies whether the identity pool supports unauthenticated logins.

Returns:



239
240
241
 
# File 'cognito/cfn_identity_pool.rb', line 239

def allow_unauthenticated_identities()
  jsii_get_property("allowUnauthenticatedIdentities")
end

#allow_unauthenticated_identities=(value) ⇒ Object 



243
244
245
246
 
# File 'cognito/cfn_identity_pool.rb', line 243

def allow_unauthenticated_identities=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "allowUnauthenticatedIdentities")
  jsii_set_property("allowUnauthenticatedIdentities", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



544
545
546
547
 
# File 'cognito/cfn_identity_pool.rb', line 544

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 = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



566
567
568
569
570
571
 
# File 'cognito/cfn_identity_pool.rb', line 566

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_id ⇒ String

Returns:

  • (String) 


211
212
213
 
# File 'cognito/cfn_identity_pool.rb', line 211

def attr_id()
  jsii_get_property("attrId")
end

#attr_name ⇒ String

The name of the Amazon Cognito identity pool, returned as a string.

Returns:

  • (String) 


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

def attr_name()
  jsii_get_property("attrName")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



225
226
227
 
# File 'cognito/cfn_identity_pool.rb', line 225

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



159
160
161
 
# File 'cognito/cfn_identity_pool.rb', line 159

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


164
165
166
 
# File 'cognito/cfn_identity_pool.rb', line 164

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


575
576
577
578
 
# File 'cognito/cfn_identity_pool.rb', line 575

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


169
170
171
 
# File 'cognito/cfn_identity_pool.rb', line 169

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


176
177
178
 
# File 'cognito/cfn_identity_pool.rb', line 176

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cognito_events ⇒ Object

The events to configure.

Returns:

  • (Object) 


251
252
253
 
# File 'cognito/cfn_identity_pool.rb', line 251

def cognito_events()
  jsii_get_property("cognitoEvents")
end

#cognito_events=(value) ⇒ Object 



255
256
257
258
 
# File 'cognito/cfn_identity_pool.rb', line 255

def cognito_events=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "cognitoEvents")
  jsii_set_property("cognitoEvents", value)
end

#cognito_identity_providers ⇒ AWSCDK::IResolvable, ...

The Amazon Cognito user pools and their client IDs.

Returns:



287
288
289
 
# File 'cognito/cfn_identity_pool.rb', line 287

def cognito_identity_providers()
  jsii_get_property("cognitoIdentityProviders")
end

#cognito_identity_providers=(value) ⇒ Object 



291
292
293
294
 
# File 'cognito/cfn_identity_pool.rb', line 291

def cognito_identity_providers=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5DZm5JZGVudGl0eVBvb2wuQ29nbml0b0lkZW50aXR5UHJvdmlkZXJQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "cognitoIdentityProviders") unless value.nil?
  jsii_set_property("cognitoIdentityProviders", value)
end

#cognito_streams ⇒ AWSCDK::IResolvable, ...

Configuration options for configuring Amazon Cognito streams.

Returns:



299
300
301
 
# File 'cognito/cfn_identity_pool.rb', line 299

def cognito_streams()
  jsii_get_property("cognitoStreams")
end

#cognito_streams=(value) ⇒ Object 



303
304
305
306
307
 
# File 'cognito/cfn_identity_pool.rb', line 303

def cognito_streams=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Cognito::CfnIdentityPool::CognitoStreamsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmbklkZW50aXR5UG9vbC5Db2duaXRvU3RyZWFtc1Byb3BlcnR5In1dfX0=")), "cognitoStreams") unless value.nil?
  jsii_set_property("cognitoStreams", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def creation_stack()
  jsii_get_property("creationStack")
end

#developer_provider_name ⇒ String?

The "domain" Amazon Cognito uses when referencing your users.

Returns:

  • (String, nil) 


312
313
314
 
# File 'cognito/cfn_identity_pool.rb', line 312

def developer_provider_name()
  jsii_get_property("developerProviderName")
end

#developer_provider_name=(value) ⇒ Object 



316
317
318
319
 
# File 'cognito/cfn_identity_pool.rb', line 316

def developer_provider_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "developerProviderName") unless value.nil?
  jsii_set_property("developerProviderName", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



181
182
183
 
# File 'cognito/cfn_identity_pool.rb', line 181

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



588
589
590
591
592
 
# File 'cognito/cfn_identity_pool.rb', line 588

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



599
600
601
602
 
# File 'cognito/cfn_identity_pool.rb', line 599

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#identity_pool_name ⇒ String?

The name of your Amazon Cognito identity pool.

Returns:

  • (String, nil) 


324
325
326
 
# File 'cognito/cfn_identity_pool.rb', line 324

def identity_pool_name()
  jsii_get_property("identityPoolName")
end

#identity_pool_name=(value) ⇒ Object 



328
329
330
331
 
# File 'cognito/cfn_identity_pool.rb', line 328

def identity_pool_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "identityPoolName") unless value.nil?
  jsii_set_property("identityPoolName", value)
end

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

A reference to a IdentityPool resource.

Returns:



232
233
234
 
# File 'cognito/cfn_identity_pool.rb', line 232

def identity_pool_ref()
  jsii_get_property("identityPoolRef")
end

#identity_pool_tags ⇒ Array<AWSCDK::CfnTag>?

Tags to assign to the identity pool.

Returns:



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

def identity_pool_tags()
  jsii_get_property("identityPoolTags")
end

#identity_pool_tags=(value) ⇒ Object 



340
341
342
343
344
 
# File 'cognito/cfn_identity_pool.rb', line 340

def identity_pool_tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "identityPoolTags") unless value.nil?
  jsii_set_property("identityPoolTags", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



669
670
671
672
 
# File 'cognito/cfn_identity_pool.rb', line 669

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


133
134
135
 
# File 'cognito/cfn_identity_pool.rb', line 133

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


116
117
118
 
# File 'cognito/cfn_identity_pool.rb', line 116

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



610
611
612
 
# File 'cognito/cfn_identity_pool.rb', line 610

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



617
618
619
 
# File 'cognito/cfn_identity_pool.rb', line 617

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#open_id_connect_provider_arns ⇒ Array<String>?

The Amazon Resource Names (ARNs) of the OpenID connect providers.

Returns:

  • (Array<String>, nil) 


349
350
351
 
# File 'cognito/cfn_identity_pool.rb', line 349

def open_id_connect_provider_arns()
  jsii_get_property("openIdConnectProviderArns")
end

#open_id_connect_provider_arns=(value) ⇒ Object 



353
354
355
356
 
# File 'cognito/cfn_identity_pool.rb', line 353

def open_id_connect_provider_arns=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "openIdConnectProviderArns") unless value.nil?
  jsii_set_property("openIdConnectProviderArns", value)
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



410
411
412
413
 
# File 'cognito/cfn_identity_pool.rb', line 410

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#push_sync ⇒ AWSCDK::IResolvable, ...

The configuration options to be applied to the identity pool.

Returns:



361
362
363
 
# File 'cognito/cfn_identity_pool.rb', line 361

def push_sync()
  jsii_get_property("pushSync")
end

#push_sync=(value) ⇒ Object 



365
366
367
368
369
 
# File 'cognito/cfn_identity_pool.rb', line 365

def push_sync=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Cognito::CfnIdentityPool::PushSyncProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2duaXRvLkNmbklkZW50aXR5UG9vbC5QdXNoU3luY1Byb3BlcnR5In1dfX0=")), "pushSync") unless value.nil?
  jsii_set_property("pushSync", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


152
153
154
 
# File 'cognito/cfn_identity_pool.rb', line 152

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



628
629
630
631
 
# File 'cognito/cfn_identity_pool.rb', line 628

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


635
636
637
638
 
# File 'cognito/cfn_identity_pool.rb', line 635

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



645
646
647
648
649
 
# File 'cognito/cfn_identity_pool.rb', line 645

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#saml_provider_arns ⇒ Array<String>?

The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.

Returns:

  • (Array<String>, nil) 


374
375
376
 
# File 'cognito/cfn_identity_pool.rb', line 374

def saml_provider_arns()
  jsii_get_property("samlProviderArns")
end

#saml_provider_arns=(value) ⇒ Object 



378
379
380
381
 
# File 'cognito/cfn_identity_pool.rb', line 378

def saml_provider_arns=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "samlProviderArns") unless value.nil?
  jsii_set_property("samlProviderArns", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



654
655
656
 
# File 'cognito/cfn_identity_pool.rb', line 654

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



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

def stack()
  jsii_get_property("stack")
end

#supported_login_providers ⇒ Object

Key-value pairs that map provider names to provider app IDs.

Returns:

  • (Object) 


263
264
265
 
# File 'cognito/cfn_identity_pool.rb', line 263

def ()
  jsii_get_property("supportedLoginProviders")
end

#supported_login_providers=(value) ⇒ Object 



267
268
269
270
 
# File 'cognito/cfn_identity_pool.rb', line 267

def (value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "supportedLoginProviders")
  jsii_set_property("supportedLoginProviders", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



386
387
388
 
# File 'cognito/cfn_identity_pool.rb', line 386

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

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


189
190
191
 
# File 'cognito/cfn_identity_pool.rb', line 189

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


199
200
201
 
# File 'cognito/cfn_identity_pool.rb', line 199

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


660
661
662
663
 
# File 'cognito/cfn_identity_pool.rb', line 660

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
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) 


399
400
401
402
403
404
 
# File 'cognito/cfn_identity_pool.rb', line 399

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