Interface PutIntegrationRequest.Builder

All Superinterfaces:
ApiGatewayRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<PutIntegrationRequest.Builder,PutIntegrationRequest>, SdkBuilder<PutIntegrationRequest.Builder,PutIntegrationRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
PutIntegrationRequest
@Mutable @NotThreadSafe public static interface PutIntegrationRequest.Builder extends ApiGatewayRequest.Builder, SdkPojo, CopyableBuilder<PutIntegrationRequest.Builder,PutIntegrationRequest>

  • Method Details

    • restApiId

      PutIntegrationRequest.Builder restApiId(String restApiId)

      The string identifier of the associated RestApi.

      Parameters:
      restApiId - The string identifier of the associated RestApi.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceId

      PutIntegrationRequest.Builder resourceId(String resourceId)

      Specifies a put integration request's resource ID.

      Parameters:
      resourceId - Specifies a put integration request's resource ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • httpMethod

      PutIntegrationRequest.Builder httpMethod(String httpMethod)

      Specifies the HTTP method for the integration.

      Parameters:
      httpMethod - Specifies the HTTP method for the integration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      PutIntegrationRequest.Builder type(String type)

      Specifies a put integration input's type.

      Parameters:
      type - Specifies a put integration input's type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      PutIntegrationRequest.Builder type(IntegrationType type)

      Specifies a put integration input's type.

      Parameters:
      type - Specifies a put integration input's type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • integrationHttpMethod

      PutIntegrationRequest.Builder integrationHttpMethod(String integrationHttpMethod)

      The HTTP method for the integration.

      Parameters:
      integrationHttpMethod - The HTTP method for the integration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • uri

      PutIntegrationRequest.Builder uri(String uri)

      Specifies Uniform Resource Identifier (URI) of the integration endpoint. For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api . Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an Amazon Web Services service path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}.

      Parameters:
      uri - Specifies Uniform Resource Identifier (URI) of the integration endpoint. For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api . Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an Amazon Web Services service path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • connectionType

      PutIntegrationRequest.Builder connectionType(String connectionType)

      The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

      Parameters:
      connectionType - The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • connectionType

      PutIntegrationRequest.Builder connectionType(ConnectionType connectionType)

      The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

      Parameters:
      connectionType - The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • connectionId

      PutIntegrationRequest.Builder connectionId(String connectionId)

      The ID of the VpcLink used for the integration. Specify this value only if you specify VPC_LINK as the connection type.

      Parameters:
      connectionId - The ID of the VpcLink used for the integration. Specify this value only if you specify VPC_LINK as the connection type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • credentials

      PutIntegrationRequest.Builder credentials(String credentials)

      Specifies whether credentials are required for a put integration.

      Parameters:
      credentials - Specifies whether credentials are required for a put integration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requestParameters

      PutIntegrationRequest.Builder requestParameters(Map<String,String> requestParameters)

      A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

      Parameters:
      requestParameters - A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring , path, or header and name must be a valid and unique method request parameter name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requestTemplates

      PutIntegrationRequest.Builder requestTemplates(Map<String,String> requestTemplates)

      Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

      Parameters:
      requestTemplates - Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • passthroughBehavior

      PutIntegrationRequest.Builder passthroughBehavior(String passthroughBehavior)

      Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

      Parameters:
      passthroughBehavior - Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cacheNamespace

      PutIntegrationRequest.Builder cacheNamespace(String cacheNamespace)

      Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

      Parameters:
      cacheNamespace - Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cacheKeyParameters

      PutIntegrationRequest.Builder cacheKeyParameters(Collection<String> cacheKeyParameters)

      A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

      Parameters:
      cacheKeyParameters - A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cacheKeyParameters

      PutIntegrationRequest.Builder cacheKeyParameters(String... cacheKeyParameters)

      A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

      Parameters:
      cacheKeyParameters - A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contentHandling

      PutIntegrationRequest.Builder contentHandling(String contentHandling)

      Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

      If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

      Parameters:
      contentHandling - Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

      If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

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

    • contentHandling

      PutIntegrationRequest.Builder contentHandling(ContentHandlingStrategy contentHandling)

      Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

      If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

      Parameters:
      contentHandling - Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

      If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

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

    • timeoutInMillis

      PutIntegrationRequest.Builder timeoutInMillis(Integer timeoutInMillis)

      Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. You can increase the default value to longer than 29 seconds for Regional or private APIs only.

      Parameters:
      timeoutInMillis - Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. You can increase the default value to longer than 29 seconds for Regional or private APIs only.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tlsConfig

      PutIntegrationRequest.Builder tlsConfig(TlsConfig tlsConfig)
      Sets the value of the TlsConfig property for this object.
      Parameters:
      tlsConfig - The new value for the TlsConfig property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tlsConfig

      default PutIntegrationRequest.Builder tlsConfig(Consumer<TlsConfig.Builder> tlsConfig)
      Sets the value of the TlsConfig property for this object. This is a convenience method that creates an instance of the TlsConfig.Builder avoiding the need to create one manually via TlsConfig.builder().

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

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

    • overrideConfiguration

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

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