Package software.amazon.awssdk.services.apigatewayv2.model

Interface UpdateApiRequest.Builder

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

  • Method Details

    • apiId

      UpdateApiRequest.Builder apiId(String apiId)

      The API identifier.

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

    • apiKeySelectionExpression

      UpdateApiRequest.Builder apiKeySelectionExpression(String apiKeySelectionExpression)

      An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

      Parameters:
      apiKeySelectionExpression - An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • corsConfiguration

      UpdateApiRequest.Builder corsConfiguration(Cors corsConfiguration)

      A CORS configuration. Supported only for HTTP APIs.

      Parameters:
      corsConfiguration - A CORS configuration. Supported only for HTTP APIs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • corsConfiguration

      default UpdateApiRequest.Builder corsConfiguration(Consumer<Cors.Builder> corsConfiguration)

      A CORS configuration. Supported only for HTTP APIs.

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

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

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

    • credentialsArn

      UpdateApiRequest.Builder credentialsArn(String credentialsArn)

      This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, don't specify this parameter. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.

      Parameters:
      credentialsArn - This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, don't specify this parameter. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      UpdateApiRequest.Builder description(String description)

      The description of the API.

      Parameters:
      description - The description of the API.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • disableSchemaValidation

      UpdateApiRequest.Builder disableSchemaValidation(Boolean disableSchemaValidation)

      Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

      Parameters:
      disableSchemaValidation - Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • disableExecuteApiEndpoint

      UpdateApiRequest.Builder disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)

      Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

      Parameters:
      disableExecuteApiEndpoint - Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      UpdateApiRequest.Builder name(String name)

      The name of the API.

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

    • routeKey

      UpdateApiRequest.Builder routeKey(String routeKey)

      This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.

      Parameters:
      routeKey - This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • routeSelectionExpression

      UpdateApiRequest.Builder routeSelectionExpression(String routeSelectionExpression)

      The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

      Parameters:
      routeSelectionExpression - The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • target

      UpdateApiRequest.Builder target(String target)

      This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.

      Parameters:
      target - This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • version

      UpdateApiRequest.Builder version(String version)

      A version identifier for the API.

      Parameters:
      version - A version identifier for the API.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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