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.
Namespace: Amazon.APIGateway.Model
Assembly: AWSSDK.APIGateway.dll
Version: 3.x.y.z
public class CreateRestApiRequest : AmazonAPIGatewayRequest IAmazonWebServiceRequest
The CreateRestApiRequest type exposes the following members
Name | Description | |
---|---|---|
CreateRestApiRequest() |
Name | Type | Description | |
---|---|---|---|
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: |
|
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. |
|
CloneFrom | System.String |
Gets and sets the property CloneFrom. The ID of the RestApi that you want to clone from. |
|
Description | System.String |
Gets and sets the property Description. The description of the RestApi. |
|
DisableExecuteApiEndpoint | System.Boolean |
Gets and sets the property DisableExecuteApiEndpoint.
Specifies whether clients can invoke your API by using the default |
|
EndpointConfiguration | Amazon.APIGateway.Model.EndpointConfiguration |
Gets and sets the property EndpointConfiguration. The endpoint configuration of this RestApi showing the endpoint types of the API. |
|
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. |
|
Name | System.String |
Gets and sets the property Name. The name of the RestApi. |
|
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. |
|
Tags | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property Tags.
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag
key can be up to 128 characters and must not start with |
|
Version | System.String |
Gets and sets the property Version. A version identifier for the API. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5