Struct aws_sdk_apigatewayv2::client::fluent_builders::UpdateApi

pub struct UpdateApi<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to UpdateApi.

Updates an Api resource.

Implementations

impl<C, M, R> UpdateApi<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(self) -> Result<UpdateApiOutput, SdkError<UpdateApiError>> where
    R::Policy: SmithyRetryPolicy<UpdateApiInputOperationOutputAlias, UpdateApiOutput, UpdateApiError, UpdateApiInputOperationRetryAlias>, 

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.

pub fn api_id(self, input: impl Into<String>) -> Self

The API identifier.

pub fn set_api_id(self, input: Option<String>) -> Self

The API identifier.

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.

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.

pub fn cors_configuration(self, input: Cors) -> Self

A CORS configuration. Supported only for HTTP APIs.

pub fn set_cors_configuration(self, input: Option<Cors>) -> Self

A CORS configuration. Supported only for HTTP APIs.

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.

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.

pub fn description(self, input: impl Into<String>) -> Self

The description of the API.

pub fn set_description(self, input: Option<String>) -> Self

The description of the API.

pub fn disable_schema_validation(self, input: bool) -> Self

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

pub fn set_disable_schema_validation(self, input: Option<bool>) -> Self

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

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.

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.

pub fn name(self, input: impl Into<String>) -> Self

The name of the API.

pub fn set_name(self, input: Option<String>) -> Self

The name of the API.

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.

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.

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.

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.

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.

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.

pub fn version(self, input: impl Into<String>) -> Self

A version identifier for the API.

pub fn set_version(self, input: Option<String>) -> Self

A version identifier for the API.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for UpdateApi<C, M, R>

fn clone(&self) -> UpdateApi<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for UpdateApi<C, M, R>

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

Formats the value using the given formatter.