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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | BinaryMediaTypes |
Amazon.PowerShell.Cmdlets.AG.AmazonAPIGatewayClientCmdlet.ClientConfig
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The ID of the RestApi that you want to clone from.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The description of the RestApi.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-DisableExecuteApiEndpoint <
Boolean>
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
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | EndpointConfiguration_Types |
-EndpointConfiguration_VpcEndpointId <
String[]>
A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | EndpointConfiguration_VpcEndpointIds |
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-MinimumCompressionSize <
Int32>
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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The name of the RestApi.
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.APIGateway.Model.CreateRestApiResponse). Specifying the name of a property of type Amazon.APIGateway.Model.CreateRestApiResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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 aws:. The tag value can be up to 256 characters.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Tags |
A version identifier for the API.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |