IdentityPool L2 construct
Define a Cognito Identity Pool.
Example
declare const openIdConnectProvider: iam.OpenIdConnectProvider;
new IdentityPool(this, 'myidentitypool', {
identityPoolName: 'myidentitypool',
authenticationProviders: {
google: {
clientId: '12345678012.apps.googleusercontent.com',
},
openIdConnectProviders: [openIdConnectProvider],
customProvider: 'my-custom-provider.example.com',
},
});
from aws_cdk.aws_cognito_identitypool import IdentityPoolAuthenticationProviders, IdentityPoolGoogleLoginProvider
# open_id_connect_provider: iam.OpenIdConnectProvider
IdentityPool(self, "myidentitypool",
identity_pool_name="myidentitypool",
authentication_providers=IdentityPoolAuthenticationProviders(
google=IdentityPoolGoogleLoginProvider(
client_id="12345678012.apps.googleusercontent.com"
),
open_id_connect_providers=[open_id_connect_provider],
custom_provider="my-custom-provider.example.com"
)
)
OpenIdConnectProvider openIdConnectProvider;
IdentityPool.Builder.create(this, "myidentitypool")
.identityPoolName("myidentitypool")
.authenticationProviders(IdentityPoolAuthenticationProviders.builder()
.google(IdentityPoolGoogleLoginProvider.builder()
.clientId("12345678012.apps.googleusercontent.com")
.build())
.openIdConnectProviders(List.of(openIdConnectProvider))
.customProvider("my-custom-provider.example.com")
.build())
.build();
// Install: dotnet add package Amazon.CDK.Lib
OpenIdConnectProvider openIdConnectProvider;
new IdentityPool(this, "myidentitypool", new IdentityPoolProps {
IdentityPoolName = "myidentitypool",
AuthenticationProviders = new IdentityPoolAuthenticationProviders {
Google = new IdentityPoolGoogleLoginProvider {
ClientId = "12345678012.apps.googleusercontent.com"
},
OpenIdConnectProviders = new [] { openIdConnectProvider },
CustomProvider = "my-custom-provider.example.com"
}
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var openIdConnectProvider OpenIdConnectProvider
awscdk.NewIdentityPool(this, jsii.String("myidentitypool"), &IdentityPoolProps{
IdentityPoolName: jsii.String("myidentitypool"),
AuthenticationProviders: &IdentityPoolAuthenticationProviders{
Google: &IdentityPoolGoogleLoginProvider{
ClientId: jsii.String("12345678012.apps.googleusercontent.com"),
},
OpenIdConnectProviders: []IOIDCProviderRef{
openIdConnectProvider,
},
CustomProvider: jsii.String("my-custom-provider.example.com"),
},
})
Initializer
new IdentityPool(scope: Construct, id: string, props?: IdentityPoolProps)
IdentityPool(scope: Construct, id: str, props: typing.Optional[IdentityPoolProps] = None)
new IdentityPool(Construct scope, String id, IdentityPoolProps props)
new IdentityPool(Construct scope, string id, IdentityPoolProps? props = null)
NewIdentityPool(Scope Construct, Id *string, Props IdentityPoolProps)
Construct Props
allowClassicFlowoptionalbooleanallow_classic_flowoptionalboolallowClassicFlowoptionalBooleanAllowClassicFlowoptionalboolAllowClassicFlowoptional*bool#Default: Classic Flow not allowed
allowUnauthenticatedIdentitiesoptionalbooleanallow_unauthenticated_identitiesoptionalboolallowUnauthenticatedIdentitiesoptionalBooleanAllowUnauthenticatedIdentitiesoptionalboolAllowUnauthenticatedIdentitiesoptional*bool= false#authenticatedRoleoptionalIRoleauthenticated_roleoptionalIRoleauthenticatedRoleoptionalIRoleAuthenticatedRoleoptionalIRoleAuthenticatedRoleoptionalIRole#Default: A default authenticated Role will be added
authenticationProvidersoptionalIdentityPoolAuthenticationProvidersauthentication_providersoptionalIdentityPoolAuthenticationProvidersauthenticationProvidersoptionalIdentityPoolAuthenticationProvidersAuthenticationProvidersoptionalIdentityPoolAuthenticationProvidersAuthenticationProvidersoptionalIdentityPoolAuthenticationProviders#Default: No Authentication Providers passed directly to Identity Pool
identityPoolNameoptionalstringidentity_pool_nameoptionalstridentityPoolNameoptionalStringIdentityPoolNameoptionalstringIdentityPoolNameoptional*string#Default: Automatically generated name by CloudFormation at deploy time
roleMappingsoptionalIdentityPoolRoleMapping[]role_mappingsoptionaltyping.List[IdentityPoolRoleMapping]roleMappingsoptionalList<IdentityPoolRoleMapping>RoleMappingsoptionalIdentityPoolRoleMapping[]RoleMappingsoptional*[]IdentityPoolRoleMapping#Default: no role mappings
Properties
authenticatedRoleIRoleauthenticated_roleIRoleauthenticatedRoleIRoleAuthenticatedRoleIRoleAuthenticatedRoleIRole#envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#notes
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.
identityPoolArnstringidentity_pool_arnstridentityPoolArnStringIdentityPoolArnstringIdentityPoolArn*string#identityPoolIdstringidentity_pool_idstridentityPoolIdStringIdentityPoolIdstringIdentityPoolId*string#identityPoolNamestringidentity_pool_namestridentityPoolNameStringIdentityPoolNamestringIdentityPoolName*string#identityPoolRefIdentityPoolReferenceidentity_pool_refIdentityPoolReferenceidentityPoolRefIdentityPoolReferenceIdentityPoolRefIdentityPoolReferenceIdentityPoolRefIdentityPoolReference#PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringstatic#roleAttachmentCfnIdentityPoolRoleAttachmentrole_attachmentCfnIdentityPoolRoleAttachmentroleAttachmentCfnIdentityPoolRoleAttachmentRoleAttachmentCfnIdentityPoolRoleAttachmentRoleAttachmentCfnIdentityPoolRoleAttachment#Methods
addUserPoolAuthentication(userPool: IUserPoolAuthenticationProvider): voiddef add_user_pool_authentication(self, user_pool: IUserPoolAuthenticationProvider) -> Nonepublic void addUserPoolAuthentication(IUserPoolAuthenticationProvider userPool)public void AddUserPoolAuthentication(IUserPoolAuthenticationProvider userPool)func AddUserPoolAuthentication(UserPool IUserPoolAuthenticationProvider)#applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
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
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
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).
fromIdentityPoolArn(scope: Construct, id: string, identityPoolArn: string): IIdentityPool@staticmethod def from_identity_pool_arn(scope: Construct, id: str, identity_pool_arn: str) -> IIdentityPoolpublic static IIdentityPool fromIdentityPoolArn(Construct scope, String id, String identityPoolArn)public static IIdentityPool FromIdentityPoolArn(Construct scope, string id, string identityPoolArn)func FromIdentityPoolArn(Scope Construct, Id *string, IdentityPoolArn *string) IIdentityPoolstatic#fromIdentityPoolId(scope: Construct, id: string, identityPoolId: string): IIdentityPool@staticmethod def from_identity_pool_id(scope: Construct, id: str, identity_pool_id: str) -> IIdentityPoolpublic static IIdentityPool fromIdentityPoolId(Construct scope, String id, String identityPoolId)public static IIdentityPool FromIdentityPoolId(Construct scope, string id, string identityPoolId)func FromIdentityPoolId(Scope Construct, Id *string, IdentityPoolId *string) IIdentityPoolstatic#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#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.