Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

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:

ApiId string

The ocid of the API.

ApiId string

The ocid of the API.

apiId String

The ocid of the API.

apiId string

The ocid of the API.

api_id str

The ocid of the API.

apiId String

The ocid of the API.

getApiDeploymentSpecification Result

The following output properties are available:

ApiId string
Id string

The provider-assigned unique ID for this managed resource.

LoggingPolicies List<GetApiDeploymentSpecificationLoggingPolicy>

Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.

RequestPolicies List<GetApiDeploymentSpecificationRequestPolicy>

Behavior applied to any requests received by the API on this route.

Routes List<GetApiDeploymentSpecificationRoute>

A list of routes that this API exposes.

ApiId string
Id string

The provider-assigned unique ID for this managed resource.

LoggingPolicies []GetApiDeploymentSpecificationLoggingPolicy

Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.

RequestPolicies []GetApiDeploymentSpecificationRequestPolicy

Behavior applied to any requests received by the API on this route.

Routes []GetApiDeploymentSpecificationRoute

A list of routes that this API exposes.

apiId String
id String

The provider-assigned unique ID for this managed resource.

loggingPolicies List<GetApiDeploymentSpecificationLoggingPolicy>

Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.

requestPolicies List<GetApiDeploymentSpecificationRequestPolicy>

Behavior applied to any requests received by the API on this route.

routes List<GetApiDeploymentSpecificationRoute>

A list of routes that this API exposes.

apiId string
id string

The provider-assigned unique ID for this managed resource.

loggingPolicies GetApiDeploymentSpecificationLoggingPolicy[]

Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.

requestPolicies GetApiDeploymentSpecificationRequestPolicy[]

Behavior applied to any requests received by the API on this route.

routes GetApiDeploymentSpecificationRoute[]

A list of routes that this API exposes.

api_id str
id str

The provider-assigned unique ID for this managed resource.

logging_policies GetApiDeploymentSpecificationLoggingPolicy]

Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.

request_policies GetApiDeploymentSpecificationRequestPolicy]

Behavior applied to any requests received by the API on this route.

routes GetApiDeploymentSpecificationRoute]

A list of routes that this API exposes.

apiId String
id String

The provider-assigned unique ID for this managed resource.

loggingPolicies List<Property Map>

Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.

requestPolicies 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

AccessLogs List<GetApiDeploymentSpecificationLoggingPolicyAccessLog>

Configures the logging policies for the access logs of an API Deployment.

ExecutionLogs List<GetApiDeploymentSpecificationLoggingPolicyExecutionLog>

Configures the logging policies for the execution logs of an API Deployment.

AccessLogs []GetApiDeploymentSpecificationLoggingPolicyAccessLog

Configures the logging policies for the access logs of an API Deployment.

ExecutionLogs []GetApiDeploymentSpecificationLoggingPolicyExecutionLog

Configures the logging policies for the execution logs of an API Deployment.

accessLogs List<GetApiDeploymentSpecificationLoggingPolicyAccessLog>

Configures the logging policies for the access logs of an API Deployment.

executionLogs List<GetApiDeploymentSpecificationLoggingPolicyExecutionLog>

Configures the logging policies for the execution logs of an API Deployment.

accessLogs GetApiDeploymentSpecificationLoggingPolicyAccessLog[]

Configures the logging policies for the access logs of an API Deployment.

executionLogs GetApiDeploymentSpecificationLoggingPolicyExecutionLog[]

Configures the logging policies for the execution logs of an API Deployment.

access_logs GetApiDeploymentSpecificationLoggingPolicyAccessLog]

Configures the logging policies for the access logs of an API Deployment.

execution_logs GetApiDeploymentSpecificationLoggingPolicyExecutionLog]

Configures the logging policies for the execution logs of an API Deployment.

accessLogs List<Property Map>

Configures the logging policies for the access logs of an API Deployment.

executionLogs List<Property Map>

Configures the logging policies for the execution logs of an API Deployment.

GetApiDeploymentSpecificationLoggingPolicyAccessLog

IsEnabled bool

Whether this policy is currently enabled.

IsEnabled bool

Whether this policy is currently enabled.

isEnabled Boolean

Whether this policy is currently enabled.

isEnabled boolean

Whether this policy is currently enabled.

is_enabled bool

Whether this policy is currently enabled.

isEnabled Boolean

Whether this policy is currently enabled.

GetApiDeploymentSpecificationLoggingPolicyExecutionLog

IsEnabled bool

Whether this policy is currently enabled.

LogLevel string

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.

IsEnabled bool

Whether this policy is currently enabled.

LogLevel string

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.

isEnabled Boolean

Whether this policy is currently enabled.

logLevel String

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.

isEnabled boolean

Whether this policy is currently enabled.

logLevel string

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.

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.

isEnabled Boolean

Whether this policy is currently enabled.

logLevel String

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<GetApiDeploymentSpecificationRequestPolicyAuthentication>

Information on how to authenticate incoming requests.

Cors List<GetApiDeploymentSpecificationRequestPolicyCor>

Enable CORS (Cross-Origin-Resource-Sharing) request handling.

MutualTls List<GetApiDeploymentSpecificationRequestPolicyMutualTl>

Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.

RateLimitings List<GetApiDeploymentSpecificationRequestPolicyRateLimiting>

Limit the number of requests that should be handled for the specified window using a specfic key.

Authentications []GetApiDeploymentSpecificationRequestPolicyAuthentication

Information on how to authenticate incoming requests.

Cors []GetApiDeploymentSpecificationRequestPolicyCor

Enable CORS (Cross-Origin-Resource-Sharing) request handling.

MutualTls []GetApiDeploymentSpecificationRequestPolicyMutualTl

Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.

RateLimitings []GetApiDeploymentSpecificationRequestPolicyRateLimiting

Limit the number of requests that should be handled for the specified window using a specfic key.

authentications List<GetApiDeploymentSpecificationRequestPolicyAuthentication>

Information on how to authenticate incoming requests.

cors List<GetApiDeploymentSpecificationRequestPolicyCor>

Enable CORS (Cross-Origin-Resource-Sharing) request handling.

mutualTls List<GetApiDeploymentSpecificationRequestPolicyMutualTl>

Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.

rateLimitings List<GetApiDeploymentSpecificationRequestPolicyRateLimiting>

Limit the number of requests that should be handled for the specified window using a specfic key.

authentications GetApiDeploymentSpecificationRequestPolicyAuthentication[]

Information on how to authenticate incoming requests.

cors GetApiDeploymentSpecificationRequestPolicyCor[]

Enable CORS (Cross-Origin-Resource-Sharing) request handling.

mutualTls GetApiDeploymentSpecificationRequestPolicyMutualTl[]

Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.

rateLimitings GetApiDeploymentSpecificationRequestPolicyRateLimiting[]

Limit the number of requests that should be handled for the specified window using a specfic key.

authentications GetApiDeploymentSpecificationRequestPolicyAuthentication]

Information on how to authenticate incoming requests.

cors GetApiDeploymentSpecificationRequestPolicyCor]

Enable CORS (Cross-Origin-Resource-Sharing) request handling.

mutual_tls GetApiDeploymentSpecificationRequestPolicyMutualTl]

Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.

rate_limitings GetApiDeploymentSpecificationRequestPolicyRateLimiting]

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.

mutualTls List<Property Map>

Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.

rateLimitings 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.

FunctionId string

The OCID of the Oracle Functions function resource.

IsAnonymousAccessAllowed bool

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.

MaxClockSkewInSeconds double

The maximum expected time difference between the system clocks of the token issuer and the API Gateway.

PublicKeys List<GetApiDeploymentSpecificationRequestPolicyAuthenticationPublicKey>

A set of Public Keys that will be used to verify the JWT signature.

TokenAuthScheme string

The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.

TokenHeader string

The name of the header containing the authentication token.

TokenQueryParam string

The name of the query parameter containing the authentication token.

Type string

Type of the Response Cache Store Policy.

VerifyClaims List<GetApiDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim>

A list of claims which should be validated to consider the token valid.

Audiences []string

The list of intended recipients for the token.

FunctionId string

The OCID of the Oracle Functions function resource.

IsAnonymousAccessAllowed bool

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.

MaxClockSkewInSeconds float64

The maximum expected time difference between the system clocks of the token issuer and the API Gateway.

PublicKeys []GetApiDeploymentSpecificationRequestPolicyAuthenticationPublicKey

A set of Public Keys that will be used to verify the JWT signature.

TokenAuthScheme string

The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.

TokenHeader string

The name of the header containing the authentication token.

TokenQueryParam string

The name of the query parameter containing the authentication token.

Type string

Type of the Response Cache Store Policy.

VerifyClaims []GetApiDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim

A list of claims which should be validated to consider the token valid.

audiences List<String>

The list of intended recipients for the token.

functionId String

The OCID of the Oracle Functions function resource.

isAnonymousAccessAllowed Boolean

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.

maxClockSkewInSeconds Double

The maximum expected time difference between the system clocks of the token issuer and the API Gateway.

publicKeys List<GetApiDeploymentSpecificationRequestPolicyAuthenticationPublicKey>

A set of Public Keys that will be used to verify the JWT signature.

tokenAuthScheme String

The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.

tokenHeader String

The name of the header containing the authentication token.

tokenQueryParam String

The name of the query parameter containing the authentication token.

type String

Type of the Response Cache Store Policy.

verifyClaims List<GetApiDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim>

A list of claims which should be validated to consider the token valid.

audiences string[]

The list of intended recipients for the token.

functionId string

The OCID of the Oracle Functions function resource.

isAnonymousAccessAllowed boolean

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.

maxClockSkewInSeconds number

The maximum expected time difference between the system clocks of the token issuer and the API Gateway.

publicKeys GetApiDeploymentSpecificationRequestPolicyAuthenticationPublicKey[]

A set of Public Keys that will be used to verify the JWT signature.

tokenAuthScheme string

The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.

tokenHeader string

The name of the header containing the authentication token.

tokenQueryParam string

The name of the query parameter containing the authentication token.

type string

Type of the Response Cache Store Policy.

verifyClaims GetApiDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim[]

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_access_allowed bool

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_skew_in_seconds float

The maximum expected time difference between the system clocks of the token issuer and the API Gateway.

public_keys GetApiDeploymentSpecificationRequestPolicyAuthenticationPublicKey]

A set of Public Keys that will be used to verify the JWT signature.

token_auth_scheme str

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_param str

The name of the query parameter containing the authentication token.

type str

Type of the Response Cache Store Policy.

verify_claims GetApiDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim]

A list of claims which should be validated to consider the token valid.

audiences List<String>

The list of intended recipients for the token.

functionId String

The OCID of the Oracle Functions function resource.

isAnonymousAccessAllowed Boolean

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.

maxClockSkewInSeconds Number

The maximum expected time difference between the system clocks of the token issuer and the API Gateway.

publicKeys List<Property Map>

A set of Public Keys that will be used to verify the JWT signature.

tokenAuthScheme String

The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.

tokenHeader String

The name of the header containing the authentication token.

tokenQueryParam String

The name of the query parameter containing the authentication token.

type String

Type of the Response Cache Store Policy.

verifyClaims List<Property Map>

A list of claims which should be validated to consider the token valid.

GetApiDeploymentSpecificationRequestPolicyAuthenticationPublicKey

IsSslVerifyDisabled bool

Defines whether or not to uphold SSL verification.

Keys List<GetApiDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey>

The set of static public keys.

MaxCacheDurationInHours int

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.

IsSslVerifyDisabled bool

Defines whether or not to uphold SSL verification.

Keys []GetApiDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey

The set of static public keys.

MaxCacheDurationInHours int

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.

isSslVerifyDisabled Boolean

Defines whether or not to uphold SSL verification.

keys List<GetApiDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey>

The set of static public keys.

maxCacheDurationInHours Integer

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.

isSslVerifyDisabled boolean

Defines whether or not to uphold SSL verification.

keys GetApiDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey[]

The set of static public keys.

maxCacheDurationInHours number

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_verify_disabled bool

Defines whether or not to uphold SSL verification.

keys GetApiDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey]

The set of static public keys.

max_cache_duration_in_hours int

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.

isSslVerifyDisabled Boolean

Defines whether or not to uphold SSL verification.

keys List<Property Map>

The set of static public keys.

maxCacheDurationInHours Number

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.

KeyOps 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.

KeyOps []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.

keyOps 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.

keyOps 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.

keyOps 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

IsRequired 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.

IsRequired 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.

isRequired 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.

isRequired 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.

isRequired 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

AllowedHeaders List<string>

The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.

AllowedMethods 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.

AllowedOrigins 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.

ExposedHeaders 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.

IsAllowCredentialsEnabled bool

Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.

MaxAgeInSeconds int

The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.

AllowedHeaders []string

The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.

AllowedMethods []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.

AllowedOrigins []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.

ExposedHeaders []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.

IsAllowCredentialsEnabled bool

Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.

MaxAgeInSeconds int

The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.

allowedHeaders List<String>

The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.

allowedMethods 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.

allowedOrigins 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.

exposedHeaders 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.

isAllowCredentialsEnabled Boolean

Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.

maxAgeInSeconds Integer

The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.

allowedHeaders string[]

The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.

allowedMethods 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.

allowedOrigins 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.

exposedHeaders 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.

isAllowCredentialsEnabled boolean

Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.

maxAgeInSeconds number

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_credentials_enabled bool

Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.

max_age_in_seconds int

The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.

allowedHeaders List<String>

The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.

allowedMethods 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.

allowedOrigins 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.

exposedHeaders 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.

isAllowCredentialsEnabled Boolean

Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.

maxAgeInSeconds Number

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

AllowedSans List<string>

Allowed list of CN or SAN which will be used for verification of certificate.

IsVerifiedCertificateRequired bool

Determines whether to enable client verification when API Consumer makes connection to the gateway.

AllowedSans []string

Allowed list of CN or SAN which will be used for verification of certificate.

IsVerifiedCertificateRequired bool

Determines whether to enable client verification when API Consumer makes connection to the gateway.

allowedSans List<String>

Allowed list of CN or SAN which will be used for verification of certificate.

isVerifiedCertificateRequired Boolean

Determines whether to enable client verification when API Consumer makes connection to the gateway.

allowedSans string[]

Allowed list of CN or SAN which will be used for verification of certificate.

isVerifiedCertificateRequired boolean

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_certificate_required bool

Determines whether to enable client verification when API Consumer makes connection to the gateway.

allowedSans List<String>

Allowed list of CN or SAN which will be used for verification of certificate.

isVerifiedCertificateRequired Boolean

Determines whether to enable client verification when API Consumer makes connection to the gateway.

GetApiDeploymentSpecificationRequestPolicyRateLimiting

RateInRequestsPerSecond int

The maximum number of requests per second to allow.

RateKey string

The key used to group requests together.

RateInRequestsPerSecond int

The maximum number of requests per second to allow.

RateKey string

The key used to group requests together.

rateInRequestsPerSecond Integer

The maximum number of requests per second to allow.

rateKey String

The key used to group requests together.

rateInRequestsPerSecond number

The maximum number of requests per second to allow.

rateKey string

The key used to group requests together.

rate_in_requests_per_second int

The maximum number of requests per second to allow.

rate_key str

The key used to group requests together.

rateInRequestsPerSecond Number

The maximum number of requests per second to allow.

rateKey String

The key used to group requests together.

GetApiDeploymentSpecificationRoute

Backends List<GetApiDeploymentSpecificationRouteBackend>

The backend to forward requests to.

LoggingPolicies List<GetApiDeploymentSpecificationRouteLoggingPolicy>

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.

RequestPolicies List<GetApiDeploymentSpecificationRouteRequestPolicy>

Behavior applied to any requests received by the API on this route.

ResponsePolicies List<GetApiDeploymentSpecificationRouteResponsePolicy>

Behavior applied to any responses sent by the API for requests on this route.

Backends []GetApiDeploymentSpecificationRouteBackend

The backend to forward requests to.

LoggingPolicies []GetApiDeploymentSpecificationRouteLoggingPolicy

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.

RequestPolicies []GetApiDeploymentSpecificationRouteRequestPolicy

Behavior applied to any requests received by the API on this route.

ResponsePolicies []GetApiDeploymentSpecificationRouteResponsePolicy

Behavior applied to any responses sent by the API for requests on this route.

backends List<GetApiDeploymentSpecificationRouteBackend>

The backend to forward requests to.

loggingPolicies List<GetApiDeploymentSpecificationRouteLoggingPolicy>

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.

requestPolicies List<GetApiDeploymentSpecificationRouteRequestPolicy>

Behavior applied to any requests received by the API on this route.

responsePolicies List<GetApiDeploymentSpecificationRouteResponsePolicy>

Behavior applied to any responses sent by the API for requests on this route.

backends GetApiDeploymentSpecificationRouteBackend[]

The backend to forward requests to.

loggingPolicies GetApiDeploymentSpecificationRouteLoggingPolicy[]

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.

requestPolicies GetApiDeploymentSpecificationRouteRequestPolicy[]

Behavior applied to any requests received by the API on this route.

responsePolicies GetApiDeploymentSpecificationRouteResponsePolicy[]

Behavior applied to any responses sent by the API for requests on this route.

backends GetApiDeploymentSpecificationRouteBackend]

The backend to forward requests to.

logging_policies GetApiDeploymentSpecificationRouteLoggingPolicy]

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 GetApiDeploymentSpecificationRouteRequestPolicy]

Behavior applied to any requests received by the API on this route.

response_policies GetApiDeploymentSpecificationRouteResponsePolicy]

Behavior applied to any responses sent by the API for requests on this route.

backends List<Property Map>

The backend to forward requests to.

loggingPolicies 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.

requestPolicies List<Property Map>

Behavior applied to any requests received by the API on this route.

responsePolicies 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.

ConnectTimeoutInSeconds double

Defines a timeout for establishing a connection with a proxied server.

FunctionId string

The OCID of the Oracle Functions function resource.

Headers List<GetApiDeploymentSpecificationRouteBackendHeader>
IsSslVerifyDisabled bool

Defines whether or not to uphold SSL verification.

ReadTimeoutInSeconds double

Defines a timeout for reading a response from the proxied server.

SendTimeoutInSeconds double

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.

ConnectTimeoutInSeconds float64

Defines a timeout for establishing a connection with a proxied server.

FunctionId string

The OCID of the Oracle Functions function resource.

Headers []GetApiDeploymentSpecificationRouteBackendHeader
IsSslVerifyDisabled bool

Defines whether or not to uphold SSL verification.

ReadTimeoutInSeconds float64

Defines a timeout for reading a response from the proxied server.

SendTimeoutInSeconds float64

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.

connectTimeoutInSeconds Double

Defines a timeout for establishing a connection with a proxied server.

functionId String

The OCID of the Oracle Functions function resource.

headers List<GetApiDeploymentSpecificationRouteBackendHeader>
isSslVerifyDisabled Boolean

Defines whether or not to uphold SSL verification.

readTimeoutInSeconds Double

Defines a timeout for reading a response from the proxied server.

sendTimeoutInSeconds Double

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.

connectTimeoutInSeconds number

Defines a timeout for establishing a connection with a proxied server.

functionId string

The OCID of the Oracle Functions function resource.

headers GetApiDeploymentSpecificationRouteBackendHeader[]
isSslVerifyDisabled boolean

Defines whether or not to uphold SSL verification.

readTimeoutInSeconds number

Defines a timeout for reading a response from the proxied server.

sendTimeoutInSeconds number

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_in_seconds float

Defines a timeout for establishing a connection with a proxied server.

function_id str

The OCID of the Oracle Functions function resource.

headers GetApiDeploymentSpecificationRouteBackendHeader]
is_ssl_verify_disabled bool

Defines whether or not to uphold SSL verification.

read_timeout_in_seconds float

Defines a timeout for reading a response from the proxied server.

send_timeout_in_seconds float

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.

connectTimeoutInSeconds Number

Defines a timeout for establishing a connection with a proxied server.

functionId String

The OCID of the Oracle Functions function resource.

headers List<Property Map>
isSslVerifyDisabled Boolean

Defines whether or not to uphold SSL verification.

readTimeoutInSeconds Number

Defines a timeout for reading a response from the proxied server.

sendTimeoutInSeconds Number

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

Name string

The case-insensitive name of the header. This name must be unique across transformation policies.

Value string

Value of the header.

Name string

The case-insensitive name of the header. This name must be unique across transformation policies.

Value string

Value of the header.

name String

The case-insensitive name of the header. This name must be unique across transformation policies.

value String

Value of the header.

name string

The case-insensitive name of the header. This name must be unique across transformation policies.

value string

Value of the header.

name str

The case-insensitive name of the header. This name must be unique across transformation policies.

value str

Value of the header.

name String

The case-insensitive name of the header. This name must be unique across transformation policies.

value String

Value of the header.

GetApiDeploymentSpecificationRouteLoggingPolicy

AccessLogs List<GetApiDeploymentSpecificationRouteLoggingPolicyAccessLog>

Configures the logging policies for the access logs of an API Deployment.

ExecutionLogs List<GetApiDeploymentSpecificationRouteLoggingPolicyExecutionLog>

Configures the logging policies for the execution logs of an API Deployment.

AccessLogs []GetApiDeploymentSpecificationRouteLoggingPolicyAccessLog

Configures the logging policies for the access logs of an API Deployment.

ExecutionLogs []GetApiDeploymentSpecificationRouteLoggingPolicyExecutionLog

Configures the logging policies for the execution logs of an API Deployment.

accessLogs List<GetApiDeploymentSpecificationRouteLoggingPolicyAccessLog>

Configures the logging policies for the access logs of an API Deployment.

executionLogs List<GetApiDeploymentSpecificationRouteLoggingPolicyExecutionLog>

Configures the logging policies for the execution logs of an API Deployment.

accessLogs GetApiDeploymentSpecificationRouteLoggingPolicyAccessLog[]

Configures the logging policies for the access logs of an API Deployment.

executionLogs GetApiDeploymentSpecificationRouteLoggingPolicyExecutionLog[]

Configures the logging policies for the execution logs of an API Deployment.

access_logs GetApiDeploymentSpecificationRouteLoggingPolicyAccessLog]

Configures the logging policies for the access logs of an API Deployment.

execution_logs GetApiDeploymentSpecificationRouteLoggingPolicyExecutionLog]

Configures the logging policies for the execution logs of an API Deployment.

accessLogs List<Property Map>

Configures the logging policies for the access logs of an API Deployment.

executionLogs List<Property Map>

Configures the logging policies for the execution logs of an API Deployment.

GetApiDeploymentSpecificationRouteLoggingPolicyAccessLog

IsEnabled bool

Whether this policy is currently enabled.

IsEnabled bool

Whether this policy is currently enabled.

isEnabled Boolean

Whether this policy is currently enabled.

isEnabled boolean

Whether this policy is currently enabled.

is_enabled bool

Whether this policy is currently enabled.

isEnabled Boolean

Whether this policy is currently enabled.

GetApiDeploymentSpecificationRouteLoggingPolicyExecutionLog

IsEnabled bool

Whether this policy is currently enabled.

LogLevel string

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.

IsEnabled bool

Whether this policy is currently enabled.

LogLevel string

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.

isEnabled Boolean

Whether this policy is currently enabled.

logLevel String

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.

isEnabled boolean

Whether this policy is currently enabled.

logLevel string

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.

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.

isEnabled Boolean

Whether this policy is currently enabled.

logLevel String

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

Authorizations List<GetApiDeploymentSpecificationRouteRequestPolicyAuthorization>

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.

BodyValidations List<GetApiDeploymentSpecificationRouteRequestPolicyBodyValidation>

Validate the payload body of the incoming API requests on a specific route.

Cors List<GetApiDeploymentSpecificationRouteRequestPolicyCor>

Enable CORS (Cross-Origin-Resource-Sharing) request handling.

HeaderTransformations List<GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformation>

A set of transformations to apply to HTTP headers that pass through the gateway.

HeaderValidations List<GetApiDeploymentSpecificationRouteRequestPolicyHeaderValidation>

Validate the HTTP headers on the incoming API requests on a specific route.

QueryParameterTransformations List<GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation>

A set of transformations to apply to query parameters that pass through the gateway.

QueryParameterValidations List<GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterValidation>

Validate the URL query parameters on the incoming API requests on a specific route.

ResponseCacheLookups List<GetApiDeploymentSpecificationRouteRequestPolicyResponseCacheLookup>

Base policy for Response Cache lookup.

Authorizations []GetApiDeploymentSpecificationRouteRequestPolicyAuthorization

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.

BodyValidations []GetApiDeploymentSpecificationRouteRequestPolicyBodyValidation

Validate the payload body of the incoming API requests on a specific route.

Cors []GetApiDeploymentSpecificationRouteRequestPolicyCor

Enable CORS (Cross-Origin-Resource-Sharing) request handling.

HeaderTransformations []GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformation

A set of transformations to apply to HTTP headers that pass through the gateway.

HeaderValidations []GetApiDeploymentSpecificationRouteRequestPolicyHeaderValidation

Validate the HTTP headers on the incoming API requests on a specific route.

QueryParameterTransformations []GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation

A set of transformations to apply to query parameters that pass through the gateway.

QueryParameterValidations []GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterValidation

Validate the URL query parameters on the incoming API requests on a specific route.

ResponseCacheLookups []GetApiDeploymentSpecificationRouteRequestPolicyResponseCacheLookup

Base policy for Response Cache lookup.

authorizations List<GetApiDeploymentSpecificationRouteRequestPolicyAuthorization>

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.

bodyValidations List<GetApiDeploymentSpecificationRouteRequestPolicyBodyValidation>

Validate the payload body of the incoming API requests on a specific route.

cors List<GetApiDeploymentSpecificationRouteRequestPolicyCor>

Enable CORS (Cross-Origin-Resource-Sharing) request handling.

headerTransformations List<GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformation>

A set of transformations to apply to HTTP headers that pass through the gateway.

headerValidations List<GetApiDeploymentSpecificationRouteRequestPolicyHeaderValidation>

Validate the HTTP headers on the incoming API requests on a specific route.

queryParameterTransformations List<GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation>

A set of transformations to apply to query parameters that pass through the gateway.

queryParameterValidations List<GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterValidation>

Validate the URL query parameters on the incoming API requests on a specific route.

responseCacheLookups List<GetApiDeploymentSpecificationRouteRequestPolicyResponseCacheLookup>

Base policy for Response Cache lookup.

authorizations GetApiDeploymentSpecificationRouteRequestPolicyAuthorization[]

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.

bodyValidations GetApiDeploymentSpecificationRouteRequestPolicyBodyValidation[]

Validate the payload body of the incoming API requests on a specific route.

cors GetApiDeploymentSpecificationRouteRequestPolicyCor[]

Enable CORS (Cross-Origin-Resource-Sharing) request handling.

headerTransformations GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformation[]

A set of transformations to apply to HTTP headers that pass through the gateway.

headerValidations GetApiDeploymentSpecificationRouteRequestPolicyHeaderValidation[]

Validate the HTTP headers on the incoming API requests on a specific route.

queryParameterTransformations GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation[]

A set of transformations to apply to query parameters that pass through the gateway.

queryParameterValidations GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterValidation[]

Validate the URL query parameters on the incoming API requests on a specific route.

responseCacheLookups GetApiDeploymentSpecificationRouteRequestPolicyResponseCacheLookup[]

Base policy for Response Cache lookup.

authorizations GetApiDeploymentSpecificationRouteRequestPolicyAuthorization]

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 GetApiDeploymentSpecificationRouteRequestPolicyBodyValidation]

Validate the payload body of the incoming API requests on a specific route.

cors GetApiDeploymentSpecificationRouteRequestPolicyCor]

Enable CORS (Cross-Origin-Resource-Sharing) request handling.

header_transformations GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformation]

A set of transformations to apply to HTTP headers that pass through the gateway.

header_validations GetApiDeploymentSpecificationRouteRequestPolicyHeaderValidation]

Validate the HTTP headers on the incoming API requests on a specific route.

query_parameter_transformations GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation]

A set of transformations to apply to query parameters that pass through the gateway.

query_parameter_validations GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterValidation]

Validate the URL query parameters on the incoming API requests on a specific route.

response_cache_lookups GetApiDeploymentSpecificationRouteRequestPolicyResponseCacheLookup]

Base policy for Response Cache lookup.

authorizations 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.

bodyValidations 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.

headerTransformations List<Property Map>

A set of transformations to apply to HTTP headers that pass through the gateway.

headerValidations List<Property Map>

Validate the HTTP headers on the incoming API requests on a specific route.

queryParameterTransformations List<Property Map>

A set of transformations to apply to query parameters that pass through the gateway.

queryParameterValidations List<Property Map>

Validate the URL query parameters on the incoming API requests on a specific route.

responseCacheLookups List<Property Map>

Base policy for Response Cache lookup.

GetApiDeploymentSpecificationRouteRequestPolicyAuthorization

AllowedScopes 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.

AllowedScopes []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.

allowedScopes 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.

allowedScopes 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.

allowedScopes 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<GetApiDeploymentSpecificationRouteRequestPolicyBodyValidationContent>

The content of the request body.

Required bool

Determines if the parameter is required in the request.

ValidationMode string

Validation behavior mode.

Contents []GetApiDeploymentSpecificationRouteRequestPolicyBodyValidationContent

The content of the request body.

Required bool

Determines if the parameter is required in the request.

ValidationMode string

Validation behavior mode.

contents List<GetApiDeploymentSpecificationRouteRequestPolicyBodyValidationContent>

The content of the request body.

required Boolean

Determines if the parameter is required in the request.

validationMode String

Validation behavior mode.

contents GetApiDeploymentSpecificationRouteRequestPolicyBodyValidationContent[]

The content of the request body.

required boolean

Determines if the parameter is required in the request.

validationMode string

Validation behavior mode.

contents GetApiDeploymentSpecificationRouteRequestPolicyBodyValidationContent]

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.

validationMode String

Validation behavior mode.

GetApiDeploymentSpecificationRouteRequestPolicyBodyValidationContent

MediaType string

The media type is a media type range subset restricted to the following schema

ValidationType string

Validation type defines the content validation method.

MediaType string

The media type is a media type range subset restricted to the following schema

ValidationType string

Validation type defines the content validation method.

mediaType String

The media type is a media type range subset restricted to the following schema

validationType String

Validation type defines the content validation method.

mediaType string

The media type is a media type range subset restricted to the following schema

validationType 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.

mediaType String

The media type is a media type range subset restricted to the following schema

validationType String

Validation type defines the content validation method.

GetApiDeploymentSpecificationRouteRequestPolicyCor

AllowedHeaders List<string>

The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.

AllowedMethods 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.

AllowedOrigins 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.

ExposedHeaders 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.

IsAllowCredentialsEnabled bool

Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.

MaxAgeInSeconds int

The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.

AllowedHeaders []string

The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.

AllowedMethods []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.

AllowedOrigins []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.

ExposedHeaders []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.

IsAllowCredentialsEnabled bool

Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.

MaxAgeInSeconds int

The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.

allowedHeaders List<String>

The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.

allowedMethods 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.

allowedOrigins 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.

exposedHeaders 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.

isAllowCredentialsEnabled Boolean

Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.

maxAgeInSeconds Integer

The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.

allowedHeaders string[]

The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.

allowedMethods 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.

allowedOrigins 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.

exposedHeaders 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.

isAllowCredentialsEnabled boolean

Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.

maxAgeInSeconds number

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_credentials_enabled bool

Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.

max_age_in_seconds int

The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.

allowedHeaders List<String>

The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.

allowedMethods 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.

allowedOrigins 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.

exposedHeaders 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.

isAllowCredentialsEnabled Boolean

Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.

maxAgeInSeconds Number

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

FilterHeaders List<GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeader>

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.

RenameHeaders List<GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader>

Rename HTTP headers as they pass through the gateway.

SetHeaders List<GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader>

Set HTTP headers as they pass through the gateway.

FilterHeaders []GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeader

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.

RenameHeaders []GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader

Rename HTTP headers as they pass through the gateway.

SetHeaders []GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader

Set HTTP headers as they pass through the gateway.

filterHeaders List<GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeader>

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.

renameHeaders List<GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader>

Rename HTTP headers as they pass through the gateway.

setHeaders List<GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader>

Set HTTP headers as they pass through the gateway.

filterHeaders GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeader[]

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.

renameHeaders GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader[]

Rename HTTP headers as they pass through the gateway.

setHeaders GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader[]

Set HTTP headers as they pass through the gateway.

filter_headers GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeader]

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 GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader]

Rename HTTP headers as they pass through the gateway.

set_headers GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader]

Set HTTP headers as they pass through the gateway.

filterHeaders 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.

renameHeaders List<Property Map>

Rename HTTP headers as they pass through the gateway.

setHeaders List<Property Map>

Set HTTP headers as they pass through the gateway.

GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeader

Items List<GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem>

The list of headers.

Type string

Type of the Response Cache Store Policy.

Items []GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem

The list of headers.

Type string

Type of the Response Cache Store Policy.

items List<GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem>

The list of headers.

type String

Type of the Response Cache Store Policy.

items GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem[]

The list of headers.

type string

Type of the Response Cache Store Policy.

items GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem]

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

From string

The original case-insensitive name of the header. This name must be unique across transformation policies.

To string

The new name of the header. This name must be unique across transformation policies.

From string

The original case-insensitive name of the header. This name must be unique across transformation policies.

To string

The new name of the header. This name must be unique across transformation policies.

from String

The original case-insensitive name of the header. This name must be unique across transformation policies.

to String

The new name of the header. This name must be unique across transformation policies.

from string

The original case-insensitive name of the header. This name must be unique across transformation policies.

to string

The new name of the header. This name must be unique across transformation policies.

from_ str

The original case-insensitive name of the header. This name must be unique across transformation policies.

to str

The new name of the header. This name must be unique across transformation policies.

from String

The original case-insensitive name of the header. This name must be unique across transformation policies.

to String

The new name of the header. This name must be unique across transformation policies.

GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader

items List<Property Map>

The list of headers.

GetApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeaderItem

IfExists 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.

IfExists 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.

ifExists 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.

ifExists 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.

ifExists 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<Property Map>
validationMode String

Validation behavior mode.

GetApiDeploymentSpecificationRouteRequestPolicyHeaderValidationHeader

Name string

The case-insensitive name of the header. This name must be unique across transformation policies.

Required bool

Determines if the parameter is required in the request.

Name string

The case-insensitive name of the header. This name must be unique across transformation policies.

Required bool

Determines if the parameter is required in the request.

name String

The case-insensitive name of the header. This name must be unique across transformation policies.

required Boolean

Determines if the parameter is required in the request.

name string

The case-insensitive name of the header. This name must be unique across transformation policies.

required boolean

Determines if the parameter is required in the request.

name str

The case-insensitive name of the header. This name must be unique across transformation policies.

required bool

Determines if the parameter is required in the request.

name String

The case-insensitive name of the header. This name must be unique across transformation policies.

required Boolean

Determines if the parameter is required in the request.

GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation

FilterQueryParameters List<GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter>

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.

RenameQueryParameters List<GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter>

Rename parameters on the query string as they pass through the gateway.

SetQueryParameters List<GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter>

Set parameters on the query string as they pass through the gateway.

FilterQueryParameters []GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter

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.

RenameQueryParameters []GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter

Rename parameters on the query string as they pass through the gateway.

SetQueryParameters []GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter

Set parameters on the query string as they pass through the gateway.

filterQueryParameters List<GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter>

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.

renameQueryParameters List<GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter>

Rename parameters on the query string as they pass through the gateway.

setQueryParameters List<GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter>

Set parameters on the query string as they pass through the gateway.

filterQueryParameters GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter[]

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.

renameQueryParameters GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter[]

Rename parameters on the query string as they pass through the gateway.

setQueryParameters GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter[]

Set parameters on the query string as they pass through the gateway.

filter_query_parameters GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter]

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_parameters GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter]

Rename parameters on the query string as they pass through the gateway.

set_query_parameters GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter]

Set parameters on the query string as they pass through the gateway.

filterQueryParameters List<Property Map>

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.

renameQueryParameters List<Property Map>

Rename parameters on the query string as they pass through the gateway.

setQueryParameters List<Property Map>

Set parameters on the query string as they pass through the gateway.

GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter

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

From string

The original case-insensitive name of the header. This name must be unique across transformation policies.

To string

The new name of the header. This name must be unique across transformation policies.

From string

The original case-insensitive name of the header. This name must be unique across transformation policies.

To string

The new name of the header. This name must be unique across transformation policies.

from String

The original case-insensitive name of the header. This name must be unique across transformation policies.

to String

The new name of the header. This name must be unique across transformation policies.

from string

The original case-insensitive name of the header. This name must be unique across transformation policies.

to string

The new name of the header. This name must be unique across transformation policies.

from_ str

The original case-insensitive name of the header. This name must be unique across transformation policies.

to str

The new name of the header. This name must be unique across transformation policies.

from String

The original case-insensitive name of the header. This name must be unique across transformation policies.

to String

The new name of the header. This name must be unique across transformation policies.

GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter

items List<Property Map>

The list of headers.

GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameterItem

IfExists 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.

IfExists 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.

ifExists 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.

ifExists 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.

ifExists 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<Property Map>
validationMode String

Validation behavior mode.

GetApiDeploymentSpecificationRouteRequestPolicyQueryParameterValidationParameter

Name string

The case-insensitive name of the header. This name must be unique across transformation policies.

Required bool

Determines if the parameter is required in the request.

Name string

The case-insensitive name of the header. This name must be unique across transformation policies.

Required bool

Determines if the parameter is required in the request.

name String

The case-insensitive name of the header. This name must be unique across transformation policies.

required Boolean

Determines if the parameter is required in the request.

name string

The case-insensitive name of the header. This name must be unique across transformation policies.

required boolean

Determines if the parameter is required in the request.

name str

The case-insensitive name of the header. This name must be unique across transformation policies.

required bool

Determines if the parameter is required in the request.

name String

The case-insensitive name of the header. This name must be unique across transformation policies.

required Boolean

Determines if the parameter is required in the request.

GetApiDeploymentSpecificationRouteRequestPolicyResponseCacheLookup

CacheKeyAdditions List<string>

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.

IsEnabled bool

Whether this policy is currently enabled.

IsPrivateCachingEnabled bool

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.

CacheKeyAdditions []string

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.

IsEnabled bool

Whether this policy is currently enabled.

IsPrivateCachingEnabled bool

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.

cacheKeyAdditions List<String>

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.

isEnabled Boolean

Whether this policy is currently enabled.

isPrivateCachingEnabled Boolean

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.

cacheKeyAdditions string[]

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.

isEnabled boolean

Whether this policy is currently enabled.

isPrivateCachingEnabled boolean

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_additions Sequence[str]

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_caching_enabled bool

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.

cacheKeyAdditions List<String>

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.

isEnabled Boolean

Whether this policy is currently enabled.

isPrivateCachingEnabled Boolean

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

HeaderTransformations List<GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformation>

A set of transformations to apply to HTTP headers that pass through the gateway.

ResponseCacheStores List<GetApiDeploymentSpecificationRouteResponsePolicyResponseCacheStore>

Base policy for how a response from a backend is cached in the Response Cache.

HeaderTransformations []GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformation

A set of transformations to apply to HTTP headers that pass through the gateway.

ResponseCacheStores []GetApiDeploymentSpecificationRouteResponsePolicyResponseCacheStore

Base policy for how a response from a backend is cached in the Response Cache.

headerTransformations List<GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformation>

A set of transformations to apply to HTTP headers that pass through the gateway.

responseCacheStores List<GetApiDeploymentSpecificationRouteResponsePolicyResponseCacheStore>

Base policy for how a response from a backend is cached in the Response Cache.

headerTransformations GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformation[]

A set of transformations to apply to HTTP headers that pass through the gateway.

responseCacheStores GetApiDeploymentSpecificationRouteResponsePolicyResponseCacheStore[]

Base policy for how a response from a backend is cached in the Response Cache.

header_transformations GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformation]

A set of transformations to apply to HTTP headers that pass through the gateway.

response_cache_stores GetApiDeploymentSpecificationRouteResponsePolicyResponseCacheStore]

Base policy for how a response from a backend is cached in the Response Cache.

headerTransformations List<Property Map>

A set of transformations to apply to HTTP headers that pass through the gateway.

responseCacheStores List<Property Map>

Base policy for how a response from a backend is cached in the Response Cache.

GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformation

FilterHeaders List<GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeader>

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.

RenameHeaders List<GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeader>

Rename HTTP headers as they pass through the gateway.

SetHeaders List<GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeader>

Set HTTP headers as they pass through the gateway.

FilterHeaders []GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeader

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.

RenameHeaders []GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeader

Rename HTTP headers as they pass through the gateway.

SetHeaders []GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeader

Set HTTP headers as they pass through the gateway.

filterHeaders List<GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeader>

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.

renameHeaders List<GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeader>

Rename HTTP headers as they pass through the gateway.

setHeaders List<GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeader>

Set HTTP headers as they pass through the gateway.

filterHeaders GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeader[]

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.

renameHeaders GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeader[]

Rename HTTP headers as they pass through the gateway.

setHeaders GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeader[]

Set HTTP headers as they pass through the gateway.

filter_headers GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeader]

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 GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeader]

Rename HTTP headers as they pass through the gateway.

set_headers GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeader]

Set HTTP headers as they pass through the gateway.

filterHeaders 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.

renameHeaders List<Property Map>

Rename HTTP headers as they pass through the gateway.

setHeaders List<Property Map>

Set HTTP headers as they pass through the gateway.

GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeader

Items List<GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem>

The list of headers.

Type string

Type of the Response Cache Store Policy.

Items []GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem

The list of headers.

Type string

Type of the Response Cache Store Policy.

items List<GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem>

The list of headers.

type String

Type of the Response Cache Store Policy.

items GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem[]

The list of headers.

type string

Type of the Response Cache Store Policy.

items GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem]

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

From string

The original case-insensitive name of the header. This name must be unique across transformation policies.

To string

The new name of the header. This name must be unique across transformation policies.

From string

The original case-insensitive name of the header. This name must be unique across transformation policies.

To string

The new name of the header. This name must be unique across transformation policies.

from String

The original case-insensitive name of the header. This name must be unique across transformation policies.

to String

The new name of the header. This name must be unique across transformation policies.

from string

The original case-insensitive name of the header. This name must be unique across transformation policies.

to string

The new name of the header. This name must be unique across transformation policies.

from_ str

The original case-insensitive name of the header. This name must be unique across transformation policies.

to str

The new name of the header. This name must be unique across transformation policies.

from String

The original case-insensitive name of the header. This name must be unique across transformation policies.

to String

The new name of the header. This name must be unique across transformation policies.

GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeader

items List<Property Map>

The list of headers.

GetApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeaderItem

IfExists 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.

IfExists 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.

ifExists 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.

ifExists 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.

ifExists 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

TimeToLiveInSeconds int

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.

TimeToLiveInSeconds int

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.

timeToLiveInSeconds Integer

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.

timeToLiveInSeconds number

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_live_in_seconds int

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.

timeToLiveInSeconds Number

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.