Interface GraphqlApi.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<GraphqlApi.Builder,
,GraphqlApi> SdkBuilder<GraphqlApi.Builder,
,GraphqlApi> SdkPojo
- Enclosing class:
GraphqlApi
-
Method Summary
Modifier and TypeMethodDescriptionadditionalAuthenticationProviders
(Collection<AdditionalAuthenticationProvider> additionalAuthenticationProviders) A list of additional authentication providers for theGraphqlApi
API.additionalAuthenticationProviders
(Consumer<AdditionalAuthenticationProvider.Builder>... additionalAuthenticationProviders) A list of additional authentication providers for theGraphqlApi
API.additionalAuthenticationProviders
(AdditionalAuthenticationProvider... additionalAuthenticationProviders) A list of additional authentication providers for theGraphqlApi
API.The API ID.The value that indicates whether the GraphQL API is a standard API (GRAPHQL
) or merged API (MERGED
).apiType
(GraphQLApiType apiType) The value that indicates whether the GraphQL API is a standard API (GRAPHQL
) or merged API (MERGED
).The Amazon Resource Name (ARN).authenticationType
(String authenticationType) The authentication type.authenticationType
(AuthenticationType authenticationType) The authentication type.The DNS records for the API.default GraphqlApi.Builder
enhancedMetricsConfig
(Consumer<EnhancedMetricsConfig.Builder> enhancedMetricsConfig) TheenhancedMetricsConfig
object.enhancedMetricsConfig
(EnhancedMetricsConfig enhancedMetricsConfig) TheenhancedMetricsConfig
object.introspectionConfig
(String introspectionConfig) Sets the value of the GraphQL API to enable (ENABLED
) or disable (DISABLED
) introspection.introspectionConfig
(GraphQLApiIntrospectionConfig introspectionConfig) Sets the value of the GraphQL API to enable (ENABLED
) or disable (DISABLED
) introspection.default GraphqlApi.Builder
lambdaAuthorizerConfig
(Consumer<LambdaAuthorizerConfig.Builder> lambdaAuthorizerConfig) Configuration for Lambda function authorization.lambdaAuthorizerConfig
(LambdaAuthorizerConfig lambdaAuthorizerConfig) Configuration for Lambda function authorization.default GraphqlApi.Builder
logConfig
(Consumer<LogConfig.Builder> logConfig) The Amazon CloudWatch Logs configuration.The Amazon CloudWatch Logs configuration.mergedApiExecutionRoleArn
(String mergedApiExecutionRoleArn) The Identity and Access Management service role ARN for a merged API.The API name.default GraphqlApi.Builder
openIDConnectConfig
(Consumer<OpenIDConnectConfig.Builder> openIDConnectConfig) The OpenID Connect configuration.openIDConnectConfig
(OpenIDConnectConfig openIDConnectConfig) The OpenID Connect configuration.The account owner of the GraphQL API.ownerContact
(String ownerContact) The owner contact information for an API resource.queryDepthLimit
(Integer queryDepthLimit) The maximum depth a query can have in a single request.resolverCountLimit
(Integer resolverCountLimit) The maximum number of resolvers that can be invoked in a single request.The tags.The URIs.default GraphqlApi.Builder
userPoolConfig
(Consumer<UserPoolConfig.Builder> userPoolConfig) The Amazon Cognito user pool configuration.userPoolConfig
(UserPoolConfig userPoolConfig) The Amazon Cognito user pool configuration.visibility
(String visibility) Sets the value of the GraphQL API to public (GLOBAL
) or private (PRIVATE
).visibility
(GraphQLApiVisibility visibility) Sets the value of the GraphQL API to public (GLOBAL
) or private (PRIVATE
).wafWebAclArn
(String wafWebAclArn) The ARN of the WAF access control list (ACL) associated with thisGraphqlApi
, if one exists.xrayEnabled
(Boolean xrayEnabled) A flag indicating whether to use X-Ray tracing for thisGraphqlApi
.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
The API name.
- Parameters:
name
- The API name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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:
-
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
The Amazon CloudWatch Logs configuration.
This is a convenience method that creates an instance of theLogConfig.Builder
avoiding the need to create one manually viaLogConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tologConfig(LogConfig)
.- Parameters:
logConfig
- a consumer that will call methods onLogConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
The Amazon Cognito user pool configuration.
This is a convenience method that creates an instance of theUserPoolConfig.Builder
avoiding the need to create one manually viaUserPoolConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed touserPoolConfig(UserPoolConfig)
.- Parameters:
userPoolConfig
- a consumer that will call methods onUserPoolConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theOpenIDConnectConfig.Builder
avoiding the need to create one manually viaOpenIDConnectConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toopenIDConnectConfig(OpenIDConnectConfig)
.- Parameters:
openIDConnectConfig
- a consumer that will call methods onOpenIDConnectConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
The URIs.
- Parameters:
uris
- The URIs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 theGraphqlApi
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 theGraphqlApi
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
This is a convenience method that creates an instance of theGraphqlApi
API.AdditionalAuthenticationProvider.Builder
avoiding the need to create one manually viaAdditionalAuthenticationProvider.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toadditionalAuthenticationProviders(List<AdditionalAuthenticationProvider>)
.- Parameters:
additionalAuthenticationProviders
- a consumer that will call methods onAdditionalAuthenticationProvider.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 thisGraphqlApi
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 thisGraphqlApi
, if one exists.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 theLambdaAuthorizerConfig.Builder
avoiding the need to create one manually viaLambdaAuthorizerConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolambdaAuthorizerConfig(LambdaAuthorizerConfig)
.- Parameters:
lambdaAuthorizerConfig
- a consumer that will call methods onLambdaAuthorizerConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
Sets the value of the GraphQL API to public (
GLOBAL
) or private (PRIVATE
). If no value is provided, the visibility will be set toGLOBAL
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 toGLOBAL
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:
-
visibility
Sets the value of the GraphQL API to public (
GLOBAL
) or private (PRIVATE
). If no value is provided, the visibility will be set toGLOBAL
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 toGLOBAL
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:
-
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:
-
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:
-
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 theAUTO_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
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
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.
-
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 toENABLED
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. If no value is provided, the introspection configuration will be set toENABLED
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 toENABLED
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. If no value is provided, the introspection configuration will be set toENABLED
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 between1
and75
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. Depth refers to the amount of nested levels allowed in the body of query. The default value is0
(or unspecified), which indicates there's no depth limit. If you set a limit, it can be between1
and75
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 to10000
. When specified, the limit value can be between1
and10000
. 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. The default value is0
(or unspecified), which will set the limit to10000
. When specified, the limit value can be between1
and10000
. This field will produce a limit error if the operation falls out of bounds.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
enhancedMetricsConfig
The
enhancedMetricsConfig
object.- Parameters:
enhancedMetricsConfig
- TheenhancedMetricsConfig
object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
enhancedMetricsConfig
default GraphqlApi.Builder enhancedMetricsConfig(Consumer<EnhancedMetricsConfig.Builder> enhancedMetricsConfig) The
This is a convenience method that creates an instance of theenhancedMetricsConfig
object.EnhancedMetricsConfig.Builder
avoiding the need to create one manually viaEnhancedMetricsConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toenhancedMetricsConfig(EnhancedMetricsConfig)
.- Parameters:
enhancedMetricsConfig
- a consumer that will call methods onEnhancedMetricsConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-