Struct aws_sdk_apigateway::output::create_rest_api_output::Builder

#[non_exhaustive]
pub struct Builder { /* fields omitted */ }

A builder for CreateRestApiOutput

Implementations

impl Builder

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

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

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

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

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

The API's name.

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

The API's name.

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

The API's description.

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

The API's description.

pub fn created_date(self, input: DateTime) -> Self

The timestamp when the API was created.

pub fn set_created_date(self, input: Option<DateTime>) -> Self

The timestamp when the API was created.

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

Appends an item to warnings.

To override the contents of this collection use set_warnings.

The warning messages reported when failonwarnings is turned on during API import.

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

The warning messages reported when failonwarnings is turned on during API import.

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

Appends an item to binary_media_types.

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 collection of tags. Each tag element is associated with a given resource.

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

The collection of tags. Each tag element is associated with a given resource.

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 build(self) -> CreateRestApiOutput

Consumes the builder and constructs a CreateRestApiOutput

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Builder) -> bool

This method tests for !=.

impl StructuralPartialEq for Builder