Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

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 System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testDeployment = Oci.ApiGateway.GetDeployment.Invoke(new()
    {
        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
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ApiGateway.ApiGatewayFunctions;
import com.pulumi.oci.ApiGateway.inputs.GetDeploymentArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testDeployment = ApiGatewayFunctions.getDeployment(GetDeploymentArgs.builder()
            .deploymentId(oci_apigateway_deployment.test_deployment().id())
            .build());

    }
}

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,
});

variables:
  testDeployment:
    Fn::Invoke:
      Function: oci:ApiGateway:getDeployment
      Arguments:
        deploymentId: ${oci_apigateway_deployment.test_deployment.id}

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:

DeploymentId string: The ocid of the deployment.

DeploymentId string: The ocid of the deployment.

deploymentId String: The ocid of the deployment.

deploymentId string: The ocid of the deployment.

deployment_id str: The ocid of the deployment.

deploymentId String: The ocid of the deployment.

getDeployment Result

The following output properties are available:

CompartmentId string: The OCID of the compartment in which the resource is created.
DefinedTags 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"}
DeploymentId string
DisplayName 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.
FreeformTags 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"}
GatewayId string: The OCID of the resource.
Id string: The OCID of the resource.
LifecycleDetails 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.
PathPrefix 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<GetDeploymentSpecification>: The logical configuration of the API exposed by a deployment.
State string: The current state of the deployment.
TimeCreated string: The time this resource was created. An RFC3339 formatted datetime string.
TimeUpdated string: The time this resource was last updated. An RFC3339 formatted datetime string.

CompartmentId string: The OCID of the compartment in which the resource is created.
DefinedTags 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"}
DeploymentId string
DisplayName 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.
FreeformTags 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"}
GatewayId string: The OCID of the resource.
Id string: The OCID of the resource.
LifecycleDetails 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.
PathPrefix 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 []GetDeploymentSpecification: The logical configuration of the API exposed by a deployment.
State string: The current state of the deployment.
TimeCreated string: The time this resource was created. An RFC3339 formatted datetime string.
TimeUpdated string: The time this resource was last updated. An RFC3339 formatted datetime string.

compartmentId String: The OCID of the compartment in which the resource is created.
definedTags 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"}
deploymentId String
displayName 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.
freeformTags 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"}
gatewayId String: The OCID of the resource.
id String: The OCID of the resource.
lifecycleDetails 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.
pathPrefix 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<GetDeploymentSpecification>: The logical configuration of the API exposed by a deployment.
state String: The current state of the deployment.
timeCreated String: The time this resource was created. An RFC3339 formatted datetime string.
timeUpdated String: The time this resource was last updated. An RFC3339 formatted datetime string.

compartmentId string: The OCID of the compartment in which the resource is created.
definedTags {[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"}
deploymentId string
displayName 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.
freeformTags {[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"}
gatewayId string: The OCID of the resource.
id string: The OCID of the resource.
lifecycleDetails 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.
pathPrefix 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 GetDeploymentSpecification[]: The logical configuration of the API exposed by a deployment.
state string: The current state of the deployment.
timeCreated string: The time this resource was created. An RFC3339 formatted datetime string.
timeUpdated 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.
defined_tags 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.
freeform_tags 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 GetDeploymentSpecification]: 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.

compartmentId String: The OCID of the compartment in which the resource is created.
definedTags 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"}
deploymentId String
displayName 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.
freeformTags 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"}
gatewayId String: The OCID of the resource.
id String: The OCID of the resource.
lifecycleDetails 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.
pathPrefix 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.
timeCreated String: The time this resource was created. An RFC3339 formatted datetime string.
timeUpdated String: The time this resource was last updated. An RFC3339 formatted datetime string.

Supporting Types

GetDeploymentSpecification

LoggingPolicies List<GetDeploymentSpecificationLoggingPolicy>: Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
RequestPolicies List<GetDeploymentSpecificationRequestPolicy>: Behavior applied to any requests received by the API on this route.
Routes List<GetDeploymentSpecificationRoute>: A list of routes that this API exposes.

LoggingPolicies []GetDeploymentSpecificationLoggingPolicy: Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
RequestPolicies []GetDeploymentSpecificationRequestPolicy: Behavior applied to any requests received by the API on this route.
Routes []GetDeploymentSpecificationRoute: A list of routes that this API exposes.

loggingPolicies List<GetDeploymentSpecificationLoggingPolicy>: Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
requestPolicies List<GetDeploymentSpecificationRequestPolicy>: Behavior applied to any requests received by the API on this route.
routes List<GetDeploymentSpecificationRoute>: A list of routes that this API exposes.

loggingPolicies GetDeploymentSpecificationLoggingPolicy[]: Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
requestPolicies GetDeploymentSpecificationRequestPolicy[]: Behavior applied to any requests received by the API on this route.
routes GetDeploymentSpecificationRoute[]: A list of routes that this API exposes.

logging_policies GetDeploymentSpecificationLoggingPolicy]: Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
request_policies GetDeploymentSpecificationRequestPolicy]: Behavior applied to any requests received by the API on this route.
routes GetDeploymentSpecificationRoute]: A list of routes that this API exposes.

loggingPolicies List<Property Map>: Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.
requestPolicies List<Property Map>: Behavior applied to any requests received by the API on this route.
routes List<Property Map>: A list of routes that this API exposes.

GetDeploymentSpecificationLoggingPolicy

AccessLogs List<GetDeploymentSpecificationLoggingPolicyAccessLog>: Configures the logging policies for the access logs of an API Deployment.
ExecutionLogs List<GetDeploymentSpecificationLoggingPolicyExecutionLog>: Configures the logging policies for the execution logs of an API Deployment.

AccessLogs []GetDeploymentSpecificationLoggingPolicyAccessLog: Configures the logging policies for the access logs of an API Deployment.
ExecutionLogs []GetDeploymentSpecificationLoggingPolicyExecutionLog: Configures the logging policies for the execution logs of an API Deployment.

accessLogs List<GetDeploymentSpecificationLoggingPolicyAccessLog>: Configures the logging policies for the access logs of an API Deployment.
executionLogs List<GetDeploymentSpecificationLoggingPolicyExecutionLog>: Configures the logging policies for the execution logs of an API Deployment.

accessLogs GetDeploymentSpecificationLoggingPolicyAccessLog[]: Configures the logging policies for the access logs of an API Deployment.
executionLogs GetDeploymentSpecificationLoggingPolicyExecutionLog[]: Configures the logging policies for the execution logs of an API Deployment.

access_logs GetDeploymentSpecificationLoggingPolicyAccessLog]: Configures the logging policies for the access logs of an API Deployment.
execution_logs GetDeploymentSpecificationLoggingPolicyExecutionLog]: Configures the logging policies for the execution logs of an API Deployment.

accessLogs List<Property Map>: Configures the logging policies for the access logs of an API Deployment.
executionLogs List<Property Map>: Configures the logging policies for the execution logs of an API Deployment.

GetDeploymentSpecificationLoggingPolicyAccessLog

IsEnabled bool: Whether this policy is currently enabled.

IsEnabled bool: Whether this policy is currently enabled.

isEnabled Boolean: Whether this policy is currently enabled.

isEnabled boolean: Whether this policy is currently enabled.

is_enabled bool: Whether this policy is currently enabled.

isEnabled Boolean: Whether this policy is currently enabled.

GetDeploymentSpecificationLoggingPolicyExecutionLog

IsEnabled bool: Whether this policy is currently enabled.
LogLevel string: Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.

IsEnabled bool: Whether this policy is currently enabled.
LogLevel string: Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.

isEnabled Boolean: Whether this policy is currently enabled.
logLevel String: Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.

isEnabled boolean: Whether this policy is currently enabled.
logLevel string: Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.

is_enabled bool: Whether this policy is currently enabled.
log_level str: Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.

isEnabled Boolean: Whether this policy is currently enabled.
logLevel String: Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.

GetDeploymentSpecificationRequestPolicy

Authentications List<GetDeploymentSpecificationRequestPolicyAuthentication>: Information on how to authenticate incoming requests.
Cors List<GetDeploymentSpecificationRequestPolicyCor>: Enable CORS (Cross-Origin-Resource-Sharing) request handling.
MutualTls List<GetDeploymentSpecificationRequestPolicyMutualTl>: Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.
RateLimitings List<GetDeploymentSpecificationRequestPolicyRateLimiting>: Limit the number of requests that should be handled for the specified window using a specfic key.
UsagePlans List<GetDeploymentSpecificationRequestPolicyUsagePlan>: Usage plan policies for this deployment

Authentications []GetDeploymentSpecificationRequestPolicyAuthentication: Information on how to authenticate incoming requests.
Cors []GetDeploymentSpecificationRequestPolicyCor: Enable CORS (Cross-Origin-Resource-Sharing) request handling.
MutualTls []GetDeploymentSpecificationRequestPolicyMutualTl: Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.
RateLimitings []GetDeploymentSpecificationRequestPolicyRateLimiting: Limit the number of requests that should be handled for the specified window using a specfic key.
UsagePlans []GetDeploymentSpecificationRequestPolicyUsagePlan: Usage plan policies for this deployment

authentications List<GetDeploymentSpecificationRequestPolicyAuthentication>: Information on how to authenticate incoming requests.
cors List<GetDeploymentSpecificationRequestPolicyCor>: Enable CORS (Cross-Origin-Resource-Sharing) request handling.
mutualTls List<GetDeploymentSpecificationRequestPolicyMutualTl>: Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.
rateLimitings List<GetDeploymentSpecificationRequestPolicyRateLimiting>: Limit the number of requests that should be handled for the specified window using a specfic key.
usagePlans List<GetDeploymentSpecificationRequestPolicyUsagePlan>: Usage plan policies for this deployment

authentications GetDeploymentSpecificationRequestPolicyAuthentication[]: Information on how to authenticate incoming requests.
cors GetDeploymentSpecificationRequestPolicyCor[]: Enable CORS (Cross-Origin-Resource-Sharing) request handling.
mutualTls GetDeploymentSpecificationRequestPolicyMutualTl[]: Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.
rateLimitings GetDeploymentSpecificationRequestPolicyRateLimiting[]: Limit the number of requests that should be handled for the specified window using a specfic key.
usagePlans GetDeploymentSpecificationRequestPolicyUsagePlan[]: Usage plan policies for this deployment

authentications GetDeploymentSpecificationRequestPolicyAuthentication]: Information on how to authenticate incoming requests.
cors GetDeploymentSpecificationRequestPolicyCor]: Enable CORS (Cross-Origin-Resource-Sharing) request handling.
mutual_tls GetDeploymentSpecificationRequestPolicyMutualTl]: Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.
rate_limitings GetDeploymentSpecificationRequestPolicyRateLimiting]: Limit the number of requests that should be handled for the specified window using a specfic key.
usage_plans GetDeploymentSpecificationRequestPolicyUsagePlan]: Usage plan policies for this deployment

authentications List<Property Map>: Information on how to authenticate incoming requests.
cors List<Property Map>: Enable CORS (Cross-Origin-Resource-Sharing) request handling.
mutualTls List<Property Map>: Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.
rateLimitings List<Property Map>: Limit the number of requests that should be handled for the specified window using a specfic key.
usagePlans List<Property Map>: Usage plan policies for this deployment

GetDeploymentSpecificationRequestPolicyAuthentication

Audiences List<string>: The list of intended recipients for the token.
FunctionId string: The OCID of the Oracle Functions function resource.
IsAnonymousAccessAllowed bool: Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
Issuers List<string>: A list of parties that could have issued the token.
MaxClockSkewInSeconds double: The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
PublicKeys List<GetDeploymentSpecificationRequestPolicyAuthenticationPublicKey>: A set of Public Keys that will be used to verify the JWT signature.
TokenAuthScheme string: The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
TokenHeader string: The name of the header containing the authentication token.
TokenQueryParam string: The name of the query parameter containing the authentication token.
Type string: Type of the Response Cache Store Policy.
VerifyClaims List<GetDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim>: A list of claims which should be validated to consider the token valid.

Audiences []string: The list of intended recipients for the token.
FunctionId string: The OCID of the Oracle Functions function resource.
IsAnonymousAccessAllowed bool: Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
Issuers []string: A list of parties that could have issued the token.
MaxClockSkewInSeconds float64: The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
PublicKeys []GetDeploymentSpecificationRequestPolicyAuthenticationPublicKey: A set of Public Keys that will be used to verify the JWT signature.
TokenAuthScheme string: The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
TokenHeader string: The name of the header containing the authentication token.
TokenQueryParam string: The name of the query parameter containing the authentication token.
Type string: Type of the Response Cache Store Policy.
VerifyClaims []GetDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim: A list of claims which should be validated to consider the token valid.

audiences List<String>: The list of intended recipients for the token.
functionId String: The OCID of the Oracle Functions function resource.
isAnonymousAccessAllowed Boolean: Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
issuers List<String>: A list of parties that could have issued the token.
maxClockSkewInSeconds Double: The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
publicKeys List<GetDeploymentSpecificationRequestPolicyAuthenticationPublicKey>: A set of Public Keys that will be used to verify the JWT signature.
tokenAuthScheme String: The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
tokenHeader String: The name of the header containing the authentication token.
tokenQueryParam String: The name of the query parameter containing the authentication token.
type String: Type of the Response Cache Store Policy.
verifyClaims List<GetDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim>: A list of claims which should be validated to consider the token valid.

audiences string[]: The list of intended recipients for the token.
functionId string: The OCID of the Oracle Functions function resource.
isAnonymousAccessAllowed boolean: Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
issuers string[]: A list of parties that could have issued the token.
maxClockSkewInSeconds number: The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
publicKeys GetDeploymentSpecificationRequestPolicyAuthenticationPublicKey[]: A set of Public Keys that will be used to verify the JWT signature.
tokenAuthScheme string: The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
tokenHeader string: The name of the header containing the authentication token.
tokenQueryParam string: The name of the query parameter containing the authentication token.
type string: Type of the Response Cache Store Policy.
verifyClaims GetDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim[]: A list of claims which should be validated to consider the token valid.

audiences Sequence[str]: The list of intended recipients for the token.
function_id str: The OCID of the Oracle Functions function resource.
is_anonymous_access_allowed bool: Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
issuers Sequence[str]: A list of parties that could have issued the token.
max_clock_skew_in_seconds float: The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
public_keys GetDeploymentSpecificationRequestPolicyAuthenticationPublicKey]: A set of Public Keys that will be used to verify the JWT signature.
token_auth_scheme str: The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
token_header str: The name of the header containing the authentication token.
token_query_param str: The name of the query parameter containing the authentication token.
type str: Type of the Response Cache Store Policy.
verify_claims GetDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim]: A list of claims which should be validated to consider the token valid.

audiences List<String>: The list of intended recipients for the token.
functionId String: The OCID of the Oracle Functions function resource.
isAnonymousAccessAllowed Boolean: Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.
issuers List<String>: A list of parties that could have issued the token.
maxClockSkewInSeconds Number: The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
publicKeys List<Property Map>: A set of Public Keys that will be used to verify the JWT signature.
tokenAuthScheme String: The authentication scheme that is to be used when authenticating the token. This must to be provided if "tokenHeader" is specified.
tokenHeader String: The name of the header containing the authentication token.
tokenQueryParam String: The name of the query parameter containing the authentication token.
type String: Type of the Response Cache Store Policy.
verifyClaims List<Property Map>: A list of claims which should be validated to consider the token valid.

GetDeploymentSpecificationRequestPolicyAuthenticationPublicKey

IsSslVerifyDisabled bool: Defines whether or not to uphold SSL verification.
Keys List<GetDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey>: The set of static public keys.
MaxCacheDurationInHours int: The duration for which the JWKS should be cached before it is fetched again.
Type string: Type of the Response Cache Store Policy.
Uri string: The uri from which to retrieve the key. It must be accessible without authentication.

IsSslVerifyDisabled bool: Defines whether or not to uphold SSL verification.
Keys []GetDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey: The set of static public keys.
MaxCacheDurationInHours int: The duration for which the JWKS should be cached before it is fetched again.
Type string: Type of the Response Cache Store Policy.
Uri string: The uri from which to retrieve the key. It must be accessible without authentication.

isSslVerifyDisabled Boolean: Defines whether or not to uphold SSL verification.
keys List<GetDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey>: The set of static public keys.
maxCacheDurationInHours Integer: The duration for which the JWKS should be cached before it is fetched again.
type String: Type of the Response Cache Store Policy.
uri String: The uri from which to retrieve the key. It must be accessible without authentication.

isSslVerifyDisabled boolean: Defines whether or not to uphold SSL verification.
keys GetDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey[]: The set of static public keys.
maxCacheDurationInHours number: The duration for which the JWKS should be cached before it is fetched again.
type string: Type of the Response Cache Store Policy.
uri string: The uri from which to retrieve the key. It must be accessible without authentication.

is_ssl_verify_disabled bool: Defines whether or not to uphold SSL verification.
keys GetDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey]: The set of static public keys.
max_cache_duration_in_hours int: The duration for which the JWKS should be cached before it is fetched again.
type str: Type of the Response Cache Store Policy.
uri str: The uri from which to retrieve the key. It must be accessible without authentication.

isSslVerifyDisabled Boolean: Defines whether or not to uphold SSL verification.
keys List<Property Map>: The set of static public keys.
maxCacheDurationInHours Number: The duration for which the JWKS should be cached before it is fetched again.
type String: Type of the Response Cache Store Policy.
uri String: The uri from which to retrieve the key. It must be accessible without authentication.

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.
KeyOps List<string>: The operations for which this key is to be used.
Kid string: A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
Kty string: The key type.
N string: The base64 url encoded modulus of the RSA public key represented by this key.
Use string: The intended use of the public key.

Alg string: The algorithm intended for use with this key.
E string: The base64 url encoded exponent of the RSA public key represented by this key.
Format string: The format of the public key.
Key string: Name of the claim.
KeyOps []string: The operations for which this key is to be used.
Kid string: A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
Kty string: The key type.
N string: The base64 url encoded modulus of the RSA public key represented by this key.
Use string: The intended use of the public key.

alg String: The algorithm intended for use with this key.
e String: The base64 url encoded exponent of the RSA public key represented by this key.
format String: The format of the public key.
key String: Name of the claim.
keyOps List<String>: The operations for which this key is to be used.
kid String: A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
kty String: The key type.
n String: The base64 url encoded modulus of the RSA public key represented by this key.
use String: The intended use of the public key.

alg string: The algorithm intended for use with this key.
e string: The base64 url encoded exponent of the RSA public key represented by this key.
format string: The format of the public key.
key string: Name of the claim.
keyOps string[]: The operations for which this key is to be used.
kid string: A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
kty string: The key type.
n string: The base64 url encoded modulus of the RSA public key represented by this key.
use string: The intended use of the public key.

alg str: The algorithm intended for use with this key.
e str: The base64 url encoded exponent of the RSA public key represented by this key.
format str: The format of the public key.
key str: Name of the claim.
key_ops Sequence[str]: The operations for which this key is to be used.
kid str: A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
kty str: The key type.
n str: The base64 url encoded modulus of the RSA public key represented by this key.
use str: The intended use of the public key.

alg String: The algorithm intended for use with this key.
e String: The base64 url encoded exponent of the RSA public key represented by this key.
format String: The format of the public key.
key String: Name of the claim.
keyOps List<String>: The operations for which this key is to be used.
kid String: A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".
kty String: The key type.
n String: The base64 url encoded modulus of the RSA public key represented by this key.
use String: The intended use of the public key.

GetDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim

IsRequired bool: Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
Key string: Name of the claim.
Values List<string>: A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

IsRequired bool: Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
Key string: Name of the claim.
Values []string: A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

isRequired Boolean: Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
key String: Name of the claim.
values List<String>: A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

isRequired boolean: Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
key string: Name of the claim.
values string[]: A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

is_required bool: Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
key str: Name of the claim.
values Sequence[str]: A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

isRequired Boolean: Whether the claim is required to be present in the JWT or not. If set to "false", the claim values will be matched only if the claim is present in the JWT.
key String: Name of the claim.
values List<String>: A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

GetDeploymentSpecificationRequestPolicyCor

AllowedHeaders List<string>: The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
AllowedMethods List<string>: The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
AllowedOrigins List<string>: The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
ExposedHeaders List<string>: The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
IsAllowCredentialsEnabled bool: Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
MaxAgeInSeconds int: The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.

AllowedHeaders []string: The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
AllowedMethods []string: The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
AllowedOrigins []string: The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
ExposedHeaders []string: The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
IsAllowCredentialsEnabled bool: Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
MaxAgeInSeconds int: The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.

allowedHeaders List<String>: The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
allowedMethods List<String>: The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
allowedOrigins List<String>: The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
exposedHeaders List<String>: The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
isAllowCredentialsEnabled Boolean: Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
maxAgeInSeconds Integer: The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.

allowedHeaders string[]: The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
allowedMethods string[]: The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
allowedOrigins string[]: The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
exposedHeaders string[]: The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
isAllowCredentialsEnabled boolean: Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
maxAgeInSeconds number: The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.

allowed_headers Sequence[str]: The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
allowed_methods Sequence[str]: The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
allowed_origins Sequence[str]: The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
exposed_headers Sequence[str]: The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
is_allow_credentials_enabled bool: Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
max_age_in_seconds int: The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.

allowedHeaders List<String>: The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.
allowedMethods List<String>: The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.
allowedOrigins List<String>: The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.
exposedHeaders List<String>: The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.
isAllowCredentialsEnabled Boolean: Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
maxAgeInSeconds Number: The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.

GetDeploymentSpecificationRequestPolicyMutualTl

AllowedSans List<string>: Allowed list of CN or SAN which will be used for verification of certificate.
IsVerifiedCertificateRequired bool: Determines whether to enable client verification when API Consumer makes connection to the gateway.

AllowedSans []string: Allowed list of CN or SAN which will be used for verification of certificate.
IsVerifiedCertificateRequired bool: Determines whether to enable client verification when API Consumer makes connection to the gateway.

allowedSans List<String>: Allowed list of CN or SAN which will be used for verification of certificate.
isVerifiedCertificateRequired Boolean: Determines whether to enable client verification when API Consumer makes connection to the gateway.

allowedSans string[]: Allowed list of CN or SAN which will be used for verification of certificate.
isVerifiedCertificateRequired boolean: Determines whether to enable client verification when API Consumer makes connection to the gateway.

allowed_sans Sequence[str]: Allowed list of CN or SAN which will be used for verification of certificate.
is_verified_certificate_required bool: Determines whether to enable client verification when API Consumer makes connection to the gateway.

allowedSans List<String>: Allowed list of CN or SAN which will be used for verification of certificate.
isVerifiedCertificateRequired Boolean: Determines whether to enable client verification when API Consumer makes connection to the gateway.

GetDeploymentSpecificationRequestPolicyRateLimiting

RateInRequestsPerSecond int: The maximum number of requests per second to allow.
RateKey string: The key used to group requests together.

RateInRequestsPerSecond int: The maximum number of requests per second to allow.
RateKey string: The key used to group requests together.

rateInRequestsPerSecond Integer: The maximum number of requests per second to allow.
rateKey String: The key used to group requests together.

rateInRequestsPerSecond number: The maximum number of requests per second to allow.
rateKey string: The key used to group requests together.

rate_in_requests_per_second int: The maximum number of requests per second to allow.
rate_key str: The key used to group requests together.

rateInRequestsPerSecond Number: The maximum number of requests per second to allow.
rateKey String: The key used to group requests together.