AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the UpdateApi operation. Updates an Api resource.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ApiGatewayV2.AmazonApiGatewayV2Request
      Amazon.ApiGatewayV2.Model.UpdateApiRequest

Namespace: Amazon.ApiGatewayV2.Model
Assembly: AWSSDK.ApiGatewayV2.dll
Version: 3.x.y.z

Syntax

C#
public class UpdateApiRequest : AmazonApiGatewayV2Request
         IAmazonWebServiceRequest

The UpdateApiRequest type exposes the following members

Constructors

NameDescription
Public Method UpdateApiRequest()

Properties

NameTypeDescription
Public Property ApiId System.String

Gets and sets the property ApiId.

The API identifier.

Public Property ApiKeySelectionExpression System.String

Gets and sets the property ApiKeySelectionExpression.

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

Public Property CorsConfiguration Amazon.ApiGatewayV2.Model.Cors

Gets and sets the property CorsConfiguration.

A CORS configuration. Supported only for HTTP APIs.

Public Property CredentialsArn System.String

Gets and sets the property CredentialsArn.

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. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.

Public Property Description System.String

Gets and sets the property Description.

The description of the API.

Public Property DisableExecuteApiEndpoint System.Boolean

Gets and sets the property DisableExecuteApiEndpoint.

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.

Public Property DisableSchemaValidation System.Boolean

Gets and sets the property DisableSchemaValidation.

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

Public Property Name System.String

Gets and sets the property Name.

The name of the API.

Public Property RouteKey System.String

Gets and sets the property RouteKey.

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.

Public Property RouteSelectionExpression System.String

Gets and sets the property RouteSelectionExpression.

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.

Public Property Target System.String

Gets and sets the property Target.

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.

Public Property Version System.String

Gets and sets the property Version.

A version identifier for the API.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0, 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5