Struct aws_sdk_apigateway::operation::put_rest_api::PutRestApiOutput

#[non_exhaustive]
pub struct PutRestApiOutput {

    pub id: Option<String>,
    pub name: Option<String>,
    pub description: Option<String>,
    pub created_date: Option<DateTime>,
    pub version: Option<String>,
    pub warnings: Option<Vec<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: bool,
    /* private fields */
}

Represents a REST API.

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.

id: Option<String>

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

name: Option<String>

The API's name.

description: Option<String>

The API's description.

created_date: Option<DateTime>

The timestamp when the API was created.

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.

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

disable_execute_api_endpoint: 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 PutRestApiOutput

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

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

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

The API's name.

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

The API's description.

pub fn created_date(&self) -> Option<&DateTime>

The timestamp when the API was created.

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

A version identifier for the API.

pub fn warnings(&self) -> Option<&[String]>

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

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

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

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

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

pub fn builder() -> PutRestApiOutputBuilder

Creates a new builder-style object to manufacture PutRestApiOutput.

Trait Implementations

impl Clone for PutRestApiOutput

fn clone(&self) -> PutRestApiOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PutRestApiOutput

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

Formats the value using the given formatter.

impl PartialEq<PutRestApiOutput> for PutRestApiOutput

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

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

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

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

impl RequestId for PutRestApiOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for PutRestApiOutput