Oracle Cloud Infrastructure
getDeployment
This data source provides details about a specific Deployment resource in Oracle Cloud Infrastructure API Gateway service.
Gets a deployment by identifier.
Example Usage
using Pulumi;
using Oci = Pulumi.Oci;
class MyStack : Stack
{
public MyStack()
{
var testDeployment = Output.Create(Oci.ApiGateway.GetDeployment.InvokeAsync(new Oci.ApiGateway.GetDeploymentArgs
{
DeploymentId = oci_apigateway_deployment.Test_deployment.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.GetDeployment(ctx, &apigateway.GetDeploymentArgs{
DeploymentId: oci_apigateway_deployment.Test_deployment.Id,
}, nil)
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_oci as oci
test_deployment = oci.ApiGateway.get_deployment(deployment_id=oci_apigateway_deployment["test_deployment"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testDeployment = oci.ApiGateway.getDeployment({
deploymentId: oci_apigateway_deployment.test_deployment.id,
});
Coming soon!
Using getDeployment
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 getDeployment(args: GetDeploymentArgs, opts?: InvokeOptions): Promise<GetDeploymentResult>
function getDeploymentOutput(args: GetDeploymentOutputArgs, opts?: InvokeOptions): Output<GetDeploymentResult>
def get_deployment(deployment_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetDeploymentResult
def get_deployment_output(deployment_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetDeploymentResult]
func GetDeployment(ctx *Context, args *GetDeploymentArgs, opts ...InvokeOption) (*GetDeploymentResult, error)
func GetDeploymentOutput(ctx *Context, args *GetDeploymentOutputArgs, opts ...InvokeOption) GetDeploymentResultOutput
> Note: This function is named GetDeployment
in the Go SDK.
public static class GetDeployment
{
public static Task<GetDeploymentResult> InvokeAsync(GetDeploymentArgs args, InvokeOptions? opts = null)
public static Output<GetDeploymentResult> Invoke(GetDeploymentInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDeploymentResult> getDeployment(GetDeploymentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
Function: oci:ApiGateway/getDeployment:getDeployment
Arguments:
# Arguments dictionary
The following arguments are supported:
- Deployment
Id string The ocid of the deployment.
- Deployment
Id string The ocid of the deployment.
- deployment
Id String The ocid of the deployment.
- deployment
Id string The ocid of the deployment.
- deployment_
id str The ocid of the deployment.
- deployment
Id String The ocid of the deployment.
getDeployment Result
The following output properties are available:
- Compartment
Id string The OCID of the compartment in which the resource is created.
- Dictionary<string, object>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Deployment
Id string - Display
Name string A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- Endpoint string
The endpoint to access this deployment on the gateway.
- Dictionary<string, object>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Gateway
Id string The OCID of the resource.
- Id string
The OCID of the resource.
- Lifecycle
Details string A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
- Path
Prefix string A path on which to deploy all routes contained in the API deployment specification. For more information, see Deploying an API on an API Gateway by Creating an API Deployment.
- Specifications
List<Get
Deployment Specification> The logical configuration of the API exposed by a deployment.
- State string
The current state of the deployment.
- Time
Created string The time this resource was created. An RFC3339 formatted datetime string.
- Time
Updated string The time this resource was last updated. An RFC3339 formatted datetime string.
- Compartment
Id string The OCID of the compartment in which the resource is created.
- map[string]interface{}
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Deployment
Id string - Display
Name string A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- Endpoint string
The endpoint to access this deployment on the gateway.
- map[string]interface{}
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- Gateway
Id string The OCID of the resource.
- Id string
The OCID of the resource.
- Lifecycle
Details string A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
- Path
Prefix string A path on which to deploy all routes contained in the API deployment specification. For more information, see Deploying an API on an API Gateway by Creating an API Deployment.
- Specifications
[]Get
Deployment Specification The logical configuration of the API exposed by a deployment.
- State string
The current state of the deployment.
- Time
Created string The time this resource was created. An RFC3339 formatted datetime string.
- Time
Updated string The time this resource was last updated. An RFC3339 formatted datetime string.
- compartment
Id String The OCID of the compartment in which the resource is created.
- Map<String,Object>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- deployment
Id String - display
Name String A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- endpoint String
The endpoint to access this deployment on the gateway.
- Map<String,Object>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- gateway
Id String The OCID of the resource.
- id String
The OCID of the resource.
- lifecycle
Details String A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
- path
Prefix String A path on which to deploy all routes contained in the API deployment specification. For more information, see Deploying an API on an API Gateway by Creating an API Deployment.
- specifications
List<Get
Deployment Specification> The logical configuration of the API exposed by a deployment.
- state String
The current state of the deployment.
- time
Created String The time this resource was created. An RFC3339 formatted datetime string.
- time
Updated String The time this resource was last updated. An RFC3339 formatted datetime string.
- compartment
Id string The OCID of the compartment in which the resource is created.
- {[key: string]: any}
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- deployment
Id string - display
Name string A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- endpoint string
The endpoint to access this deployment on the gateway.
- {[key: string]: any}
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- gateway
Id string The OCID of the resource.
- id string
The OCID of the resource.
- lifecycle
Details string A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
- path
Prefix string A path on which to deploy all routes contained in the API deployment specification. For more information, see Deploying an API on an API Gateway by Creating an API Deployment.
- specifications
Get
Deployment Specification[] The logical configuration of the API exposed by a deployment.
- state string
The current state of the deployment.
- time
Created string The time this resource was created. An RFC3339 formatted datetime string.
- time
Updated string The time this resource was last updated. An RFC3339 formatted datetime string.
- compartment_
id str The OCID of the compartment in which the resource is created.
- Mapping[str, Any]
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- deployment_
id str - display_
name str A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- endpoint str
The endpoint to access this deployment on the gateway.
- Mapping[str, Any]
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- gateway_
id str The OCID of the resource.
- id str
The OCID of the resource.
- lifecycle_
details str A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
- path_
prefix str A path on which to deploy all routes contained in the API deployment specification. For more information, see Deploying an API on an API Gateway by Creating an API Deployment.
- specifications
Get
Deployment Specification] The logical configuration of the API exposed by a deployment.
- state str
The current state of the deployment.
- time_
created str The time this resource was created. An RFC3339 formatted datetime string.
- time_
updated str The time this resource was last updated. An RFC3339 formatted datetime string.
- compartment
Id String The OCID of the compartment in which the resource is created.
- Map<Any>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- deployment
Id String - display
Name String A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- endpoint String
The endpoint to access this deployment on the gateway.
- Map<Any>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example:
{"Department": "Finance"}
- gateway
Id String The OCID of the resource.
- id String
The OCID of the resource.
- lifecycle
Details String A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
- path
Prefix String A path on which to deploy all routes contained in the API deployment specification. For more information, see Deploying an API on an API Gateway by Creating an API Deployment.
- specifications List<Property Map>
The logical configuration of the API exposed by a deployment.
- state String
The current state of the deployment.
- time
Created String The time this resource was created. An RFC3339 formatted datetime string.
- time
Updated String The time this resource was last updated. An RFC3339 formatted datetime string.
Supporting Types
GetDeploymentSpecification
- Logging
Policies List<GetDeployment Specification Logging Policy> Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
- Request
Policies List<GetDeployment Specification Request Policy> Behavior applied to any requests received by the API on this route.
- Routes
List<Get
Deployment Specification Route> A list of routes that this API exposes.
- Logging
Policies []GetDeployment Specification Logging Policy Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
- Request
Policies []GetDeployment Specification Request Policy Behavior applied to any requests received by the API on this route.
- Routes
[]Get
Deployment Specification Route A list of routes that this API exposes.
- logging
Policies List<GetDeployment Specification Logging Policy> Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
- request
Policies List<GetDeployment Specification Request Policy> Behavior applied to any requests received by the API on this route.
- routes
List<Get
Deployment Specification Route> A list of routes that this API exposes.
- logging
Policies GetDeployment Specification Logging Policy[] Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
- request
Policies GetDeployment Specification Request Policy[] Behavior applied to any requests received by the API on this route.
- routes
Get
Deployment Specification Route[] A list of routes that this API exposes.
- logging_
policies GetDeployment Specification Logging Policy] Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
- request_
policies GetDeployment Specification Request Policy] Behavior applied to any requests received by the API on this route.
- routes
Get
Deployment Specification Route] A list of routes that this API exposes.
- logging
Policies List<Property Map> Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
- request
Policies List<Property Map> Behavior applied to any requests received by the API on this route.
- routes List<Property Map>
A list of routes that this API exposes.
GetDeploymentSpecificationLoggingPolicy
- Access
Logs List<GetDeployment Specification Logging Policy Access Log> Configures the logging policies for the access logs of an API Deployment.
- Execution
Logs List<GetDeployment Specification Logging Policy Execution Log> Configures the logging policies for the execution logs of an API Deployment.
- Access
Logs []GetDeployment Specification Logging Policy Access Log Configures the logging policies for the access logs of an API Deployment.
- Execution
Logs []GetDeployment Specification Logging Policy Execution Log Configures the logging policies for the execution logs of an API Deployment.
- access
Logs List<GetDeployment Specification Logging Policy Access Log> Configures the logging policies for the access logs of an API Deployment.
- execution
Logs List<GetDeployment Specification Logging Policy Execution Log> Configures the logging policies for the execution logs of an API Deployment.
- access
Logs GetDeployment Specification Logging Policy Access Log[] Configures the logging policies for the access logs of an API Deployment.
- execution
Logs GetDeployment Specification Logging Policy Execution Log[] Configures the logging policies for the execution logs of an API Deployment.
- access_
logs GetDeployment Specification Logging Policy Access Log] Configures the logging policies for the access logs of an API Deployment.
- execution_
logs GetDeployment Specification Logging Policy Execution Log] Configures the logging policies for the execution logs of an API Deployment.
- access
Logs List<Property Map> Configures the logging policies for the access logs of an API Deployment.
- execution
Logs List<Property Map> Configures the logging policies for the execution logs of an API Deployment.
GetDeploymentSpecificationLoggingPolicyAccessLog
- Is
Enabled bool Whether this policy is currently enabled.
- Is
Enabled bool Whether this policy is currently enabled.
- is
Enabled Boolean Whether this policy is currently enabled.
- is
Enabled boolean Whether this policy is currently enabled.
- is_
enabled bool Whether this policy is currently enabled.
- is
Enabled Boolean Whether this policy is currently enabled.
GetDeploymentSpecificationLoggingPolicyExecutionLog
- 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.
GetDeploymentSpecificationRequestPolicy
- Authentications
List<Get
Deployment Specification Request Policy Authentication> Information on how to authenticate incoming requests.
- Cors
List<Get
Deployment Specification Request Policy Cor> Enable CORS (Cross-Origin-Resource-Sharing) request handling.
- Mutual
Tls List<GetDeployment Specification Request Policy Mutual Tl> Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.
- Rate
Limitings List<GetDeployment Specification Request Policy Rate Limiting> Limit the number of requests that should be handled for the specified window using a specfic key.
- Authentications
[]Get
Deployment Specification Request Policy Authentication Information on how to authenticate incoming requests.
- Cors
[]Get
Deployment Specification Request Policy Cor Enable CORS (Cross-Origin-Resource-Sharing) request handling.
- Mutual
Tls []GetDeployment Specification Request Policy Mutual Tl Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.
- Rate
Limitings []GetDeployment Specification Request Policy Rate Limiting Limit the number of requests that should be handled for the specified window using a specfic key.
- authentications
List<Get
Deployment Specification Request Policy Authentication> Information on how to authenticate incoming requests.
- cors
List<Get
Deployment Specification Request Policy Cor> Enable CORS (Cross-Origin-Resource-Sharing) request handling.
- mutual
Tls List<GetDeployment Specification Request Policy Mutual Tl> Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.
- rate
Limitings List<GetDeployment Specification Request Policy Rate Limiting> Limit the number of requests that should be handled for the specified window using a specfic key.
- authentications
Get
Deployment Specification Request Policy Authentication[] Information on how to authenticate incoming requests.
- cors
Get
Deployment Specification Request Policy Cor[] Enable CORS (Cross-Origin-Resource-Sharing) request handling.
- mutual
Tls GetDeployment Specification Request Policy Mutual Tl[] Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.
- rate
Limitings GetDeployment Specification Request Policy Rate Limiting[] Limit the number of requests that should be handled for the specified window using a specfic key.
- authentications
Get
Deployment Specification Request Policy Authentication] Information on how to authenticate incoming requests.
- cors
Get
Deployment Specification Request Policy Cor] Enable CORS (Cross-Origin-Resource-Sharing) request handling.
- mutual_
tls GetDeployment Specification Request Policy Mutual Tl] Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.
- rate_
limitings GetDeployment Specification Request Policy Rate Limiting] Limit the number of requests that should be handled for the specified window using a specfic key.
- authentications List<Property Map>
Information on how to authenticate incoming requests.
- cors List<Property Map>
Enable CORS (Cross-Origin-Resource-Sharing) request handling.
- mutual
Tls List<Property Map> Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.
- rate
Limitings List<Property Map> Limit the number of requests that should be handled for the specified window using a specfic key.
GetDeploymentSpecificationRequestPolicyAuthentication
- Audiences List<string>
The list of intended recipients for the token.
- Function
Id string The OCID of the Oracle Functions function resource.
- Is
Anonymous boolAccess Allowed Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
- Issuers List<string>
A list of parties that could have issued the token.
- Max
Clock doubleSkew In Seconds The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
- Public
Keys List<GetDeployment Specification Request Policy Authentication Public Key> A set of Public Keys that will be used to verify the JWT signature.
- Token
Auth stringScheme The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
- Token
Header string The name of the header containing the authentication token.
- Token
Query stringParam The name of the query parameter containing the authentication token.
- Type string
Type of the Response Cache Store Policy.
- Verify
Claims List<GetDeployment Specification Request Policy Authentication Verify Claim> A list of claims which should be validated to consider the token valid.
- Audiences []string
The list of intended recipients for the token.
- Function
Id string The OCID of the Oracle Functions function resource.
- Is
Anonymous boolAccess Allowed Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
- Issuers []string
A list of parties that could have issued the token.
- Max
Clock float64Skew In Seconds The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
- Public
Keys []GetDeployment Specification Request Policy Authentication Public Key A set of Public Keys that will be used to verify the JWT signature.
- Token
Auth stringScheme The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
- Token
Header string The name of the header containing the authentication token.
- Token
Query stringParam The name of the query parameter containing the authentication token.
- Type string
Type of the Response Cache Store Policy.
- Verify
Claims []GetDeployment Specification Request Policy Authentication Verify Claim A list of claims which should be validated to consider the token valid.
- audiences List<String>
The list of intended recipients for the token.
- function
Id String The OCID of the Oracle Functions function resource.
- is
Anonymous BooleanAccess Allowed Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
- issuers List<String>
A list of parties that could have issued the token.
- max
Clock DoubleSkew In Seconds The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
- public
Keys List<GetDeployment Specification Request Policy Authentication Public Key> A set of Public Keys that will be used to verify the JWT signature.
- token
Auth StringScheme The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
- token
Header String The name of the header containing the authentication token.
- token
Query StringParam The name of the query parameter containing the authentication token.
- type String
Type of the Response Cache Store Policy.
- verify
Claims List<GetDeployment Specification Request Policy Authentication Verify Claim> A list of claims which should be validated to consider the token valid.
- audiences string[]
The list of intended recipients for the token.
- function
Id string The OCID of the Oracle Functions function resource.
- is
Anonymous booleanAccess Allowed Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
- issuers string[]
A list of parties that could have issued the token.
- max
Clock numberSkew In Seconds The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
- public
Keys GetDeployment Specification Request Policy Authentication Public Key[] A set of Public Keys that will be used to verify the JWT signature.
- token
Auth stringScheme The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
- token
Header string The name of the header containing the authentication token.
- token
Query stringParam The name of the query parameter containing the authentication token.
- type string
Type of the Response Cache Store Policy.
- verify
Claims GetDeployment Specification Request Policy Authentication Verify Claim[] A list of claims which should be validated to consider the token valid.
- audiences Sequence[str]
The list of intended recipients for the token.
- function_
id str The OCID of the Oracle Functions function resource.
- is_
anonymous_ boolaccess_ allowed Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
- issuers Sequence[str]
A list of parties that could have issued the token.
- max_
clock_ floatskew_ in_ seconds The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
- public_
keys GetDeployment Specification Request Policy Authentication Public Key] A set of Public Keys that will be used to verify the JWT signature.
- token_
auth_ strscheme The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
- token_
header str The name of the header containing the authentication token.
- token_
query_ strparam The name of the query parameter containing the authentication token.
- type str
Type of the Response Cache Store Policy.
- verify_
claims GetDeployment Specification Request Policy Authentication Verify Claim] A list of claims which should be validated to consider the token valid.
- audiences List<String>
The list of intended recipients for the token.
- function
Id String The OCID of the Oracle Functions function resource.
- is
Anonymous BooleanAccess Allowed Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
- issuers List<String>
A list of parties that could have issued the token.
- max
Clock NumberSkew In Seconds The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
- public
Keys List<Property Map> A set of Public Keys that will be used to verify the JWT signature.
- token
Auth StringScheme The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
- token
Header String The name of the header containing the authentication token.
- token
Query StringParam The name of the query parameter containing the authentication token.
- type String
Type of the Response Cache Store Policy.
- verify
Claims List<Property Map> A list of claims which should be validated to consider the token valid.
GetDeploymentSpecificationRequestPolicyAuthenticationPublicKey
- Is
Ssl boolVerify Disabled Defines whether or not to uphold SSL verification.
- Keys
List<Get
Deployment Specification Request Policy Authentication Public Key Key> The set of static public keys.
- Max
Cache intDuration In Hours The duration for which the JWKS should be cached before it is fetched again.
- Type string
Type of the Response Cache Store Policy.
- Uri string
The uri from which to retrieve the key. It must be accessible without authentication.
- Is
Ssl boolVerify Disabled Defines whether or not to uphold SSL verification.
- Keys
[]Get
Deployment Specification Request Policy Authentication Public Key Key The set of static public keys.
- Max
Cache intDuration In Hours The duration for which the JWKS should be cached before it is fetched again.
- Type string
Type of the Response Cache Store Policy.
- Uri string
The uri from which to retrieve the key. It must be accessible without authentication.
- is
Ssl BooleanVerify Disabled Defines whether or not to uphold SSL verification.
- keys
List<Get
Deployment Specification Request Policy Authentication Public Key Key> The set of static public keys.
- max
Cache IntegerDuration In Hours The duration for which the JWKS should be cached before it is fetched again.
- type String
Type of the Response Cache Store Policy.
- uri String
The uri from which to retrieve the key. It must be accessible without authentication.
- is
Ssl booleanVerify Disabled Defines whether or not to uphold SSL verification.
- keys
Get
Deployment Specification Request Policy Authentication Public Key Key[] The set of static public keys.
- max
Cache numberDuration In Hours The duration for which the JWKS should be cached before it is fetched again.
- type string
Type of the Response Cache Store Policy.
- uri string
The uri from which to retrieve the key. It must be accessible without authentication.
- is_
ssl_ boolverify_ disabled Defines whether or not to uphold SSL verification.
- keys
Get
Deployment Specification Request Policy Authentication Public Key Key] The set of static public keys.
- max_
cache_ intduration_ in_ hours The duration for which the JWKS should be cached before it is fetched again.
- type str
Type of the Response Cache Store Policy.
- uri str
The uri from which to retrieve the key. It must be accessible without authentication.
- is
Ssl BooleanVerify Disabled Defines whether or not to uphold SSL verification.
- keys List<Property Map>
The set of static public keys.
- max
Cache NumberDuration In Hours The duration for which the JWKS should be cached before it is fetched again.
- type String
Type of the Response Cache Store Policy.
- uri String
The uri from which to retrieve the key. It must be accessible without authentication.
GetDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey
- Alg string
The algorithm intended for use with this key.
- E string
The base64 url encoded exponent of the RSA public key represented by this key.
- Format string
The format of the public key.
- Key string
Name of the claim.
- Key
Ops List<string> The operations for which this key is to be used.
- Kid string
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
- Kty string
The key type.
- N string
The base64 url encoded modulus of the RSA public key represented by this key.
- Use string
The intended use of the public key.
- Alg string
The algorithm intended for use with this key.
- E string
The base64 url encoded exponent of the RSA public key represented by this key.
- Format string
The format of the public key.
- Key string
Name of the claim.
- Key
Ops []string The operations for which this key is to be used.
- Kid string
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
- Kty string
The key type.
- N string
The base64 url encoded modulus of the RSA public key represented by this key.
- Use string
The intended use of the public key.
- alg String
The algorithm intended for use with this key.
- e String
The base64 url encoded exponent of the RSA public key represented by this key.
- format String
The format of the public key.
- key String
Name of the claim.
- key
Ops List<String> The operations for which this key is to be used.
- kid String
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
- kty String
The key type.
- n String
The base64 url encoded modulus of the RSA public key represented by this key.
- use String
The intended use of the public key.
- alg string
The algorithm intended for use with this key.
- e string
The base64 url encoded exponent of the RSA public key represented by this key.
- format string
The format of the public key.
- key string
Name of the claim.
- key
Ops string[] The operations for which this key is to be used.
- kid string
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
- kty string
The key type.
- n string
The base64 url encoded modulus of the RSA public key represented by this key.
- use string
The intended use of the public key.
- alg str
The algorithm intended for use with this key.
- e str
The base64 url encoded exponent of the RSA public key represented by this key.
- format str
The format of the public key.
- key str
Name of the claim.
- key_
ops Sequence[str] The operations for which this key is to be used.
- kid str
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
- kty str
The key type.
- n str
The base64 url encoded modulus of the RSA public key represented by this key.
- use str
The intended use of the public key.
- alg String
The algorithm intended for use with this key.
- e String
The base64 url encoded exponent of the RSA public key represented by this key.
- format String
The format of the public key.
- key String
Name of the claim.
- key
Ops List<String> The operations for which this key is to be used.
- kid String
A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
- kty String
The key type.
- n String
The base64 url encoded modulus of the RSA public key represented by this key.
- use String
The intended use of the public key.
GetDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim
- Is
Required bool Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
- Key string
Name of the claim.
- Values List<string>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- Is
Required bool Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
- Key string
Name of the claim.
- Values []string
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- is
Required Boolean Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
- key String
Name of the claim.
- values List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- is
Required boolean Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
- key string
Name of the claim.
- values string[]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- is_
required bool Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
- key str
Name of the claim.
- values Sequence[str]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- is
Required Boolean Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
- key String
Name of the claim.
- values List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
GetDeploymentSpecificationRequestPolicyCor
- Allowed
Headers List<string> The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
- Allowed
Methods List<string> The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
- Allowed
Origins List<string> The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
- Exposed
Headers List<string> The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
- Is
Allow boolCredentials Enabled Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
- Max
Age intIn Seconds The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
- Allowed
Headers []string The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
- Allowed
Methods []string The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
- Allowed
Origins []string The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
- Exposed
Headers []string The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
- Is
Allow boolCredentials Enabled Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
- Max
Age intIn Seconds The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
- allowed
Headers List<String> The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
- allowed
Methods List<String> The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
- allowed
Origins List<String> The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
- exposed
Headers List<String> The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
- is
Allow BooleanCredentials Enabled Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
- max
Age IntegerIn Seconds The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
- allowed
Headers string[] The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
- allowed
Methods string[] The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
- allowed
Origins string[] The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
- exposed
Headers string[] The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
- is
Allow booleanCredentials Enabled Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
- max
Age numberIn Seconds The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
- allowed_
headers Sequence[str] The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
- allowed_
methods Sequence[str] The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
- allowed_
origins Sequence[str] The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
- exposed_
headers Sequence[str] The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
- is_
allow_ boolcredentials_ enabled Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
- max_
age_ intin_ seconds The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
- allowed
Headers List<String> The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
- allowed
Methods List<String> The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
- allowed
Origins List<String> The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
- exposed
Headers List<String> The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
- is
Allow BooleanCredentials Enabled Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
- max
Age NumberIn Seconds The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
GetDeploymentSpecificationRequestPolicyMutualTl
- Allowed
Sans List<string> Allowed list of CN or SAN which will be used for verification of certificate.
- Is
Verified boolCertificate Required Determines whether to enable client verification when API Consumer makes connection to the gateway.
- Allowed
Sans []string Allowed list of CN or SAN which will be used for verification of certificate.
- Is
Verified boolCertificate Required Determines whether to enable client verification when API Consumer makes connection to the gateway.
- allowed
Sans List<String> Allowed list of CN or SAN which will be used for verification of certificate.
- is
Verified BooleanCertificate Required Determines whether to enable client verification when API Consumer makes connection to the gateway.
- allowed
Sans string[] Allowed list of CN or SAN which will be used for verification of certificate.
- is
Verified booleanCertificate Required Determines whether to enable client verification when API Consumer makes connection to the gateway.
- allowed_
sans Sequence[str] Allowed list of CN or SAN which will be used for verification of certificate.
- is_
verified_ boolcertificate_ required Determines whether to enable client verification when API Consumer makes connection to the gateway.
- allowed
Sans List<String> Allowed list of CN or SAN which will be used for verification of certificate.
- is
Verified BooleanCertificate Required Determines whether to enable client verification when API Consumer makes connection to the gateway.
GetDeploymentSpecificationRequestPolicyRateLimiting
- Rate
In intRequests Per Second The maximum number of requests per second to allow.
- Rate
Key string The key used to group requests together.
- Rate
In intRequests Per Second The maximum number of requests per second to allow.
- Rate
Key string The key used to group requests together.
- rate
In IntegerRequests Per Second The maximum number of requests per second to allow.
- rate
Key String The key used to group requests together.
- rate
In numberRequests Per Second The maximum number of requests per second to allow.
- rate
Key string The key used to group requests together.
- rate_
in_ intrequests_ per_ second The maximum number of requests per second to allow.
- rate_
key str The key used to group requests together.
- rate
In NumberRequests Per Second The maximum number of requests per second to allow.
- rate
Key String The key used to group requests together.
GetDeploymentSpecificationRoute
- Backends
List<Get
Deployment Specification Route Backend> The backend to forward requests to.
- Logging
Policies List<GetDeployment Specification Route Logging Policy> Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
- Methods List<string>
A list of allowed methods on this route.
- Path string
A URL path pattern that must be matched on this route. The path pattern may contain a subset of RFC 6570 identifiers to allow wildcard and parameterized matching.
- Request
Policies List<GetDeployment Specification Route Request Policy> Behavior applied to any requests received by the API on this route.
- Response
Policies List<GetDeployment Specification Route Response Policy> Behavior applied to any responses sent by the API for requests on this route.
- Backends
[]Get
Deployment Specification Route Backend The backend to forward requests to.
- Logging
Policies []GetDeployment Specification Route Logging Policy Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
- Methods []string
A list of allowed methods on this route.
- Path string
A URL path pattern that must be matched on this route. The path pattern may contain a subset of RFC 6570 identifiers to allow wildcard and parameterized matching.
- Request
Policies []GetDeployment Specification Route Request Policy Behavior applied to any requests received by the API on this route.
- Response
Policies []GetDeployment Specification Route Response Policy Behavior applied to any responses sent by the API for requests on this route.
- backends
List<Get
Deployment Specification Route Backend> The backend to forward requests to.
- logging
Policies List<GetDeployment Specification Route Logging Policy> Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
- methods List<String>
A list of allowed methods on this route.
- path String
A URL path pattern that must be matched on this route. The path pattern may contain a subset of RFC 6570 identifiers to allow wildcard and parameterized matching.
- request
Policies List<GetDeployment Specification Route Request Policy> Behavior applied to any requests received by the API on this route.
- response
Policies List<GetDeployment Specification Route Response Policy> Behavior applied to any responses sent by the API for requests on this route.
- backends
Get
Deployment Specification Route Backend[] The backend to forward requests to.
- logging
Policies GetDeployment Specification Route Logging Policy[] Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
- methods string[]
A list of allowed methods on this route.
- path string
A URL path pattern that must be matched on this route. The path pattern may contain a subset of RFC 6570 identifiers to allow wildcard and parameterized matching.
- request
Policies GetDeployment Specification Route Request Policy[] Behavior applied to any requests received by the API on this route.
- response
Policies GetDeployment Specification Route Response Policy[] Behavior applied to any responses sent by the API for requests on this route.
- backends
Get
Deployment Specification Route Backend] The backend to forward requests to.
- logging_
policies GetDeployment Specification Route Logging Policy] Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
- methods Sequence[str]
A list of allowed methods on this route.
- path str
A URL path pattern that must be matched on this route. The path pattern may contain a subset of RFC 6570 identifiers to allow wildcard and parameterized matching.
- request_
policies GetDeployment Specification Route Request Policy] Behavior applied to any requests received by the API on this route.
- response_
policies GetDeployment Specification Route Response Policy] Behavior applied to any responses sent by the API for requests on this route.
- backends List<Property Map>
The backend to forward requests to.
- logging
Policies List<Property Map> Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
- methods List<String>
A list of allowed methods on this route.
- path String
A URL path pattern that must be matched on this route. The path pattern may contain a subset of RFC 6570 identifiers to allow wildcard and parameterized matching.
- request
Policies List<Property Map> Behavior applied to any requests received by the API on this route.
- response
Policies List<Property Map> Behavior applied to any responses sent by the API for requests on this route.
GetDeploymentSpecificationRouteBackend
- Body string
The body of the stock response from the mock backend.
- Connect
Timeout doubleIn Seconds Defines a timeout for establishing a connection with a proxied server.
- Function
Id string The OCID of the Oracle Functions function resource.
- Headers
List<Get
Deployment Specification Route Backend Header> - Is
Ssl boolVerify Disabled Defines whether or not to uphold SSL verification.
- Read
Timeout doubleIn Seconds Defines a timeout for reading a response from the proxied server.
- Send
Timeout doubleIn Seconds Defines a timeout for transmitting a request to the proxied server.
- Status int
The status code of the stock response from the mock backend.
- Type string
Type of the Response Cache Store Policy.
- Url string
- Body string
The body of the stock response from the mock backend.
- Connect
Timeout float64In Seconds Defines a timeout for establishing a connection with a proxied server.
- Function
Id string The OCID of the Oracle Functions function resource.
- Headers
[]Get
Deployment Specification Route Backend Header - Is
Ssl boolVerify Disabled Defines whether or not to uphold SSL verification.
- Read
Timeout float64In Seconds Defines a timeout for reading a response from the proxied server.
- Send
Timeout float64In Seconds Defines a timeout for transmitting a request to the proxied server.
- Status int
The status code of the stock response from the mock backend.
- Type string
Type of the Response Cache Store Policy.
- Url string
- body String
The body of the stock response from the mock backend.
- connect
Timeout DoubleIn Seconds Defines a timeout for establishing a connection with a proxied server.
- function
Id String The OCID of the Oracle Functions function resource.
- headers
List<Get
Deployment Specification Route Backend Header> - is
Ssl BooleanVerify Disabled Defines whether or not to uphold SSL verification.
- read
Timeout DoubleIn Seconds Defines a timeout for reading a response from the proxied server.
- send
Timeout DoubleIn Seconds Defines a timeout for transmitting a request to the proxied server.
- status Integer
The status code of the stock response from the mock backend.
- type String
Type of the Response Cache Store Policy.
- url String
- body string
The body of the stock response from the mock backend.
- connect
Timeout numberIn Seconds Defines a timeout for establishing a connection with a proxied server.
- function
Id string The OCID of the Oracle Functions function resource.
- headers
Get
Deployment Specification Route Backend Header[] - is
Ssl booleanVerify Disabled Defines whether or not to uphold SSL verification.
- read
Timeout numberIn Seconds Defines a timeout for reading a response from the proxied server.
- send
Timeout numberIn Seconds Defines a timeout for transmitting a request to the proxied server.
- status number
The status code of the stock response from the mock backend.
- type string
Type of the Response Cache Store Policy.
- url string
- body str
The body of the stock response from the mock backend.
- connect_
timeout_ floatin_ seconds Defines a timeout for establishing a connection with a proxied server.
- function_
id str The OCID of the Oracle Functions function resource.
- headers
Get
Deployment Specification Route Backend Header] - is_
ssl_ boolverify_ disabled Defines whether or not to uphold SSL verification.
- read_
timeout_ floatin_ seconds Defines a timeout for reading a response from the proxied server.
- send_
timeout_ floatin_ seconds Defines a timeout for transmitting a request to the proxied server.
- status int
The status code of the stock response from the mock backend.
- type str
Type of the Response Cache Store Policy.
- url str
- body String
The body of the stock response from the mock backend.
- connect
Timeout NumberIn Seconds Defines a timeout for establishing a connection with a proxied server.
- function
Id String The OCID of the Oracle Functions function resource.
- headers List<Property Map>
- is
Ssl BooleanVerify Disabled Defines whether or not to uphold SSL verification.
- read
Timeout NumberIn Seconds Defines a timeout for reading a response from the proxied server.
- send
Timeout NumberIn Seconds Defines a timeout for transmitting a request to the proxied server.
- status Number
The status code of the stock response from the mock backend.
- type String
Type of the Response Cache Store Policy.
- url String
GetDeploymentSpecificationRouteBackendHeader
GetDeploymentSpecificationRouteLoggingPolicy
- Access
Logs List<GetDeployment Specification Route Logging Policy Access Log> Configures the logging policies for the access logs of an API Deployment.
- Execution
Logs List<GetDeployment Specification Route Logging Policy Execution Log> Configures the logging policies for the execution logs of an API Deployment.
- Access
Logs []GetDeployment Specification Route Logging Policy Access Log Configures the logging policies for the access logs of an API Deployment.
- Execution
Logs []GetDeployment Specification Route Logging Policy Execution Log Configures the logging policies for the execution logs of an API Deployment.
- access
Logs List<GetDeployment Specification Route Logging Policy Access Log> Configures the logging policies for the access logs of an API Deployment.
- execution
Logs List<GetDeployment Specification Route Logging Policy Execution Log> Configures the logging policies for the execution logs of an API Deployment.
- access
Logs GetDeployment Specification Route Logging Policy Access Log[] Configures the logging policies for the access logs of an API Deployment.
- execution
Logs GetDeployment Specification Route Logging Policy Execution Log[] Configures the logging policies for the execution logs of an API Deployment.
- access_
logs GetDeployment Specification Route Logging Policy Access Log] Configures the logging policies for the access logs of an API Deployment.
- execution_
logs GetDeployment Specification Route Logging Policy Execution Log] Configures the logging policies for the execution logs of an API Deployment.
- access
Logs List<Property Map> Configures the logging policies for the access logs of an API Deployment.
- execution
Logs List<Property Map> Configures the logging policies for the execution logs of an API Deployment.
GetDeploymentSpecificationRouteLoggingPolicyAccessLog
- Is
Enabled bool Whether this policy is currently enabled.
- Is
Enabled bool Whether this policy is currently enabled.
- is
Enabled Boolean Whether this policy is currently enabled.
- is
Enabled boolean Whether this policy is currently enabled.
- is_
enabled bool Whether this policy is currently enabled.
- is
Enabled Boolean Whether this policy is currently enabled.
GetDeploymentSpecificationRouteLoggingPolicyExecutionLog
- 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.
GetDeploymentSpecificationRouteRequestPolicy
- List<Get
Deployment Specification Route Request Policy Authorization> If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.
- Body
Validations List<GetDeployment Specification Route Request Policy Body Validation> Validate the payload body of the incoming API requests on a specific route.
- Cors
List<Get
Deployment Specification Route Request Policy Cor> Enable CORS (Cross-Origin-Resource-Sharing) request handling.
- Header
Transformations List<GetDeployment Specification Route Request Policy Header Transformation> A set of transformations to apply to HTTP headers that pass through the gateway.
- Header
Validations List<GetDeployment Specification Route Request Policy Header Validation> Validate the HTTP headers on the incoming API requests on a specific route.
- Query
Parameter List<GetTransformations Deployment Specification Route Request Policy Query Parameter Transformation> A set of transformations to apply to query parameters that pass through the gateway.
- Query
Parameter List<GetValidations Deployment Specification Route Request Policy Query Parameter Validation> Validate the URL query parameters on the incoming API requests on a specific route.
- Response
Cache List<GetLookups Deployment Specification Route Request Policy Response Cache Lookup> Base policy for Response Cache lookup.
- []Get
Deployment Specification Route Request Policy Authorization If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.
- Body
Validations []GetDeployment Specification Route Request Policy Body Validation Validate the payload body of the incoming API requests on a specific route.
- Cors
[]Get
Deployment Specification Route Request Policy Cor Enable CORS (Cross-Origin-Resource-Sharing) request handling.
- Header
Transformations []GetDeployment Specification Route Request Policy Header Transformation A set of transformations to apply to HTTP headers that pass through the gateway.
- Header
Validations []GetDeployment Specification Route Request Policy Header Validation Validate the HTTP headers on the incoming API requests on a specific route.
- Query
Parameter []GetTransformations Deployment Specification Route Request Policy Query Parameter Transformation A set of transformations to apply to query parameters that pass through the gateway.
- Query
Parameter []GetValidations Deployment Specification Route Request Policy Query Parameter Validation Validate the URL query parameters on the incoming API requests on a specific route.
- Response
Cache []GetLookups Deployment Specification Route Request Policy Response Cache Lookup Base policy for Response Cache lookup.
- List<Get
Deployment Specification Route Request Policy Authorization> If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.
- body
Validations List<GetDeployment Specification Route Request Policy Body Validation> Validate the payload body of the incoming API requests on a specific route.
- cors
List<Get
Deployment Specification Route Request Policy Cor> Enable CORS (Cross-Origin-Resource-Sharing) request handling.
- header
Transformations List<GetDeployment Specification Route Request Policy Header Transformation> A set of transformations to apply to HTTP headers that pass through the gateway.
- header
Validations List<GetDeployment Specification Route Request Policy Header Validation> Validate the HTTP headers on the incoming API requests on a specific route.
- query
Parameter List<GetTransformations Deployment Specification Route Request Policy Query Parameter Transformation> A set of transformations to apply to query parameters that pass through the gateway.
- query
Parameter List<GetValidations Deployment Specification Route Request Policy Query Parameter Validation> Validate the URL query parameters on the incoming API requests on a specific route.
- response
Cache List<GetLookups Deployment Specification Route Request Policy Response Cache Lookup> Base policy for Response Cache lookup.
- Get
Deployment Specification Route Request Policy Authorization[] If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.
- body
Validations GetDeployment Specification Route Request Policy Body Validation[] Validate the payload body of the incoming API requests on a specific route.
- cors
Get
Deployment Specification Route Request Policy Cor[] Enable CORS (Cross-Origin-Resource-Sharing) request handling.
- header
Transformations GetDeployment Specification Route Request Policy Header Transformation[] A set of transformations to apply to HTTP headers that pass through the gateway.
- header
Validations GetDeployment Specification Route Request Policy Header Validation[] Validate the HTTP headers on the incoming API requests on a specific route.
- query
Parameter GetTransformations Deployment Specification Route Request Policy Query Parameter Transformation[] A set of transformations to apply to query parameters that pass through the gateway.
- query
Parameter GetValidations Deployment Specification Route Request Policy Query Parameter Validation[] Validate the URL query parameters on the incoming API requests on a specific route.
- response
Cache GetLookups Deployment Specification Route Request Policy Response Cache Lookup[] Base policy for Response Cache lookup.
- Get
Deployment Specification Route Request Policy Authorization] If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.
- body_
validations GetDeployment Specification Route Request Policy Body Validation] Validate the payload body of the incoming API requests on a specific route.
- cors
Get
Deployment Specification Route Request Policy Cor] Enable CORS (Cross-Origin-Resource-Sharing) request handling.
- header_
transformations GetDeployment Specification Route Request Policy Header Transformation] A set of transformations to apply to HTTP headers that pass through the gateway.
- header_
validations GetDeployment Specification Route Request Policy Header Validation] Validate the HTTP headers on the incoming API requests on a specific route.
- query_
parameter_ Gettransformations Deployment Specification Route Request Policy Query Parameter Transformation] A set of transformations to apply to query parameters that pass through the gateway.
- query_
parameter_ Getvalidations Deployment Specification Route Request Policy Query Parameter Validation] Validate the URL query parameters on the incoming API requests on a specific route.
- response_
cache_ Getlookups Deployment Specification Route Request Policy Response Cache Lookup] Base policy for Response Cache lookup.
- List<Property Map>
If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.
- body
Validations List<Property Map> Validate the payload body of the incoming API requests on a specific route.
- cors List<Property Map>
Enable CORS (Cross-Origin-Resource-Sharing) request handling.
- header
Transformations List<Property Map> A set of transformations to apply to HTTP headers that pass through the gateway.
- header
Validations List<Property Map> Validate the HTTP headers on the incoming API requests on a specific route.
- query
Parameter List<Property Map>Transformations A set of transformations to apply to query parameters that pass through the gateway.
- query
Parameter List<Property Map>Validations Validate the URL query parameters on the incoming API requests on a specific route.
- response
Cache List<Property Map>Lookups Base policy for Response Cache lookup.
GetDeploymentSpecificationRouteRequestPolicyAuthorization
- Allowed
Scopes List<string> A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.
- Type string
Type of the Response Cache Store Policy.
- Allowed
Scopes []string A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.
- Type string
Type of the Response Cache Store Policy.
- allowed
Scopes List<String> A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.
- type String
Type of the Response Cache Store Policy.
- allowed
Scopes string[] A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.
- type string
Type of the Response Cache Store Policy.
- allowed_
scopes Sequence[str] A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.
- type str
Type of the Response Cache Store Policy.
- allowed
Scopes List<String> A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.
- type String
Type of the Response Cache Store Policy.
GetDeploymentSpecificationRouteRequestPolicyBodyValidation
- Contents
List<Get
Deployment Specification Route Request Policy Body Validation Content> The content of the request body.
- Required bool
Determines if the parameter is required in the request.
- Validation
Mode string Validation behavior mode.
- Contents
[]Get
Deployment Specification Route Request Policy Body Validation Content The content of the request body.
- Required bool
Determines if the parameter is required in the request.
- Validation
Mode string Validation behavior mode.
- contents
List<Get
Deployment Specification Route Request Policy Body Validation Content> The content of the request body.
- required Boolean
Determines if the parameter is required in the request.
- validation
Mode String Validation behavior mode.
- contents
Get
Deployment Specification Route Request Policy Body Validation Content[] The content of the request body.
- required boolean
Determines if the parameter is required in the request.
- validation
Mode string Validation behavior mode.
- contents
Get
Deployment Specification Route Request Policy Body Validation Content] The content of the request body.
- required bool
Determines if the parameter is required in the request.
- validation_
mode str Validation behavior mode.
- contents List<Property Map>
The content of the request body.
- required Boolean
Determines if the parameter is required in the request.
- validation
Mode String Validation behavior mode.
GetDeploymentSpecificationRouteRequestPolicyBodyValidationContent
- Media
Type string The media type is a media type range subset restricted to the following schema
- Validation
Type string Validation type defines the content validation method.
- Media
Type string The media type is a media type range subset restricted to the following schema
- Validation
Type string Validation type defines the content validation method.
- media
Type String The media type is a media type range subset restricted to the following schema
- validation
Type String Validation type defines the content validation method.
- media
Type string The media type is a media type range subset restricted to the following schema
- validation
Type string Validation type defines the content validation method.
- media_
type str The media type is a media type range subset restricted to the following schema
- validation_
type str Validation type defines the content validation method.
- media
Type String The media type is a media type range subset restricted to the following schema
- validation
Type String Validation type defines the content validation method.
GetDeploymentSpecificationRouteRequestPolicyCor
- Allowed
Headers List<string> The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
- Allowed
Methods List<string> The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
- Allowed
Origins List<string> The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
- Exposed
Headers List<string> The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
- Is
Allow boolCredentials Enabled Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
- Max
Age intIn Seconds The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
- Allowed
Headers []string The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
- Allowed
Methods []string The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
- Allowed
Origins []string The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
- Exposed
Headers []string The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
- Is
Allow boolCredentials Enabled Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
- Max
Age intIn Seconds The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
- allowed
Headers List<String> The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
- allowed
Methods List<String> The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
- allowed
Origins List<String> The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
- exposed
Headers List<String> The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
- is
Allow BooleanCredentials Enabled Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
- max
Age IntegerIn Seconds The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
- allowed
Headers string[] The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
- allowed
Methods string[] The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
- allowed
Origins string[] The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
- exposed
Headers string[] The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
- is
Allow booleanCredentials Enabled Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
- max
Age numberIn Seconds The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
- allowed_
headers Sequence[str] The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
- allowed_
methods Sequence[str] The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
- allowed_
origins Sequence[str] The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
- exposed_
headers Sequence[str] The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
- is_
allow_ boolcredentials_ enabled Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
- max_
age_ intin_ seconds The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
- allowed
Headers List<String> The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
- allowed
Methods List<String> The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
- allowed
Origins List<String> The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
- exposed
Headers List<String> The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
- is
Allow BooleanCredentials Enabled Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
- max
Age NumberIn Seconds The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.
GetDeploymentSpecificationRouteRequestPolicyHeaderTransformation
- Filter
Headers List<GetDeployment Specification Route Request Policy Header Transformation Filter Header> Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
- Rename
Headers List<GetDeployment Specification Route Request Policy Header Transformation Rename Header> Rename HTTP headers as they pass through the gateway.
- Set
Headers List<GetDeployment Specification Route Request Policy Header Transformation Set Header> Set HTTP headers as they pass through the gateway.
- Filter
Headers []GetDeployment Specification Route Request Policy Header Transformation Filter Header Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
- Rename
Headers []GetDeployment Specification Route Request Policy Header Transformation Rename Header Rename HTTP headers as they pass through the gateway.
- Set
Headers []GetDeployment Specification Route Request Policy Header Transformation Set Header Set HTTP headers as they pass through the gateway.
- filter
Headers List<GetDeployment Specification Route Request Policy Header Transformation Filter Header> Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
- rename
Headers List<GetDeployment Specification Route Request Policy Header Transformation Rename Header> Rename HTTP headers as they pass through the gateway.
- set
Headers List<GetDeployment Specification Route Request Policy Header Transformation Set Header> Set HTTP headers as they pass through the gateway.
- filter
Headers GetDeployment Specification Route Request Policy Header Transformation Filter Header[] Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
- rename
Headers GetDeployment Specification Route Request Policy Header Transformation Rename Header[] Rename HTTP headers as they pass through the gateway.
- set
Headers GetDeployment Specification Route Request Policy Header Transformation Set Header[] Set HTTP headers as they pass through the gateway.
- filter_
headers GetDeployment Specification Route Request Policy Header Transformation Filter Header] Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
- rename_
headers GetDeployment Specification Route Request Policy Header Transformation Rename Header] Rename HTTP headers as they pass through the gateway.
- set_
headers GetDeployment Specification Route Request Policy Header Transformation Set Header] Set HTTP headers as they pass through the gateway.
- filter
Headers List<Property Map> Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
- rename
Headers List<Property Map> Rename HTTP headers as they pass through the gateway.
- set
Headers List<Property Map> Set HTTP headers as they pass through the gateway.
GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeader
- Items
List<Get
Deployment Specification Route Request Policy Header Transformation Filter Header Item> The list of headers.
- Type string
Type of the Response Cache Store Policy.
- Items
[]Get
Deployment Specification Route Request Policy Header Transformation Filter Header Item The list of headers.
- Type string
Type of the Response Cache Store Policy.
- items
List<Get
Deployment Specification Route Request Policy Header Transformation Filter Header Item> The list of headers.
- type String
Type of the Response Cache Store Policy.
- items
Get
Deployment Specification Route Request Policy Header Transformation Filter Header Item[] The list of headers.
- type string
Type of the Response Cache Store Policy.
- items
Get
Deployment Specification Route Request Policy Header Transformation Filter Header Item] The list of headers.
- type str
Type of the Response Cache Store Policy.
- items List<Property Map>
The list of headers.
- type String
Type of the Response Cache Store Policy.
GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem
- 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.
GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader
- items List<Property Map>
The list of headers.
GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeaderItem
GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader
- Items
[]Get
Deployment Specification Route Request Policy Header Transformation Set Header Item The list of headers.
- items
Get
Deployment Specification Route Request Policy Header Transformation Set Header Item[] The list of headers.
- items
Get
Deployment Specification Route Request Policy Header Transformation Set Header Item] The list of headers.
- items List<Property Map>
The list of headers.
GetDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeaderItem
- If
Exists string If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- Name string
The case-insensitive name of the header. This name must be unique across transformation policies.
- Values List<string>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- If
Exists string If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- Name string
The case-insensitive name of the header. This name must be unique across transformation policies.
- Values []string
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- if
Exists String If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- name String
The case-insensitive name of the header. This name must be unique across transformation policies.
- values List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- if
Exists string If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- name string
The case-insensitive name of the header. This name must be unique across transformation policies.
- values string[]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- if_
exists str If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- name str
The case-insensitive name of the header. This name must be unique across transformation policies.
- values Sequence[str]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- if
Exists String If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- name String
The case-insensitive name of the header. This name must be unique across transformation policies.
- values List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
GetDeploymentSpecificationRouteRequestPolicyHeaderValidation
- Headers
List<Get
Deployment Specification Route Request Policy Header Validation Header> - Validation
Mode string Validation behavior mode.
- Headers
[]Get
Deployment Specification Route Request Policy Header Validation Header - Validation
Mode string Validation behavior mode.
- headers
List<Get
Deployment Specification Route Request Policy Header Validation Header> - validation
Mode String Validation behavior mode.
- headers
Get
Deployment Specification Route Request Policy Header Validation Header[] - validation
Mode string Validation behavior mode.
- headers
Get
Deployment Specification Route Request Policy Header Validation Header] - validation_
mode str Validation behavior mode.
- headers List<Property Map>
- validation
Mode String Validation behavior mode.
GetDeploymentSpecificationRouteRequestPolicyHeaderValidationHeader
GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation
- Filter
Query List<GetParameters Deployment Specification Route Request Policy Query Parameter Transformation Filter Query Parameter> Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.
- Rename
Query List<GetParameters Deployment Specification Route Request Policy Query Parameter Transformation Rename Query Parameter> Rename parameters on the query string as they pass through the gateway.
- Set
Query List<GetParameters Deployment Specification Route Request Policy Query Parameter Transformation Set Query Parameter> Set parameters on the query string as they pass through the gateway.
- Filter
Query []GetParameters Deployment Specification Route Request Policy Query Parameter Transformation Filter Query Parameter Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.
- Rename
Query []GetParameters Deployment Specification Route Request Policy Query Parameter Transformation Rename Query Parameter Rename parameters on the query string as they pass through the gateway.
- Set
Query []GetParameters Deployment Specification Route Request Policy Query Parameter Transformation Set Query Parameter Set parameters on the query string as they pass through the gateway.
- filter
Query List<GetParameters Deployment Specification Route Request Policy Query Parameter Transformation Filter Query Parameter> Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.
- rename
Query List<GetParameters Deployment Specification Route Request Policy Query Parameter Transformation Rename Query Parameter> Rename parameters on the query string as they pass through the gateway.
- set
Query List<GetParameters Deployment Specification Route Request Policy Query Parameter Transformation Set Query Parameter> Set parameters on the query string as they pass through the gateway.
- filter
Query GetParameters Deployment Specification Route Request Policy Query Parameter Transformation Filter Query Parameter[] Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.
- rename
Query GetParameters Deployment Specification Route Request Policy Query Parameter Transformation Rename Query Parameter[] Rename parameters on the query string as they pass through the gateway.
- set
Query GetParameters Deployment Specification Route Request Policy Query Parameter Transformation Set Query Parameter[] Set parameters on the query string as they pass through the gateway.
- filter_
query_ Getparameters Deployment Specification Route Request Policy Query Parameter Transformation Filter Query Parameter] Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.
- rename_
query_ Getparameters Deployment Specification Route Request Policy Query Parameter Transformation Rename Query Parameter] Rename parameters on the query string as they pass through the gateway.
- set_
query_ Getparameters Deployment Specification Route Request Policy Query Parameter Transformation Set Query Parameter] Set parameters on the query string as they pass through the gateway.
- filter
Query List<Property Map>Parameters Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.
- rename
Query List<Property Map>Parameters Rename parameters on the query string as they pass through the gateway.
- set
Query List<Property Map>Parameters Set parameters on the query string as they pass through the gateway.
GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter
- Items
List<Get
Deployment Specification Route Request Policy Query Parameter Transformation Filter Query Parameter Item> The list of headers.
- Type string
Type of the Response Cache Store Policy.
- Items
[]Get
Deployment Specification Route Request Policy Query Parameter Transformation Filter Query Parameter Item The list of headers.
- Type string
Type of the Response Cache Store Policy.
- items
List<Get
Deployment Specification Route Request Policy Query Parameter Transformation Filter Query Parameter Item> The list of headers.
- type String
Type of the Response Cache Store Policy.
- items
Get
Deployment Specification Route Request Policy Query Parameter Transformation Filter Query Parameter Item[] The list of headers.
- type string
Type of the Response Cache Store Policy.
- items
Get
Deployment Specification Route Request Policy Query Parameter Transformation Filter Query Parameter Item] The list of headers.
- type str
Type of the Response Cache Store Policy.
- items List<Property Map>
The list of headers.
- type String
Type of the Response Cache Store Policy.
GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameterItem
- 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.
GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter
- items List<Property Map>
The list of headers.
GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameterItem
GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter
- items List<Property Map>
The list of headers.
GetDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameterItem
- If
Exists string If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- Name string
The case-insensitive name of the header. This name must be unique across transformation policies.
- Values List<string>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- If
Exists string If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- Name string
The case-insensitive name of the header. This name must be unique across transformation policies.
- Values []string
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- if
Exists String If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- name String
The case-insensitive name of the header. This name must be unique across transformation policies.
- values List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- if
Exists string If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- name string
The case-insensitive name of the header. This name must be unique across transformation policies.
- values string[]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- if_
exists str If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- name str
The case-insensitive name of the header. This name must be unique across transformation policies.
- values Sequence[str]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- if
Exists String If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- name String
The case-insensitive name of the header. This name must be unique across transformation policies.
- values List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
GetDeploymentSpecificationRouteRequestPolicyQueryParameterValidation
- Parameters
List<Get
Deployment Specification Route Request Policy Query Parameter Validation Parameter> - Validation
Mode string Validation behavior mode.
- Parameters
[]Get
Deployment Specification Route Request Policy Query Parameter Validation Parameter - Validation
Mode string Validation behavior mode.
- parameters
List<Get
Deployment Specification Route Request Policy Query Parameter Validation Parameter> - validation
Mode String Validation behavior mode.
- parameters
Get
Deployment Specification Route Request Policy Query Parameter Validation Parameter[] - validation
Mode string Validation behavior mode.
- parameters
Get
Deployment Specification Route Request Policy Query Parameter Validation Parameter] - validation_
mode str Validation behavior mode.
- parameters List<Property Map>
- validation
Mode String Validation behavior mode.
GetDeploymentSpecificationRouteRequestPolicyQueryParameterValidationParameter
GetDeploymentSpecificationRouteRequestPolicyResponseCacheLookup
- Cache
Key List<string>Additions A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available.
- Is
Enabled bool Whether this policy is currently enabled.
- Is
Private boolCaching Enabled Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your cache key additions to get the level of isolation across authenticated requests that you require.
- Type string
Type of the Response Cache Store Policy.
- Cache
Key []stringAdditions A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available.
- Is
Enabled bool Whether this policy is currently enabled.
- Is
Private boolCaching Enabled Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your cache key additions to get the level of isolation across authenticated requests that you require.
- Type string
Type of the Response Cache Store Policy.
- cache
Key List<String>Additions A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available.
- is
Enabled Boolean Whether this policy is currently enabled.
- is
Private BooleanCaching Enabled Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your cache key additions to get the level of isolation across authenticated requests that you require.
- type String
Type of the Response Cache Store Policy.
- cache
Key string[]Additions A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available.
- is
Enabled boolean Whether this policy is currently enabled.
- is
Private booleanCaching Enabled Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your cache key additions to get the level of isolation across authenticated requests that you require.
- type string
Type of the Response Cache Store Policy.
- cache_
key_ Sequence[str]additions A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available.
- is_
enabled bool Whether this policy is currently enabled.
- is_
private_ boolcaching_ enabled Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your cache key additions to get the level of isolation across authenticated requests that you require.
- type str
Type of the Response Cache Store Policy.
- cache
Key List<String>Additions A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available.
- is
Enabled Boolean Whether this policy is currently enabled.
- is
Private BooleanCaching Enabled Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your cache key additions to get the level of isolation across authenticated requests that you require.
- type String
Type of the Response Cache Store Policy.
GetDeploymentSpecificationRouteResponsePolicy
- Header
Transformations List<GetDeployment Specification Route Response Policy Header Transformation> A set of transformations to apply to HTTP headers that pass through the gateway.
- Response
Cache List<GetStores Deployment Specification Route Response Policy Response Cache Store> Base policy for how a response from a backend is cached in the Response Cache.
- Header
Transformations []GetDeployment Specification Route Response Policy Header Transformation A set of transformations to apply to HTTP headers that pass through the gateway.
- Response
Cache []GetStores Deployment Specification Route Response Policy Response Cache Store Base policy for how a response from a backend is cached in the Response Cache.
- header
Transformations List<GetDeployment Specification Route Response Policy Header Transformation> A set of transformations to apply to HTTP headers that pass through the gateway.
- response
Cache List<GetStores Deployment Specification Route Response Policy Response Cache Store> Base policy for how a response from a backend is cached in the Response Cache.
- header
Transformations GetDeployment Specification Route Response Policy Header Transformation[] A set of transformations to apply to HTTP headers that pass through the gateway.
- response
Cache GetStores Deployment Specification Route Response Policy Response Cache Store[] Base policy for how a response from a backend is cached in the Response Cache.
- header_
transformations GetDeployment Specification Route Response Policy Header Transformation] A set of transformations to apply to HTTP headers that pass through the gateway.
- response_
cache_ Getstores Deployment Specification Route Response Policy Response Cache Store] Base policy for how a response from a backend is cached in the Response Cache.
- header
Transformations List<Property Map> A set of transformations to apply to HTTP headers that pass through the gateway.
- response
Cache List<Property Map>Stores Base policy for how a response from a backend is cached in the Response Cache.
GetDeploymentSpecificationRouteResponsePolicyHeaderTransformation
- Filter
Headers List<GetDeployment Specification Route Response Policy Header Transformation Filter Header> Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
- Rename
Headers List<GetDeployment Specification Route Response Policy Header Transformation Rename Header> Rename HTTP headers as they pass through the gateway.
- Set
Headers List<GetDeployment Specification Route Response Policy Header Transformation Set Header> Set HTTP headers as they pass through the gateway.
- Filter
Headers []GetDeployment Specification Route Response Policy Header Transformation Filter Header Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
- Rename
Headers []GetDeployment Specification Route Response Policy Header Transformation Rename Header Rename HTTP headers as they pass through the gateway.
- Set
Headers []GetDeployment Specification Route Response Policy Header Transformation Set Header Set HTTP headers as they pass through the gateway.
- filter
Headers List<GetDeployment Specification Route Response Policy Header Transformation Filter Header> Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
- rename
Headers List<GetDeployment Specification Route Response Policy Header Transformation Rename Header> Rename HTTP headers as they pass through the gateway.
- set
Headers List<GetDeployment Specification Route Response Policy Header Transformation Set Header> Set HTTP headers as they pass through the gateway.
- filter
Headers GetDeployment Specification Route Response Policy Header Transformation Filter Header[] Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
- rename
Headers GetDeployment Specification Route Response Policy Header Transformation Rename Header[] Rename HTTP headers as they pass through the gateway.
- set
Headers GetDeployment Specification Route Response Policy Header Transformation Set Header[] Set HTTP headers as they pass through the gateway.
- filter_
headers GetDeployment Specification Route Response Policy Header Transformation Filter Header] Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
- rename_
headers GetDeployment Specification Route Response Policy Header Transformation Rename Header] Rename HTTP headers as they pass through the gateway.
- set_
headers GetDeployment Specification Route Response Policy Header Transformation Set Header] Set HTTP headers as they pass through the gateway.
- filter
Headers List<Property Map> Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.
- rename
Headers List<Property Map> Rename HTTP headers as they pass through the gateway.
- set
Headers List<Property Map> Set HTTP headers as they pass through the gateway.
GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeader
- Items
List<Get
Deployment Specification Route Response Policy Header Transformation Filter Header Item> The list of headers.
- Type string
Type of the Response Cache Store Policy.
- Items
[]Get
Deployment Specification Route Response Policy Header Transformation Filter Header Item The list of headers.
- Type string
Type of the Response Cache Store Policy.
- items
List<Get
Deployment Specification Route Response Policy Header Transformation Filter Header Item> The list of headers.
- type String
Type of the Response Cache Store Policy.
- items
Get
Deployment Specification Route Response Policy Header Transformation Filter Header Item[] The list of headers.
- type string
Type of the Response Cache Store Policy.
- items
Get
Deployment Specification Route Response Policy Header Transformation Filter Header Item] The list of headers.
- type str
Type of the Response Cache Store Policy.
- items List<Property Map>
The list of headers.
- type String
Type of the Response Cache Store Policy.
GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem
- 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.
GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeader
- items List<Property Map>
The list of headers.
GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeaderItem
GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeader
- items
Get
Deployment Specification Route Response Policy Header Transformation Set Header Item] The list of headers.
- items List<Property Map>
The list of headers.
GetDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeaderItem
- If
Exists string If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- Name string
The case-insensitive name of the header. This name must be unique across transformation policies.
- Values List<string>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- If
Exists string If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- Name string
The case-insensitive name of the header. This name must be unique across transformation policies.
- Values []string
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- if
Exists String If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- name String
The case-insensitive name of the header. This name must be unique across transformation policies.
- values List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- if
Exists string If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- name string
The case-insensitive name of the header. This name must be unique across transformation policies.
- values string[]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- if_
exists str If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- name str
The case-insensitive name of the header. This name must be unique across transformation policies.
- values Sequence[str]
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
- if
Exists String If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.
- name String
The case-insensitive name of the header. This name must be unique across transformation policies.
- values List<String>
A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.
GetDeploymentSpecificationRouteResponsePolicyResponseCacheStore
- Time
To intLive In Seconds Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.
- Type string
Type of the Response Cache Store Policy.
- Time
To intLive In Seconds Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.
- Type string
Type of the Response Cache Store Policy.
- time
To IntegerLive In Seconds Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.
- type String
Type of the Response Cache Store Policy.
- time
To numberLive In Seconds Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.
- type string
Type of the Response Cache Store Policy.
- time_
to_ intlive_ in_ seconds Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.
- type str
Type of the Response Cache Store Policy.
- time
To NumberLive In Seconds Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.
- type String
Type of the Response Cache Store Policy.
Package Details
- Repository
- https://github.com/pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
oci
Terraform Provider.