#[non_exhaustive]pub struct UpdateApiInputBuilder { /* private fields */ }
Expand description
A builder for UpdateApiInput
.
Implementations§
Source§impl UpdateApiInputBuilder
impl UpdateApiInputBuilder
Sourcepub fn api_id(self, input: impl Into<String>) -> Self
pub fn api_id(self, input: impl Into<String>) -> Self
The API identifier.
This field is required.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 ip_address_type(self, input: IpAddressType) -> Self
pub fn ip_address_type(self, input: IpAddressType) -> Self
The IP address types that can invoke your API or domain name.
Sourcepub fn set_ip_address_type(self, input: Option<IpAddressType>) -> Self
pub fn set_ip_address_type(self, input: Option<IpAddressType>) -> Self
The IP address types that can invoke your API or domain name.
Sourcepub fn get_ip_address_type(&self) -> &Option<IpAddressType>
pub fn get_ip_address_type(&self) -> &Option<IpAddressType>
The IP address types that can invoke your API or domain name.
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.
Sourcepub fn build(self) -> Result<UpdateApiInput, BuildError>
pub fn build(self) -> Result<UpdateApiInput, BuildError>
Consumes the builder and constructs a UpdateApiInput
.
Source§impl UpdateApiInputBuilder
impl UpdateApiInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<UpdateApiOutput, SdkError<UpdateApiError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<UpdateApiOutput, SdkError<UpdateApiError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for UpdateApiInputBuilder
impl Clone for UpdateApiInputBuilder
Source§fn clone(&self) -> UpdateApiInputBuilder
fn clone(&self) -> UpdateApiInputBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for UpdateApiInputBuilder
impl Debug for UpdateApiInputBuilder
Source§impl Default for UpdateApiInputBuilder
impl Default for UpdateApiInputBuilder
Source§fn default() -> UpdateApiInputBuilder
fn default() -> UpdateApiInputBuilder
Source§impl PartialEq for UpdateApiInputBuilder
impl PartialEq for UpdateApiInputBuilder
impl StructuralPartialEq for UpdateApiInputBuilder
Auto Trait Implementations§
impl Freeze for UpdateApiInputBuilder
impl RefUnwindSafe for UpdateApiInputBuilder
impl Send for UpdateApiInputBuilder
impl Sync for UpdateApiInputBuilder
impl Unpin for UpdateApiInputBuilder
impl UnwindSafe for UpdateApiInputBuilder
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);