Struct aws_sdk_apigatewayv2::operation::create_api::builders::CreateApiFluentBuilder

pub struct CreateApiFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateApi.

Creates an Api resource.

Implementations

impl CreateApiFluentBuilder

pub fn as_input(&self) -> &CreateApiInputBuilder

Access the CreateApi as a reference.

pub async fn send( self ) -> Result<CreateApiOutput, SdkError<CreateApiError, 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.

pub fn customize( self ) -> CustomizableOperation<CreateApiOutput, CreateApiError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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. See Configuring CORS for more information.

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

A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

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

A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

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, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.

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, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.

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, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.

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

This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.

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

This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.

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

This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.

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.

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 get_tags(&self) -> &Option<HashMap<String, String>>

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

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

This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. 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. Supported only for HTTP APIs.

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

This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. 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. Supported only for HTTP APIs.

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

This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. 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. Supported only for HTTP APIs.

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.

Trait Implementations

impl Clone for CreateApiFluentBuilder

fn clone(&self) -> CreateApiFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateApiFluentBuilder

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

Formats the value using the given formatter.