software.amazon.awssdk.services.appsync.model

Interface GraphqlApi.Builder

All Superinterfaces:

Buildable, CopyableBuilder<GraphqlApi.Builder,GraphqlApi>, SdkBuilder<GraphqlApi.Builder,GraphqlApi>, SdkPojo

Enclosing class:

GraphqlApi

public static interface GraphqlApi.Builder
extends SdkPojo, CopyableBuilder<GraphqlApi.Builder,GraphqlApi>

Method Summary

Modifier and Type	Method and Description
GraphqlApi.Builder	additionalAuthenticationProviders(AdditionalAuthenticationProvider... additionalAuthenticationProviders) A list of additional authentication providers for the GraphqlApi API.
GraphqlApi.Builder	additionalAuthenticationProviders(Collection<AdditionalAuthenticationProvider> additionalAuthenticationProviders) A list of additional authentication providers for the GraphqlApi API.
GraphqlApi.Builder	additionalAuthenticationProviders(Consumer<AdditionalAuthenticationProvider.Builder>... additionalAuthenticationProviders) A list of additional authentication providers for the GraphqlApi API.
GraphqlApi.Builder	apiId(String apiId) The API ID.
GraphqlApi.Builder	apiType(GraphQLApiType apiType) The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).
GraphqlApi.Builder	apiType(String apiType) The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).
GraphqlApi.Builder	arn(String arn) The Amazon Resource Name (ARN).
GraphqlApi.Builder	authenticationType(AuthenticationType authenticationType) The authentication type.
GraphqlApi.Builder	authenticationType(String authenticationType) The authentication type.
GraphqlApi.Builder	dns(Map<String,String> dns) The DNS records for the API.
default GraphqlApi.Builder	lambdaAuthorizerConfig(Consumer<LambdaAuthorizerConfig.Builder> lambdaAuthorizerConfig) Configuration for Lambda function authorization.
GraphqlApi.Builder	lambdaAuthorizerConfig(LambdaAuthorizerConfig lambdaAuthorizerConfig) Configuration for Lambda function authorization.
default GraphqlApi.Builder	logConfig(Consumer<LogConfig.Builder> logConfig) The Amazon CloudWatch Logs configuration.
GraphqlApi.Builder	logConfig(LogConfig logConfig) The Amazon CloudWatch Logs configuration.
GraphqlApi.Builder	mergedApiExecutionRoleArn(String mergedApiExecutionRoleArn) The Identity and Access Management service role ARN for a merged API.
GraphqlApi.Builder	name(String name) The API name.
default GraphqlApi.Builder	openIDConnectConfig(Consumer<OpenIDConnectConfig.Builder> openIDConnectConfig) The OpenID Connect configuration.
GraphqlApi.Builder	openIDConnectConfig(OpenIDConnectConfig openIDConnectConfig) The OpenID Connect configuration.
GraphqlApi.Builder	owner(String owner) The account owner of the GraphQL API.
GraphqlApi.Builder	ownerContact(String ownerContact) The owner contact information for an API resource.
GraphqlApi.Builder	tags(Map<String,String> tags) The tags.
GraphqlApi.Builder	uris(Map<String,String> uris) The URIs.
default GraphqlApi.Builder	userPoolConfig(Consumer<UserPoolConfig.Builder> userPoolConfig) The Amazon Cognito user pool configuration.
GraphqlApi.Builder	userPoolConfig(UserPoolConfig userPoolConfig) The Amazon Cognito user pool configuration.
GraphqlApi.Builder	visibility(GraphQLApiVisibility visibility) Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE).
GraphqlApi.Builder	visibility(String visibility) Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE).
GraphqlApi.Builder	wafWebAclArn(String wafWebAclArn) The ARN of the WAF access control list (ACL) associated with this GraphqlApi, if one exists.
GraphqlApi.Builder	xrayEnabled(Boolean xrayEnabled) A flag indicating whether to use X-Ray tracing for this GraphqlApi.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

name

GraphqlApi.Builder name(String name)

The API name.

Parameters:

name - The API name.

Returns:

Returns a reference to this object so that method calls can be chained together.

apiId

GraphqlApi.Builder apiId(String apiId)

The API ID.

Parameters:

apiId - The API ID.

Returns:

Returns a reference to this object so that method calls can be chained together.

authenticationType

GraphqlApi.Builder authenticationType(String authenticationType)

The authentication type.

Parameters:

authenticationType - The authentication type.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthenticationType, AuthenticationType

authenticationType

GraphqlApi.Builder authenticationType(AuthenticationType authenticationType)

The authentication type.

Parameters:

authenticationType - The authentication type.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AuthenticationType, AuthenticationType

logConfig

GraphqlApi.Builder logConfig(LogConfig logConfig)

The Amazon CloudWatch Logs configuration.

Parameters:

logConfig - The Amazon CloudWatch Logs configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

logConfig

default GraphqlApi.Builder logConfig(Consumer<LogConfig.Builder> logConfig)

The Amazon CloudWatch Logs configuration.

This is a convenience method that creates an instance of the LogConfig.Builder avoiding the need to create one manually via LogConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to logConfig(LogConfig).

Parameters:

logConfig - a consumer that will call methods on LogConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

logConfig(LogConfig)

userPoolConfig

GraphqlApi.Builder userPoolConfig(UserPoolConfig userPoolConfig)

The Amazon Cognito user pool configuration.

Parameters:

userPoolConfig - The Amazon Cognito user pool configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

userPoolConfig

default GraphqlApi.Builder userPoolConfig(Consumer<UserPoolConfig.Builder> userPoolConfig)

The Amazon Cognito user pool configuration.

This is a convenience method that creates an instance of the UserPoolConfig.Builder avoiding the need to create one manually via UserPoolConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to userPoolConfig(UserPoolConfig).

Parameters:

userPoolConfig - a consumer that will call methods on UserPoolConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

userPoolConfig(UserPoolConfig)

openIDConnectConfig

GraphqlApi.Builder openIDConnectConfig(OpenIDConnectConfig openIDConnectConfig)

The OpenID Connect configuration.

Parameters:

openIDConnectConfig - The OpenID Connect configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

openIDConnectConfig

default GraphqlApi.Builder openIDConnectConfig(Consumer<OpenIDConnectConfig.Builder> openIDConnectConfig)

The OpenID Connect configuration.

This is a convenience method that creates an instance of the OpenIDConnectConfig.Builder avoiding the need to create one manually via OpenIDConnectConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to openIDConnectConfig(OpenIDConnectConfig).

Parameters:

openIDConnectConfig - a consumer that will call methods on OpenIDConnectConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

openIDConnectConfig(OpenIDConnectConfig)

arn

GraphqlApi.Builder arn(String arn)

The Amazon Resource Name (ARN).

Parameters:

arn - The Amazon Resource Name (ARN).

Returns:

Returns a reference to this object so that method calls can be chained together.

uris

GraphqlApi.Builder uris(Map<String,String> uris)

The URIs.

Parameters:

uris - The URIs.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

GraphqlApi.Builder tags(Map<String,String> tags)

The tags.

Parameters:

tags - The tags.

Returns:

Returns a reference to this object so that method calls can be chained together.

additionalAuthenticationProviders

GraphqlApi.Builder additionalAuthenticationProviders(Collection<AdditionalAuthenticationProvider> additionalAuthenticationProviders)

A list of additional authentication providers for the GraphqlApi API.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

additionalAuthenticationProviders

GraphqlApi.Builder additionalAuthenticationProviders(AdditionalAuthenticationProvider... additionalAuthenticationProviders)

A list of additional authentication providers for the GraphqlApi API.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

additionalAuthenticationProviders

GraphqlApi.Builder additionalAuthenticationProviders(Consumer<AdditionalAuthenticationProvider.Builder>... additionalAuthenticationProviders)

A list of additional authentication providers for the GraphqlApi API.

This is a convenience method that creates an instance of the AdditionalAuthenticationProvider.Builder avoiding the need to create one manually via AdditionalAuthenticationProvider.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #additionalAuthenticationProviders(List).

Parameters:

additionalAuthenticationProviders - a consumer that will call methods on AdditionalAuthenticationProvider.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#additionalAuthenticationProviders(java.util.Collection)

xrayEnabled

GraphqlApi.Builder xrayEnabled(Boolean xrayEnabled)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

wafWebAclArn

GraphqlApi.Builder wafWebAclArn(String wafWebAclArn)

The ARN of the WAF access control list (ACL) associated with this GraphqlApi, if one exists.

Parameters:

wafWebAclArn - The ARN of the WAF access control list (ACL) associated with this GraphqlApi, if one exists.

Returns:

Returns a reference to this object so that method calls can be chained together.

lambdaAuthorizerConfig

GraphqlApi.Builder lambdaAuthorizerConfig(LambdaAuthorizerConfig lambdaAuthorizerConfig)

Configuration for Lambda function authorization.

Parameters:

lambdaAuthorizerConfig - Configuration for Lambda function authorization.

Returns:

Returns a reference to this object so that method calls can be chained together.

lambdaAuthorizerConfig

default GraphqlApi.Builder lambdaAuthorizerConfig(Consumer<LambdaAuthorizerConfig.Builder> lambdaAuthorizerConfig)

Configuration for Lambda function authorization.

This is a convenience method that creates an instance of the LambdaAuthorizerConfig.Builder avoiding the need to create one manually via LambdaAuthorizerConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lambdaAuthorizerConfig(LambdaAuthorizerConfig).

Parameters:

lambdaAuthorizerConfig - a consumer that will call methods on LambdaAuthorizerConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

lambdaAuthorizerConfig(LambdaAuthorizerConfig)

dns

GraphqlApi.Builder dns(Map<String,String> dns)

The DNS records for the API.

Parameters:

dns - The DNS records for the API.

Returns:

Returns a reference to this object so that method calls can be chained together.

visibility

GraphqlApi.Builder visibility(String visibility)

Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.

Parameters:

visibility - Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

GraphQLApiVisibility, GraphQLApiVisibility

visibility

GraphqlApi.Builder visibility(GraphQLApiVisibility visibility)

Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.

Parameters:

visibility - Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

GraphQLApiVisibility, GraphQLApiVisibility

apiType

GraphqlApi.Builder apiType(String apiType)

The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

GraphQLApiType, GraphQLApiType

apiType

GraphqlApi.Builder apiType(GraphQLApiType apiType)

The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

GraphQLApiType, GraphQLApiType

mergedApiExecutionRoleArn

GraphqlApi.Builder mergedApiExecutionRoleArn(String mergedApiExecutionRoleArn)

The 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 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:

Returns a reference to this object so that method calls can be chained together.

owner

GraphqlApi.Builder owner(String owner)

The account owner of the GraphQL API.

Parameters:

owner - The account owner of the GraphQL API.

Returns:

Returns a reference to this object so that method calls can be chained together.

ownerContact

GraphqlApi.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 field accepts any string input with a length of 0 - 256 characters.

Returns:

Returns a reference to this object so that method calls can be chained together.