Oracle Cloud Infrastructure
getApiDeploymentSpecification
This data source provides details about a specific Api Deployment Specification resource in Oracle Cloud Infrastructure API Gateway service.
Gets an API Deployment specification by identifier.
Example Usage
using Pulumi;
using Oci = Pulumi.Oci;
class MyStack : Stack
{
public MyStack()
{
var testApiDeploymentSpecification = Output.Create(Oci.ApiGateway.GetApiDeploymentSpecification.InvokeAsync(new Oci.ApiGateway.GetApiDeploymentSpecificationArgs
{
ApiId = oci_apigateway_api.Test_api.Id,
}));
}
}
package main
import (
"github.com/pulumi/pulumi-oci/sdk/go/oci/ApiGateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ApiGateway.GetApiDeploymentSpecification(ctx, &apigateway.GetApiDeploymentSpecificationArgs{
ApiId: oci_apigateway_api.Test_api.Id,
}, nil)
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_oci as oci
test_api_deployment_specification = oci.ApiGateway.get_api_deployment_specification(api_id=oci_apigateway_api["test_api"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testApiDeploymentSpecification = oci.ApiGateway.getApiDeploymentSpecification({
apiId: oci_apigateway_api.test_api.id,
});
Coming soon!
Using getApiDeploymentSpecification
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getApiDeploymentSpecification(args: GetApiDeploymentSpecificationArgs, opts?: InvokeOptions): Promise<GetApiDeploymentSpecificationResult>
function getApiDeploymentSpecificationOutput(args: GetApiDeploymentSpecificationOutputArgs, opts?: InvokeOptions): Output<GetApiDeploymentSpecificationResult>
def get_api_deployment_specification(api_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetApiDeploymentSpecificationResult
def get_api_deployment_specification_output(api_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetApiDeploymentSpecificationResult]
func GetApiDeploymentSpecification(ctx *Context, args *GetApiDeploymentSpecificationArgs, opts ...InvokeOption) (*GetApiDeploymentSpecificationResult, error)
func GetApiDeploymentSpecificationOutput(ctx *Context, args *GetApiDeploymentSpecificationOutputArgs, opts ...InvokeOption) GetApiDeploymentSpecificationResultOutput
> Note: This function is named GetApiDeploymentSpecification
in the Go SDK.
public static class GetApiDeploymentSpecification
{
public static Task<GetApiDeploymentSpecificationResult> InvokeAsync(GetApiDeploymentSpecificationArgs args, InvokeOptions? opts = null)
public static Output<GetApiDeploymentSpecificationResult> Invoke(GetApiDeploymentSpecificationInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetApiDeploymentSpecificationResult> getApiDeploymentSpecification(GetApiDeploymentSpecificationArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
Function: oci:ApiGateway/getApiDeploymentSpecification:getApiDeploymentSpecification
Arguments:
# Arguments dictionary
The following arguments are supported:
- Api
Id string The ocid of the API.
- Api
Id string The ocid of the API.
- api
Id String The ocid of the API.
- api
Id string The ocid of the API.
- api_
id str The ocid of the API.
- api
Id String The ocid of the API.
getApiDeploymentSpecification Result
The following output properties are available:
- Api
Id string - Id string
The provider-assigned unique ID for this managed resource.
- Logging
Policies List<GetApi Deployment Specification Logging Policy> Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
- Request
Policies List<GetApi Deployment Specification Request Policy> Behavior applied to any requests received by the API on this route.
- Routes
List<Get
Api Deployment Specification Route> A list of routes that this API exposes.
- Api
Id string - Id string
The provider-assigned unique ID for this managed resource.
- Logging
Policies []GetApi Deployment Specification Logging Policy Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
- Request
Policies []GetApi Deployment Specification Request Policy Behavior applied to any requests received by the API on this route.
- Routes
[]Get
Api Deployment Specification Route A list of routes that this API exposes.
- api
Id String - id String
The provider-assigned unique ID for this managed resource.
- logging
Policies List<GetApi Deployment Specification Logging Policy> Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
- request
Policies List<GetApi Deployment Specification Request Policy> Behavior applied to any requests received by the API on this route.
- routes
List<Get
Api Deployment Specification Route> A list of routes that this API exposes.
- api
Id string - id string
The provider-assigned unique ID for this managed resource.
- logging
Policies GetApi Deployment Specification Logging Policy[] Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
- request
Policies GetApi Deployment Specification Request Policy[] Behavior applied to any requests received by the API on this route.
- routes
Get
Api Deployment Specification Route[] A list of routes that this API exposes.
- api_
id str - id str
The provider-assigned unique ID for this managed resource.
- logging_
policies GetApi Deployment Specification Logging Policy] Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
- request_
policies GetApi Deployment Specification Request Policy] Behavior applied to any requests received by the API on this route.
- routes
Get
Api Deployment Specification Route] A list of routes that this API exposes.
- api
Id String - id String
The provider-assigned unique ID for this managed resource.
- logging
Policies List<Property Map> Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
- request
Policies List<Property Map> Behavior applied to any requests received by the API on this route.
- routes List<Property Map>
A list of routes that this API exposes.
Supporting Types
GetApiDeploymentSpecificationLoggingPolicy
- Access
Logs List<GetApi Deployment Specification Logging Policy Access Log> Configures the logging policies for the access logs of an API Deployment.
- Execution
Logs List<GetApi Deployment Specification Logging Policy Execution Log> Configures the logging policies for the execution logs of an API Deployment.
- Access
Logs []GetApi Deployment Specification Logging Policy Access Log Configures the logging policies for the access logs of an API Deployment.
- Execution
Logs []GetApi Deployment Specification Logging Policy Execution Log Configures the logging policies for the execution logs of an API Deployment.
- access
Logs List<GetApi Deployment Specification Logging Policy Access Log> Configures the logging policies for the access logs of an API Deployment.
- execution
Logs List<GetApi Deployment Specification Logging Policy Execution Log> Configures the logging policies for the execution logs of an API Deployment.
- access
Logs GetApi Deployment Specification Logging Policy Access Log[] Configures the logging policies for the access logs of an API Deployment.
- execution
Logs GetApi Deployment Specification Logging Policy Execution Log[] Configures the logging policies for the execution logs of an API Deployment.
- access_
logs GetApi Deployment Specification Logging Policy Access Log] Configures the logging policies for the access logs of an API Deployment.
- execution_
logs GetApi Deployment Specification Logging Policy Execution Log] Configures the logging policies for the execution logs of an API Deployment.
- access
Logs List<Property Map> Configures the logging policies for the access logs of an API Deployment.
- execution
Logs List<Property Map> Configures the logging policies for the execution logs of an API Deployment.
GetApiDeploymentSpecificationLoggingPolicyAccessLog
- Is
Enabled bool Whether this policy is currently enabled.
- Is
Enabled bool Whether this policy is currently enabled.
- is
Enabled Boolean Whether this policy is currently enabled.
- is
Enabled boolean Whether this policy is currently enabled.
- is_
enabled bool Whether this policy is currently enabled.
- is
Enabled Boolean Whether this policy is currently enabled.
GetApiDeploymentSpecificationLoggingPolicyExecutionLog
- is_
enabled bool Whether this policy is currently enabled.
- log_
level str Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.
GetApiDeploymentSpecificationRequestPolicy
- Authentications
List<Get
Api Deployment Specification Request Policy Authentication> Information on how to authenticate incoming requests.
- Cors
List<Get
Api Deployment Specification Request Policy Cor> Enable CORS (Cross-Origin-Resource-Sharing) request handling.
- Mutual
Tls List<GetApi Deployment Specification Request Policy Mutual Tl> Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.
- Rate
Limitings List<GetApi Deployment Specification Request Policy Rate Limiting> Limit the number of requests that should be handled for the specified window using a specfic key.
- Authentications
[]Get
Api Deployment Specification Request Policy Authentication Information on how to authenticate incoming requests.
- Cors
[]Get
Api Deployment Specification Request Policy Cor Enable CORS (Cross-Origin-Resource-Sharing) request handling.
- Mutual
Tls []GetApi Deployment Specification Request Policy Mutual Tl Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.
- Rate
Limitings []GetApi Deployment Specification Request Policy Rate Limiting Limit the number of requests that should be handled for the specified window using a specfic key.
- authentications
List<Get
Api Deployment Specification Request Policy Authentication> Information on how to authenticate incoming requests.
- cors
List<Get
Api Deployment Specification Request Policy Cor> Enable CORS (Cross-Origin-Resource-Sharing) request handling.
- mutual
Tls List<GetApi Deployment Specification Request Policy Mutual Tl> Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.
- rate
Limitings List<GetApi Deployment Specification Request Policy Rate Limiting> Limit the number of requests that should be handled for the specified window using a specfic key.
- authentications
Get
Api Deployment Specification Request Policy Authentication[] Information on how to authenticate incoming requests.
- cors
Get
Api Deployment Specification Request Policy Cor[] Enable CORS (Cross-Origin-Resource-Sharing) request handling.
- mutual
Tls GetApi Deployment Specification Request Policy Mutual Tl[] Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.
- rate
Limitings GetApi Deployment Specification Request Policy Rate Limiting[] Limit the number of requests that should be handled for the specified window using a specfic key.
- authentications
Get
Api Deployment Specification Request Policy Authentication] Information on how to authenticate incoming requests.
- cors
Get
Api Deployment Specification Request Policy Cor] Enable CORS (Cross-Origin-Resource-Sharing) request handling.
- mutual_
tls GetApi Deployment Specification Request Policy Mutual Tl] Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.
- rate_
limitings GetApi Deployment Specification Request Policy Rate Limiting] Limit the number of requests that should be handled for the specified window using a specfic key.
- authentications List<Property Map>
Information on how to authenticate incoming requests.
- cors List<Property Map>
Enable CORS (Cross-Origin-Resource-Sharing) request handling.
- mutual
Tls List<Property Map> Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.
- rate
Limitings List<Property Map> Limit the number of requests that should be handled for the specified window using a specfic key.
GetApiDeploymentSpecificationRequestPolicyAuthentication
- Audiences List<string>
The list of intended recipients for the token.
- Function
Id string The OCID of the Oracle Functions function resource.
- Is
Anonymous boolAccess Allowed Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
- Issuers List<string>
A list of parties that could have issued the token.
- Max
Clock doubleSkew In Seconds The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
- Public
Keys List<GetApi Deployment Specification Request Policy Authentication Public Key> A set of Public Keys that will be used to verify the JWT signature.
- Token
Auth stringScheme The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
- Token
Header string The name of the header containing the authentication token.
- Token
Query stringParam The name of the query parameter containing the authentication token.
- Type string
Type of the Response Cache Store Policy.
- Verify
Claims List<GetApi Deployment Specification Request Policy Authentication Verify Claim> A list of claims which should be validated to consider the token valid.
- Audiences []string
The list of intended recipients for the token.
- Function
Id string The OCID of the Oracle Functions function resource.
- Is
Anonymous boolAccess Allowed Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
- Issuers []string
A list of parties that could have issued the token.
- Max
Clock float64Skew In Seconds The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
- Public
Keys []GetApi Deployment Specification Request Policy Authentication Public Key A set of Public Keys that will be used to verify the JWT signature.
- Token
Auth stringScheme The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
- Token
Header string The name of the header containing the authentication token.
- Token
Query stringParam The name of the query parameter containing the authentication token.
- Type string
Type of the Response Cache Store Policy.
- Verify
Claims []GetApi Deployment Specification Request Policy Authentication Verify Claim A list of claims which should be validated to consider the token valid.
- audiences List<String>
The list of intended recipients for the token.
- function
Id String The OCID of the Oracle Functions function resource.
- is
Anonymous BooleanAccess Allowed Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
- issuers List<String>
A list of parties that could have issued the token.
- max
Clock DoubleSkew In Seconds The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
- public
Keys List<GetApi Deployment Specification Request Policy Authentication Public Key> A set of Public Keys that will be used to verify the JWT signature.
- token
Auth StringScheme The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
- token
Header String The name of the header containing the authentication token.
- token
Query StringParam The name of the query parameter containing the authentication token.
- type String
Type of the Response Cache Store Policy.
- verify
Claims List<GetApi Deployment Specification Request Policy Authentication Verify Claim> A list of claims which should be validated to consider the token valid.
- audiences string[]
The list of intended recipients for the token.
- function
Id string The OCID of the Oracle Functions function resource.
- is
Anonymous booleanAccess Allowed Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
- issuers string[]
A list of parties that could have issued the token.
- max
Clock numberSkew In Seconds The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
- public
Keys GetApi Deployment Specification Request Policy Authentication Public Key[] A set of Public Keys that will be used to verify the JWT signature.
- token
Auth stringScheme The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
- token
Header string The name of the header containing the authentication token.
- token
Query stringParam The name of the query parameter containing the authentication token.
- type string
Type of the Response Cache Store Policy.
- verify
Claims GetApi Deployment Specification Request Policy Authentication Verify Claim[] A list of claims which should be validated to consider the token valid.
- audiences Sequence[str]
The list of intended recipients for the token.
- function_
id str The OCID of the Oracle Functions function resource.
- is_
anonymous_ boolaccess_ allowed Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
- issuers Sequence[str]
A list of parties that could have issued the token.
- max_
clock_ floatskew_ in_ seconds The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
- public_
keys GetApi Deployment Specification Request Policy Authentication Public Key] A set of Public Keys that will be used to verify the JWT signature.
- token_
auth_ strscheme The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
- token_
header str The name of the header containing the authentication token.
- token_
query_ strparam The name of the query parameter containing the authentication token.
- type str
Type of the Response Cache Store Policy.
- verify_
claims GetApi Deployment Specification Request Policy Authentication Verify Claim] A list of claims which should be validated to consider the token valid.
- audiences List<String>
The list of intended recipients for the token.
- function
Id String The OCID of the Oracle Functions function resource.
- is
Anonymous BooleanAccess Allowed Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
- issuers List<String>
A list of parties that could have issued the token.
- max
Clock NumberSkew In Seconds The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
- public
Keys List<Property Map> A set of Public Keys that will be used to verify the JWT signature.
- token
Auth StringScheme The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
- token
Header String The name of the header containing the authentication token.
- token
Query StringParam The name of the query parameter containing the authentication token.
- type String
Type of the Response Cache Store Policy.
- verify
Claims List<Property Map> A list of claims which should be validated to consider the token valid.
GetApiDeploymentSpecificationRequestPolicyAuthenticationPublicKey
- Is
Ssl boolVerify Disabled Defines whether or not to uphold SSL verification.
- Keys
List<Get
Api Deployment Specification Request Policy Authentication Public Key Key> The set of static public keys.
- Max
Cache intDuration In Hours The duration for which the JWKS should be cached before it is fetched again.
- Type string
Type of the Response Cache Store Policy.
- Uri string
The uri from which to retrieve the key. It must be accessible without authentication.
- Is
Ssl boolVerify Disabled Defines whether or not to uphold SSL verification.
- Keys
[]Get
Api Deployment Specification Request Policy Authentication Public Key Key The set of static public keys.
- Max
Cache intDuration In Hours The duration for which the JWKS should be cached before it is fetched again.
- Type string
Type of the Response Cache Store Policy.
- Uri string
The uri from which to retrieve the key. It must be accessible without authentication.
- is
Ssl BooleanVerify Disabled Defines whether or not to uphold SSL verification.
- keys
List<Get
Api Deployment Specification Request Policy Authentication Public Key Key> The set of static public keys.
- max
Cache IntegerDuration In Hours The duration for which the JWKS should be cached before it is fetched again.
- type String
Type of the Response Cache Store Policy.
- uri String
The uri from which to retrieve the key. It must be accessible without authentication.
- is
Ssl booleanVerify Disabled Defines whether or not to uphold SSL verification.
- keys
Get
Api Deployment Specification Request Policy Authentication Public Key Key[] The set of static public keys.
- max
Cache numberDuration In Hours The duration for which the JWKS should be cached before it is fetched again.
- type string
Type of the Response Cache Store Policy.
- uri string
The uri from which to retrieve the key. It must be accessible without authentication.
- is_
ssl_ boolverify_ disabled Defines whether or not to uphold SSL verification.
- keys
Get
Api Deployment Specification Request Policy Authentication Public Key Key] The set of static public keys.
- max_
cache_ intduration_ in_ hours The duration for which the JWKS should be cached before it is fetched again.
- type str
Type of the Response Cache Store Policy.
- uri str
The uri from which to retrieve the key. It must be accessible without authentication.
- is
Ssl BooleanVerify Disabled Defines whether or not to uphold SSL verification.
- keys List<Property Map>
The set of static public keys.
- max
Cache NumberDuration In Hours The duration for which the JWKS should be cached before it is fetched again.
- type String
Type of the Response Cache Store Policy.
- uri String
The uri from which to retrieve the key. It must be accessible without authentication.
GetApiDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey
- Alg string
The algorithm intended for use with this key.
- E string
The base64 url encoded exponent of the RSA public key represented by this key.
- Format string
The format of the public key.
- Key string
Name of the claim.
- Key
Ops List<string> The operations for which this key is to be used.
- Kid string
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
- Kty string
The key type.
- N string
The base64 url encoded modulus of the RSA public key represented by this key.
- Use string
The intended use of the public key.
- Alg string
The algorithm intended for use with this key.
- E string
The base64 url encoded exponent of the RSA public key represented by this key.
- Format string
The format of the public key.
- Key string
Name of the claim.
- Key
Ops []string The operations for which this key is to be used.
- Kid string
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
- Kty string
The key type.
- N string
The base64 url encoded modulus of the RSA public key represented by this key.
- Use string
The intended use of the public key.
- alg String
The algorithm intended for use with this key.
- e String
The base64 url encoded exponent of the RSA public key represented by this key.
- format String
The format of the public key.
- key String
Name of the claim.
- key
Ops List<String> The operations for which this key is to be used.
- kid String
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
- kty String
The key type.
- n String
The base64 url encoded modulus of the RSA public key represented by this key.
- use String
The intended use of the public key.
- alg string
The algorithm intended for use with this key.
- e string
The base64 url encoded exponent of the RSA public key represented by this key.
- format string
The format of the public key.
- key string
Name of the claim.
- key
Ops string[] The operations for which this key is to be used.
- kid string
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
- kty string
The key type.
- n string
The base64 url encoded modulus of the RSA public key represented by this key.
- use string
The intended use of the public key.
- alg str
The algorithm intended for use with this key.
- e str
The base64 url encoded exponent of the RSA public key represented by this key.
- format str
The format of the public key.
- key str
Name of the claim.
- key_
ops Sequence[str] The operations for which this key is to be used.
- kid str
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
- kty str
The key type.
- n str
The base64 url encoded modulus of the RSA public key represented by this key.
- use str
The intended use of the public key.
- alg String
The algorithm intended for use with this key.
- e String
The base64 url encoded exponent of the RSA public key represented by this key.
- format String
The format of the public key.
- key String
Name of the claim.
- key
Ops List<String> The operations for which this key is to be used.
- kid String
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
- kty String
The key type.
- n String
The base64 url encoded modulus of the RSA public key represented by this key.
- use String
The intended use of the public key.
GetApiDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim
- Is
Required bool Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
- Key string
Name of the claim.
- Values List<string>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- Is
Required bool Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
- Key string
Name of the claim.
- Values []string
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- is
Required Boolean Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
- key String
Name of the claim.
- values List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- is
Required boolean Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
- key string
Name of the claim.
- values string[]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- is_
required bool Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
- key str
Name of the claim.
- values Sequence[str]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- is
Required Boolean Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
- key String
Name of the claim.
- values List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
GetApiDeploymentSpecificationRequestPolicyCor
- Allowed
Headers List<string> The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
- Allowed
Methods List<string> The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
- Allowed
Origins List<string> The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
- Exposed
Headers List<string> The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
- Is
Allow boolCredentials Enabled Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
- Max
Age intIn Seconds The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
- Allowed
Headers []string The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
- Allowed
Methods []string The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
- Allowed
Origins []string The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
- Exposed
Headers []string The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
- Is
Allow boolCredentials Enabled Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
- Max
Age intIn Seconds The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
- allowed
Headers List<String> The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
- allowed
Methods List<String> The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
- allowed
Origins List<String> The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
- exposed
Headers List<String> The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
- is
Allow BooleanCredentials Enabled Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
- max
Age IntegerIn Seconds The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
- allowed
Headers string[] The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
- allowed
Methods string[] The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
- allowed
Origins string[] The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
- exposed
Headers string[] The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
- is
Allow booleanCredentials Enabled Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
- max
Age numberIn Seconds The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
- allowed_
headers Sequence[str] The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
- allowed_
methods Sequence[str] The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
- allowed_
origins Sequence[str] The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
- exposed_
headers Sequence[str] The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
- is_
allow_ boolcredentials_ enabled Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
- max_
age_ intin_ seconds The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
- allowed
Headers List<String> The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
- allowed
Methods List<String> The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
- allowed
Origins List<String> The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
- exposed
Headers List<String> The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
- is
Allow BooleanCredentials Enabled Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
- max
Age NumberIn Seconds The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
GetApiDeploymentSpecificationRequestPolicyMutualTl
- Allowed
Sans List<string> Allowed list of CN or SAN which will be used for verification of certificate.
- Is
Verified boolCertificate Required Determines whether to enable client verification when API Consumer makes connection to the gateway.
- Allowed
Sans []string Allowed list of CN or SAN which will be used for verification of certificate.
- Is
Verified boolCertificate Required Determines whether to enable client verification when API Consumer makes connection to the gateway.
- allowed
Sans List<String> Allowed list of CN or SAN which will be used for verification of certificate.
- is
Verified BooleanCertificate Required Determines whether to enable client verification when API Consumer makes connection to the gateway.
- allowed
Sans string[] Allowed list of CN or SAN which will be used for verification of certificate.
- is
Verified booleanCertificate Required Determines whether to enable client verification when API Consumer makes connection to the gateway.
- allowed_
sans Sequence[str] Allowed list of CN or SAN which will be used for verification of certificate.
- is_
verified_ boolcertificate_ required Determines whether to enable client verification when API Consumer makes connection to the gateway.
- allowed
Sans List<String> Allowed list of CN or SAN which will be used for verification of certificate.
- is
Verified BooleanCertificate Required Determines whether to enable client verification when API Consumer makes connection to the gateway.
GetApiDeploymentSpecificationRequestPolicyRateLimiting
- Rate
In intRequests Per Second The maximum number of requests per second to allow.
- Rate
Key string The key used to group requests together.
- Rate
In intRequests Per Second The maximum number of requests per second to allow.
- Rate
Key string The key used to group requests together.
- rate
In IntegerRequests Per Second The maximum number of requests per second to allow.
- rate
Key String The key used to group requests together.
- rate
In numberRequests Per Second The maximum number of requests per second to allow.
- rate
Key string The key used to group requests together.
- rate_
in_ intrequests_ per_ second The maximum number of requests per second to allow.
- rate_
key str The key used to group requests together.
- rate
In NumberRequests Per Second The maximum number of requests per second to allow.
- rate
Key String The key used to group requests together.
GetApiDeploymentSpecificationRoute
- Backends
List<Get
Api Deployment Specification Route Backend> The backend to forward requests to.
- Logging
Policies List<GetApi Deployment Specification Route Logging Policy> Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
- Methods List<string>
A list of allowed methods on this route.
- Path string
A URL path pattern that must be matched on this route. The path pattern may contain a subset of RFC 6570 identifiers to allow wildcard and parameterized matching.
- Request
Policies List<GetApi Deployment Specification Route Request Policy> Behavior applied to any requests received by the API on this route.
- Response
Policies List<GetApi Deployment Specification Route Response Policy> Behavior applied to any responses sent by the API for requests on this route.
- Backends
[]Get
Api Deployment Specification Route Backend The backend to forward requests to.
- Logging
Policies []GetApi Deployment Specification Route Logging Policy Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
- Methods []string
A list of allowed methods on this route.
- Path string
A URL path pattern that must be matched on this route. The path pattern may contain a subset of RFC 6570 identifiers to allow wildcard and parameterized matching.
- Request
Policies []GetApi Deployment Specification Route Request Policy Behavior applied to any requests received by the API on this route.
- Response
Policies []GetApi Deployment Specification Route Response Policy Behavior applied to any responses sent by the API for requests on this route.
- backends
List<Get
Api Deployment Specification Route Backend> The backend to forward requests to.
- logging
Policies List<GetApi Deployment Specification Route Logging Policy> Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
- methods List<String>
A list of allowed methods on this route.
- path String
A URL path pattern that must be matched on this route. The path pattern may contain a subset of RFC 6570 identifiers to allow wildcard and parameterized matching.
- request
Policies List<GetApi Deployment Specification Route Request Policy> Behavior applied to any requests received by the API on this route.
- response
Policies List<GetApi Deployment Specification Route Response Policy> Behavior applied to any responses sent by the API for requests on this route.
- backends
Get
Api Deployment Specification Route Backend[] The backend to forward requests to.
- logging
Policies GetApi Deployment Specification Route Logging Policy[] Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
- methods string[]
A list of allowed methods on this route.
- path string
A URL path pattern that must be matched on this route. The path pattern may contain a subset of RFC 6570 identifiers to allow wildcard and parameterized matching.
- request
Policies GetApi Deployment Specification Route Request Policy[] Behavior applied to any requests received by the API on this route.
- response
Policies GetApi Deployment Specification Route Response Policy[] Behavior applied to any responses sent by the API for requests on this route.
- backends
Get
Api Deployment Specification Route Backend] The backend to forward requests to.
- logging_
policies GetApi Deployment Specification Route Logging Policy] Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
- methods Sequence[str]
A list of allowed methods on this route.
- path str
A URL path pattern that must be matched on this route. The path pattern may contain a subset of RFC 6570 identifiers to allow wildcard and parameterized matching.
- request_
policies GetApi Deployment Specification Route Request Policy] Behavior applied to any requests received by the API on this route.
- response_
policies GetApi Deployment Specification Route Response Policy] Behavior applied to any responses sent by the API for requests on this route.
- backends List<Property Map>
The backend to forward requests to.
- logging
Policies List<Property Map> Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
- methods List<String>
A list of allowed methods on this route.
- path String
A URL path pattern that must be matched on this route. The path pattern may contain a subset of RFC 6570 identifiers to allow wildcard and parameterized matching.
- request
Policies List<Property Map> Behavior applied to any requests received by the API on this route.
- response
Policies List<Property Map> Behavior applied to any responses sent by the API for requests on this route.
GetApiDeploymentSpecificationRouteBackend
- Body string
The body of the stock response from the mock backend.
- Connect
Timeout doubleIn Seconds Defines a timeout for establishing a connection with a proxied server.
- Function
Id string The OCID of the Oracle Functions function resource.
- Headers
List<Get
Api Deployment Specification Route Backend Header> - Is
Ssl boolVerify Disabled Defines whether or not to uphold SSL verification.
- Read
Timeout doubleIn Seconds Defines a timeout for reading a response from the proxied server.
- Send
Timeout doubleIn Seconds Defines a timeout for transmitting a request to the proxied server.
- Status int
The status code of the stock response from the mock backend.
- Type string
Type of the Response Cache Store Policy.
- Url string
- Body string
The body of the stock response from the mock backend.
- Connect
Timeout float64In Seconds Defines a timeout for establishing a connection with a proxied server.
- Function
Id string The OCID of the Oracle Functions function resource.
- Headers
[]Get
Api Deployment Specification Route Backend Header - Is
Ssl boolVerify Disabled Defines whether or not to uphold SSL verification.
- Read
Timeout float64In Seconds Defines a timeout for reading a response from the proxied server.
- Send
Timeout float64In Seconds Defines a timeout for transmitting a request to the proxied server.
- Status int
The status code of the stock response from the mock backend.
- Type string
Type of the Response Cache Store Policy.
- Url string
- body String
The body of the stock response from the mock backend.
- connect
Timeout DoubleIn Seconds Defines a timeout for establishing a connection with a proxied server.
- function
Id String The OCID of the Oracle Functions function resource.
- headers
List<Get
Api Deployment Specification Route Backend Header> - is
Ssl BooleanVerify Disabled Defines whether or not to uphold SSL verification.
- read
Timeout DoubleIn Seconds Defines a timeout for reading a response from the proxied server.
- send
Timeout DoubleIn Seconds Defines a timeout for transmitting a request to the proxied server.
- status Integer
The status code of the stock response from the mock backend.
- type String
Type of the Response Cache Store Policy.
- url String
- body string
The body of the stock response from the mock backend.
- connect
Timeout numberIn Seconds Defines a timeout for establishing a connection with a proxied server.
- function
Id string The OCID of the Oracle Functions function resource.
- headers
Get
Api Deployment Specification Route Backend Header[] - is
Ssl booleanVerify Disabled Defines whether or not to uphold SSL verification.
- read
Timeout numberIn Seconds Defines a timeout for reading a response from the proxied server.
- send
Timeout numberIn Seconds Defines a timeout for transmitting a request to the proxied server.
- status number
The status code of the stock response from the mock backend.
- type string
Type of the Response Cache Store Policy.
- url string
- body str
The body of the stock response from the mock backend.
- connect_
timeout_ floatin_ seconds Defines a timeout for establishing a connection with a proxied server.
- function_
id str The OCID of the Oracle Functions function resource.
- headers
Get
Api Deployment Specification Route Backend Header] - is_
ssl_ boolverify_ disabled Defines whether or not to uphold SSL verification.
- read_
timeout_ floatin_ seconds Defines a timeout for reading a response from the proxied server.
- send_
timeout_ floatin_ seconds Defines a timeout for transmitting a request to the proxied server.
- status int
The status code of the stock response from the mock backend.
- type str
Type of the Response Cache Store Policy.
- url str
- body String
The body of the stock response from the mock backend.
- connect
Timeout NumberIn Seconds Defines a timeout for establishing a connection with a proxied server.
- function
Id String The OCID of the Oracle Functions function resource.
- headers List<Property Map>
- is
Ssl BooleanVerify Disabled Defines whether or not to uphold SSL verification.
- read
Timeout NumberIn Seconds Defines a timeout for reading a response from the proxied server.
- send
Timeout NumberIn Seconds Defines a timeout for transmitting a request to the proxied server.
- status Number
The status code of the stock response from the mock backend.
- type String
Type of the Response Cache Store Policy.
- url String
GetApiDeploymentSpecificationRouteBackendHeader
GetApiDeploymentSpecificationRouteLoggingPolicy
- Access
Logs List<GetApi Deployment Specification Route Logging Policy Access Log> Configures the logging policies for the access logs of an API Deployment.
- Execution
Logs List<GetApi Deployment Specification Route Logging Policy Execution Log> Configures the logging policies for the execution logs of an API Deployment.
- Access
Logs []GetApi Deployment Specification Route Logging Policy Access Log Configures the logging policies for the access logs of an API Deployment.
- Execution
Logs []GetApi Deployment Specification Route Logging Policy Execution Log Configures the logging policies for the execution logs of an API Deployment.
- access
Logs List<GetApi Deployment Specification Route Logging Policy Access Log> Configures the logging policies for the access logs of an API Deployment.
- execution
Logs List<GetApi Deployment Specification Route Logging Policy Execution Log> Configures the logging policies for the execution logs of an API Deployment.
- access
Logs GetApi Deployment Specification Route Logging Policy Access Log[] Configures the logging policies for the access logs of an API Deployment.
- execution
Logs GetApi Deployment Specification Route Logging Policy Execution Log[] Configures the logging policies for the execution logs of an API Deployment.
- access_
logs GetApi Deployment Specification Route Logging Policy Access Log] Configures the logging policies for the access logs of an API Deployment.
- execution_
logs GetApi Deployment Specification Route Logging Policy Execution Log] Configures the logging policies for the execution logs of an API Deployment.
- access
Logs List<Property Map> Configures the logging policies for the access logs of an API Deployment.
- execution
Logs List<Property Map> Configures the logging policies for the execution logs of an API Deployment.
GetApiDeploymentSpecificationRouteLoggingPolicyAccessLog
- Is
Enabled bool Whether this policy is currently enabled.
- Is
Enabled bool Whether this policy is currently enabled.
- is
Enabled Boolean Whether this policy is currently enabled.
- is
Enabled boolean Whether this policy is currently enabled.
- is_
enabled bool Whether this policy is currently enabled.
- is
Enabled Boolean Whether this policy is currently enabled.
GetApiDeploymentSpecificationRouteLoggingPolicyExecutionLog
- is_
enabled bool Whether this policy is currently enabled.
- log_
level str Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.
GetApiDeploymentSpecificationRouteRequestPolicy
- List<Get
Api Deployment Specification Route Request Policy Authorization> If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.
- Body
Validations List<GetApi Deployment Specification Route Request Policy Body Validation> Validate the payload body of the incoming API requests on a specific route.
- Cors
List<Get
Api Deployment Specification Route Request Policy Cor> Enable CORS (Cross-Origin-Resource-Sharing) request handling.
- Header
Transformations List<GetApi Deployment Specification Route Request Policy Header Transformation> A set of transformations to apply to HTTP headers that pass through the gateway.
- Header
Validations List<GetApi Deployment Specification Route Request Policy Header Validation> Validate the HTTP headers on the incoming API requests on a specific route.
- Query
Parameter List<GetTransformations Api Deployment Specification Route Request Policy Query Parameter Transformation> A set of transformations to apply to query parameters that pass through the gateway.
- Query
Parameter List<GetValidations Api Deployment Specification Route Request Policy Query Parameter Validation> Validate the URL query parameters on the incoming API requests on a specific route.
- Response
Cache List<GetLookups Api Deployment Specification Route Request Policy Response Cache Lookup> Base policy for Response Cache lookup.
- []Get
Api Deployment Specification Route Request Policy Authorization If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.
- Body
Validations []GetApi Deployment Specification Route Request Policy Body Validation Validate the payload body of the incoming API requests on a specific route.
- Cors
[]Get
Api Deployment Specification Route Request Policy Cor Enable CORS (Cross-Origin-Resource-Sharing) request handling.
- Header
Transformations []GetApi Deployment Specification Route Request Policy Header Transformation A set of transformations to apply to HTTP headers that pass through the gateway.
- Header
Validations []GetApi Deployment Specification Route Request Policy Header Validation Validate the HTTP headers on the incoming API requests on a specific route.
- Query
Parameter []GetTransformations Api Deployment Specification Route Request Policy Query Parameter Transformation A set of transformations to apply to query parameters that pass through the gateway.
- Query
Parameter []GetValidations Api Deployment Specification Route Request Policy Query Parameter Validation Validate the URL query parameters on the incoming API requests on a specific route.
- Response
Cache []GetLookups Api Deployment Specification Route Request Policy Response Cache Lookup Base policy for Response Cache lookup.
- List<Get
Api Deployment Specification Route Request Policy Authorization> If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.
- body
Validations List<GetApi Deployment Specification Route Request Policy Body Validation> Validate the payload body of the incoming API requests on a specific route.
- cors
List<Get
Api Deployment Specification Route Request Policy Cor> Enable CORS (Cross-Origin-Resource-Sharing) request handling.
- header
Transformations List<GetApi Deployment Specification Route Request Policy Header Transformation> A set of transformations to apply to HTTP headers that pass through the gateway.
- header
Validations List<GetApi Deployment Specification Route Request Policy Header Validation> Validate the HTTP headers on the incoming API requests on a specific route.
- query
Parameter List<GetTransformations Api Deployment Specification Route Request Policy Query Parameter Transformation> A set of transformations to apply to query parameters that pass through the gateway.
- query
Parameter List<GetValidations Api Deployment Specification Route Request Policy Query Parameter Validation> Validate the URL query parameters on the incoming API requests on a specific route.
- response
Cache List<GetLookups Api Deployment Specification Route Request Policy Response Cache Lookup> Base policy for Response Cache lookup.
- Get
Api Deployment Specification Route Request Policy Authorization[] If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.
- body
Validations GetApi Deployment Specification Route Request Policy Body Validation[] Validate the payload body of the incoming API requests on a specific route.
- cors
Get
Api Deployment Specification Route Request Policy Cor[] Enable CORS (Cross-Origin-Resource-Sharing) request handling.
- header
Transformations GetApi Deployment Specification Route Request Policy Header Transformation[] A set of transformations to apply to HTTP headers that pass through the gateway.
- header
Validations GetApi Deployment Specification Route Request Policy Header Validation[] Validate the HTTP headers on the incoming API requests on a specific route.
- query
Parameter GetTransformations Api Deployment Specification Route Request Policy Query Parameter Transformation[] A set of transformations to apply to query parameters that pass through the gateway.
- query
Parameter GetValidations Api Deployment Specification Route Request Policy Query Parameter Validation[] Validate the URL query parameters on the incoming API requests on a specific route.
- response
Cache GetLookups Api Deployment Specification Route Request Policy Response Cache Lookup[] Base policy for Response Cache lookup.
- Get
Api Deployment Specification Route Request Policy Authorization] If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.
- body_
validations GetApi Deployment Specification Route Request Policy Body Validation] Validate the payload body of the incoming API requests on a specific route.
- cors
Get
Api Deployment Specification Route Request Policy Cor] Enable CORS (Cross-Origin-Resource-Sharing) request handling.
- header_
transformations GetApi Deployment Specification Route Request Policy Header Transformation] A set of transformations to apply to HTTP headers that pass through the gateway.
- header_
validations GetApi Deployment Specification Route Request Policy Header Validation] Validate the HTTP headers on the incoming API requests on a specific route.
- query_
parameter_ Gettransformations Api Deployment Specification Route Request Policy Query Parameter Transformation] A set of transformations to apply to query parameters that pass through the gateway.
- query_
parameter_ Getvalidations Api Deployment Specification Route Request Policy Query Parameter Validation] Validate the URL query parameters on the incoming API requests on a specific route.
- response_
cache_ Getlookups Api Deployment Specification Route Request Policy Response Cache Lookup] Base policy for Response Cache lookup.
- List<Property Map>
If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.
- body
Validations List<Property Map> Validate the payload body of the incoming API requests on a specific route.
- cors List<Property Map>
Enable CORS (Cross-Origin-Resource-Sharing) request handling.
- header
Transformations List<Property Map> A set of transformations to apply to HTTP headers that pass through the gateway.
- header
Validations List<Property Map> Validate the HTTP headers on the incoming API requests on a specific route.
- query
Parameter List<Property Map>Transformations A set of transformations to apply to query parameters that pass through the gateway.
- query
Parameter List<Property Map>Validations Validate the URL query parameters on the incoming API requests on a specific route.
- response
Cache List<Property Map>Lookups Base policy for Response Cache lookup.
GetApiDeploymentSpecificationRouteRequestPolicyAuthorization
- Allowed
Scopes List<string> A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.
- Type string
Type of the Response Cache Store Policy.
- Allowed
Scopes []string A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.
- Type string
Type of the Response Cache Store Policy.
- allowed
Scopes List<String> A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.
- type String
Type of the Response Cache Store Policy.
- allowed
Scopes string[] A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.
- type string
Type of the Response Cache Store Policy.
- allowed_
scopes Sequence[str] A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.
- type str
Type of the Response Cache Store Policy.
- allowed
Scopes List<String> A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.
- type String
Type of the Response Cache Store Policy.
GetApiDeploymentSpecificationRouteRequestPolicyBodyValidation
- Contents
List<Get
Api Deployment Specification Route Request Policy Body Validation Content> The content of the request body.
- Required bool
Determines if the parameter is required in the request.
- Validation
Mode string Validation behavior mode.
- Contents
[]Get
Api Deployment Specification Route Request Policy Body Validation Content The content of the request body.
- Required bool
Determines if the parameter is required in the request.
- Validation
Mode string Validation behavior mode.
- contents
List<Get
Api Deployment Specification Route Request Policy Body Validation Content> The content of the request body.
- required Boolean
Determines if the parameter is required in the request.
- validation
Mode String Validation behavior mode.
- contents
Get
Api Deployment Specification Route Request Policy Body Validation Content[] The content of the request body.
- required boolean
Determines if the parameter is required in the request.
- validation
Mode string Validation behavior mode.
- contents
Get
Api Deployment Specification Route Request Policy Body Validation Content] The content of the request body.
- required bool
Determines if the parameter is required in the request.
- validation_
mode str Validation behavior mode.
- contents List<Property Map>
The content of the request body.
- required Boolean
Determines if the parameter is required in the request.
- validation
Mode String Validation behavior mode.
GetApiDeploymentSpecificationRouteRequestPolicyBodyValidationContent
- Media
Type string The media type is a media type range subset restricted to the following schema
- Validation
Type string Validation type defines the content validation method.
- Media
Type string The media type is a media type range subset restricted to the following schema
- Validation
Type string Validation type defines the content validation method.
- media
Type String The media type is a media type range subset restricted to the following schema
- validation
Type String Validation type defines the content validation method.
- media
Type string The media type is a media type range subset restricted to the following schema
- validation
Type string Validation type defines the content validation method.
- media_
type str The media type is a media type range subset restricted to the following schema
- validation_
type str Validation type defines the content validation method.
- media
Type String The media type is a media type range subset restricted to the following schema
- validation
Type String Validation type defines the content validation method.
GetApiDeploymentSpecificationRouteRequestPolicyCor
- Allowed
Headers List<string> The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
- Allowed
Methods List<string> The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
- Allowed
Origins List<string> The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
- Exposed
Headers List<string> The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
- Is
Allow boolCredentials Enabled Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
- Max
Age intIn Seconds The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
- Allowed
Headers []string The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
- Allowed
Methods []string The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
- Allowed
Origins []string The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
- Exposed
Headers []string The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
- Is
Allow boolCredentials Enabled Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
- Max
Age intIn Seconds The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
- allowed
Headers List<String> The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
- allowed
Methods List<String> The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
- allowed
Origins List<String> The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
- exposed
Headers List<String> The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
- is
Allow BooleanCredentials Enabled Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
- max
Age IntegerIn Seconds The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
- allowed
Headers string[] The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
- allowed
Methods string[] The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
- allowed
Origins string[] The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
- exposed
Headers string[] The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
- is
Allow booleanCredentials Enabled Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
- max
Age numberIn Seconds The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
- allowed_
headers Sequence[str] The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
- allowed_
methods Sequence[str] The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
- allowed_
origins Sequence[str] The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
- exposed_
headers Sequence[str] The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
- is_
allow_ boolcredentials_ enabled Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
- max_
age_ intin_ seconds The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
- allowed
Headers List<String> The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
- allowed
Methods List<String> The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
- allowed
Origins List<String> The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
- exposed
Headers List<String> The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
- is
Allow BooleanCredentials Enabled Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
- max
Age NumberIn Seconds The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformation
- Filter
Headers List<GetApi Deployment Specification Route Request Policy Header Transformation Filter Header> Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
- Rename
Headers List<GetApi Deployment Specification Route Request Policy Header Transformation Rename Header> Rename HTTP headers as they pass through the gateway.
- Set
Headers List<GetApi Deployment Specification Route Request Policy Header Transformation Set Header> Set HTTP headers as they pass through the gateway.
- Filter
Headers []GetApi Deployment Specification Route Request Policy Header Transformation Filter Header Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
- Rename
Headers []GetApi Deployment Specification Route Request Policy Header Transformation Rename Header Rename HTTP headers as they pass through the gateway.
- Set
Headers []GetApi Deployment Specification Route Request Policy Header Transformation Set Header Set HTTP headers as they pass through the gateway.
- filter
Headers List<GetApi Deployment Specification Route Request Policy Header Transformation Filter Header> Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
- rename
Headers List<GetApi Deployment Specification Route Request Policy Header Transformation Rename Header> Rename HTTP headers as they pass through the gateway.
- set
Headers List<GetApi Deployment Specification Route Request Policy Header Transformation Set Header> Set HTTP headers as they pass through the gateway.
- filter
Headers GetApi Deployment Specification Route Request Policy Header Transformation Filter Header[] Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
- rename
Headers GetApi Deployment Specification Route Request Policy Header Transformation Rename Header[] Rename HTTP headers as they pass through the gateway.
- set
Headers GetApi Deployment Specification Route Request Policy Header Transformation Set Header[] Set HTTP headers as they pass through the gateway.
- filter_
headers GetApi Deployment Specification Route Request Policy Header Transformation Filter Header] Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
- rename_
headers GetApi Deployment Specification Route Request Policy Header Transformation Rename Header] Rename HTTP headers as they pass through the gateway.
- set_
headers GetApi Deployment Specification Route Request Policy Header Transformation Set Header] Set HTTP headers as they pass through the gateway.
- filter
Headers List<Property Map> Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
- rename
Headers List<Property Map> Rename HTTP headers as they pass through the gateway.
- set
Headers List<Property Map> Set HTTP headers as they pass through the gateway.
GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeader
- Items
List<Get
Api Deployment Specification Route Request Policy Header Transformation Filter Header Item> The list of headers.
- Type string
Type of the Response Cache Store Policy.
- Items
[]Get
Api Deployment Specification Route Request Policy Header Transformation Filter Header Item The list of headers.
- Type string
Type of the Response Cache Store Policy.
- items
List<Get
Api Deployment Specification Route Request Policy Header Transformation Filter Header Item> The list of headers.
- type String
Type of the Response Cache Store Policy.
- items
Get
Api Deployment Specification Route Request Policy Header Transformation Filter Header Item[] The list of headers.
- type string
Type of the Response Cache Store Policy.
- items
Get
Api Deployment Specification Route Request Policy Header Transformation Filter Header Item] The list of headers.
- type str
Type of the Response Cache Store Policy.
- items List<Property Map>
The list of headers.
- type String
Type of the Response Cache Store Policy.
GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem
- Name string
The case-insensitive name of the header. This name must be unique across transformation policies.
- Name string
The case-insensitive name of the header. This name must be unique across transformation policies.
- name String
The case-insensitive name of the header. This name must be unique across transformation policies.
- name string
The case-insensitive name of the header. This name must be unique across transformation policies.
- name str
The case-insensitive name of the header. This name must be unique across transformation policies.
- name String
The case-insensitive name of the header. This name must be unique across transformation policies.
GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader
- items List<Property Map>
The list of headers.
GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeaderItem
GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader
- items List<Property Map>
The list of headers.
GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeaderItem
- If
Exists string If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- Name string
The case-insensitive name of the header. This name must be unique across transformation policies.
- Values List<string>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- If
Exists string If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- Name string
The case-insensitive name of the header. This name must be unique across transformation policies.
- Values []string
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- if
Exists String If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- name String
The case-insensitive name of the header. This name must be unique across transformation policies.
- values List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- if
Exists string If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- name string
The case-insensitive name of the header. This name must be unique across transformation policies.
- values string[]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- if_
exists str If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- name str
The case-insensitive name of the header. This name must be unique across transformation policies.
- values Sequence[str]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- if
Exists String If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- name String
The case-insensitive name of the header. This name must be unique across transformation policies.
- values List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
GetApiDeploymentSpecificationRouteRequestPolicyHeaderValidation
- Headers
List<Get
Api Deployment Specification Route Request Policy Header Validation Header> - Validation
Mode string Validation behavior mode.
- Headers
[]Get
Api Deployment Specification Route Request Policy Header Validation Header - Validation
Mode string Validation behavior mode.
- headers
List<Get
Api Deployment Specification Route Request Policy Header Validation Header> - validation
Mode String Validation behavior mode.
- headers
Get
Api Deployment Specification Route Request Policy Header Validation Header[] - validation
Mode string Validation behavior mode.
- headers
Get
Api Deployment Specification Route Request Policy Header Validation Header] - validation_
mode str Validation behavior mode.
- headers List<Property Map>
- validation
Mode String Validation behavior mode.
GetApiDeploymentSpecificationRouteRequestPolicyHeaderValidationHeader
GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation
- Filter
Query List<GetParameters Api Deployment Specification Route Request Policy Query Parameter Transformation Filter Query Parameter> Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.
- Rename
Query List<GetParameters Api Deployment Specification Route Request Policy Query Parameter Transformation Rename Query Parameter> Rename parameters on the query string as they pass through the gateway.
- Set
Query List<GetParameters Api Deployment Specification Route Request Policy Query Parameter Transformation Set Query Parameter> Set parameters on the query string as they pass through the gateway.
- Filter
Query []GetParameters Api Deployment Specification Route Request Policy Query Parameter Transformation Filter Query Parameter Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.
- Rename
Query []GetParameters Api Deployment Specification Route Request Policy Query Parameter Transformation Rename Query Parameter Rename parameters on the query string as they pass through the gateway.
- Set
Query []GetParameters Api Deployment Specification Route Request Policy Query Parameter Transformation Set Query Parameter Set parameters on the query string as they pass through the gateway.
- filter
Query List<GetParameters Api Deployment Specification Route Request Policy Query Parameter Transformation Filter Query Parameter> Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.
- rename
Query List<GetParameters Api Deployment Specification Route Request Policy Query Parameter Transformation Rename Query Parameter> Rename parameters on the query string as they pass through the gateway.
- set
Query List<GetParameters Api Deployment Specification Route Request Policy Query Parameter Transformation Set Query Parameter> Set parameters on the query string as they pass through the gateway.
- filter
Query GetParameters Api Deployment Specification Route Request Policy Query Parameter Transformation Filter Query Parameter[] Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.
- rename
Query GetParameters Api Deployment Specification Route Request Policy Query Parameter Transformation Rename Query Parameter[] Rename parameters on the query string as they pass through the gateway.
- set
Query GetParameters Api Deployment Specification Route Request Policy Query Parameter Transformation Set Query Parameter[] Set parameters on the query string as they pass through the gateway.
- filter_
query_ Getparameters Api Deployment Specification Route Request Policy Query Parameter Transformation Filter Query Parameter] Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.
- rename_
query_ Getparameters Api Deployment Specification Route Request Policy Query Parameter Transformation Rename Query Parameter] Rename parameters on the query string as they pass through the gateway.
- set_
query_ Getparameters Api Deployment Specification Route Request Policy Query Parameter Transformation Set Query Parameter] Set parameters on the query string as they pass through the gateway.
- filter
Query List<Property Map>Parameters Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.
- rename
Query List<Property Map>Parameters Rename parameters on the query string as they pass through the gateway.
- set
Query List<Property Map>Parameters Set parameters on the query string as they pass through the gateway.
GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter
- Items
List<Get
Api Deployment Specification Route Request Policy Query Parameter Transformation Filter Query Parameter Item> The list of headers.
- Type string
Type of the Response Cache Store Policy.
- Items
[]Get
Api Deployment Specification Route Request Policy Query Parameter Transformation Filter Query Parameter Item The list of headers.
- Type string
Type of the Response Cache Store Policy.
- items
List<Get
Api Deployment Specification Route Request Policy Query Parameter Transformation Filter Query Parameter Item> The list of headers.
- type String
Type of the Response Cache Store Policy.
- items
Get
Api Deployment Specification Route Request Policy Query Parameter Transformation Filter Query Parameter Item[] The list of headers.
- type string
Type of the Response Cache Store Policy.
- items
Get
Api Deployment Specification Route Request Policy Query Parameter Transformation Filter Query Parameter Item] The list of headers.
- type str
Type of the Response Cache Store Policy.
- items List<Property Map>
The list of headers.
- type String
Type of the Response Cache Store Policy.
GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameterItem
- Name string
The case-insensitive name of the header. This name must be unique across transformation policies.
- Name string
The case-insensitive name of the header. This name must be unique across transformation policies.
- name String
The case-insensitive name of the header. This name must be unique across transformation policies.
- name string
The case-insensitive name of the header. This name must be unique across transformation policies.
- name str
The case-insensitive name of the header. This name must be unique across transformation policies.
- name String
The case-insensitive name of the header. This name must be unique across transformation policies.
GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter
- items List<Property Map>
The list of headers.
GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameterItem
GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter
- items List<Property Map>
The list of headers.
GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameterItem
- If
Exists string If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- Name string
The case-insensitive name of the header. This name must be unique across transformation policies.
- Values List<string>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- If
Exists string If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- Name string
The case-insensitive name of the header. This name must be unique across transformation policies.
- Values []string
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- if
Exists String If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- name String
The case-insensitive name of the header. This name must be unique across transformation policies.
- values List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- if
Exists string If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- name string
The case-insensitive name of the header. This name must be unique across transformation policies.
- values string[]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- if_
exists str If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- name str
The case-insensitive name of the header. This name must be unique across transformation policies.
- values Sequence[str]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- if
Exists String If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- name String
The case-insensitive name of the header. This name must be unique across transformation policies.
- values List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterValidation
- Parameters
List<Get
Api Deployment Specification Route Request Policy Query Parameter Validation Parameter> - Validation
Mode string Validation behavior mode.
- Parameters
[]Get
Api Deployment Specification Route Request Policy Query Parameter Validation Parameter - Validation
Mode string Validation behavior mode.
- parameters
List<Get
Api Deployment Specification Route Request Policy Query Parameter Validation Parameter> - validation
Mode String Validation behavior mode.
- parameters
Get
Api Deployment Specification Route Request Policy Query Parameter Validation Parameter[] - validation
Mode string Validation behavior mode.
- parameters
Get
Api Deployment Specification Route Request Policy Query Parameter Validation Parameter] - validation_
mode str Validation behavior mode.
- parameters List<Property Map>
- validation
Mode String Validation behavior mode.
GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterValidationParameter
GetApiDeploymentSpecificationRouteRequestPolicyResponseCacheLookup
- Cache
Key List<string>Additions A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available.
- Is
Enabled bool Whether this policy is currently enabled.
- Is
Private boolCaching Enabled Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your cache key additions to get the level of isolation across authenticated requests that you require.
- Type string
Type of the Response Cache Store Policy.
- Cache
Key []stringAdditions A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available.
- Is
Enabled bool Whether this policy is currently enabled.
- Is
Private boolCaching Enabled Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your cache key additions to get the level of isolation across authenticated requests that you require.
- Type string
Type of the Response Cache Store Policy.
- cache
Key List<String>Additions A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available.
- is
Enabled Boolean Whether this policy is currently enabled.
- is
Private BooleanCaching Enabled Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your cache key additions to get the level of isolation across authenticated requests that you require.
- type String
Type of the Response Cache Store Policy.
- cache
Key string[]Additions A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available.
- is
Enabled boolean Whether this policy is currently enabled.
- is
Private booleanCaching Enabled Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your cache key additions to get the level of isolation across authenticated requests that you require.
- type string
Type of the Response Cache Store Policy.
- cache_
key_ Sequence[str]additions A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available.
- is_
enabled bool Whether this policy is currently enabled.
- is_
private_ boolcaching_ enabled Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your cache key additions to get the level of isolation across authenticated requests that you require.
- type str
Type of the Response Cache Store Policy.
- cache
Key List<String>Additions A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available.
- is
Enabled Boolean Whether this policy is currently enabled.
- is
Private BooleanCaching Enabled Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your cache key additions to get the level of isolation across authenticated requests that you require.
- type String
Type of the Response Cache Store Policy.
GetApiDeploymentSpecificationRouteResponsePolicy
- Header
Transformations List<GetApi Deployment Specification Route Response Policy Header Transformation> A set of transformations to apply to HTTP headers that pass through the gateway.
- Response
Cache List<GetStores Api Deployment Specification Route Response Policy Response Cache Store> Base policy for how a response from a backend is cached in the Response Cache.
- Header
Transformations []GetApi Deployment Specification Route Response Policy Header Transformation A set of transformations to apply to HTTP headers that pass through the gateway.
- Response
Cache []GetStores Api Deployment Specification Route Response Policy Response Cache Store Base policy for how a response from a backend is cached in the Response Cache.
- header
Transformations List<GetApi Deployment Specification Route Response Policy Header Transformation> A set of transformations to apply to HTTP headers that pass through the gateway.
- response
Cache List<GetStores Api Deployment Specification Route Response Policy Response Cache Store> Base policy for how a response from a backend is cached in the Response Cache.
- header
Transformations GetApi Deployment Specification Route Response Policy Header Transformation[] A set of transformations to apply to HTTP headers that pass through the gateway.
- response
Cache GetStores Api Deployment Specification Route Response Policy Response Cache Store[] Base policy for how a response from a backend is cached in the Response Cache.
- header_
transformations GetApi Deployment Specification Route Response Policy Header Transformation] A set of transformations to apply to HTTP headers that pass through the gateway.
- response_
cache_ Getstores Api Deployment Specification Route Response Policy Response Cache Store] Base policy for how a response from a backend is cached in the Response Cache.
- header
Transformations List<Property Map> A set of transformations to apply to HTTP headers that pass through the gateway.
- response
Cache List<Property Map>Stores Base policy for how a response from a backend is cached in the Response Cache.
GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformation
- Filter
Headers List<GetApi Deployment Specification Route Response Policy Header Transformation Filter Header> Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
- Rename
Headers List<GetApi Deployment Specification Route Response Policy Header Transformation Rename Header> Rename HTTP headers as they pass through the gateway.
- Set
Headers List<GetApi Deployment Specification Route Response Policy Header Transformation Set Header> Set HTTP headers as they pass through the gateway.
- Filter
Headers []GetApi Deployment Specification Route Response Policy Header Transformation Filter Header Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
- Rename
Headers []GetApi Deployment Specification Route Response Policy Header Transformation Rename Header Rename HTTP headers as they pass through the gateway.
- Set
Headers []GetApi Deployment Specification Route Response Policy Header Transformation Set Header Set HTTP headers as they pass through the gateway.
- filter
Headers List<GetApi Deployment Specification Route Response Policy Header Transformation Filter Header> Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
- rename
Headers List<GetApi Deployment Specification Route Response Policy Header Transformation Rename Header> Rename HTTP headers as they pass through the gateway.
- set
Headers List<GetApi Deployment Specification Route Response Policy Header Transformation Set Header> Set HTTP headers as they pass through the gateway.
- filter
Headers GetApi Deployment Specification Route Response Policy Header Transformation Filter Header[] Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
- rename
Headers GetApi Deployment Specification Route Response Policy Header Transformation Rename Header[] Rename HTTP headers as they pass through the gateway.
- set
Headers GetApi Deployment Specification Route Response Policy Header Transformation Set Header[] Set HTTP headers as they pass through the gateway.
- filter_
headers GetApi Deployment Specification Route Response Policy Header Transformation Filter Header] Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
- rename_
headers GetApi Deployment Specification Route Response Policy Header Transformation Rename Header] Rename HTTP headers as they pass through the gateway.
- set_
headers GetApi Deployment Specification Route Response Policy Header Transformation Set Header] Set HTTP headers as they pass through the gateway.
- filter
Headers List<Property Map> Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
- rename
Headers List<Property Map> Rename HTTP headers as they pass through the gateway.
- set
Headers List<Property Map> Set HTTP headers as they pass through the gateway.
GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeader
- Items
List<Get
Api Deployment Specification Route Response Policy Header Transformation Filter Header Item> The list of headers.
- Type string
Type of the Response Cache Store Policy.
- Items
[]Get
Api Deployment Specification Route Response Policy Header Transformation Filter Header Item The list of headers.
- Type string
Type of the Response Cache Store Policy.
- items
List<Get
Api Deployment Specification Route Response Policy Header Transformation Filter Header Item> The list of headers.
- type String
Type of the Response Cache Store Policy.
- items
Get
Api Deployment Specification Route Response Policy Header Transformation Filter Header Item[] The list of headers.
- type string
Type of the Response Cache Store Policy.
- items
Get
Api Deployment Specification Route Response Policy Header Transformation Filter Header Item] The list of headers.
- type str
Type of the Response Cache Store Policy.
- items List<Property Map>
The list of headers.
- type String
Type of the Response Cache Store Policy.
GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem
- Name string
The case-insensitive name of the header. This name must be unique across transformation policies.
- Name string
The case-insensitive name of the header. This name must be unique across transformation policies.
- name String
The case-insensitive name of the header. This name must be unique across transformation policies.
- name string
The case-insensitive name of the header. This name must be unique across transformation policies.
- name str
The case-insensitive name of the header. This name must be unique across transformation policies.
- name String
The case-insensitive name of the header. This name must be unique across transformation policies.
GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeader
- items List<Property Map>
The list of headers.
GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeaderItem
GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeader
- items List<Property Map>
The list of headers.
GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeaderItem
- If
Exists string If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- Name string
The case-insensitive name of the header. This name must be unique across transformation policies.
- Values List<string>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- If
Exists string If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- Name string
The case-insensitive name of the header. This name must be unique across transformation policies.
- Values []string
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- if
Exists String If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- name String
The case-insensitive name of the header. This name must be unique across transformation policies.
- values List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- if
Exists string If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- name string
The case-insensitive name of the header. This name must be unique across transformation policies.
- values string[]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- if_
exists str If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- name str
The case-insensitive name of the header. This name must be unique across transformation policies.
- values Sequence[str]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- if
Exists String If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- name String
The case-insensitive name of the header. This name must be unique across transformation policies.
- values List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
GetApiDeploymentSpecificationRouteResponsePolicyResponseCacheStore
- Time
To intLive In Seconds Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.
- Type string
Type of the Response Cache Store Policy.
- Time
To intLive In Seconds Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.
- Type string
Type of the Response Cache Store Policy.
- time
To IntegerLive In Seconds Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.
- type String
Type of the Response Cache Store Policy.
- time
To numberLive In Seconds Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.
- type string
Type of the Response Cache Store Policy.
- time_
to_ intlive_ in_ seconds Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.
- type str
Type of the Response Cache Store Policy.
- time
To NumberLive In Seconds Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.
- type String
Type of the Response Cache Store Policy.
Package Details
- Repository
- https://github.com/pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
oci
Terraform Provider.