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 CreateApi operation. Creates an Api resource.

Inheritance Hierarchy

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

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

Syntax

C#
public class CreateApiRequest : AmazonApiGatewayV2Request
         IAmazonWebServiceRequest

The CreateApiRequest type exposes the following members

Constructors

NameDescription
Public Method CreateApiRequest()

Properties

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

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. Supported only for HTTP APIs.

Public Property Description System.String

Gets and sets the property Description.

The description of the API.

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 ProtocolType Amazon.ApiGatewayV2.ProtocolType

Gets and sets the property ProtocolType.

The API protocol.

Public Property RouteKey System.String

Gets and sets the property RouteKey.

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.

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 Tags System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Tags.

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

Public Property Target System.String

Gets and sets the property Target.

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.

Public Property Version System.String

Gets and sets the property Version.

A version identifier for the API.

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms