class CfnIdentityPool (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Cognito.CfnIdentityPool |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awscognito#CfnIdentityPool |
![]() | software.amazon.awscdk.services.cognito.CfnIdentityPool |
![]() | aws_cdk.aws_cognito.CfnIdentityPool |
![]() | aws-cdk-lib » aws_cognito » CfnIdentityPool |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
The AWS::Cognito::IdentityPool
resource creates an Amazon Cognito identity pool.
To avoid deleting the resource accidentally from AWS CloudFormation , use DeletionPolicy Attribute and the UpdateReplacePolicy Attribute to retain the resource on deletion or replacement.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html
Example
import * as cognito from 'aws-cdk-lib/aws-cognito';
declare const myProvider: iam.OpenIdConnectProvider;
new cognito.CfnIdentityPool(this, 'IdentityPool', {
openIdConnectProviderArns: [myProvider.openIdConnectProviderArn],
// And the other properties for your identity pool
allowUnauthenticatedIdentities: false,
});
Initializer
new CfnIdentityPool(scope: Construct, id: string, props: CfnIdentityPoolProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.Identity Pool Props
Construct Props
Name | Type | Description |
---|---|---|
allow | boolean | IResolvable | Specifies whether the identity pool supports unauthenticated logins. |
allow | boolean | IResolvable | Enables the Basic (Classic) authentication flow. |
cognito | any | The events to configure. |
cognito | IResolvable | IResolvable | Cognito [] | The Amazon Cognito user pools and their client IDs. |
cognito | IResolvable | Cognito | Configuration options for configuring Amazon Cognito streams. |
developer | string | The "domain" Amazon Cognito uses when referencing your users. |
identity | string | The name of your Amazon Cognito identity pool. |
identity | Cfn [] | Tags to assign to the identity pool. |
open | string[] | The Amazon Resource Names (ARNs) of the OpenID connect providers. |
push | IResolvable | Push | The configuration options to be applied to the identity pool. |
saml | string[] | The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers. |
supported | any | Key-value pairs that map provider names to provider app IDs. |
allowUnauthenticatedIdentities
Type:
boolean |
IResolvable
Specifies whether the identity pool supports unauthenticated logins.
allowClassicFlow?
Type:
boolean |
IResolvable
(optional)
Enables the Basic (Classic) authentication flow.
cognitoEvents?
Type:
any
(optional)
The events to configure.
cognitoIdentityProviders?
Type:
IResolvable
|
IResolvable
|
Cognito
[]
(optional)
The Amazon Cognito user pools and their client IDs.
cognitoStreams?
Type:
IResolvable
|
Cognito
(optional)
Configuration options for configuring Amazon Cognito streams.
developerProviderName?
Type:
string
(optional)
The "domain" Amazon Cognito uses when referencing your users.
This name acts as a placeholder that allows your backend and the Amazon Cognito service to communicate about the developer provider. For the DeveloperProviderName
, you can use letters and periods (.), underscores (_), and dashes (-).
Minimum length : 1
Maximum length : 100
identityPoolName?
Type:
string
(optional)
The name of your Amazon Cognito identity pool.
Minimum length : 1
Maximum length : 128
Pattern : [\w\s+=,.@-]+
identityPoolTags?
Type:
Cfn
[]
(optional)
Tags to assign to the identity pool.
A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
openIdConnectProviderArns?
Type:
string[]
(optional)
The Amazon Resource Names (ARNs) of the OpenID connect providers.
pushSync?
Type:
IResolvable
|
Push
(optional)
The configuration options to be applied to the identity pool.
samlProviderArns?
Type:
string[]
(optional)
The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.
supportedLoginProviders?
Type:
any
(optional)
Key-value pairs that map provider names to provider app IDs.
Properties
Name | Type | Description |
---|---|---|
allow | boolean | IResolvable | Specifies whether the identity pool supports unauthenticated logins. |
attr | string | |
attr | string | The name of the Amazon Cognito identity pool, returned as a string. |
cdk | Tag | Tag Manager which manages the tags for this resource. |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
logical | string | The logical ID for this CloudFormation stack element. |
node | Node | The tree node. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
stack | Stack | The stack in which this element is defined. |
allow | boolean | IResolvable | Enables the Basic (Classic) authentication flow. |
cognito | any | The events to configure. |
cognito | IResolvable | IResolvable | Cognito [] | The Amazon Cognito user pools and their client IDs. |
cognito | IResolvable | Cognito | Configuration options for configuring Amazon Cognito streams. |
developer | string | The "domain" Amazon Cognito uses when referencing your users. |
identity | string | The name of your Amazon Cognito identity pool. |
identity | Cfn [] | Tags to assign to the identity pool. |
open | string[] | The Amazon Resource Names (ARNs) of the OpenID connect providers. |
push | IResolvable | Push | The configuration options to be applied to the identity pool. |
saml | string[] | The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers. |
supported | any | Key-value pairs that map provider names to provider app IDs. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
allowUnauthenticatedIdentities
Type:
boolean |
IResolvable
Specifies whether the identity pool supports unauthenticated logins.
attrId
Type:
string
attrName
Type:
string
The name of the Amazon Cognito identity pool, returned as a string.
cdkTagManager
Type:
Tag
Tag Manager which manages the tags for this resource.
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
logicalId
Type:
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 overrideLogicalId(newLogicalId)
.
node
Type:
Node
The tree node.
ref
Type:
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 })
.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
allowClassicFlow?
Type:
boolean |
IResolvable
(optional)
Enables the Basic (Classic) authentication flow.
cognitoEvents?
Type:
any
(optional)
The events to configure.
cognitoIdentityProviders?
Type:
IResolvable
|
IResolvable
|
Cognito
[]
(optional)
The Amazon Cognito user pools and their client IDs.
cognitoStreams?
Type:
IResolvable
|
Cognito
(optional)
Configuration options for configuring Amazon Cognito streams.
developerProviderName?
Type:
string
(optional)
The "domain" Amazon Cognito uses when referencing your users.
identityPoolName?
Type:
string
(optional)
The name of your Amazon Cognito identity pool.
identityPoolTags?
Type:
Cfn
[]
(optional)
Tags to assign to the identity pool.
openIdConnectProviderArns?
Type:
string[]
(optional)
The Amazon Resource Names (ARNs) of the OpenID connect providers.
pushSync?
Type:
IResolvable
|
Push
(optional)
The configuration options to be applied to the identity pool.
samlProviderArns?
Type:
string[]
(optional)
The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.
supportedLoginProviders?
Type:
any
(optional)
Key-value pairs that map provider names to provider app IDs.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
DeletionOverride(path)
addpublic addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
Dependency(target)
addpublic addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
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.
DependsOn(target)
addpublic addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
Metadata(key, value)
addpublic addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
Override(path, value)
addpublic addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use addPropertyOverride
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,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value
argument to addOverride
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.
PropertyDeletionOverride(propertyPath)
addpublic addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
PropertyOverride(propertyPath, value)
addpublic addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
RemovalPolicy(policy?, options?)
applypublic applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
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:
Att(attributeName, typeHint?)
getpublic getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
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.
Metadata(key)
getpublic getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
Dependencies()
obtainpublic obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
ResourceDependencies()
obtainpublic obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
LogicalId(newLogicalId)
overridepublic overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
Dependency(target)
removepublic removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
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.
Dependency(target, newTarget)
replacepublic replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
String()
topublic toString(): string
Returns
string
Returns a string representation of this construct.
Properties(props)
protected renderprotected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }