Struct aws_sdk_apigateway::client::fluent_builders::CreateRestApi

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

Fluent builder constructing a request to CreateRestApi.

Creates a new RestApi resource.

Implementations

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

pub async fn send(
    self
) -> Result<CreateRestApiOutput, SdkError<CreateRestApiError>> where
    R::Policy: SmithyRetryPolicy<CreateRestApiInputOperationOutputAlias, CreateRestApiOutput, CreateRestApiError, CreateRestApiInputOperationRetryAlias>, 

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 name(self, input: impl Into<String>) -> Self

[Required] The name of the RestApi.

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

[Required] The name of the RestApi.

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

The description of the RestApi.

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

The description of the RestApi.

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.

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

The ID of the RestApi that you want to clone from.

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

The ID of the RestApi that you want to clone from.

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.

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.

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.

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.

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.

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.

pub fn endpoint_configuration(self, input: EndpointConfiguration) -> Self

The endpoint configuration of this RestApi showing the endpoint types of the API.

pub fn set_endpoint_configuration(
    self,
    input: Option<EndpointConfiguration>
) -> Self

The endpoint configuration of this RestApi showing the endpoint types of the API.

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.

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.

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

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.

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

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.

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.

Trait Implementations

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

fn clone(&self) -> CreateRestApi<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 CreateRestApi<C, M, R>

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

Formats the value using the given formatter.