Class IdentityPoolProps
(experimental) Props for the IdentityPool construct.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Cognito.IdentityPool
Assembly: Amazon.CDK.AWS.Cognito.IdentityPool.dll
Syntax (csharp)
public class IdentityPoolProps : Object, IIdentityPoolProps
Syntax (vb)
Public Class IdentityPoolProps
Inherits Object
Implements IIdentityPoolProps
Remarks
Stability: Experimental
ExampleMetadata: infused
Examples
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"
}
});
Synopsis
Constructors
IdentityPoolProps() |
Properties
AllowClassicFlow | (experimental) Enables the Basic (Classic) authentication flow. |
AllowUnauthenticatedIdentities | (experimental) Wwhether the identity pool supports unauthenticated logins. |
AuthenticatedRole | (experimental) The Default Role to be assumed by Authenticated Users. |
AuthenticationProviders | (experimental) Authentication providers for using in identity pool. |
IdentityPoolName | (experimental) The name of the Identity Pool. |
RoleMappings | (experimental) Rules for mapping roles to users. |
UnauthenticatedRole | (experimental) The Default Role to be assumed by Unauthenticated Users. |
Constructors
IdentityPoolProps()
public IdentityPoolProps()
Properties
AllowClassicFlow
(experimental) Enables the Basic (Classic) authentication flow.
public Nullable<bool> AllowClassicFlow { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: - Classic Flow not allowed
Stability: Experimental
AllowUnauthenticatedIdentities
(experimental) Wwhether the identity pool supports unauthenticated logins.
public Nullable<bool> AllowUnauthenticatedIdentities { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: - false
Stability: Experimental
AuthenticatedRole
(experimental) The Default Role to be assumed by Authenticated Users.
public IRole AuthenticatedRole { get; set; }
Property Value
Remarks
Default: - A Default Authenticated Role will be added
Stability: Experimental
AuthenticationProviders
(experimental) Authentication providers for using in identity pool.
public IIdentityPoolAuthenticationProviders AuthenticationProviders { get; set; }
Property Value
IIdentityPoolAuthenticationProviders
Remarks
Default: - No Authentication Providers passed directly to Identity Pool
Stability: Experimental
IdentityPoolName
(experimental) The name of the Identity Pool.
public string IdentityPoolName { get; set; }
Property Value
System.String
Remarks
Default: - automatically generated name by CloudFormation at deploy time
Stability: Experimental
RoleMappings
(experimental) Rules for mapping roles to users.
public IIdentityPoolRoleMapping[] RoleMappings { get; set; }
Property Value
Remarks
Default: - no Role Mappings
Stability: Experimental
UnauthenticatedRole
(experimental) The Default Role to be assumed by Unauthenticated Users.
public IRole UnauthenticatedRole { get; set; }
Property Value
Remarks
Default: - A Default Unauthenticated Role will be added
Stability: Experimental