Package software.amazon.awscdk.cfnpropertymixins.services.verifiedpermissions

Interface CfnIdentitySourcePropsMixin.CognitoUserPoolConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIdentitySourcePropsMixin.CognitoUserPoolConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnIdentitySourcePropsMixin

@Stability(Stable)
public static interface CfnIdentitySourcePropsMixin.CognitoUserPoolConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

A structure that contains configuration information used when creating or updating an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.verifiedpermissions.*;
 CognitoUserPoolConfigurationProperty cognitoUserPoolConfigurationProperty = CognitoUserPoolConfigurationProperty.builder()
         .clientIds(List.of("clientIds"))
         .groupConfiguration(CognitoGroupConfigurationProperty.builder()
                 .groupEntityType("groupEntityType")
                 .build())
         .userPoolArn("userPoolArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-cognitouserpoolconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnIdentitySourcePropsMixin.CognitoUserPoolConfigurationProperty.Builder	A builder for CfnIdentitySourcePropsMixin.CognitoUserPoolConfigurationProperty
static final class	CfnIdentitySourcePropsMixin.CognitoUserPoolConfigurationProperty.Jsii$Proxy	An implementation for CfnIdentitySourcePropsMixin.CognitoUserPoolConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnIdentitySourcePropsMixin.CognitoUserPoolConfigurationProperty.Builder	builder()
default List<String>	getClientIds()	The unique application client IDs that are associated with the specified Amazon Cognito user pool.
default Object	getGroupConfiguration()	The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
default String	getUserPoolArn()	The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getClientIds

@Stability(Stable)
@Nullable
default List<String> getClientIds()

The unique application client IDs that are associated with the specified Amazon Cognito user pool.

Example: "ClientIds": ["&ExampleCogClientId;"]

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-cognitouserpoolconfiguration.html#cfn-verifiedpermissions-identitysource-cognitouserpoolconfiguration-clientids

getGroupConfiguration

@Stability(Stable)
@Nullable
default Object getGroupConfiguration()

The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.

Returns union: either IResolvable or CfnIdentitySourcePropsMixin.CognitoGroupConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-cognitouserpoolconfiguration.html#cfn-verifiedpermissions-identitysource-cognitouserpoolconfiguration-groupconfiguration

getUserPoolArn

@Stability(Stable)
@Nullable
default String getUserPoolArn()

The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-cognitouserpoolconfiguration.html#cfn-verifiedpermissions-identitysource-cognitouserpoolconfiguration-userpoolarn

builder

@Stability(Stable)
static CfnIdentitySourcePropsMixin.CognitoUserPoolConfigurationProperty.Builder builder()

Returns:

a CfnIdentitySourcePropsMixin.CognitoUserPoolConfigurationProperty.Builder of CfnIdentitySourcePropsMixin.CognitoUserPoolConfigurationProperty