Package 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.89.0 (build 2f74b3e)",
           date="2023-10-26T00:56:04.428Z")
@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")
         .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")
         .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:

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

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	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 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.

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

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-resource-appsync-graphqlapi.html#cfn-appsync-graphqlapi-lambdaauthorizerconfig

getLogConfig

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

The Amazon CloudWatch Logs configuration.

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.

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

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.

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 .

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