Struct aws_sdk_apigatewayv2::input::UpdateApiInput

#[non_exhaustive]
pub struct UpdateApiInput {
    pub api_id: Option<String>,
    pub api_key_selection_expression: Option<String>,
    pub cors_configuration: Option<Cors>,
    pub credentials_arn: Option<String>,
    pub description: Option<String>,
    pub disable_schema_validation: bool,
    pub disable_execute_api_endpoint: bool,
    pub name: Option<String>,
    pub route_key: Option<String>,
    pub route_selection_expression: Option<String>,
    pub target: Option<String>,
    pub version: Option<String>,
}

Updates an Api.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

api_id: Option<String>

The API identifier.

api_key_selection_expression: Option<String>

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

cors_configuration: Option<Cors>

A CORS configuration. Supported only for HTTP APIs.

credentials_arn: 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, 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.

description: Option<String>

The description of the API.

disable_schema_validation: bool

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

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

name: Option<String>

The name of the API.

route_key: Option<String>

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.

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

target: Option<String>

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.

version: Option<String>

A version identifier for the API.

Implementations

impl UpdateApiInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<UpdateApi, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<UpdateApi>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture UpdateApiInput.

impl UpdateApiInput

pub fn api_id(&self) -> Option<&str>

The API identifier.

pub fn api_key_selection_expression(&self) -> Option<&str>

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

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

A CORS configuration. Supported only for HTTP APIs.

pub fn credentials_arn(&self) -> Option<&str>

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.

pub fn description(&self) -> Option<&str>

The description of the API.

pub fn disable_schema_validation(&self) -> bool

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

pub fn disable_execute_api_endpoint(&self) -> 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) -> Option<&str>

The name of the API.

pub fn route_key(&self) -> Option<&str>

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.

pub fn route_selection_expression(&self) -> Option<&str>

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 target(&self) -> Option<&str>

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.

pub fn version(&self) -> Option<&str>

A version identifier for the API.

Trait Implementations

impl Clone for UpdateApiInput

fn clone(&self) -> UpdateApiInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateApiInput

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

Formats the value using the given formatter.

impl PartialEq<UpdateApiInput> for UpdateApiInput

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

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

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

This method tests for !=.

impl StructuralPartialEq for UpdateApiInput