Package software.amazon.awscdk.services.appsync

Interface CfnApi.CognitoConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApi.CognitoConfigProperty.Jsii$Proxy

Enclosing class:

CfnApi

@Stability(Stable)
public static interface CfnApi.CognitoConfigProperty
extends software.amazon.jsii.JsiiSerializable

Describes an Amazon Cognito 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.*;
 CognitoConfigProperty cognitoConfigProperty = CognitoConfigProperty.builder()
         .awsRegion("awsRegion")
         .userPoolId("userPoolId")
         // the properties below are optional
         .appIdClientRegex("appIdClientRegex")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAwsRegion

@Stability(Stable)
@NotNull
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-api-cognitoconfig.html#cfn-appsync-api-cognitoconfig-awsregion

getUserPoolId

@Stability(Stable)
@NotNull
String getUserPoolId()

The user pool ID.

See Also:

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

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-api-cognitoconfig.html#cfn-appsync-api-cognitoconfig-appidclientregex

builder

@Stability(Stable)
static CfnApi.CognitoConfigProperty.Builder builder()

Returns:

a CfnApi.CognitoConfigProperty.Builder of CfnApi.CognitoConfigProperty