All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnGraphQLApiProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:31.414Z") @Stability(Stable) public interface CfnGraphQLApiProps extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnGraphQLApi.

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.*;
 CfnGraphQLApiProps cfnGraphQLApiProps = CfnGraphQLApiProps.builder()
         .authenticationType("authenticationType")
         .name("name")
         // the properties below are optional
         .additionalAuthenticationProviders(List.of(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()))
         .apiType("apiType")
         .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")
         .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();

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnGraphQLApiProps.Builder

A builder for CfnGraphQLApiProps

static final class

CfnGraphQLApiProps.Jsii$Proxy

An implementation for CfnGraphQLApiProps
Method Summary

Modifier and Type

Method

Description

static CfnGraphQLApiProps.Builder

builder()

default Object

getAdditionalAuthenticationProviders()

A list of additional authentication providers for the GraphqlApi API.

default String

getApiType()

The value that indicates whether the GraphQL API is a standard API ( GRAPHQL ) or merged API ( MERGED ).

String

getAuthenticationType()

Security configuration for your GraphQL API.

default Object

getEnhancedMetricsConfig()

Enables and controls the enhanced metrics feature.

default Object

getEnvironmentVariables()

A map containing the list of resources with their properties and environment variables.

default String

getIntrospectionConfig()

Sets the value of the GraphQL API to enable ( ENABLED ) or disable ( DISABLED ) introspection.

default Object

getLambdaAuthorizerConfig()

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

default Object

getLogConfig()

The Amazon CloudWatch Logs configuration.

default String

getMergedApiExecutionRoleArn()

The AWS Identity and Access Management service role ARN for a merged API.

String

getName()

The API name.

default Object

getOpenIdConnectConfig()

The OpenID Connect configuration.

default String

getOwnerContact()

The owner contact information for an API resource.

default Number

getQueryDepthLimit()

The maximum depth a query can have in a single request.

default Number

getResolverCountLimit()

The maximum number of resolvers that can be invoked in a single request.

default List<CfnTag>

getTags()

An arbitrary set of tags (key-value pairs) for this GraphQL API.

default Object

getUserPoolConfig()

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

default String

getVisibility()

Sets the scope of the GraphQL API to public ( GLOBAL ) or private ( PRIVATE ).

default Object

getXrayEnabled()

A flag indicating whether to use AWS X-Ray tracing for this GraphqlApi .

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getAuthenticationType
  
  @Stability(Stable) @NotNull String getAuthenticationType()
  
  Security configuration for your GraphQL API.
  For allowed values (such as API_KEY , AWS_IAM , AMAZON_COGNITO_USER_POOLS , OPENID_CONNECT , or AWS_LAMBDA ), see Security in the AWS AppSync Developer Guide .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-authenticationtype
- getName
  
  @Stability(Stable) @NotNull String getName()
  
  The API name.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-name
- getAdditionalAuthenticationProviders
  
  @Stability(Stable) @Nullable default Object getAdditionalAuthenticationProviders()
  
  A list of additional authentication providers for the GraphqlApi API.
  Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnGraphQLApi.AdditionalAuthenticationProviderProperty>
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-additionalauthenticationproviders
- getApiType
  
  @Stability(Stable) @Nullable default String getApiType()
  
  The value that indicates whether the GraphQL API is a standard API ( GRAPHQL ) or merged API ( MERGED ).
  WARNING : If the ApiType has not been defined, explicitly setting it to GRAPHQL in a template/stack update will result in an API replacement and new DNS values.
  The following values are valid:
  GRAPHQL | MERGED
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-apitype
- getEnhancedMetricsConfig
  
  @Stability(Stable) @Nullable default Object getEnhancedMetricsConfig()
  
  Enables and controls the enhanced metrics feature.
  Enhanced metrics emit granular data on API usage and performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data is sent to your CloudWatch account, and you can configure the types of data that will be sent.
  Enhanced metrics can be configured at the resolver, data source, and operation levels. For more information, see Monitoring and logging in the AWS AppSync User Guide .
  Returns union: either IResolvable or CfnGraphQLApi.EnhancedMetricsConfigProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-enhancedmetricsconfig
- getEnvironmentVariables
  
  @Stability(Stable) @Nullable default Object getEnvironmentVariables()
  
  A map containing the list of resources with their properties and environment variables.
  For more information, see Environmental variables .
  Pattern : ^[A-Za-z]+\\w*$\\
  Minimum : 2
  Maximum : 64
  Returns union: either Mapinvalid input: '<'String, String> or IResolvable
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-environmentvariables
- getIntrospectionConfig
  
  @Stability(Stable) @Nullable default String getIntrospectionConfig()
  
  Sets the value of the GraphQL API to enable ( ENABLED ) or disable ( DISABLED ) introspection.
  If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.
  For more information about introspection, see GraphQL introspection .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-introspectionconfig
- 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.
  Returns union: either IResolvable or CfnGraphQLApi.LambdaAuthorizerConfigProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-lambdaauthorizerconfig
- getLogConfig
  
  @Stability(Stable) @Nullable default Object getLogConfig()
  
  The Amazon CloudWatch Logs configuration.
  Returns union: either IResolvable or CfnGraphQLApi.LogConfigProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-logconfig
- getMergedApiExecutionRoleArn
  
  @Stability(Stable) @Nullable default String getMergedApiExecutionRoleArn()
  
  The AWS Identity and Access Management service role ARN for a merged API.
  The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE to update the merged API endpoint with the source API changes automatically.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-mergedapiexecutionrolearn
- getOpenIdConnectConfig
  
  @Stability(Stable) @Nullable default Object getOpenIdConnectConfig()
  
  The OpenID Connect configuration.
  Returns union: either IResolvable or CfnGraphQLApi.OpenIDConnectConfigProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-openidconnectconfig
- getOwnerContact
  
  @Stability(Stable) @Nullable default String getOwnerContact()
  
  The owner contact information for an API resource.
  This field accepts any string input with a length of 0 - 256 characters.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-ownercontact
- getQueryDepthLimit
  
  @Stability(Stable) @Nullable default Number getQueryDepthLimit()
  
  The maximum depth a query can have in a single request.
  Depth refers to the amount of nested levels allowed in the body of query. The default value is 0 (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between 1 and 75 nested levels. This field will produce a limit error if the operation falls out of bounds. Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-querydepthlimit
- getResolverCountLimit
  
  @Stability(Stable) @Nullable default Number getResolverCountLimit()
  
  The maximum number of resolvers that can be invoked in a single request.
  The default value is 0 (or unspecified), which will set the limit to 10000 . When specified, the limit value can be between 1 and 10000 . This field will produce a limit error if the operation falls out of bounds.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-resolvercountlimit
- getTags
  
  @Stability(Stable) @Nullable default List<CfnTag> getTags()
  
  An arbitrary set of tags (key-value pairs) for this GraphQL API.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-tags
- getUserPoolConfig
  
  @Stability(Stable) @Nullable default Object getUserPoolConfig()
  
  Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
  Returns union: either IResolvable or CfnGraphQLApi.UserPoolConfigProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-userpoolconfig
- getVisibility
  
  @Stability(Stable) @Nullable default String getVisibility()
  
  Sets the scope of the GraphQL API to public ( GLOBAL ) or private ( PRIVATE ).
  By default, the scope is set to Global if no value is provided.
  WARNING : If Visibility has not been defined, explicitly setting it to GLOBAL in a template/stack update will result in an API replacement and new DNS values.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-visibility
- getXrayEnabled
  
  @Stability(Stable) @Nullable default Object getXrayEnabled()
  
  A flag indicating whether to use AWS X-Ray tracing for this GraphqlApi .
  Returns union: either Boolean or IResolvable
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-xrayenabled
- builder
  
  @Stability(Stable) static CfnGraphQLApiProps.Builder builder()
  
  Returns:
  
  a CfnGraphQLApiProps.Builder of CfnGraphQLApiProps

Interface CfnGraphQLApiProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getAuthenticationType

getName

getAdditionalAuthenticationProviders

getApiType

getEnhancedMetricsConfig

getEnvironmentVariables

getIntrospectionConfig

getLambdaAuthorizerConfig

getLogConfig

getMergedApiExecutionRoleArn

getOpenIdConnectConfig

getOwnerContact

getQueryDepthLimit

getResolverCountLimit

getTags

getUserPoolConfig

getVisibility

getXrayEnabled

builder