Package software.amazon.awscdk.services.apigateway

Class CfnMethod.MethodResponseProperty.Builder

java.lang.Object
software.amazon.awscdk.services.apigateway.CfnMethod.MethodResponseProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnMethod.MethodResponseProperty>
Enclosing interface:
CfnMethod.MethodResponseProperty
@Stability(Stable) public static final class CfnMethod.MethodResponseProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnMethod.MethodResponseProperty>
A builder for CfnMethod.MethodResponseProperty

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • statusCode

      @Stability(Stable) public CfnMethod.MethodResponseProperty.Builder statusCode(String statusCode)
      Sets the value of CfnMethod.MethodResponseProperty.getStatusCode()
      Parameters:
      statusCode - The method response's status code. This parameter is required.
      Returns:
      this

    • responseModels

      @Stability(Stable) public CfnMethod.MethodResponseProperty.Builder responseModels(IResolvable responseModels)
      Sets the value of CfnMethod.MethodResponseProperty.getResponseModels()
      Parameters:
      responseModels - Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
      Returns:
      this

    • responseModels

      @Stability(Stable) public CfnMethod.MethodResponseProperty.Builder responseModels(Map<String,String> responseModels)
      Sets the value of CfnMethod.MethodResponseProperty.getResponseModels()
      Parameters:
      responseModels - Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
      Returns:
      this

    • responseParameters

      @Stability(Stable) public CfnMethod.MethodResponseProperty.Builder responseParameters(IResolvable responseParameters)
      Sets the value of CfnMethod.MethodResponseProperty.getResponseParameters()
      Parameters:
      responseParameters - A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name} , where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name} , a static value enclosed within a pair of single quotes (e.g., 'application/json' ), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression} , where JSON-expression is a valid JSON expression without the $ prefix.)
      Returns:
      this

    • responseParameters

      @Stability(Stable) public CfnMethod.MethodResponseProperty.Builder responseParameters(Map<String,? extends Object> responseParameters)
      Sets the value of CfnMethod.MethodResponseProperty.getResponseParameters()
      Parameters:
      responseParameters - A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name} , where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name} , a static value enclosed within a pair of single quotes (e.g., 'application/json' ), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression} , where JSON-expression is a valid JSON expression without the $ prefix.)
      Returns:
      this

    • build

      @Stability(Stable) public CfnMethod.MethodResponseProperty build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnMethod.MethodResponseProperty>
      Returns:
      a new instance of CfnMethod.MethodResponseProperty
      Throws:
      NullPointerException - if any required attribute was not provided