Struct aws_sdk_apigatewayv2::input::update_api_input::Builder

pub struct Builder { /* private fields */ }

A builder for UpdateApiInput.

Implementations

impl Builder

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

The API identifier.

Examples found in repository

src/client.rs (line 7886)

        pub fn api_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.api_id(input.into());
            self
        }

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

The API identifier.

Examples found in repository

src/client.rs (line 7891)

        pub fn set_api_id(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_api_id(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 7899)

        pub fn api_key_selection_expression(
            mut self,
            input: impl Into<std::string::String>,
        ) -> Self {
            self.inner = self.inner.api_key_selection_expression(input.into());
            self
        }

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.

Examples found in repository

src/client.rs (line 7907)

        pub fn set_api_key_selection_expression(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_api_key_selection_expression(input);
            self
        }

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

A CORS configuration. Supported only for HTTP APIs.

Examples found in repository

src/client.rs (line 7912)

        pub fn cors_configuration(mut self, input: crate::model::Cors) -> Self {
            self.inner = self.inner.cors_configuration(input);
            self
        }

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

A CORS configuration. Supported only for HTTP APIs.

Examples found in repository

src/client.rs (line 7920)

        pub fn set_cors_configuration(
            mut self,
            input: std::option::Option<crate::model::Cors>,
        ) -> Self {
            self.inner = self.inner.set_cors_configuration(input);
            self
        }

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, don't specify this parameter. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.

Examples found in repository

src/client.rs (line 7925)

        pub fn credentials_arn(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.credentials_arn(input.into());
            self
        }

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, don't specify this parameter. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.

Examples found in repository

src/client.rs (line 7933)

        pub fn set_credentials_arn(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_credentials_arn(input);
            self
        }

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

The description of the API.

Examples found in repository

src/client.rs (line 7938)

        pub fn description(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.description(input.into());
            self
        }

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

The description of the API.

Examples found in repository

src/client.rs (line 7943)

        pub fn set_description(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_description(input);
            self
        }

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

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

Examples found in repository

src/client.rs (line 7948)

        pub fn disable_schema_validation(mut self, input: bool) -> Self {
            self.inner = self.inner.disable_schema_validation(input);
            self
        }

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

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

Examples found in repository

src/client.rs (line 7953)

        pub fn set_disable_schema_validation(mut self, input: std::option::Option<bool>) -> Self {
            self.inner = self.inner.set_disable_schema_validation(input);
            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.

Examples found in repository

src/client.rs (line 7958)

        pub fn disable_execute_api_endpoint(mut self, input: bool) -> Self {
            self.inner = self.inner.disable_execute_api_endpoint(input);
            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.

Examples found in repository

src/client.rs (line 7966)

        pub fn set_disable_execute_api_endpoint(
            mut self,
            input: std::option::Option<bool>,
        ) -> Self {
            self.inner = self.inner.set_disable_execute_api_endpoint(input);
            self
        }

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

The name of the API.

Examples found in repository

src/client.rs (line 7971)

        pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.name(input.into());
            self
        }

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

The name of the API.

Examples found in repository

src/client.rs (line 7976)

        pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_name(input);
            self
        }

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

This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.

Examples found in repository

src/client.rs (line 7981)

        pub fn route_key(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.route_key(input.into());
            self
        }

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

This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.

Examples found in repository

src/client.rs (line 7986)

        pub fn set_route_key(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_route_key(input);
            self
        }

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.

Examples found in repository

src/client.rs (line 7991)

        pub fn route_selection_expression(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.route_selection_expression(input.into());
            self
        }

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.

Examples found in repository

src/client.rs (line 7999)

        pub fn set_route_selection_expression(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_route_selection_expression(input);
            self
        }

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

This property is part of quick create. 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. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.

Examples found in repository

src/client.rs (line 8004)

        pub fn target(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.target(input.into());
            self
        }

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

This property is part of quick create. 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. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.

Examples found in repository

src/client.rs (line 8009)

        pub fn set_target(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_target(input);
            self
        }

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

A version identifier for the API.

Examples found in repository

src/client.rs (line 8014)

        pub fn version(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.version(input.into());
            self
        }

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

A version identifier for the API.

Examples found in repository

src/client.rs (line 8019)

        pub fn set_version(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_version(input);
            self
        }

pub fn build(self) -> Result<UpdateApiInput, BuildError>

Consumes the builder and constructs a UpdateApiInput.

Examples found in repository

src/client.rs (line 7853)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::UpdateApi,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::UpdateApiError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// 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](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::UpdateApiOutput,
            aws_smithy_http::result::SdkError<crate::error::UpdateApiError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

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: &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 Builder