Struct aws_sdk_apigatewayv2::operation::create_api::builders::CreateApiOutputBuilder

#[non_exhaustive]
pub struct CreateApiOutputBuilder { /* private fields */ }

A builder for CreateApiOutput.

Implementations

impl CreateApiOutputBuilder

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

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

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

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

pub fn get_api_endpoint(&self) -> &Option<String>

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

pub fn api_gateway_managed(self, input: bool) -> Self

Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

pub fn set_api_gateway_managed(self, input: Option<bool>) -> Self

Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

pub fn get_api_gateway_managed(&self) -> &Option<bool>

Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

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

The API ID.

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

The API ID.

pub fn get_api_id(&self) -> &Option<String>

The API ID.

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.

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.

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.

pub fn cors_configuration(self, input: Cors) -> Self

A CORS configuration. Supported only for HTTP APIs.

pub fn set_cors_configuration(self, input: Option<Cors>) -> Self

A CORS configuration. Supported only for HTTP APIs.

pub fn get_cors_configuration(&self) -> &Option<Cors>

A CORS configuration. Supported only for HTTP APIs.

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 get_created_date(&self) -> &Option<DateTime>

The timestamp when the API was created.

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

The description of the API.

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

The description of the API.

pub fn get_description(&self) -> &Option<String>

The description of the API.

pub fn disable_schema_validation(self, input: bool) -> Self

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

pub fn set_disable_schema_validation(self, input: Option<bool>) -> Self

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

pub fn get_disable_schema_validation(&self) -> &Option<bool>

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

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 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.

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

Appends an item to import_info.

To override the contents of this collection use set_import_info.

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

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

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

pub fn get_import_info(&self) -> &Option<Vec<String>>

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

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

The name of the API.

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

The name of the API.

pub fn get_name(&self) -> &Option<String>

The name of the API.

pub fn protocol_type(self, input: ProtocolType) -> Self

The API protocol.

pub fn set_protocol_type(self, input: Option<ProtocolType>) -> Self

The API protocol.

pub fn get_protocol_type(&self) -> &Option<ProtocolType>

The API protocol.

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.

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.

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.

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.

A collection of tags associated with the API.

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

A collection of tags associated with the API.

pub fn get_tags(&self) -> &Option<HashMap<String, String>>

A collection of tags associated with the API.

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 get_version(&self) -> &Option<String>

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 get_warnings(&self) -> &Option<Vec<String>>

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

pub fn build(self) -> CreateApiOutput

Consumes the builder and constructs a CreateApiOutput.

Trait Implementations

impl Clone for CreateApiOutputBuilder

fn clone(&self) -> CreateApiOutputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateApiOutputBuilder

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

Formats the value using the given formatter.

impl Default for CreateApiOutputBuilder

fn default() -> CreateApiOutputBuilder

Returns the “default value” for a type.

impl PartialEq for CreateApiOutputBuilder

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateApiOutputBuilder