Package software.amazon.awscdk.cfnpropertymixins.services.appsync

Class CfnGraphQLApiPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.appsync.CfnGraphQLApiPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnGraphQLApiPropsMixin>

Enclosing class:

CfnGraphQLApiPropsMixin

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

A fluent builder for CfnGraphQLApiPropsMixin.

Method Summary

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

Parameters:

options - Mixin options.

Returns:

a new instance of CfnGraphQLApiPropsMixin.Builder.

create

@Stability(Stable)
public static CfnGraphQLApiPropsMixin.Builder create()

Returns:

a new instance of CfnGraphQLApiPropsMixin.Builder.

additionalAuthenticationProviders

@Stability(Stable)
public CfnGraphQLApiPropsMixin.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 CfnGraphQLApiPropsMixin.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 CfnGraphQLApiPropsMixin.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

authenticationType

@Stability(Stable)
public CfnGraphQLApiPropsMixin.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

enhancedMetricsConfig

@Stability(Stable)
public CfnGraphQLApiPropsMixin.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 CfnGraphQLApiPropsMixin.Builder enhancedMetricsConfig(CfnGraphQLApiPropsMixin.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 CfnGraphQLApiPropsMixin.Builder environmentVariables(Map<String,String> 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

environmentVariables

@Stability(Stable)
public CfnGraphQLApiPropsMixin.Builder environmentVariables(IResolvable 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 CfnGraphQLApiPropsMixin.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 CfnGraphQLApiPropsMixin.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 CfnGraphQLApiPropsMixin.Builder lambdaAuthorizerConfig(CfnGraphQLApiPropsMixin.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 CfnGraphQLApiPropsMixin.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 CfnGraphQLApiPropsMixin.Builder logConfig(CfnGraphQLApiPropsMixin.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 CfnGraphQLApiPropsMixin.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

name

@Stability(Stable)
public CfnGraphQLApiPropsMixin.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

openIdConnectConfig

@Stability(Stable)
public CfnGraphQLApiPropsMixin.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 CfnGraphQLApiPropsMixin.Builder openIdConnectConfig(CfnGraphQLApiPropsMixin.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 CfnGraphQLApiPropsMixin.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 CfnGraphQLApiPropsMixin.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 CfnGraphQLApiPropsMixin.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 CfnGraphQLApiPropsMixin.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 CfnGraphQLApiPropsMixin.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 CfnGraphQLApiPropsMixin.Builder userPoolConfig(CfnGraphQLApiPropsMixin.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 CfnGraphQLApiPropsMixin.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 CfnGraphQLApiPropsMixin.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 CfnGraphQLApiPropsMixin.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 CfnGraphQLApiPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnGraphQLApiPropsMixin.