Class SagemakerIntegration.Builder

java.lang.Object
software.amazon.awscdk.services.apigateway.SagemakerIntegration.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<SagemakerIntegration>
Enclosing class:
SagemakerIntegration

@Stability(Stable) public static final class SagemakerIntegration.Builder extends Object implements software.amazon.jsii.Builder<SagemakerIntegration>
A fluent builder for SagemakerIntegration.
  • Method Details

    • create

      @Stability(Stable) public static SagemakerIntegration.Builder create(IEndpoint endpoint)
      Parameters:
      endpoint - This parameter is required.
      Returns:
      a new instance of SagemakerIntegration.Builder.
    • cacheKeyParameters

      @Stability(Stable) public SagemakerIntegration.Builder cacheKeyParameters(List<String> cacheKeyParameters)
      A list of request parameters whose values are to be cached.

      It determines request parameters that will make it into the cache key.

      Parameters:
      cacheKeyParameters - A list of request parameters whose values are to be cached. This parameter is required.
      Returns:
      this
    • cacheNamespace

      @Stability(Stable) public SagemakerIntegration.Builder cacheNamespace(String cacheNamespace)
      An API-specific tag group of related cached parameters.

      Parameters:
      cacheNamespace - An API-specific tag group of related cached parameters. This parameter is required.
      Returns:
      this
    • connectionType

      @Stability(Stable) public SagemakerIntegration.Builder connectionType(ConnectionType connectionType)
      The type of network connection to the integration endpoint.

      Default: - ConnectionType.VPC_LINK if `vpcLink` property is configured; ConnectionType.Internet otherwise.

      Parameters:
      connectionType - The type of network connection to the integration endpoint. This parameter is required.
      Returns:
      this
    • contentHandling

      @Stability(Stable) public SagemakerIntegration.Builder contentHandling(ContentHandling contentHandling)
      Specifies how to handle request payload content type conversions.

      Default: none if this property isn't defined, the request payload is passed through from the method request to the integration request without modification, provided that the `passthroughBehaviors` property is configured to support payload pass-through.

      Parameters:
      contentHandling - Specifies how to handle request payload content type conversions. This parameter is required.
      Returns:
      this
    • credentialsPassthrough

      @Stability(Stable) public SagemakerIntegration.Builder credentialsPassthrough(Boolean credentialsPassthrough)
      Requires that the caller's identity be passed through from the request.

      Default: Caller identity is not passed through

      Parameters:
      credentialsPassthrough - Requires that the caller's identity be passed through from the request. This parameter is required.
      Returns:
      this
    • credentialsRole

      @Stability(Stable) public SagemakerIntegration.Builder credentialsRole(IRole credentialsRole)
      An IAM role that API Gateway assumes.

      Mutually exclusive with credentialsPassThrough.

      Default: A role is not assumed

      Parameters:
      credentialsRole - An IAM role that API Gateway assumes. This parameter is required.
      Returns:
      this
    • integrationResponses

      @Stability(Stable) public SagemakerIntegration.Builder integrationResponses(List<? extends IntegrationResponse> integrationResponses)
      The response that API Gateway provides after a method's backend completes processing a request.

      API Gateway intercepts the response from the backend so that you can control how API Gateway surfaces backend responses. For example, you can map the backend status codes to codes that you define.

      Parameters:
      integrationResponses - The response that API Gateway provides after a method's backend completes processing a request. This parameter is required.
      Returns:
      this
    • passthroughBehavior

      @Stability(Stable) public SagemakerIntegration.Builder passthroughBehavior(PassthroughBehavior 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. This parameter is required.
      Returns:
      this
    • requestParameters

      @Stability(Stable) public SagemakerIntegration.Builder requestParameters(Map<String,String> requestParameters)
      The request parameters that API Gateway sends with the backend request.

      Specify request parameters as key-value pairs (string-to-string mappings), with a destination as the key and a source as the value.

      Specify the destination by using the following pattern integration.request.location.name, where location is querystring, path, or header, and name is a valid, unique parameter name.

      The source must be an existing method request parameter or a static value. You must enclose static values in single quotation marks and pre-encode these values based on their destination in the request.

      Parameters:
      requestParameters - The request parameters that API Gateway sends with the backend request. This parameter is required.
      Returns:
      this
    • requestTemplates

      @Stability(Stable) public SagemakerIntegration.Builder requestTemplates(Map<String,String> requestTemplates)
      A map of Apache Velocity templates that are applied on the request payload.

      The template that API Gateway uses is based on the value of the Content-Type header that's sent by the client. The content type value is the key, and the template is the value (specified as a string), such as the following snippet:

         { "application/json": "{ \"statusCode\": 200 }" }
       

      Parameters:
      requestTemplates - A map of Apache Velocity templates that are applied on the request payload. This parameter is required.
      Returns:
      this
      See Also:
    • timeout

      @Stability(Stable) public SagemakerIntegration.Builder timeout(Duration timeout)
      The maximum amount of time an integration will run before it returns without a response.

      By default, the value must be between 50 milliseconds and 29 seconds. The upper bound can be increased for regional and private Rest APIs only, via a quota increase request for your acccount. This increase might require a reduction in your account-level throttle quota limit. See

      invalid @link
      {@link https://docs.aws.amazon.com/apigateway/latest/developerguide/limits.html
      Amazon API Gateway quotas} for more details.

      Default: Duration.seconds(29)

      Parameters:
      timeout - The maximum amount of time an integration will run before it returns without a response. This parameter is required.
      Returns:
      this
    • vpcLink

      @Stability(Stable) public SagemakerIntegration.Builder vpcLink(IVpcLink vpcLink)
      The VpcLink used for the integration.

      Required if connectionType is VPC_LINK

      Parameters:
      vpcLink - The VpcLink used for the integration. This parameter is required.
      Returns:
      this
    • build

      @Stability(Stable) public SagemakerIntegration build()
      Specified by:
      build in interface software.amazon.jsii.Builder<SagemakerIntegration>
      Returns:
      a newly built instance of SagemakerIntegration.