Interface AwsAppSyncGraphQlApiDetails.Builder

All Superinterfaces:

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

Enclosing class:

AwsAppSyncGraphQlApiDetails

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

Method Summary

Modifier and Type	Method	Description
AwsAppSyncGraphQlApiDetails.Builder	additionalAuthenticationProviders(Collection<AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails> additionalAuthenticationProviders)	A list of additional authentication providers for the GraphQL API.
AwsAppSyncGraphQlApiDetails.Builder	additionalAuthenticationProviders(Consumer<AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails.Builder>... additionalAuthenticationProviders)	A list of additional authentication providers for the GraphQL API.
AwsAppSyncGraphQlApiDetails.Builder	additionalAuthenticationProviders(AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails... additionalAuthenticationProviders)	A list of additional authentication providers for the GraphQL API.
AwsAppSyncGraphQlApiDetails.Builder	apiId(String apiId)	The unique identifier for the API.
AwsAppSyncGraphQlApiDetails.Builder	arn(String arn)	The Amazon Resource Name (ARN) of the API.
AwsAppSyncGraphQlApiDetails.Builder	authenticationType(String authenticationType)	The type of security configuration for your GraphQL API: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
AwsAppSyncGraphQlApiDetails.Builder	id(String id)	The unique identifier for the API.
default AwsAppSyncGraphQlApiDetails.Builder	lambdaAuthorizerConfig(Consumer<AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails.Builder> lambdaAuthorizerConfig)	Specifies the configuration for Lambda function authorization.
AwsAppSyncGraphQlApiDetails.Builder	lambdaAuthorizerConfig(AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails lambdaAuthorizerConfig)	Specifies the configuration for Lambda function authorization.
default AwsAppSyncGraphQlApiDetails.Builder	logConfig(Consumer<AwsAppSyncGraphQlApiLogConfigDetails.Builder> logConfig)	The Amazon CloudWatch Logs configuration.
AwsAppSyncGraphQlApiDetails.Builder	logConfig(AwsAppSyncGraphQlApiLogConfigDetails logConfig)	The Amazon CloudWatch Logs configuration.
AwsAppSyncGraphQlApiDetails.Builder	name(String name)	The API name.
default AwsAppSyncGraphQlApiDetails.Builder	openIdConnectConfig(Consumer<AwsAppSyncGraphQlApiOpenIdConnectConfigDetails.Builder> openIdConnectConfig)	Specifies the authorization configuration for using an OpenID Connect compliant service with an AppSync GraphQL API endpoint.
AwsAppSyncGraphQlApiDetails.Builder	openIdConnectConfig(AwsAppSyncGraphQlApiOpenIdConnectConfigDetails openIdConnectConfig)	Specifies the authorization configuration for using an OpenID Connect compliant service with an AppSync GraphQL API endpoint.
default AwsAppSyncGraphQlApiDetails.Builder	userPoolConfig(Consumer<AwsAppSyncGraphQlApiUserPoolConfigDetails.Builder> userPoolConfig)	The Amazon Cognito user pools configuration.
AwsAppSyncGraphQlApiDetails.Builder	userPoolConfig(AwsAppSyncGraphQlApiUserPoolConfigDetails userPoolConfig)	The Amazon Cognito user pools configuration.
AwsAppSyncGraphQlApiDetails.Builder	wafWebAclArn(String wafWebAclArn)	The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this GraphQL API, if one exists.
AwsAppSyncGraphQlApiDetails.Builder	xrayEnabled(Boolean xrayEnabled)	Indicates whether to use X-Ray tracing for the GraphQL API.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Method Details

apiId

AwsAppSyncGraphQlApiDetails.Builder apiId(String apiId)

The unique identifier for the API.

Parameters:

apiId - The unique identifier for the API.

Returns:

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

id

AwsAppSyncGraphQlApiDetails.Builder id(String id)

The unique identifier for the API.

Parameters:

id - The unique identifier for the API.

Returns:

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

openIdConnectConfig

AwsAppSyncGraphQlApiDetails.Builder openIdConnectConfig(AwsAppSyncGraphQlApiOpenIdConnectConfigDetails openIdConnectConfig)

Specifies the authorization configuration for using an OpenID Connect compliant service with an AppSync GraphQL API endpoint.

Parameters:

openIdConnectConfig - Specifies the authorization configuration for using an OpenID Connect compliant service with an AppSync GraphQL API endpoint.

Returns:

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

openIdConnectConfig

default AwsAppSyncGraphQlApiDetails.Builder openIdConnectConfig(Consumer<AwsAppSyncGraphQlApiOpenIdConnectConfigDetails.Builder> openIdConnectConfig)

Specifies the authorization configuration for using an OpenID Connect compliant service with an AppSync GraphQL API endpoint.

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

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

Parameters:

openIdConnectConfig - a consumer that will call methods on AwsAppSyncGraphQlApiOpenIdConnectConfigDetails.Builder

Returns:

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

See Also:

• openIdConnectConfig(AwsAppSyncGraphQlApiOpenIdConnectConfigDetails)

name

AwsAppSyncGraphQlApiDetails.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.

lambdaAuthorizerConfig

AwsAppSyncGraphQlApiDetails.Builder lambdaAuthorizerConfig(AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails lambdaAuthorizerConfig)

Specifies the configuration for Lambda function authorization.

Parameters:

lambdaAuthorizerConfig - Specifies the configuration for Lambda function authorization.

Returns:

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

lambdaAuthorizerConfig

default AwsAppSyncGraphQlApiDetails.Builder lambdaAuthorizerConfig(Consumer<AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails.Builder> lambdaAuthorizerConfig)

Specifies the configuration for Lambda function authorization.

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

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

Parameters:

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

Returns:

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

See Also:

• lambdaAuthorizerConfig(AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails)

xrayEnabled

AwsAppSyncGraphQlApiDetails.Builder xrayEnabled(Boolean xrayEnabled)

Indicates whether to use X-Ray tracing for the GraphQL API.

Parameters:

xrayEnabled - Indicates whether to use X-Ray tracing for the GraphQL API.

Returns:

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

arn

AwsAppSyncGraphQlApiDetails.Builder arn(String arn)

The Amazon Resource Name (ARN) of the API.

Parameters:

arn - The Amazon Resource Name (ARN) of the API.

Returns:

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

userPoolConfig

AwsAppSyncGraphQlApiDetails.Builder userPoolConfig(AwsAppSyncGraphQlApiUserPoolConfigDetails userPoolConfig)

The Amazon Cognito user pools configuration.

Parameters:

userPoolConfig - The Amazon Cognito user pools configuration.

Returns:

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

userPoolConfig

default AwsAppSyncGraphQlApiDetails.Builder userPoolConfig(Consumer<AwsAppSyncGraphQlApiUserPoolConfigDetails.Builder> userPoolConfig)

The Amazon Cognito user pools configuration.

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

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

Parameters:

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

Returns:

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

See Also:

• userPoolConfig(AwsAppSyncGraphQlApiUserPoolConfigDetails)

authenticationType

AwsAppSyncGraphQlApiDetails.Builder authenticationType(String authenticationType)

The type of security configuration for your GraphQL API: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

Parameters:

authenticationType - The type of security configuration for your GraphQL API: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

Returns:

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

logConfig

AwsAppSyncGraphQlApiDetails.Builder logConfig(AwsAppSyncGraphQlApiLogConfigDetails 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 AwsAppSyncGraphQlApiDetails.Builder logConfig(Consumer<AwsAppSyncGraphQlApiLogConfigDetails.Builder> logConfig)

The Amazon CloudWatch Logs configuration.

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

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

Parameters:

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

Returns:

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

See Also:

• logConfig(AwsAppSyncGraphQlApiLogConfigDetails)

additionalAuthenticationProviders

AwsAppSyncGraphQlApiDetails.Builder additionalAuthenticationProviders(Collection<AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails> additionalAuthenticationProviders)

A list of additional authentication providers for the GraphQL API.

Parameters:

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

Returns:

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

additionalAuthenticationProviders

AwsAppSyncGraphQlApiDetails.Builder additionalAuthenticationProviders(AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails... additionalAuthenticationProviders)

A list of additional authentication providers for the GraphQL API.

Parameters:

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

Returns:

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

additionalAuthenticationProviders

AwsAppSyncGraphQlApiDetails.Builder additionalAuthenticationProviders(Consumer<AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails.Builder>... additionalAuthenticationProviders)

A list of additional authentication providers for the GraphQL API.

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

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

Parameters:

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

Returns:

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

See Also:

• additionalAuthenticationProviders(java.util.Collection<AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails>)

wafWebAclArn

AwsAppSyncGraphQlApiDetails.Builder wafWebAclArn(String wafWebAclArn)

The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this GraphQL API, if one exists.

Parameters:

wafWebAclArn - The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this GraphQL API, if one exists.

Returns:

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