Module Values.CreateDeploymentRequestSource

Requests API Gateway to create a Deployment resource.

Sourcetype nonrec t = {
  1. restApiId : String_.t;
    (*

    The string identifier of the associated RestApi.

    *)
  2. stageName : String_.t option;
    (*

    The name of the Stage resource for the Deployment resource to create.

    *)
  3. stageDescription : String_.t option;
    (*

    The description of the Stage resource for the Deployment resource to create.

    *)
  4. description : String_.t option;
    (*

    The description for the Deployment resource to create.

    *)
  5. cacheClusterEnabled : NullableBoolean.t option;
    (*

    Enables a cache cluster for the Stage resource specified in the input.

    *)
  6. cacheClusterSize : CacheClusterSize.t option;
    (*

    The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

    *)
  7. variables : MapOfStringToString.t option;
    (*

    A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

    *)
  8. canarySettings : DeploymentCanarySettings.t option;
    (*

    The input configuration for the canary deployment when the deployment is a canary release deployment.

    *)
  9. tracingEnabled : NullableBoolean.t option;
    (*

    Specifies whether active tracing with X-ray is enabled for the Stage.

    *)
}
Sourceval context_ : string
Sourceval make : ?stageName:String_.t -> ?stageDescription:String_.t -> ?description:String_.t -> ?cacheClusterEnabled:NullableBoolean.t -> ?cacheClusterSize:CacheClusterSize.t -> ?variables:MapOfStringToString.t -> ?canarySettings:DeploymentCanarySettings.t -> ?tracingEnabled:NullableBoolean.t -> restApiId:String_.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of NullableBoolean.t | `Enum of string | `Map of ([> `String of String_.t ] * [> `String of String_.t ]) list | `String of String_.t | `Structure of (string * [> `Boolean of Boolean.t | `Double of Double.t | `Map of ([> `String of String_.t ] * [> `String of String_.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