Struct UpdateApiOutput

#[non_exhaustive]
pub struct UpdateApiOutput {

    pub api_endpoint: Option<String>,
    pub api_gateway_managed: Option<bool>,
    pub api_id: Option<String>,
    pub api_key_selection_expression: Option<String>,
    pub cors_configuration: Option<Cors>,
    pub created_date: Option<DateTime>,
    pub description: Option<String>,
    pub disable_schema_validation: Option<bool>,
    pub disable_execute_api_endpoint: Option<bool>,
    pub import_info: Option<Vec<String>>,
    pub ip_address_type: Option<IpAddressType>,
    pub name: Option<String>,
    pub protocol_type: Option<ProtocolType>,
    pub route_selection_expression: Option<String>,
    pub tags: Option<HashMap<String, String>>,
    pub version: Option<String>,
    pub warnings: Option<Vec<String>>,
    /* private fields */
}

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.

api_endpoint: Option<String>

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

api_gateway_managed: Option<bool>

Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

api_id: Option<String>

The API ID.

api_key_selection_expression: Option<String>

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

cors_configuration: Option<Cors>

A CORS configuration. Supported only for HTTP APIs.

created_date: Option<DateTime>

The timestamp when the API was created.

description: Option<String>

The description of the API.

disable_schema_validation: Option<bool>

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

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.

import_info: Option<Vec<String>>

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

ip_address_type: Option<IpAddressType>

The IP address types that can invoke the API.

name: Option<String>

The name of the API.

protocol_type: Option<ProtocolType>

The API protocol.

route_selection_expression: Option<String>

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

tags: Option<HashMap<String, String>>

A collection of tags associated with the API.

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.

Implementations

impl UpdateApiOutput

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

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

pub fn api_gateway_managed(&self) -> Option<bool>

Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

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

The API ID.

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

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

pub fn cors_configuration(&self) -> Option<&Cors>

A CORS configuration. Supported only for HTTP APIs.

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

The timestamp when the API was created.

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

The description of the API.

pub fn disable_schema_validation(&self) -> Option<bool>

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

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.

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

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

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

pub fn ip_address_type(&self) -> Option<&IpAddressType>

The IP address types that can invoke the API.

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

The name of the API.

pub fn protocol_type(&self) -> Option<&ProtocolType>

The API protocol.

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

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

pub fn tags(&self) -> Option<&HashMap<String, String>>

A collection of tags associated with the API.

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

A version identifier for the API.

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

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

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

impl UpdateApiOutput

pub fn builder() -> UpdateApiOutputBuilder

Creates a new builder-style object to manufacture UpdateApiOutput.

Trait Implementations

impl Clone for UpdateApiOutput

fn clone(&self) -> UpdateApiOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateApiOutput

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

Formats the value using the given formatter.

impl PartialEq for UpdateApiOutput

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

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

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 RequestId for UpdateApiOutput

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

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

impl StructuralPartialEq for UpdateApiOutput