Interface MethodOptions

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
MethodOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:45.008Z") @Stability(Stable) public interface MethodOptions extends software.amazon.jsii.JsiiSerializable
Example:

 RestApi api;
 Function userLambda;
 Model userModel = api.addModel("UserModel", ModelOptions.builder()
         .schema(JsonSchema.builder()
                 .type(JsonSchemaType.OBJECT)
                 .properties(Map.of(
                         "userId", JsonSchema.builder()
                                 .type(JsonSchemaType.STRING)
                                 .build(),
                         "name", JsonSchema.builder()
                                 .type(JsonSchemaType.STRING)
                                 .build()))
                 .required(List.of("userId"))
                 .build())
         .build());
 api.root.addResource("user").addMethod("POST",
 new LambdaIntegration(userLambda), MethodOptions.builder()
         .requestModels(Map.of(
                 "application/json", userModel))
         .build());
 
  • Method Details

    • getApiKeyRequired

      @Stability(Stable) @Nullable default Boolean getApiKeyRequired()
      Indicates whether the method requires clients to submit a valid API key.

      Default: false

    • getAuthorizationScopes

      @Stability(Stable) @Nullable default List<String> getAuthorizationScopes()
      A list of authorization scopes configured on the method.

      The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation.

      Default: - no authorization scopes

      See Also:
    • getAuthorizationType

      @Stability(Stable) @Nullable default AuthorizationType getAuthorizationType()
      Method authorization. If the value is set of Custom, an authorizer must also be specified.

      If you're using one of the authorizers that are available via the Authorizer class, such as

      invalid @link
      Authorizer#token()
      , it is recommended that this option not be specified. The authorizer will take care of setting the correct authorization type. However, specifying an authorization type using this property that conflicts with what is expected by the Authorizer will result in an error.

      Default: - open access unless `authorizer` is specified

    • getAuthorizer

      @Stability(Stable) @Nullable default IAuthorizer getAuthorizer()
      If authorizationType is Custom, this specifies the ID of the method authorizer resource.

      If specified, the value of authorizationType must be set to Custom

    • getMethodResponses

      @Stability(Stable) @Nullable default List<MethodResponse> getMethodResponses()
      The responses that can be sent to the client who calls the method.

      Default: None This property is not required, but if these are not supplied for a Lambda proxy integration, the Lambda function must return a value of the correct format, for the integration response to be correctly mapped to a response to the client.

      See Also:
    • getOperationName

      @Stability(Stable) @Nullable default String getOperationName()
      A friendly operation name for the method.

      For example, you can assign the OperationName of ListPets for the GET /pets method.

    • getRequestModels

      @Stability(Stable) @Nullable default Map<String,IModel> getRequestModels()
      The models which describe data structure of request payload.

      When combined with requestValidator or requestValidatorOptions, the service will validate the API request payload before it reaches the API's Integration (including proxies). Specify requestModels as key-value pairs, with a content type (e.g. 'application/json') as the key and an API Gateway Model as the value.

      Example:

       RestApi api;
       Function userLambda;
       Model userModel = api.addModel("UserModel", ModelOptions.builder()
               .schema(JsonSchema.builder()
                       .type(JsonSchemaType.OBJECT)
                       .properties(Map.of(
                               "userId", JsonSchema.builder()
                                       .type(JsonSchemaType.STRING)
                                       .build(),
                               "name", JsonSchema.builder()
                                       .type(JsonSchemaType.STRING)
                                       .build()))
                       .required(List.of("userId"))
                       .build())
               .build());
       api.root.addResource("user").addMethod("POST",
       new LambdaIntegration(userLambda), MethodOptions.builder()
               .requestModels(Map.of(
                       "application/json", userModel))
               .build());
       

      See Also:
    • getRequestParameters

      @Stability(Stable) @Nullable default Map<String,Boolean> getRequestParameters()
      The request parameters that API Gateway accepts.

      Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value. The Boolean specifies whether a parameter is required. A source must match the format method.request.location.name, where the location is querystring, path, or header, and name is a valid, unique parameter name.

      Default: None

    • getRequestValidator

      @Stability(Stable) @Nullable default IRequestValidator getRequestValidator()
      The ID of the associated request validator.

      Only one of requestValidator or requestValidatorOptions must be specified. Works together with requestModels or requestParameters to validate the request before it reaches integration like Lambda Proxy Integration.

      Default: - No default validator

    • getRequestValidatorOptions

      @Stability(Stable) @Nullable default RequestValidatorOptions getRequestValidatorOptions()
      Request validator options to create new validator Only one of requestValidator or requestValidatorOptions must be specified.

      Works together with requestModels or requestParameters to validate the request before it reaches integration like Lambda Proxy Integration.

      Default: - No default validator

    • builder

      @Stability(Stable) static MethodOptions.Builder builder()
      Returns:
      a MethodOptions.Builder of MethodOptions