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.
This is the response object from the CreateApi operation.
Namespace: Amazon.ApiGatewayV2.Model
Assembly: AWSSDK.ApiGatewayV2.dll
Version: 3.x.y.z
public class CreateApiResponse : AmazonWebServiceResponse
The CreateApiResponse type exposes the following members
Name | Description | |
---|---|---|
CreateApiResponse() |
Name | Type | Description | |
---|---|---|---|
ApiEndpoint | System.String |
Gets and sets the property ApiEndpoint. The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage. |
|
ApiGatewayManaged | System.Boolean |
Gets and sets the property ApiGatewayManaged. Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it. |
|
ApiId | System.String |
Gets and sets the property ApiId. The API ID. |
|
ApiKeySelectionExpression | System.String |
Gets and sets the property ApiKeySelectionExpression. An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions. |
|
ContentLength | System.Int64 | Inherited from Amazon.Runtime.AmazonWebServiceResponse. | |
CorsConfiguration | Amazon.ApiGatewayV2.Model.Cors |
Gets and sets the property CorsConfiguration. A CORS configuration. Supported only for HTTP APIs. |
|
CreatedDate | System.DateTime |
Gets and sets the property CreatedDate. The timestamp when the API was created. |
|
Description | System.String |
Gets and sets the property Description. The description of the API. |
|
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. |
|
DisableSchemaValidation | System.Boolean |
Gets and sets the property DisableSchemaValidation. Avoid validating models when creating a deployment. Supported only for WebSocket APIs. |
|
HttpStatusCode | System.Net.HttpStatusCode | Inherited from Amazon.Runtime.AmazonWebServiceResponse. | |
ImportInfo | System.Collections.Generic.List<System.String> |
Gets and sets the property ImportInfo. The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs. |
|
Name | System.String |
Gets and sets the property Name. The name of the API. |
|
ProtocolType | Amazon.ApiGatewayV2.ProtocolType |
Gets and sets the property ProtocolType. The API protocol. |
|
ResponseMetadata | Amazon.Runtime.ResponseMetadata | Inherited from Amazon.Runtime.AmazonWebServiceResponse. | |
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. |
|
Tags | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property Tags. A collection of tags associated with the API. |
|
Version | System.String |
Gets and sets the property Version. A version identifier for the API. |
|
Warnings | System.Collections.Generic.List<System.String> |
Gets and sets the property Warnings. The warning messages reported when failonwarnings is turned on during API import. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5