Struct aws_sdk_apigatewayv2::types::Api
source · #[non_exhaustive]pub struct Api {Show 16 fields
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 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>>,
}
Expand description
Represents an API.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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.
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.
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§
source§impl Api
impl Api
sourcepub fn api_endpoint(&self) -> Option<&str>
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.
sourcepub fn api_gateway_managed(&self) -> Option<bool>
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.
sourcepub fn api_key_selection_expression(&self) -> Option<&str>
pub fn api_key_selection_expression(&self) -> Option<&str>
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
sourcepub fn cors_configuration(&self) -> Option<&Cors>
pub fn cors_configuration(&self) -> Option<&Cors>
A CORS configuration. Supported only for HTTP APIs.
sourcepub fn created_date(&self) -> Option<&DateTime>
pub fn created_date(&self) -> Option<&DateTime>
The timestamp when the API was created.
sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The description of the API.
sourcepub fn disable_schema_validation(&self) -> Option<bool>
pub fn disable_schema_validation(&self) -> Option<bool>
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
sourcepub fn disable_execute_api_endpoint(&self) -> Option<bool>
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.
sourcepub fn import_info(&self) -> &[String]
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()
.
sourcepub fn protocol_type(&self) -> Option<&ProtocolType>
pub fn protocol_type(&self) -> Option<&ProtocolType>
The API protocol.
sourcepub fn route_selection_expression(&self) -> Option<&str>
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.
A collection of tags associated with the API.
Trait Implementations§
impl StructuralPartialEq for Api
Auto Trait Implementations§
impl Freeze for Api
impl RefUnwindSafe for Api
impl Send for Api
impl Sync for Api
impl Unpin for Api
impl UnwindSafe for Api
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more