CfnIdentityPoolProps¶

class aws_cdk.aws_cognito.CfnIdentityPoolProps(*, allow_unauthenticated_identities, allow_classic_flow=None, cognito_events=None, cognito_identity_providers=None, cognito_streams=None, developer_provider_name=None, identity_pool_name=None, open_id_connect_provider_arns=None, push_sync=None, saml_provider_arns=None, supported_login_providers=None)¶

Bases: object

Properties for defining a CfnIdentityPool.

Parameters

allow_unauthenticated_identities (Union[bool, IResolvable]) – Specifies whether the identity pool supports unauthenticated logins.
allow_classic_flow (Union[bool, IResolvable, None]) – Enables the Basic (Classic) authentication flow.
cognito_events (Optional[Any]) – The events to configure.
cognito_identity_providers (Union[IResolvable, Sequence[Union[IResolvable, CognitoIdentityProviderProperty, Dict[str, Any]]], None]) – The Amazon Cognito user pools and their client IDs.
cognito_streams (Union[IResolvable, CognitoStreamsProperty, Dict[str, Any], None]) – Configuration options for configuring Amazon Cognito streams.
developer_provider_name (Optional[str]) – 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
identity_pool_name (Optional[str]) – The name of your Amazon Cognito identity pool. Minimum length : 1 Maximum length : 128 Pattern : [\w\s+=,.@-]+
open_id_connect_provider_arns (Optional[Sequence[str]]) – The Amazon Resource Names (ARNs) of the OpenID connect providers.
push_sync (Union[IResolvable, PushSyncProperty, Dict[str, Any], None]) – The configuration options to be applied to the identity pool.
saml_provider_arns (Optional[Sequence[str]]) – The Amazon Resource Names (ARNs) of the Security Assertion Markup Language (SAML) providers.
supported_login_providers (Optional[Any]) – Key-value pairs that map provider names to provider app IDs.

ExampleMetadata

infused

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html

Example:

import aws_cdk.aws_cognito as cognito

# my_provider: iam.OpenIdConnectProvider

cognito.CfnIdentityPool(self, "IdentityPool",
    open_id_connect_provider_arns=[my_provider.open_id_connect_provider_arn],
    # And the other properties for your identity pool
    allow_unauthenticated_identities=False
)

Attributes

allow_classic_flow¶

Enables the Basic (Classic) authentication flow.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-allowclassicflow
Return type: Union[bool, IResolvable, None]

allow_unauthenticated_identities¶

Specifies whether the identity pool supports unauthenticated logins.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-allowunauthenticatedidentities
Return type: Union[bool, IResolvable]

cognito_events¶

The events to configure.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-cognitoevents
Return type: Any

cognito_identity_providers¶

The Amazon Cognito user pools and their client IDs.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-cognitoidentityproviders
Return type: Union[IResolvable, List[Union[IResolvable, CognitoIdentityProviderProperty]], None]

cognito_streams¶

Configuration options for configuring Amazon Cognito streams.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html#cfn-cognito-identitypool-cognitostreams
Return type: Union[IResolvable, CognitoStreamsProperty, None]

developer_provider_name¶

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