Package software.amazon.awscdk.services.appsync

Class CfnGraphQLApiProps.Builder

java.lang.Object

software.amazon.awscdk.services.appsync.CfnGraphQLApiProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnGraphQLApiProps>

Enclosing interface:

CfnGraphQLApiProps

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

A builder for CfnGraphQLApiProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnGraphQLApiProps.Builder	additionalAuthenticationProviders(List<? extends Object> additionalAuthenticationProviders)	Sets the value of CfnGraphQLApiProps.getAdditionalAuthenticationProviders()
CfnGraphQLApiProps.Builder	additionalAuthenticationProviders(IResolvable additionalAuthenticationProviders)	Sets the value of CfnGraphQLApiProps.getAdditionalAuthenticationProviders()
CfnGraphQLApiProps.Builder	apiType(String apiType)	Sets the value of CfnGraphQLApiProps.getApiType()
CfnGraphQLApiProps.Builder	authenticationType(String authenticationType)	Sets the value of CfnGraphQLApiProps.getAuthenticationType()
CfnGraphQLApiProps	build()	Builds the configured instance.
CfnGraphQLApiProps.Builder	enhancedMetricsConfig(IResolvable enhancedMetricsConfig)	Sets the value of CfnGraphQLApiProps.getEnhancedMetricsConfig()
CfnGraphQLApiProps.Builder	enhancedMetricsConfig(CfnGraphQLApi.EnhancedMetricsConfigProperty enhancedMetricsConfig)	Sets the value of CfnGraphQLApiProps.getEnhancedMetricsConfig()
CfnGraphQLApiProps.Builder	environmentVariables(Map<String,String> environmentVariables)	Sets the value of CfnGraphQLApiProps.getEnvironmentVariables()
CfnGraphQLApiProps.Builder	environmentVariables(IResolvable environmentVariables)	Sets the value of CfnGraphQLApiProps.getEnvironmentVariables()
CfnGraphQLApiProps.Builder	introspectionConfig(String introspectionConfig)	Sets the value of CfnGraphQLApiProps.getIntrospectionConfig()
CfnGraphQLApiProps.Builder	lambdaAuthorizerConfig(IResolvable lambdaAuthorizerConfig)	Sets the value of CfnGraphQLApiProps.getLambdaAuthorizerConfig()
CfnGraphQLApiProps.Builder	lambdaAuthorizerConfig(CfnGraphQLApi.LambdaAuthorizerConfigProperty lambdaAuthorizerConfig)	Sets the value of CfnGraphQLApiProps.getLambdaAuthorizerConfig()
CfnGraphQLApiProps.Builder	logConfig(IResolvable logConfig)	Sets the value of CfnGraphQLApiProps.getLogConfig()
CfnGraphQLApiProps.Builder	logConfig(CfnGraphQLApi.LogConfigProperty logConfig)	Sets the value of CfnGraphQLApiProps.getLogConfig()
CfnGraphQLApiProps.Builder	mergedApiExecutionRoleArn(String mergedApiExecutionRoleArn)	Sets the value of CfnGraphQLApiProps.getMergedApiExecutionRoleArn()
CfnGraphQLApiProps.Builder	name(String name)	Sets the value of CfnGraphQLApiProps.getName()
CfnGraphQLApiProps.Builder	openIdConnectConfig(IResolvable openIdConnectConfig)	Sets the value of CfnGraphQLApiProps.getOpenIdConnectConfig()
CfnGraphQLApiProps.Builder	openIdConnectConfig(CfnGraphQLApi.OpenIDConnectConfigProperty openIdConnectConfig)	Sets the value of CfnGraphQLApiProps.getOpenIdConnectConfig()
CfnGraphQLApiProps.Builder	ownerContact(String ownerContact)	Sets the value of CfnGraphQLApiProps.getOwnerContact()
CfnGraphQLApiProps.Builder	queryDepthLimit(Number queryDepthLimit)	Sets the value of CfnGraphQLApiProps.getQueryDepthLimit()
CfnGraphQLApiProps.Builder	resolverCountLimit(Number resolverCountLimit)	Sets the value of CfnGraphQLApiProps.getResolverCountLimit()
CfnGraphQLApiProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnGraphQLApiProps.getTags()
CfnGraphQLApiProps.Builder	userPoolConfig(IResolvable userPoolConfig)	Sets the value of CfnGraphQLApiProps.getUserPoolConfig()
CfnGraphQLApiProps.Builder	userPoolConfig(CfnGraphQLApi.UserPoolConfigProperty userPoolConfig)	Sets the value of CfnGraphQLApiProps.getUserPoolConfig()
CfnGraphQLApiProps.Builder	visibility(String visibility)	Sets the value of CfnGraphQLApiProps.getVisibility()
CfnGraphQLApiProps.Builder	xrayEnabled(Boolean xrayEnabled)	Sets the value of CfnGraphQLApiProps.getXrayEnabled()
CfnGraphQLApiProps.Builder	xrayEnabled(IResolvable xrayEnabled)	Sets the value of CfnGraphQLApiProps.getXrayEnabled()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

authenticationType

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

Sets the value of CfnGraphQLApiProps.getAuthenticationType()

Parameters:

authenticationType - Security configuration for your GraphQL API. This parameter is required. 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 .

Returns:

this

name

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

Sets the value of CfnGraphQLApiProps.getName()

Parameters:

name - The API name. This parameter is required.

Returns:

this

additionalAuthenticationProviders

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

Sets the value of CfnGraphQLApiProps.getAdditionalAuthenticationProviders()

Parameters:

additionalAuthenticationProviders - A list of additional authentication providers for the GraphqlApi API.

Returns:

this

additionalAuthenticationProviders

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

Sets the value of CfnGraphQLApiProps.getAdditionalAuthenticationProviders()

Parameters:

additionalAuthenticationProviders - A list of additional authentication providers for the GraphqlApi API.

Returns:

this

apiType

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

Sets the value of CfnGraphQLApiProps.getApiType()

Parameters:

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

Returns:

this

enhancedMetricsConfig

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

Sets the value of CfnGraphQLApiProps.getEnhancedMetricsConfig()

Parameters:

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 .

Returns:

this

enhancedMetricsConfig

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

Sets the value of CfnGraphQLApiProps.getEnhancedMetricsConfig()

Parameters:

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 .

Returns:

this

environmentVariables

@Stability(Stable)
public CfnGraphQLApiProps.Builder environmentVariables(IResolvable environmentVariables)

Sets the value of CfnGraphQLApiProps.getEnvironmentVariables()

Parameters:

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

Returns:

this

environmentVariables

@Stability(Stable)
public CfnGraphQLApiProps.Builder environmentVariables(Map<String,String> environmentVariables)

Sets the value of CfnGraphQLApiProps.getEnvironmentVariables()

Parameters:

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

Returns:

this

introspectionConfig

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

Sets the value of CfnGraphQLApiProps.getIntrospectionConfig()

Parameters:

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 .

Returns:

this

lambdaAuthorizerConfig

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

Sets the value of CfnGraphQLApiProps.getLambdaAuthorizerConfig()

Parameters:

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.

Returns:

this

lambdaAuthorizerConfig

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

Sets the value of CfnGraphQLApiProps.getLambdaAuthorizerConfig()

Parameters:

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.

Returns:

this

logConfig

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

Sets the value of CfnGraphQLApiProps.getLogConfig()

Parameters:

logConfig - The Amazon CloudWatch Logs configuration.

Returns:

this

logConfig

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

Sets the value of CfnGraphQLApiProps.getLogConfig()

Parameters:

logConfig - The Amazon CloudWatch Logs configuration.

Returns:

this

mergedApiExecutionRoleArn

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

Sets the value of CfnGraphQLApiProps.getMergedApiExecutionRoleArn()

Parameters:

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.

Returns:

this

openIdConnectConfig

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

Sets the value of CfnGraphQLApiProps.getOpenIdConnectConfig()

Parameters:

openIdConnectConfig - The OpenID Connect configuration.

Returns:

this

openIdConnectConfig

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

Sets the value of CfnGraphQLApiProps.getOpenIdConnectConfig()

Parameters:

openIdConnectConfig - The OpenID Connect configuration.

Returns:

this

ownerContact

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

Sets the value of CfnGraphQLApiProps.getOwnerContact()

Parameters:

ownerContact - The owner contact information for an API resource. This field accepts any string input with a length of 0 - 256 characters.

Returns:

this

queryDepthLimit

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

Sets the value of CfnGraphQLApiProps.getQueryDepthLimit()

Parameters:

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.

Returns:

this

resolverCountLimit

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

Sets the value of CfnGraphQLApiProps.getResolverCountLimit()

Parameters:

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.

Returns:

this

tags

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

Sets the value of CfnGraphQLApiProps.getTags()

Parameters:

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

Returns:

this

userPoolConfig

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

Sets the value of CfnGraphQLApiProps.getUserPoolConfig()

Parameters:

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

Returns:

this

userPoolConfig

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

Sets the value of CfnGraphQLApiProps.getUserPoolConfig()

Parameters:

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

Returns:

this

visibility

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

Sets the value of CfnGraphQLApiProps.getVisibility()

Parameters:

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.

Returns:

this

xrayEnabled

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

Sets the value of CfnGraphQLApiProps.getXrayEnabled()

Parameters:

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

Returns:

this

xrayEnabled

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

Sets the value of CfnGraphQLApiProps.getXrayEnabled()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnGraphQLApiProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnGraphQLApiProps

Throws:

NullPointerException - if any required attribute was not provided