Struct rusoto_apigatewayv2::UpdateApiRequest
source · [−]pub struct UpdateApiRequest {
pub api_id: String,
pub api_key_selection_expression: Option<String>,
pub cors_configuration: Option<Cors>,
pub credentials_arn: Option<String>,
pub description: Option<String>,
pub disable_execute_api_endpoint: Option<bool>,
pub disable_schema_validation: Option<bool>,
pub name: Option<String>,
pub route_key: Option<String>,
pub route_selection_expression: Option<String>,
pub target: Option<String>,
pub version: Option<String>,
}
Expand description
Updates an Api.
Fields
api_id: String
The API identifier.
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.
credentials_arn: Option<String>
This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, don't specify this parameter. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.
description: Option<String>
The description of the API.
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.
disable_schema_validation: Option<bool>
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
name: Option<String>
The name of the API.
route_key: Option<String>
This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.
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.
target: Option<String>
This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.
version: Option<String>
A version identifier for the API.
Trait Implementations
sourceimpl Clone for UpdateApiRequest
impl Clone for UpdateApiRequest
sourcefn clone(&self) -> UpdateApiRequest
fn clone(&self) -> UpdateApiRequest
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for UpdateApiRequest
impl Debug for UpdateApiRequest
sourceimpl Default for UpdateApiRequest
impl Default for UpdateApiRequest
sourcefn default() -> UpdateApiRequest
fn default() -> UpdateApiRequest
Returns the “default value” for a type. Read more
sourceimpl PartialEq<UpdateApiRequest> for UpdateApiRequest
impl PartialEq<UpdateApiRequest> for UpdateApiRequest
sourcefn eq(&self, other: &UpdateApiRequest) -> bool
fn eq(&self, other: &UpdateApiRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &UpdateApiRequest) -> bool
fn ne(&self, other: &UpdateApiRequest) -> bool
This method tests for !=
.
sourceimpl Serialize for UpdateApiRequest
impl Serialize for UpdateApiRequest
impl StructuralPartialEq for UpdateApiRequest
Auto Trait Implementations
impl RefUnwindSafe for UpdateApiRequest
impl Send for UpdateApiRequest
impl Sync for UpdateApiRequest
impl Unpin for UpdateApiRequest
impl UnwindSafe for UpdateApiRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more