logo
pub struct CreateRestApiRequest {
    pub api_key_source: Option<String>,
    pub binary_media_types: Option<Vec<String>>,
    pub clone_from: Option<String>,
    pub description: Option<String>,
    pub disable_execute_api_endpoint: Option<bool>,
    pub endpoint_configuration: Option<EndpointConfiguration>,
    pub minimum_compression_size: Option<i64>,
    pub name: String,
    pub policy: Option<String>,
    pub tags: Option<HashMap<String, String>>,
    pub version: Option<String>,
}
Expand description

The POST Request to add a new RestApi resource to your collection.

Fields

api_key_source: Option<String>

The source of the API key for metering requests according to a usage plan. Valid values are:

  • HEADER to read the API key from the X-API-Key header of a request.
  • AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

binary_media_types: Option<Vec<String>>

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

clone_from: Option<String>

The ID of the RestApi that you want to clone from.

description: Option<String>

The description of the RestApi.

disable_execute_api_endpoint: Option<bool>

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

endpoint_configuration: Option<EndpointConfiguration>

The endpoint configuration of this RestApi showing the endpoint types of the API.

minimum_compression_size: Option<i64>

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

name: String

[Required] The name of the RestApi.

policy: Option<String>

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

tags: Option<HashMap<String, String>>

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

version: Option<String>

A version identifier for the API.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more