Skip to content
v2.278.0

AdditionalAuthenticationProviderProperty Struct ​

Describes an additional authentication provider.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appsync as appsync } from 'aws-cdk-lib';
const additionalAuthenticationProviderProperty: appsync.CfnGraphQLApi.AdditionalAuthenticationProviderProperty = {
  authenticationType: 'authenticationType',

  // the properties below are optional
  lambdaAuthorizerConfig: {
    authorizerResultTtlInSeconds: 123,
    authorizerUri: 'authorizerUri',
    identityValidationExpression: 'identityValidationExpression',
  },
  openIdConnectConfig: {
    authTtl: 123,
    clientId: 'clientId',
    iatTtl: 123,
    issuer: 'issuer',
  },
  userPoolConfig: {
    appIdClientRegex: 'appIdClientRegex',
    awsRegion: 'awsRegion',
    userPoolId: 'userPoolId',
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_appsync as appsync

additional_authentication_provider_property = appsync.CfnGraphQLApi.AdditionalAuthenticationProviderProperty(
    authentication_type="authenticationType",

    # the properties below are optional
    lambda_authorizer_config=appsync.CfnGraphQLApi.LambdaAuthorizerConfigProperty(
        authorizer_result_ttl_in_seconds=123,
        authorizer_uri="authorizerUri",
        identity_validation_expression="identityValidationExpression"
    ),
    open_id_connect_config=appsync.CfnGraphQLApi.OpenIDConnectConfigProperty(
        auth_ttl=123,
        client_id="clientId",
        iat_ttl=123,
        issuer="issuer"
    ),
    user_pool_config=appsync.CfnGraphQLApi.CognitoUserPoolConfigProperty(
        app_id_client_regex="appIdClientRegex",
        aws_region="awsRegion",
        user_pool_id="userPoolId"
    )
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppSync;

var additionalAuthenticationProviderProperty = new AdditionalAuthenticationProviderProperty {
    AuthenticationType = "authenticationType",

    // the properties below are optional
    LambdaAuthorizerConfig = new LambdaAuthorizerConfigProperty {
        AuthorizerResultTtlInSeconds = 123,
        AuthorizerUri = "authorizerUri",
        IdentityValidationExpression = "identityValidationExpression"
    },
    OpenIdConnectConfig = new OpenIDConnectConfigProperty {
        AuthTtl = 123,
        ClientId = "clientId",
        IatTtl = 123,
        Issuer = "issuer"
    },
    UserPoolConfig = new CognitoUserPoolConfigProperty {
        AppIdClientRegex = "appIdClientRegex",
        AwsRegion = "awsRegion",
        UserPoolId = "userPoolId"
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

additionalAuthenticationProviderProperty := &AdditionalAuthenticationProviderProperty{
	AuthenticationType: jsii.String("authenticationType"),

	// the properties below are optional
	LambdaAuthorizerConfig: &LambdaAuthorizerConfigProperty{
		AuthorizerResultTtlInSeconds: jsii.Number(123),
		AuthorizerUri: jsii.String("authorizerUri"),
		IdentityValidationExpression: jsii.String("identityValidationExpression"),
	},
	OpenIdConnectConfig: &OpenIDConnectConfigProperty{
		AuthTtl: jsii.Number(123),
		ClientId: jsii.String("clientId"),
		IatTtl: jsii.Number(123),
		Issuer: jsii.String("issuer"),
	},
	UserPoolConfig: &CognitoUserPoolConfigProperty{
		AppIdClientRegex: jsii.String("appIdClientRegex"),
		AwsRegion: jsii.String("awsRegion"),
		UserPoolId: jsii.String("userPoolId"),
	},
}

Properties ​

authenticationTypestringauthentication_typestrauthenticationTypeStringAuthenticationTypestringAuthenticationType*string required #
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

lambdaAuthorizerConfigoptionalIResolvable | CfnGraphQLApi.LambdaAuthorizerConfigPropertylambda_authorizer_configoptionaltyping.Union[IResolvable, LambdaAuthorizerConfigProperty]lambdaAuthorizerConfigoptionalIResolvableLambdaAuthorizerConfigoptionalIResolvableLambdaAuthorizerConfigoptionalinterface{} #
Configuration for AWS Lambda function authorization.
openIdConnectConfigoptionalIResolvable | CfnGraphQLApi.OpenIDConnectConfigPropertyopen_id_connect_configoptionaltyping.Union[IResolvable, OpenIDConnectConfigProperty]openIdConnectConfigoptionalIResolvableOpenIdConnectConfigoptionalIResolvableOpenIdConnectConfigoptionalinterface{} #
The OIDC configuration.
userPoolConfigoptionalIResolvable | CfnGraphQLApi.CognitoUserPoolConfigPropertyuser_pool_configoptionaltyping.Union[IResolvable, CognitoUserPoolConfigProperty]userPoolConfigoptionalIResolvableUserPoolConfigoptionalIResolvableUserPoolConfigoptionalinterface{} #
The Amazon Cognito user pool configuration.