Package software.amazon.awscdk.services.appsync

Interface CfnApi.AuthProviderProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApi.AuthProviderProperty.Jsii$Proxy

Enclosing class:

CfnApi

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

An auth provider for the AppSync API.

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.*;
 AuthProviderProperty authProviderProperty = AuthProviderProperty.builder()
         .authType("authType")
         // the properties below are optional
         .cognitoConfig(CognitoConfigProperty.builder()
                 .awsRegion("awsRegion")
                 .userPoolId("userPoolId")
                 // the properties below are optional
                 .appIdClientRegex("appIdClientRegex")
                 .build())
         .lambdaAuthorizerConfig(LambdaAuthorizerConfigProperty.builder()
                 .authorizerUri("authorizerUri")
                 // the properties below are optional
                 .authorizerResultTtlInSeconds(123)
                 .identityValidationExpression("identityValidationExpression")
                 .build())
         .openIdConnectConfig(OpenIDConnectConfigProperty.builder()
                 .issuer("issuer")
                 // the properties below are optional
                 .authTtl(123)
                 .clientId("clientId")
                 .iatTtl(123)
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnApi.AuthProviderProperty.Builder	builder()
String	getAuthType()	Security configuration for your AppSync API.
default Object	getCognitoConfig()	Optional authorization configuration for using Amazon Cognito user pools with your API endpoint.
default Object	getLambdaAuthorizerConfig()	A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode.
default Object	getOpenIdConnectConfig()	The OpenID Connect configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthType

@Stability(Stable)
@NotNull
String getAuthType()

Security configuration for your AppSync API.

See Also:

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

getCognitoConfig

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

Optional authorization configuration for using Amazon Cognito user pools with your API endpoint.

See Also:

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

getLambdaAuthorizerConfig

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

A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode.

Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time.

See Also:

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

getOpenIdConnectConfig

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

The OpenID Connect configuration.

See Also:

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

builder

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

Returns:

a CfnApi.AuthProviderProperty.Builder of CfnApi.AuthProviderProperty