Package software.amazon.awscdk.services.verifiedpermissions

Interface CfnIdentitySource.CognitoUserPoolConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIdentitySource.CognitoUserPoolConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnIdentitySource

@Stability(Stable)
public static interface CfnIdentitySource.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.services.verifiedpermissions.*;
 CognitoUserPoolConfigurationProperty cognitoUserPoolConfigurationProperty = CognitoUserPoolConfigurationProperty.builder()
         .userPoolArn("userPoolArn")
         // the properties below are optional
         .clientIds(List.of("clientIds"))
         .groupConfiguration(CognitoGroupConfigurationProperty.builder()
                 .groupEntityType("groupEntityType")
                 .build())
         .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	CfnIdentitySource.CognitoUserPoolConfigurationProperty.Builder	A builder for CfnIdentitySource.CognitoUserPoolConfigurationProperty
static final class	CfnIdentitySource.CognitoUserPoolConfigurationProperty.Jsii$Proxy	An implementation for CfnIdentitySource.CognitoUserPoolConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnIdentitySource.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.
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

getUserPoolArn

@Stability(Stable)
@NotNull
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

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.

See Also:

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

builder

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

Returns:

a CfnIdentitySource.CognitoUserPoolConfigurationProperty.Builder of CfnIdentitySource.CognitoUserPoolConfigurationProperty