Package software.amazon.awscdk.services.appsync

Interface CfnGraphQLApi.AdditionalAuthenticationProviderProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGraphQLApi.AdditionalAuthenticationProviderProperty.Jsii$Proxy

Enclosing class:

CfnGraphQLApi

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

Describes an additional authentication provider.

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.*;
 AdditionalAuthenticationProviderProperty additionalAuthenticationProviderProperty = AdditionalAuthenticationProviderProperty.builder()
         .authenticationType("authenticationType")
         // the properties below are optional
         .lambdaAuthorizerConfig(LambdaAuthorizerConfigProperty.builder()
                 .authorizerResultTtlInSeconds(123)
                 .authorizerUri("authorizerUri")
                 .identityValidationExpression("identityValidationExpression")
                 .build())
         .openIdConnectConfig(OpenIDConnectConfigProperty.builder()
                 .authTtl(123)
                 .clientId("clientId")
                 .iatTtl(123)
                 .issuer("issuer")
                 .build())
         .userPoolConfig(CognitoUserPoolConfigProperty.builder()
                 .appIdClientRegex("appIdClientRegex")
                 .awsRegion("awsRegion")
                 .userPoolId("userPoolId")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnGraphQLApi.AdditionalAuthenticationProviderProperty.Builder	builder()
String	getAuthenticationType()	The authentication type for API key, AWS Identity and Access Management , OIDC, Amazon Cognito user pools , or AWS Lambda .
default Object	getLambdaAuthorizerConfig()	Configuration for AWS Lambda function authorization.
default Object	getOpenIdConnectConfig()	The OIDC configuration.
default Object	getUserPoolConfig()	The Amazon Cognito user pool configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthenticationType

@Stability(Stable)
@NotNull
String getAuthenticationType()

The authentication type for API key, AWS Identity and Access Management , OIDC, Amazon Cognito user pools , or AWS Lambda .

Valid Values: API_KEY | AWS_IAM | OPENID_CONNECT | AMAZON_COGNITO_USER_POOLS | AWS_LAMBDA

See Also:

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

getLambdaAuthorizerConfig

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

Configuration for AWS Lambda function authorization.

See Also:

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

getOpenIdConnectConfig

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

The OIDC configuration.

See Also:

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

getUserPoolConfig

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

The Amazon Cognito user pool configuration.

See Also:

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

builder

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

Returns:

a CfnGraphQLApi.AdditionalAuthenticationProviderProperty.Builder of CfnGraphQLApi.AdditionalAuthenticationProviderProperty