Module Values.AwsApiGatewayV2ApiDetailsSource

Contains information about a version 2 API in Amazon API Gateway.

Sourcetype nonrec t = {
  1. apiEndpoint : NonEmptyString.t option;
    (*

    The URI of the API. Uses the format <api-id>.execute-api.<region>.amazonaws.com The stage name is typically appended to the URI to form a complete path to a deployed API stage.

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

    The identifier of the API.

    *)
  3. apiKeySelectionExpression : NonEmptyString.t option;
    (*

    An API key selection expression. Supported only for WebSocket APIs.

    *)
  4. createdDate : NonEmptyString.t option;
    (*

    Indicates when the API was created. For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.

    *)
  5. description : NonEmptyString.t option;
    (*

    A description of the API.

    *)
  6. version : NonEmptyString.t option;
    (*

    The version identifier for the API.

    *)
  7. name : NonEmptyString.t option;
    (*

    The name of the API.

    *)
  8. protocolType : NonEmptyString.t option;
    (*

    The API protocol for the API. Valid values: WEBSOCKET | HTTP

    *)
  9. routeSelectionExpression : NonEmptyString.t option;
    (*

    The route selection expression for the API. For HTTP APIs, must be ${request.method} ${request.path}. This is the default value for HTTP APIs. For WebSocket APIs, there is no default value.

    *)
  10. corsConfiguration : AwsCorsConfiguration.t option;
    (*

    A cross-origin resource sharing (CORS) configuration. Supported only for HTTP APIs.

    *)
}
Sourceval make : ?apiEndpoint:??? -> ?apiId:??? -> ?apiKeySelectionExpression:??? -> ?createdDate:??? -> ?description:??? -> ?version:??? -> ?name:??? -> ?protocolType:??? -> ?routeSelectionExpression:??? -> ?corsConfiguration:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `String of NonEmptyString.t | `Structure of (string * [> `Boolean of Boolean.t | `Integer of Integer.t | `List of [> `String of NonEmptyString.t ] list ]) list ]) 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