[−][src]Struct rusoto_apigateway::RestApi

pub struct RestApi {
    pub api_key_source: Option<String>,
    pub binary_media_types: Option<Vec<String>>,
    pub created_date: Option<f64>,
    pub description: Option<String>,
    pub endpoint_configuration: Option<EndpointConfiguration>,
    pub id: Option<String>,
    pub minimum_compression_size: Option<i64>,
    pub name: Option<String>,
    pub policy: Option<String>,
    pub tags: Option<HashMap<String, String>>,
    pub version: Option<String>,
    pub warnings: Option<Vec<String>>,
}

Represents a REST API.

Create an API

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.

created_date: Option<f64>

The timestamp when the API was created.

description: Option<String>

The API's description.

endpoint_configuration: Option<EndpointConfiguration>

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

id: Option<String>

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

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: Option<String>

The API's name.

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 collection of tags. Each tag element is associated with a given resource.

version: Option<String>

A version identifier for the API.

warnings: Option<Vec<String>>

The warning messages reported when failonwarnings is turned on during API import.

Trait Implementations

impl Clone for RestApi[src]

impl Debug for RestApi[src]

impl Default for RestApi[src]

impl<'de> Deserialize<'de> for RestApi[src]

impl PartialEq<RestApi> for RestApi[src]

impl StructuralPartialEq for RestApi[src]

Auto Trait Implementations

impl RefUnwindSafe for RestApi

impl Send for RestApi

impl Sync for RestApi

impl Unpin for RestApi

impl UnwindSafe for RestApi

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> DeserializeOwned for T where
    T: Deserialize<'de>, [src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.