pub struct UpdateApiFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to UpdateApi
.
Updates an Api resource.
Implementations§
source§impl UpdateApiFluentBuilder
impl UpdateApiFluentBuilder
sourcepub fn as_input(&self) -> &UpdateApiInputBuilder
pub fn as_input(&self) -> &UpdateApiInputBuilder
Access the UpdateApi as a reference.
sourcepub async fn send(
self
) -> Result<UpdateApiOutput, SdkError<UpdateApiError, HttpResponse>>
pub async fn send( self ) -> Result<UpdateApiOutput, SdkError<UpdateApiError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self
) -> CustomizableOperation<UpdateApiOutput, UpdateApiError, Self>
pub fn customize( self ) -> CustomizableOperation<UpdateApiOutput, UpdateApiError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn set_api_id(self, input: Option<String>) -> Self
pub fn set_api_id(self, input: Option<String>) -> Self
The API identifier.
sourcepub fn get_api_id(&self) -> &Option<String>
pub fn get_api_id(&self) -> &Option<String>
The API identifier.
sourcepub fn api_key_selection_expression(self, input: impl Into<String>) -> Self
pub fn api_key_selection_expression(self, input: impl Into<String>) -> Self
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
sourcepub fn set_api_key_selection_expression(self, input: Option<String>) -> Self
pub fn set_api_key_selection_expression(self, input: Option<String>) -> Self
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
sourcepub fn get_api_key_selection_expression(&self) -> &Option<String>
pub fn get_api_key_selection_expression(&self) -> &Option<String>
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
sourcepub fn cors_configuration(self, input: Cors) -> Self
pub fn cors_configuration(self, input: Cors) -> Self
A CORS configuration. Supported only for HTTP APIs.
sourcepub fn set_cors_configuration(self, input: Option<Cors>) -> Self
pub fn set_cors_configuration(self, input: Option<Cors>) -> Self
A CORS configuration. Supported only for HTTP APIs.
sourcepub fn get_cors_configuration(&self) -> &Option<Cors>
pub fn get_cors_configuration(&self) -> &Option<Cors>
A CORS configuration. Supported only for HTTP APIs.
sourcepub fn credentials_arn(self, input: impl Into<String>) -> Self
pub fn credentials_arn(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_credentials_arn(self, input: Option<String>) -> Self
pub fn set_credentials_arn(self, input: Option<String>) -> Self
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.
sourcepub fn get_credentials_arn(&self) -> &Option<String>
pub fn get_credentials_arn(&self) -> &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.
sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description of the API.
sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description of the API.
sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description of the API.
sourcepub fn disable_schema_validation(self, input: bool) -> Self
pub fn disable_schema_validation(self, input: bool) -> Self
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
sourcepub fn set_disable_schema_validation(self, input: Option<bool>) -> Self
pub fn set_disable_schema_validation(self, input: Option<bool>) -> Self
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
sourcepub fn get_disable_schema_validation(&self) -> &Option<bool>
pub fn get_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, input: bool) -> Self
pub fn disable_execute_api_endpoint(self, input: bool) -> Self
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 set_disable_execute_api_endpoint(self, input: Option<bool>) -> Self
pub fn set_disable_execute_api_endpoint(self, input: Option<bool>) -> Self
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 get_disable_execute_api_endpoint(&self) -> &Option<bool>
pub fn get_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 route_key(self, input: impl Into<String>) -> Self
pub fn route_key(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_route_key(self, input: Option<String>) -> Self
pub fn set_route_key(self, input: Option<String>) -> Self
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.
sourcepub fn get_route_key(&self) -> &Option<String>
pub fn get_route_key(&self) -> &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.
sourcepub fn route_selection_expression(self, input: impl Into<String>) -> Self
pub fn route_selection_expression(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_route_selection_expression(self, input: Option<String>) -> Self
pub fn set_route_selection_expression(self, input: Option<String>) -> Self
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.
sourcepub fn get_route_selection_expression(&self) -> &Option<String>
pub fn get_route_selection_expression(&self) -> &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.
sourcepub fn target(self, input: impl Into<String>) -> Self
pub fn target(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_target(self, input: Option<String>) -> Self
pub fn set_target(self, input: Option<String>) -> Self
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.
sourcepub fn get_target(&self) -> &Option<String>
pub fn get_target(&self) -> &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.
sourcepub fn set_version(self, input: Option<String>) -> Self
pub fn set_version(self, input: Option<String>) -> Self
A version identifier for the API.
sourcepub fn get_version(&self) -> &Option<String>
pub fn get_version(&self) -> &Option<String>
A version identifier for the API.
Trait Implementations§
source§impl Clone for UpdateApiFluentBuilder
impl Clone for UpdateApiFluentBuilder
source§fn clone(&self) -> UpdateApiFluentBuilder
fn clone(&self) -> UpdateApiFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for UpdateApiFluentBuilder
impl !RefUnwindSafe for UpdateApiFluentBuilder
impl Send for UpdateApiFluentBuilder
impl Sync for UpdateApiFluentBuilder
impl Unpin for UpdateApiFluentBuilder
impl !UnwindSafe for UpdateApiFluentBuilder
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