1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::update_api::_update_api_output::UpdateApiOutputBuilder;
pub use crate::operation::update_api::_update_api_input::UpdateApiInputBuilder;
/// Fluent builder constructing a request to `UpdateApi`.
///
/// <p>Updates an Api resource.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct UpdateApiFluentBuilder {
handle: std::sync::Arc<crate::client::Handle>,
inner: crate::operation::update_api::builders::UpdateApiInputBuilder,
}
impl UpdateApiFluentBuilder {
/// Creates a new `UpdateApi`.
pub(crate) fn new(handle: std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::client::customize::CustomizableOperation<
crate::operation::update_api::UpdateApi,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<crate::operation::update_api::UpdateApiError>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::client::customize::CustomizableOperation { handle, operation })
}
/// 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](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::operation::update_api::UpdateApiOutput,
aws_smithy_http::result::SdkError<crate::operation::update_api::UpdateApiError>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>The API identifier.</p>
pub fn api_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.api_id(input.into());
self
}
/// <p>The API identifier.</p>
pub fn set_api_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_api_id(input);
self
}
/// <p>An API key selection expression. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions">API Key Selection Expressions</a>.</p>
pub fn api_key_selection_expression(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.api_key_selection_expression(input.into());
self
}
/// <p>An API key selection expression. Supported only for WebSocket APIs. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions">API Key Selection Expressions</a>.</p>
pub fn set_api_key_selection_expression(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_api_key_selection_expression(input);
self
}
/// <p>A CORS configuration. Supported only for HTTP APIs.</p>
pub fn cors_configuration(mut self, input: crate::types::Cors) -> Self {
self.inner = self.inner.cors_configuration(input);
self
}
/// <p>A CORS configuration. Supported only for HTTP APIs.</p>
pub fn set_cors_configuration(
mut self,
input: std::option::Option<crate::types::Cors>,
) -> Self {
self.inner = self.inner.set_cors_configuration(input);
self
}
/// <p>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.</p>
pub fn credentials_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.credentials_arn(input.into());
self
}
/// <p>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.</p>
pub fn set_credentials_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_credentials_arn(input);
self
}
/// <p>The description of the API.</p>
pub fn description(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.description(input.into());
self
}
/// <p>The description of the API.</p>
pub fn set_description(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_description(input);
self
}
/// <p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>
pub fn disable_schema_validation(mut self, input: bool) -> Self {
self.inner = self.inner.disable_schema_validation(input);
self
}
/// <p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>
pub fn set_disable_schema_validation(mut self, input: std::option::Option<bool>) -> Self {
self.inner = self.inner.set_disable_schema_validation(input);
self
}
/// <p>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.</p>
pub fn disable_execute_api_endpoint(mut self, input: bool) -> Self {
self.inner = self.inner.disable_execute_api_endpoint(input);
self
}
/// <p>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.</p>
pub fn set_disable_execute_api_endpoint(mut self, input: std::option::Option<bool>) -> Self {
self.inner = self.inner.set_disable_execute_api_endpoint(input);
self
}
/// <p>The name of the API.</p>
pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p>The name of the API.</p>
pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// <p>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.</p>
pub fn route_key(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.route_key(input.into());
self
}
/// <p>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.</p>
pub fn set_route_key(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_route_key(input);
self
}
/// <p>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.</p>
pub fn route_selection_expression(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.route_selection_expression(input.into());
self
}
/// <p>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.</p>
pub fn set_route_selection_expression(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_route_selection_expression(input);
self
}
/// <p>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.</p>
pub fn target(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.target(input.into());
self
}
/// <p>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.</p>
pub fn set_target(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_target(input);
self
}
/// <p>A version identifier for the API.</p>
pub fn version(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.version(input.into());
self
}
/// <p>A version identifier for the API.</p>
pub fn set_version(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_version(input);
self
}
}