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

Interface UpdateGraphqlApiRequest.Builder

All Superinterfaces:
AppSyncRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<UpdateGraphqlApiRequest.Builder,UpdateGraphqlApiRequest>, SdkBuilder<UpdateGraphqlApiRequest.Builder,UpdateGraphqlApiRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateGraphqlApiRequest
public static interface UpdateGraphqlApiRequest.Builder extends AppSyncRequest.Builder, SdkPojo, CopyableBuilder<UpdateGraphqlApiRequest.Builder,UpdateGraphqlApiRequest>

  • Method Details

    • apiId

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

    • name

      UpdateGraphqlApiRequest.Builder name(String name)

      The new name for the GraphqlApi object.

      Parameters:
      name - The new name for the GraphqlApi object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logConfig

      UpdateGraphqlApiRequest.Builder logConfig(LogConfig logConfig)

      The Amazon CloudWatch Logs configuration for the GraphqlApi object.

      Parameters:
      logConfig - The Amazon CloudWatch Logs configuration for the GraphqlApi object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logConfig

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

      The Amazon CloudWatch Logs configuration for the GraphqlApi object.

      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:

    • authenticationType

      UpdateGraphqlApiRequest.Builder authenticationType(String authenticationType)

      The new authentication type for the GraphqlApi object.

      Parameters:
      authenticationType - The new authentication type for the GraphqlApi object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authenticationType

      UpdateGraphqlApiRequest.Builder authenticationType(AuthenticationType authenticationType)

      The new authentication type for the GraphqlApi object.

      Parameters:
      authenticationType - The new authentication type for the GraphqlApi object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • userPoolConfig

      UpdateGraphqlApiRequest.Builder userPoolConfig(UserPoolConfig userPoolConfig)

      The new Amazon Cognito user pool configuration for the ~GraphqlApi object.

      Parameters:
      userPoolConfig - The new Amazon Cognito user pool configuration for the ~GraphqlApi object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userPoolConfig

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

      The new Amazon Cognito user pool configuration for the ~GraphqlApi object.

      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:

    • openIDConnectConfig

      UpdateGraphqlApiRequest.Builder openIDConnectConfig(OpenIDConnectConfig openIDConnectConfig)

      The OpenID Connect configuration for the GraphqlApi object.

      Parameters:
      openIDConnectConfig - The OpenID Connect configuration for the GraphqlApi object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • openIDConnectConfig

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

      The OpenID Connect configuration for the GraphqlApi object.

      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:

    • additionalAuthenticationProviders

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

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

      UpdateGraphqlApiRequest.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:

    • xrayEnabled

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

      UpdateGraphqlApiRequest.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 UpdateGraphqlApiRequest.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:

    • mergedApiExecutionRoleArn

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

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

    • introspectionConfig

      UpdateGraphqlApiRequest.Builder introspectionConfig(String 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 to ENABLED 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 to ENABLED 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

      UpdateGraphqlApiRequest.Builder introspectionConfig(GraphQLApiIntrospectionConfig 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 to ENABLED 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 to ENABLED 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

      UpdateGraphqlApiRequest.Builder queryDepthLimit(Integer 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 between 1 and 75 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 is 0 (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between 1 and 75 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

      UpdateGraphqlApiRequest.Builder resolverCountLimit(Integer 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 to 10000. When specified, the limit value can be between 1 and 10000. 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 is 0 (or unspecified), which will set the limit to 10000. When specified, the limit value can be between 1 and 10000. 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

      UpdateGraphqlApiRequest.Builder enhancedMetricsConfig(EnhancedMetricsConfig enhancedMetricsConfig)

      The enhancedMetricsConfig object.

      Parameters:
      enhancedMetricsConfig - The enhancedMetricsConfig object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enhancedMetricsConfig

      default UpdateGraphqlApiRequest.Builder enhancedMetricsConfig(Consumer<EnhancedMetricsConfig.Builder> enhancedMetricsConfig)

      The enhancedMetricsConfig object.

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

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

      Parameters:
      enhancedMetricsConfig - a consumer that will call methods on EnhancedMetricsConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

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

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