Struct CreateRestApiInput

#[non_exhaustive]
pub struct CreateRestApiInput {
    pub name: Option<String>,
    pub description: Option<String>,
    pub version: Option<String>,
    pub clone_from: Option<String>,
    pub binary_media_types: Option<Vec<String>>,
    pub minimum_compression_size: Option<i32>,
    pub api_key_source: Option<ApiKeySourceType>,
    pub endpoint_configuration: Option<EndpointConfiguration>,
    pub policy: Option<String>,
    pub tags: Option<HashMap<String, String>>,
    pub disable_execute_api_endpoint: Option<bool>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of the RestApi.

description: Option<String>

The description of the RestApi.

version: Option<String>

A version identifier for the API.

clone_from: Option<String>

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

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.

minimum_compression_size: Option<i32>

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.

api_key_source: Option<ApiKeySourceType>

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.

endpoint_configuration: Option<EndpointConfiguration>

The endpoint configuration of this RestApi showing the endpoint types and IP address types of the API.

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.

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

Implementations

impl CreateRestApiInput

pub fn name(&self) -> Option<&str>

The name of the RestApi.

pub fn description(&self) -> Option<&str>

The description of the RestApi.

pub fn version(&self) -> Option<&str>

A version identifier for the API.

pub fn clone_from(&self) -> Option<&str>

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

pub fn binary_media_types(&self) -> &[String]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .binary_media_types.is_none().

pub fn minimum_compression_size(&self) -> Option<i32>

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.

pub fn api_key_source(&self) -> Option<&ApiKeySourceType>

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.

pub fn endpoint_configuration(&self) -> Option<&EndpointConfiguration>

The endpoint configuration of this RestApi showing the endpoint types and IP address types of the API.

pub fn policy(&self) -> Option<&str>

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

pub fn tags(&self) -> 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.

pub fn disable_execute_api_endpoint(&self) -> 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

impl CreateRestApiInput

pub fn builder() -> CreateRestApiInputBuilder

Creates a new builder-style object to manufacture CreateRestApiInput.

Trait Implementations

impl Clone for CreateRestApiInput

fn clone(&self) -> CreateRestApiInput

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateRestApiInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateRestApiInput

fn eq(&self, other: &CreateRestApiInput) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateRestApiInput