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(value=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 and Description
CfnGraphQLApi.Builder	additionalAuthenticationProviders(IResolvable additionalAuthenticationProviders) A list of additional authentication providers for the `GraphqlApi` API.
CfnGraphQLApi.Builder	additionalAuthenticationProviders(List<? extends Object> additionalAuthenticationProviders) A list of additional authentication providers for the `GraphqlApi` API.
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	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	lambdaAuthorizerConfig(IResolvable lambdaAuthorizerConfig) A `LambdaAuthorizerConfig` holds configuration on how to authorize AWS AppSync API access when using the `AWS_LAMBDA` authorizer mode.
CfnGraphQLApi.Builder	logConfig(CfnGraphQLApi.LogConfigProperty logConfig) The Amazon CloudWatch Logs configuration.
CfnGraphQLApi.Builder	logConfig(IResolvable logConfig) The Amazon CloudWatch Logs configuration.
CfnGraphQLApi.Builder	name(String name) The API name.
CfnGraphQLApi.Builder	openIdConnectConfig(CfnGraphQLApi.OpenIDConnectConfigProperty openIdConnectConfig) The OpenID Connect configuration.
CfnGraphQLApi.Builder	openIdConnectConfig(IResolvable openIdConnectConfig) The OpenID Connect configuration.
CfnGraphQLApi.Builder	tags(List<? extends CfnTag> tags) An arbitrary set of tags (key-value pairs) for this GraphQL API.
CfnGraphQLApi.Builder	userPoolConfig(CfnGraphQLApi.UserPoolConfigProperty userPoolConfig) Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
CfnGraphQLApi.Builder	userPoolConfig(IResolvable userPoolConfig) Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
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 Detail

create

@Stability(value=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 - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnGraphQLApi.AdditionalAuthenticationProviderProperty.Builder.

authenticationType

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

name

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

The API name.

Parameters:

name - The API name. This parameter is required.

Returns:

this

additionalAuthenticationProviders

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

additionalAuthenticationProviders

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

lambdaAuthorizerConfig

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

lambdaAuthorizerConfig

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

logConfig

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

logConfig

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

openIdConnectConfig

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

The OpenID Connect configuration.

Parameters:

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

Returns:

this

openIdConnectConfig

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

The OpenID Connect configuration.

Parameters:

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

Returns:

this

tags

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

userPoolConfig

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

userPoolConfig

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

xrayEnabled

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

xrayEnabled

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

build

@Stability(value=Stable)
public CfnGraphQLApi build()

Specified by:

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