Package software.amazon.awscdk.cfnpropertymixins.services.appsync

Class CfnGraphQLApiPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.appsync.CfnGraphQLApiPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.982Z")
@Stability(Stable)
public class CfnGraphQLApiPropsMixin
extends Mixin
implements software.constructs.IMixin

The AWS::AppSync::GraphQLApi resource creates a new AWS AppSync GraphQL API.

This is the top-level construct for your application. For more information, see Quick Start in the AWS AppSync Developer Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.appsync.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnGraphQLApiPropsMixin cfnGraphQLApiPropsMixin = CfnGraphQLApiPropsMixin.Builder.create(CfnGraphQLApiMixinProps.builder()
         .additionalAuthenticationProviders(List.of(AdditionalAuthenticationProviderProperty.builder()
                 .authenticationType("authenticationType")
                 .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()))
         .apiType("apiType")
         .authenticationType("authenticationType")
         .enhancedMetricsConfig(EnhancedMetricsConfigProperty.builder()
                 .dataSourceLevelMetricsBehavior("dataSourceLevelMetricsBehavior")
                 .operationLevelMetricsConfig("operationLevelMetricsConfig")
                 .resolverLevelMetricsBehavior("resolverLevelMetricsBehavior")
                 .build())
         .environmentVariables(Map.of(
                 "environmentVariablesKey", "environmentVariables"))
         .introspectionConfig("introspectionConfig")
         .lambdaAuthorizerConfig(LambdaAuthorizerConfigProperty.builder()
                 .authorizerResultTtlInSeconds(123)
                 .authorizerUri("authorizerUri")
                 .identityValidationExpression("identityValidationExpression")
                 .build())
         .logConfig(LogConfigProperty.builder()
                 .cloudWatchLogsRoleArn("cloudWatchLogsRoleArn")
                 .excludeVerboseContent(false)
                 .fieldLogLevel("fieldLogLevel")
                 .build())
         .mergedApiExecutionRoleArn("mergedApiExecutionRoleArn")
         .name("name")
         .openIdConnectConfig(OpenIDConnectConfigProperty.builder()
                 .authTtl(123)
                 .clientId("clientId")
                 .iatTtl(123)
                 .issuer("issuer")
                 .build())
         .ownerContact("ownerContact")
         .queryDepthLimit(123)
         .resolverCountLimit(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .userPoolConfig(UserPoolConfigProperty.builder()
                 .appIdClientRegex("appIdClientRegex")
                 .awsRegion("awsRegion")
                 .defaultAction("defaultAction")
                 .userPoolId("userPoolId")
                 .build())
         .visibility("visibility")
         .xrayEnabled(false)
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnGraphQLApiPropsMixin.AdditionalAuthenticationProviderProperty	Describes an additional authentication provider.
static final class	CfnGraphQLApiPropsMixin.Builder	A fluent builder for CfnGraphQLApiPropsMixin.
static interface	CfnGraphQLApiPropsMixin.CognitoUserPoolConfigProperty	Describes an Amazon Cognito user pool configuration.
static interface	CfnGraphQLApiPropsMixin.EnhancedMetricsConfigProperty	Describes an enhanced metrics configuration.
static interface	CfnGraphQLApiPropsMixin.LambdaAuthorizerConfigProperty	Configuration for AWS Lambda function authorization.
static interface	CfnGraphQLApiPropsMixin.LogConfigProperty	The LogConfig property type specifies the logging configuration when writing GraphQL operations and tracing to Amazon CloudWatch for an AWS AppSync GraphQL API.
static interface	CfnGraphQLApiPropsMixin.OpenIDConnectConfigProperty	The OpenIDConnectConfig property type specifies the optional authorization configuration for using an OpenID Connect compliant service with your GraphQL endpoint for an AWS AppSync GraphQL API.
static interface	CfnGraphQLApiPropsMixin.UserPoolConfigProperty	The UserPoolConfig property type specifies the optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint for an AWS AppSync GraphQL API.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnGraphQLApiPropsMixin(CfnGraphQLApiMixinProps props)	Create a mixin to apply properties to AWS::AppSync::GraphQLApi.
	CfnGraphQLApiPropsMixin(CfnGraphQLApiMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::AppSync::GraphQLApi.
protected	CfnGraphQLApiPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnGraphQLApiPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnGraphQLApiMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnGraphQLApiPropsMixin

protected CfnGraphQLApiPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnGraphQLApiPropsMixin

protected CfnGraphQLApiPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnGraphQLApiPropsMixin

@Stability(Stable)
public CfnGraphQLApiPropsMixin(@NotNull
 CfnGraphQLApiMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::AppSync::GraphQLApi.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnGraphQLApiPropsMixin

@Stability(Stable)
public CfnGraphQLApiPropsMixin(@NotNull
 CfnGraphQLApiMixinProps props)

Create a mixin to apply properties to AWS::AppSync::GraphQLApi.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnGraphQLApiMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()