pub struct CreateRestApiFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateRestApi
.
Creates a new RestApi resource.
Implementations§
source§impl CreateRestApiFluentBuilder
impl CreateRestApiFluentBuilder
sourcepub fn as_input(&self) -> &CreateRestApiInputBuilder
pub fn as_input(&self) -> &CreateRestApiInputBuilder
Access the CreateRestApi as a reference.
sourcepub async fn send(
self
) -> Result<CreateRestApiOutput, SdkError<CreateRestApiError, HttpResponse>>
pub async fn send( self ) -> Result<CreateRestApiOutput, SdkError<CreateRestApiError, 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<CreateRestApiOutput, CreateRestApiError, Self>
pub fn customize( self ) -> CustomizableOperation<CreateRestApiOutput, CreateRestApiError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description of the RestApi.
sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description of the RestApi.
sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description of the RestApi.
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 clone_from(self, input: impl Into<String>) -> Self
pub fn clone_from(self, input: impl Into<String>) -> Self
The ID of the RestApi that you want to clone from.
sourcepub fn set_clone_from(self, input: Option<String>) -> Self
pub fn set_clone_from(self, input: Option<String>) -> Self
The ID of the RestApi that you want to clone from.
sourcepub fn get_clone_from(&self) -> &Option<String>
pub fn get_clone_from(&self) -> &Option<String>
The ID of the RestApi that you want to clone from.
sourcepub fn binary_media_types(self, input: impl Into<String>) -> Self
pub fn binary_media_types(self, input: impl Into<String>) -> Self
Appends an item to binaryMediaTypes
.
To override the contents of this collection use set_binary_media_types
.
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
sourcepub fn set_binary_media_types(self, input: Option<Vec<String>>) -> Self
pub fn set_binary_media_types(self, input: Option<Vec<String>>) -> Self
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
sourcepub fn get_binary_media_types(&self) -> &Option<Vec<String>>
pub fn get_binary_media_types(&self) -> &Option<Vec<String>>
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
sourcepub fn minimum_compression_size(self, input: i32) -> Self
pub fn minimum_compression_size(self, input: i32) -> Self
A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
sourcepub fn set_minimum_compression_size(self, input: Option<i32>) -> Self
pub fn set_minimum_compression_size(self, input: Option<i32>) -> Self
A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
sourcepub fn get_minimum_compression_size(&self) -> &Option<i32>
pub fn get_minimum_compression_size(&self) -> &Option<i32>
A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
sourcepub fn api_key_source(self, input: ApiKeySourceType) -> Self
pub fn api_key_source(self, input: ApiKeySourceType) -> Self
The source of the API key for metering requests according to a usage plan. Valid values are: HEADER
to read the API key from the X-API-Key
header of a request. AUTHORIZER
to read the API key from the UsageIdentifierKey
from a custom authorizer.
sourcepub fn set_api_key_source(self, input: Option<ApiKeySourceType>) -> Self
pub fn set_api_key_source(self, input: Option<ApiKeySourceType>) -> Self
The source of the API key for metering requests according to a usage plan. Valid values are: HEADER
to read the API key from the X-API-Key
header of a request. AUTHORIZER
to read the API key from the UsageIdentifierKey
from a custom authorizer.
sourcepub fn get_api_key_source(&self) -> &Option<ApiKeySourceType>
pub fn get_api_key_source(&self) -> &Option<ApiKeySourceType>
The source of the API key for metering requests according to a usage plan. Valid values are: HEADER
to read the API key from the X-API-Key
header of a request. AUTHORIZER
to read the API key from the UsageIdentifierKey
from a custom authorizer.
sourcepub fn endpoint_configuration(self, input: EndpointConfiguration) -> Self
pub fn endpoint_configuration(self, input: EndpointConfiguration) -> Self
The endpoint configuration of this RestApi showing the endpoint types of the API.
sourcepub fn set_endpoint_configuration(
self,
input: Option<EndpointConfiguration>
) -> Self
pub fn set_endpoint_configuration( self, input: Option<EndpointConfiguration> ) -> Self
The endpoint configuration of this RestApi showing the endpoint types of the API.
sourcepub fn get_endpoint_configuration(&self) -> &Option<EndpointConfiguration>
pub fn get_endpoint_configuration(&self) -> &Option<EndpointConfiguration>
The endpoint configuration of this RestApi showing the endpoint types of the API.
sourcepub fn policy(self, input: impl Into<String>) -> Self
pub fn policy(self, input: impl Into<String>) -> Self
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
sourcepub fn set_policy(self, input: Option<String>) -> Self
pub fn set_policy(self, input: Option<String>) -> Self
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
sourcepub fn get_policy(&self) -> &Option<String>
pub fn get_policy(&self) -> &Option<String>
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
Adds a key-value pair to tags
.
To override the contents of this collection use set_tags
.
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:
. The tag value can be up to 256 characters.
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:
. The tag value can be up to 256 characters.
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:
. The tag value can be up to 256 characters.
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
Trait Implementations§
source§impl Clone for CreateRestApiFluentBuilder
impl Clone for CreateRestApiFluentBuilder
source§fn clone(&self) -> CreateRestApiFluentBuilder
fn clone(&self) -> CreateRestApiFluentBuilder
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 CreateRestApiFluentBuilder
impl !RefUnwindSafe for CreateRestApiFluentBuilder
impl Send for CreateRestApiFluentBuilder
impl Sync for CreateRestApiFluentBuilder
impl Unpin for CreateRestApiFluentBuilder
impl !UnwindSafe for CreateRestApiFluentBuilder
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