UserPoolConfig

class aws_cdk.aws_appsync.UserPoolConfig(*, user_pool, app_id_client_regex=None, default_action=None)

Bases: object

(experimental) Configuration for Cognito user-pools in AppSync.

Parameters
  • user_pool (IUserPool) – (experimental) The Cognito user pool to use as identity source.

  • app_id_client_regex (Optional[str]) – (experimental) the optional app id regex. Default: - None

  • default_action (Optional[UserPoolDefaultAction]) – (experimental) Default auth action. Default: ALLOW

Stability

experimental

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_appsync as appsync
import aws_cdk.aws_cognito as cognito

# user_pool: cognito.UserPool

user_pool_config = appsync.UserPoolConfig(
    user_pool=user_pool,

    # the properties below are optional
    app_id_client_regex="appIdClientRegex",
    default_action=appsync.UserPoolDefaultAction.ALLOW
)

Attributes

app_id_client_regex

(experimental) the optional app id regex.

Default
  • None

Stability

experimental

Return type

Optional[str]

default_action

(experimental) Default auth action.

Default

ALLOW

Stability

experimental

Return type

Optional[UserPoolDefaultAction]

user_pool

(experimental) The Cognito user pool to use as identity source.

Stability

experimental

Return type

IUserPool