software.amazon.awscdk.services.appsync

Interface CfnGraphQLApiProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGraphQLApiProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.682Z")
 @Stability(value=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()))
         .lambdaAuthorizerConfig(LambdaAuthorizerConfigProperty.builder()
                 .authorizerResultTtlInSeconds(123)
                 .authorizerUri("authorizerUri")
                 .identityValidationExpression("identityValidationExpression")
                 .build())
         .logConfig(LogConfigProperty.builder()
                 .cloudWatchLogsRoleArn("cloudWatchLogsRoleArn")
                 .excludeVerboseContent(false)
                 .fieldLogLevel("fieldLogLevel")
                 .build())
         .openIdConnectConfig(OpenIDConnectConfigProperty.builder()
                 .authTtl(123)
                 .clientId("clientId")
                 .iatTtl(123)
                 .issuer("issuer")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .userPoolConfig(UserPoolConfigProperty.builder()
                 .appIdClientRegex("appIdClientRegex")
                 .awsRegion("awsRegion")
                 .defaultAction("defaultAction")
                 .userPoolId("userPoolId")
                 .build())
         .xrayEnabled(false)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnGraphQLApiProps.Builder	builder()
default Object	getAdditionalAuthenticationProviders() A list of additional authentication providers for the `GraphqlApi` API.
String	getAuthenticationType() Security configuration for your GraphQL API.
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.
String	getName() The API name.
default Object	getOpenIdConnectConfig() The OpenID Connect configuration.
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 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 Detail

getAuthenticationType

@Stability(value=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 .

getName

@Stability(value=Stable)
 @NotNull
String getName()

The API name.

getAdditionalAuthenticationProviders

@Stability(value=Stable)
 @Nullable
default Object getAdditionalAuthenticationProviders()

A list of additional authentication providers for the `GraphqlApi` API.

getLambdaAuthorizerConfig

@Stability(value=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.

getLogConfig

@Stability(value=Stable)
 @Nullable
default Object getLogConfig()

The Amazon CloudWatch Logs configuration.

getOpenIdConnectConfig

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

The OpenID Connect configuration.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

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

getUserPoolConfig

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

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

getXrayEnabled

@Stability(value=Stable)
 @Nullable
default Object getXrayEnabled()

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

builder

@Stability(value=Stable)
static CfnGraphQLApiProps.Builder builder()

Returns:

a CfnGraphQLApiProps.Builder of CfnGraphQLApiProps