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 CreateRestApi operation. Creates a new RestApi resource.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.APIGateway.AmazonAPIGatewayRequest
      Amazon.APIGateway.Model.CreateRestApiRequest

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

Syntax

C#
public class CreateRestApiRequest : AmazonAPIGatewayRequest
         IAmazonWebServiceRequest

The CreateRestApiRequest type exposes the following members

Constructors

NameDescription
Public Method CreateRestApiRequest()

Properties

NameTypeDescription
Public Property ApiKeySource Amazon.APIGateway.ApiKeySourceType

Gets and sets the property ApiKeySource.

The source of the API key for metering requests according to a usage plan. Valid values are:

  • HEADER to read the API key from the X-API-Key header of a request.
  • AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

Public Property BinaryMediaTypes System.Collections.Generic.List<System.String>

Gets and sets the property BinaryMediaTypes.

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Public Property CloneFrom System.String

Gets and sets the property CloneFrom.

The ID of the RestApi that you want to clone from.

Public Property Description System.String

Gets and sets the property Description.

The description of the RestApi.

Public Property EndpointConfiguration Amazon.APIGateway.Model.EndpointConfiguration

Gets and sets the property EndpointConfiguration.

The endpoint configuration of this RestApi showing the endpoint types of the API.

Public Property MinimumCompressionSize System.Int32

Gets and sets the property MinimumCompressionSize.

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

Public Property Name System.String

Gets and sets the property Name.

[Required] The name of the RestApi.

Public Property Policy System.String

Gets and sets the property Policy. A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

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