Package software.amazon.awscdk.services.appsync

Class CfnGraphQLApi.Builder

java.lang.Object

software.amazon.awscdk.services.appsync.CfnGraphQLApi.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnGraphQLApi>

Enclosing class:

CfnGraphQLApi

@Stability(Stable)
public static final class CfnGraphQLApi.Builder
extends Object
implements software.amazon.jsii.Builder<CfnGraphQLApi>

A fluent builder for CfnGraphQLApi.

Method Summary

Modifier and Type	Method	Description
CfnGraphQLApi.Builder	additionalAuthenticationProviders(List<? extends Object> additionalAuthenticationProviders)	A list of additional authentication providers for the GraphqlApi API.
CfnGraphQLApi.Builder	additionalAuthenticationProviders(IResolvable additionalAuthenticationProviders)	A list of additional authentication providers for the GraphqlApi API.
CfnGraphQLApi.Builder	apiType(String apiType)	The value that indicates whether the GraphQL API is a standard API ( GRAPHQL ) or merged API ( MERGED ).
CfnGraphQLApi.Builder	authenticationType(String authenticationType)	Security configuration for your GraphQL API.
CfnGraphQLApi	build()
static CfnGraphQLApi.Builder	create(software.constructs.Construct scope, String id)
CfnGraphQLApi.Builder	enhancedMetricsConfig(IResolvable enhancedMetricsConfig)	Enables and controls the enhanced metrics feature.
CfnGraphQLApi.Builder	enhancedMetricsConfig(CfnGraphQLApi.EnhancedMetricsConfigProperty enhancedMetricsConfig)	Enables and controls the enhanced metrics feature.
CfnGraphQLApi.Builder	environmentVariables(Object environmentVariables)	A map containing the list of resources with their properties and environment variables.
CfnGraphQLApi.Builder	introspectionConfig(String introspectionConfig)	Sets the value of the GraphQL API to enable ( ENABLED ) or disable ( DISABLED ) introspection.
CfnGraphQLApi.Builder	lambdaAuthorizerConfig(IResolvable lambdaAuthorizerConfig)	A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode.
CfnGraphQLApi.Builder	lambdaAuthorizerConfig(CfnGraphQLApi.LambdaAuthorizerConfigProperty lambdaAuthorizerConfig)	A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode.
CfnGraphQLApi.Builder	logConfig(IResolvable logConfig)	The Amazon CloudWatch Logs configuration.
CfnGraphQLApi.Builder	logConfig(CfnGraphQLApi.LogConfigProperty logConfig)	The Amazon CloudWatch Logs configuration.
CfnGraphQLApi.Builder	mergedApiExecutionRoleArn(String mergedApiExecutionRoleArn)	The AWS Identity and Access Management service role ARN for a merged API.
CfnGraphQLApi.Builder	name(String name)	The API name.
CfnGraphQLApi.Builder	openIdConnectConfig(IResolvable openIdConnectConfig)	The OpenID Connect configuration.
CfnGraphQLApi.Builder	openIdConnectConfig(CfnGraphQLApi.OpenIDConnectConfigProperty openIdConnectConfig)	The OpenID Connect configuration.
CfnGraphQLApi.Builder	ownerContact(String ownerContact)	The owner contact information for an API resource.
CfnGraphQLApi.Builder	queryDepthLimit(Number queryDepthLimit)	The maximum depth a query can have in a single request.
CfnGraphQLApi.Builder	resolverCountLimit(Number resolverCountLimit)	The maximum number of resolvers that can be invoked in a single request.
CfnGraphQLApi.Builder	tags(List<? extends CfnTag> tags)	An arbitrary set of tags (key-value pairs) for this GraphQL API.
CfnGraphQLApi.Builder	userPoolConfig(IResolvable userPoolConfig)	Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
CfnGraphQLApi.Builder	userPoolConfig(CfnGraphQLApi.UserPoolConfigProperty userPoolConfig)	Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
CfnGraphQLApi.Builder	visibility(String visibility)	Sets the scope of the GraphQL API to public ( GLOBAL ) or private ( PRIVATE ).
CfnGraphQLApi.Builder	xrayEnabled(Boolean xrayEnabled)	A flag indicating whether to use AWS X-Ray tracing for this GraphqlApi .
CfnGraphQLApi.Builder	xrayEnabled(IResolvable xrayEnabled)	A flag indicating whether to use AWS X-Ray tracing for this GraphqlApi .

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnGraphQLApi.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnGraphQLApi.Builder.

authenticationType

@Stability(Stable)
public CfnGraphQLApi.Builder authenticationType(String authenticationType)

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 .

Parameters:

authenticationType - Security configuration for your GraphQL API. This parameter is required.

Returns:

this

See Also:

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

name

@Stability(Stable)
public CfnGraphQLApi.Builder name(String name)

The API name.

Parameters:

name - The API name. This parameter is required.

Returns:

this

See Also:

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

additionalAuthenticationProviders

@Stability(Stable)
public CfnGraphQLApi.Builder additionalAuthenticationProviders(IResolvable additionalAuthenticationProviders)

A list of additional authentication providers for the GraphqlApi API.

Parameters:

additionalAuthenticationProviders - A list of additional authentication providers for the GraphqlApi API. This parameter is required.

Returns:

this

See Also:

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

additionalAuthenticationProviders

@Stability(Stable)
public CfnGraphQLApi.Builder additionalAuthenticationProviders(List<? extends Object> additionalAuthenticationProviders)

A list of additional authentication providers for the GraphqlApi API.

Parameters:

additionalAuthenticationProviders - A list of additional authentication providers for the GraphqlApi API. This parameter is required.

Returns:

this

See Also:

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

apiType

@Stability(Stable)
public CfnGraphQLApi.Builder apiType(String apiType)

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

Parameters:

apiType - The value that indicates whether the GraphQL API is a standard API ( GRAPHQL ) or merged API ( MERGED ). This parameter is required.

Returns:

this

See Also:

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

enhancedMetricsConfig

@Stability(Stable)
public CfnGraphQLApi.Builder enhancedMetricsConfig(IResolvable enhancedMetricsConfig)

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 .

Parameters:

enhancedMetricsConfig - Enables and controls the enhanced metrics feature. This parameter is required.

Returns:

this

See Also:

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

enhancedMetricsConfig

@Stability(Stable)
public CfnGraphQLApi.Builder enhancedMetricsConfig(CfnGraphQLApi.EnhancedMetricsConfigProperty enhancedMetricsConfig)

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 .

Parameters:

enhancedMetricsConfig - Enables and controls the enhanced metrics feature. This parameter is required.

Returns:

this

See Also:

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

environmentVariables

@Stability(Stable)
public CfnGraphQLApi.Builder environmentVariables(Object environmentVariables)

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

Parameters:

environmentVariables - A map containing the list of resources with their properties and environment variables. This parameter is required.

Returns:

this

See Also:

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

introspectionConfig

@Stability(Stable)
public CfnGraphQLApi.Builder introspectionConfig(String introspectionConfig)

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 .

Parameters:

introspectionConfig - Sets the value of the GraphQL API to enable ( ENABLED ) or disable ( DISABLED ) introspection. This parameter is required.

Returns:

this

See Also:

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

lambdaAuthorizerConfig

@Stability(Stable)
public CfnGraphQLApi.Builder lambdaAuthorizerConfig(IResolvable lambdaAuthorizerConfig)

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.

Parameters:

lambdaAuthorizerConfig - A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode. This parameter is required.

Returns:

this

See Also:

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

lambdaAuthorizerConfig

@Stability(Stable)
public CfnGraphQLApi.Builder lambdaAuthorizerConfig(CfnGraphQLApi.LambdaAuthorizerConfigProperty lambdaAuthorizerConfig)

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.

Parameters:

lambdaAuthorizerConfig - A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode. This parameter is required.

Returns:

this

See Also:

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

logConfig

@Stability(Stable)
public CfnGraphQLApi.Builder logConfig(IResolvable logConfig)

The Amazon CloudWatch Logs configuration.

Parameters:

logConfig - The Amazon CloudWatch Logs configuration. This parameter is required.

Returns:

this

See Also:

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

logConfig

@Stability(Stable)
public CfnGraphQLApi.Builder logConfig(CfnGraphQLApi.LogConfigProperty logConfig)

The Amazon CloudWatch Logs configuration.

Parameters:

logConfig - The Amazon CloudWatch Logs configuration. This parameter is required.

Returns:

this

See Also:

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

mergedApiExecutionRoleArn

@Stability(Stable)
public CfnGraphQLApi.Builder mergedApiExecutionRoleArn(String mergedApiExecutionRoleArn)

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.

Parameters:

mergedApiExecutionRoleArn - The AWS Identity and Access Management service role ARN for a merged API. This parameter is required.

Returns:

this

See Also:

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

openIdConnectConfig

@Stability(Stable)
public CfnGraphQLApi.Builder openIdConnectConfig(IResolvable openIdConnectConfig)

The OpenID Connect configuration.

Parameters:

openIdConnectConfig - The OpenID Connect configuration. This parameter is required.

Returns:

this

See Also:

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

openIdConnectConfig

@Stability(Stable)
public CfnGraphQLApi.Builder openIdConnectConfig(CfnGraphQLApi.OpenIDConnectConfigProperty openIdConnectConfig)

The OpenID Connect configuration.

Parameters:

openIdConnectConfig - The OpenID Connect configuration. This parameter is required.

Returns:

this

See Also:

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

ownerContact

@Stability(Stable)
public CfnGraphQLApi.Builder ownerContact(String ownerContact)

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

Parameters:

ownerContact - The owner contact information for an API resource. This parameter is required.

Returns:

this

See Also:

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

queryDepthLimit

@Stability(Stable)
public CfnGraphQLApi.Builder queryDepthLimit(Number queryDepthLimit)

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.

Parameters:

queryDepthLimit - The maximum depth a query can have in a single request. This parameter is required.

Returns:

this

See Also:

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

resolverCountLimit

@Stability(Stable)
public CfnGraphQLApi.Builder resolverCountLimit(Number resolverCountLimit)

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.

Parameters:

resolverCountLimit - The maximum number of resolvers that can be invoked in a single request. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnGraphQLApi.Builder tags(List<? extends CfnTag> tags)

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

Parameters:

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

Returns:

this

See Also:

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

userPoolConfig

@Stability(Stable)
public CfnGraphQLApi.Builder userPoolConfig(IResolvable userPoolConfig)

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

Parameters:

userPoolConfig - Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint. This parameter is required.

Returns:

this

See Also:

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

userPoolConfig

@Stability(Stable)
public CfnGraphQLApi.Builder userPoolConfig(CfnGraphQLApi.UserPoolConfigProperty userPoolConfig)

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

Parameters:

userPoolConfig - Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint. This parameter is required.

Returns:

this

See Also:

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

visibility

@Stability(Stable)
public CfnGraphQLApi.Builder visibility(String visibility)

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.

Parameters:

visibility - Sets the scope of the GraphQL API to public ( GLOBAL ) or private ( PRIVATE ). This parameter is required.

Returns:

this

See Also:

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

xrayEnabled

@Stability(Stable)
public CfnGraphQLApi.Builder xrayEnabled(Boolean xrayEnabled)

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

Parameters:

xrayEnabled - A flag indicating whether to use AWS X-Ray tracing for this GraphqlApi . This parameter is required.

Returns:

this

See Also:

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

xrayEnabled

@Stability(Stable)
public CfnGraphQLApi.Builder xrayEnabled(IResolvable xrayEnabled)

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

Parameters:

xrayEnabled - A flag indicating whether to use AWS X-Ray tracing for this GraphqlApi . This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnGraphQLApi build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnGraphQLApi>

Returns:

a newly built instance of CfnGraphQLApi.