Module Values.AwsApiGatewayMethodSettingsSource

Defines settings for a method for the stage.

Sourcetype nonrec t = {
  1. metricsEnabled : Boolean.t option;
    (*

    Indicates whether CloudWatch metrics are enabled for the method.

    *)
  2. loggingLevel : NonEmptyString.t option;
    (*

    The logging level for this method. The logging level affects the log entries that are pushed to CloudWatch Logs. If the logging level is ERROR, then the logs only include error-level entries. If the logging level is INFO, then the logs include both ERROR events and extra informational events. Valid values: OFF | ERROR | INFO

    *)
  3. dataTraceEnabled : Boolean.t option;
    (*

    Indicates whether data trace logging is enabled for the method. Data trace logging affects the log entries that are pushed to CloudWatch Logs.

    *)
  4. throttlingBurstLimit : Integer.t option;
    (*

    The throttling burst limit for the method.

    *)
  5. throttlingRateLimit : Double.t option;
    (*

    The throttling rate limit for the method.

    *)
  6. cachingEnabled : Boolean.t option;
    (*

    Indicates whether responses are cached and returned for requests. For responses to be cached, a cache cluster must be enabled on the stage.

    *)
  7. cacheTtlInSeconds : Integer.t option;
    (*

    Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response is cached.

    *)
  8. cacheDataEncrypted : Boolean.t option;
    (*

    Indicates whether the cached responses are encrypted.

    *)
  9. requireAuthorizationForCacheControl : Boolean.t option;
    (*

    Indicates whether authorization is required for a cache invalidation request.

    *)
  10. unauthorizedCacheControlHeaderStrategy : NonEmptyString.t option;
    (*

    Indicates how to handle unauthorized requests for cache invalidation. Valid values: FAIL_WITH_403 | SUCCEED_WITH_RESPONSE_HEADER | SUCCEED_WITHOUT_RESPONSE_HEADER

    *)
  11. httpMethod : NonEmptyString.t option;
    (*

    The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

    *)
  12. resourcePath : NonEmptyString.t option;
    (*

    The resource path for this method. Forward slashes (/) are encoded as ~1 . The initial slash must include a forward slash. For example, the path value /resource/subresource must be encoded as /~1resource~1subresource. To specify the root path, use only a slash (/). You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.

    *)
}
Sourceval make : ?metricsEnabled:??? -> ?loggingLevel:??? -> ?dataTraceEnabled:??? -> ?throttlingBurstLimit:??? -> ?throttlingRateLimit:??? -> ?cachingEnabled:??? -> ?cacheTtlInSeconds:??? -> ?cacheDataEncrypted:??? -> ?requireAuthorizationForCacheControl:??? -> ?unauthorizedCacheControlHeaderStrategy:??? -> ?httpMethod:??? -> ?resourcePath:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of Boolean.t | `Double of Double.t | `Integer of Integer.t | `String of NonEmptyString.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t