Package software.amazon.awssdk.services.appsync.model

Interface CreateGraphqlApiRequest.Builder

All Superinterfaces:

AppSyncRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<CreateGraphqlApiRequest.Builder,CreateGraphqlApiRequest>, SdkBuilder<CreateGraphqlApiRequest.Builder,CreateGraphqlApiRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateGraphqlApiRequest

public static interface CreateGraphqlApiRequest.Builder
extends AppSyncRequest.Builder, SdkPojo, CopyableBuilder<CreateGraphqlApiRequest.Builder,CreateGraphqlApiRequest>

Method Summary

Modifier and Type	Method	Description
CreateGraphqlApiRequest.Builder	additionalAuthenticationProviders(Collection<AdditionalAuthenticationProvider> additionalAuthenticationProviders)	A list of additional authentication providers for the GraphqlApi API.
CreateGraphqlApiRequest.Builder	additionalAuthenticationProviders(Consumer<AdditionalAuthenticationProvider.Builder>... additionalAuthenticationProviders)	A list of additional authentication providers for the GraphqlApi API.
CreateGraphqlApiRequest.Builder	additionalAuthenticationProviders(AdditionalAuthenticationProvider... additionalAuthenticationProviders)	A list of additional authentication providers for the GraphqlApi API.
CreateGraphqlApiRequest.Builder	apiType(String apiType)	The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).
CreateGraphqlApiRequest.Builder	apiType(GraphQLApiType apiType)	The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API ( MERGED).
CreateGraphqlApiRequest.Builder	authenticationType(String authenticationType)	The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
CreateGraphqlApiRequest.Builder	authenticationType(AuthenticationType authenticationType)	The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
default CreateGraphqlApiRequest.Builder	lambdaAuthorizerConfig(Consumer<LambdaAuthorizerConfig.Builder> lambdaAuthorizerConfig)	Configuration for Lambda function authorization.
CreateGraphqlApiRequest.Builder	lambdaAuthorizerConfig(LambdaAuthorizerConfig lambdaAuthorizerConfig)	Configuration for Lambda function authorization.
default CreateGraphqlApiRequest.Builder	logConfig(Consumer<LogConfig.Builder> logConfig)	The Amazon CloudWatch Logs configuration.
CreateGraphqlApiRequest.Builder	logConfig(LogConfig logConfig)	The Amazon CloudWatch Logs configuration.
CreateGraphqlApiRequest.Builder	mergedApiExecutionRoleArn(String mergedApiExecutionRoleArn)	The Identity and Access Management service role ARN for a merged API.
CreateGraphqlApiRequest.Builder	name(String name)	A user-supplied name for the GraphqlApi.
default CreateGraphqlApiRequest.Builder	openIDConnectConfig(Consumer<OpenIDConnectConfig.Builder> openIDConnectConfig)	The OIDC configuration.
CreateGraphqlApiRequest.Builder	openIDConnectConfig(OpenIDConnectConfig openIDConnectConfig)	The OIDC configuration.
CreateGraphqlApiRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateGraphqlApiRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateGraphqlApiRequest.Builder	ownerContact(String ownerContact)	The owner contact information for an API resource.
CreateGraphqlApiRequest.Builder	tags(Map<String,String> tags)	A TagMap object.
default CreateGraphqlApiRequest.Builder	userPoolConfig(Consumer<UserPoolConfig.Builder> userPoolConfig)	The Amazon Cognito user pool configuration.
CreateGraphqlApiRequest.Builder	userPoolConfig(UserPoolConfig userPoolConfig)	The Amazon Cognito user pool configuration.
CreateGraphqlApiRequest.Builder	visibility(String visibility)	Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE).
CreateGraphqlApiRequest.Builder	visibility(GraphQLApiVisibility visibility)	Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE).
CreateGraphqlApiRequest.Builder	xrayEnabled(Boolean xrayEnabled)	A flag indicating whether to use X-Ray tracing for the GraphqlApi.

Methods inherited from interface software.amazon.awssdk.services.appsync.model.AppSyncRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

name

CreateGraphqlApiRequest.Builder name(String name)

A user-supplied name for the GraphqlApi.

Parameters:

name - A user-supplied name for the GraphqlApi.

Returns:

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

logConfig

CreateGraphqlApiRequest.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 CreateGraphqlApiRequest.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)

authenticationType

CreateGraphqlApiRequest.Builder authenticationType(String authenticationType)

The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

Parameters:

authenticationType - The authentication type: 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.

See Also:

• AuthenticationType
• AuthenticationType

authenticationType

CreateGraphqlApiRequest.Builder authenticationType(AuthenticationType authenticationType)

The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

Parameters:

authenticationType - The authentication type: 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.

See Also:

• AuthenticationType
• AuthenticationType

userPoolConfig

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

CreateGraphqlApiRequest.Builder openIDConnectConfig(OpenIDConnectConfig openIDConnectConfig)

The OIDC configuration.

Parameters:

openIDConnectConfig - The OIDC configuration.

Returns:

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

openIDConnectConfig

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

The OIDC 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)

tags

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

A TagMap object.

Parameters:

tags - A TagMap object.

Returns:

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

additionalAuthenticationProviders

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

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

CreateGraphqlApiRequest.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<AdditionalAuthenticationProvider>).

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<AdditionalAuthenticationProvider>)

xrayEnabled

CreateGraphqlApiRequest.Builder xrayEnabled(Boolean xrayEnabled)

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

Parameters:

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

Returns:

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

lambdaAuthorizerConfig

CreateGraphqlApiRequest.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 CreateGraphqlApiRequest.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)

visibility

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

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

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

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

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

ownerContact

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

overrideConfiguration

CreateGraphqlApiRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateGraphqlApiRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.