Package software.amazon.awscdk.services.appsync

Interface CfnGraphQLApi.CognitoUserPoolConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGraphQLApi.CognitoUserPoolConfigProperty.Jsii$Proxy

Enclosing class:

CfnGraphQLApi

@Stability(Stable)
public static interface CfnGraphQLApi.CognitoUserPoolConfigProperty
extends software.amazon.jsii.JsiiSerializable

Describes an Amazon Cognito user pool configuration.

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.appsync.*;
 CognitoUserPoolConfigProperty cognitoUserPoolConfigProperty = CognitoUserPoolConfigProperty.builder()
         .appIdClientRegex("appIdClientRegex")
         .awsRegion("awsRegion")
         .userPoolId("userPoolId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-cognitouserpoolconfig.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnGraphQLApi.CognitoUserPoolConfigProperty.Builder	builder()
default String	getAppIdClientRegex()	A regular expression for validating the incoming Amazon Cognito user pool app client ID.
default String	getAwsRegion()	The AWS Region in which the user pool was created.
default String	getUserPoolId()	The user pool ID.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAppIdClientRegex

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

A regular expression for validating the incoming Amazon Cognito user pool app client ID.

If this value isn't set, no filtering is applied.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-cognitouserpoolconfig.html#cfn-appsync-graphqlapi-cognitouserpoolconfig-appidclientregex

getAwsRegion

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

The AWS Region in which the user pool was created.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-cognitouserpoolconfig.html#cfn-appsync-graphqlapi-cognitouserpoolconfig-awsregion

getUserPoolId

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

The user pool ID.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-cognitouserpoolconfig.html#cfn-appsync-graphqlapi-cognitouserpoolconfig-userpoolid

builder

@Stability(Stable)
static CfnGraphQLApi.CognitoUserPoolConfigProperty.Builder builder()

Returns:

a CfnGraphQLApi.CognitoUserPoolConfigProperty.Builder of CfnGraphQLApi.CognitoUserPoolConfigProperty