Oracle Cloud Infrastructure

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

Deployment

This resource provides the Deployment resource in Oracle Cloud Infrastructure API Gateway service.

Creates a new deployment.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testDeployment = new Oci.ApiGateway.Deployment("testDeployment", new Oci.ApiGateway.DeploymentArgs
        {
            CompartmentId = @var.Compartment_id,
            GatewayId = oci_apigateway_gateway.Test_gateway.Id,
            PathPrefix = @var.Deployment_path_prefix,
            DefinedTags = 
            {
                { "Operations.CostCenter", "42" },
            },
            DisplayName = @var.Deployment_display_name,
            FreeformTags = 
            {
                { "Department", "Finance" },
            },
            Specification = new Oci.ApiGateway.Inputs.DeploymentSpecificationArgs
            {
                LoggingPolicies = new Oci.ApiGateway.Inputs.DeploymentSpecificationLoggingPoliciesArgs
                {
                    AccessLog = new Oci.ApiGateway.Inputs.DeploymentSpecificationLoggingPoliciesAccessLogArgs
                    {
                        IsEnabled = @var.Deployment_specification_logging_policies_access_log_is_enabled,
                    },
                    ExecutionLog = new Oci.ApiGateway.Inputs.DeploymentSpecificationLoggingPoliciesExecutionLogArgs
                    {
                        IsEnabled = @var.Deployment_specification_logging_policies_execution_log_is_enabled,
                        LogLevel = @var.Deployment_specification_logging_policies_execution_log_log_level,
                    },
                },
                RequestPolicies = new Oci.ApiGateway.Inputs.DeploymentSpecificationRequestPoliciesArgs
                {
                    Authentication = new Oci.ApiGateway.Inputs.DeploymentSpecificationRequestPoliciesAuthenticationArgs
                    {
                        Type = @var.Deployment_specification_request_policies_authentication_type,
                        Audiences = @var.Deployment_specification_request_policies_authentication_audiences,
                        FunctionId = oci_functions_function.Test_function.Id,
                        IsAnonymousAccessAllowed = @var.Deployment_specification_request_policies_authentication_is_anonymous_access_allowed,
                        Issuers = @var.Deployment_specification_request_policies_authentication_issuers,
                        MaxClockSkewInSeconds = @var.Deployment_specification_request_policies_authentication_max_clock_skew_in_seconds,
                        PublicKeys = new Oci.ApiGateway.Inputs.DeploymentSpecificationRequestPoliciesAuthenticationPublicKeysArgs
                        {
                            Type = @var.Deployment_specification_request_policies_authentication_public_keys_type,
                            IsSslVerifyDisabled = @var.Deployment_specification_request_policies_authentication_public_keys_is_ssl_verify_disabled,
                            Keys = 
                            {
                                new Oci.ApiGateway.Inputs.DeploymentSpecificationRequestPoliciesAuthenticationPublicKeysKeyArgs
                                {
                                    Format = @var.Deployment_specification_request_policies_authentication_public_keys_keys_format,
                                    Alg = @var.Deployment_specification_request_policies_authentication_public_keys_keys_alg,
                                    E = @var.Deployment_specification_request_policies_authentication_public_keys_keys_e,
                                    Key = @var.Deployment_specification_request_policies_authentication_public_keys_keys_key,
                                    KeyOps = @var.Deployment_specification_request_policies_authentication_public_keys_keys_key_ops,
                                    Kid = @var.Deployment_specification_request_policies_authentication_public_keys_keys_kid,
                                    Kty = @var.Deployment_specification_request_policies_authentication_public_keys_keys_kty,
                                    N = @var.Deployment_specification_request_policies_authentication_public_keys_keys_n,
                                    Use = @var.Deployment_specification_request_policies_authentication_public_keys_keys_use,
                                },
                            },
                            MaxCacheDurationInHours = @var.Deployment_specification_request_policies_authentication_public_keys_max_cache_duration_in_hours,
                            Uri = @var.Deployment_specification_request_policies_authentication_public_keys_uri,
                        },
                        TokenAuthScheme = @var.Deployment_specification_request_policies_authentication_token_auth_scheme,
                        TokenHeader = @var.Deployment_specification_request_policies_authentication_token_header,
                        TokenQueryParam = @var.Deployment_specification_request_policies_authentication_token_query_param,
                        VerifyClaims = 
                        {
                            new Oci.ApiGateway.Inputs.DeploymentSpecificationRequestPoliciesAuthenticationVerifyClaimArgs
                            {
                                IsRequired = @var.Deployment_specification_request_policies_authentication_verify_claims_is_required,
                                Key = @var.Deployment_specification_request_policies_authentication_verify_claims_key,
                                Values = @var.Deployment_specification_request_policies_authentication_verify_claims_values,
                            },
                        },
                    },
                    Cors = new Oci.ApiGateway.Inputs.DeploymentSpecificationRequestPoliciesCorsArgs
                    {
                        AllowedOrigins = @var.Deployment_specification_request_policies_cors_allowed_origins,
                        AllowedHeaders = @var.Deployment_specification_request_policies_cors_allowed_headers,
                        AllowedMethods = @var.Deployment_specification_request_policies_cors_allowed_methods,
                        ExposedHeaders = @var.Deployment_specification_request_policies_cors_exposed_headers,
                        IsAllowCredentialsEnabled = @var.Deployment_specification_request_policies_cors_is_allow_credentials_enabled,
                        MaxAgeInSeconds = @var.Deployment_specification_request_policies_cors_max_age_in_seconds,
                    },
                    MutualTls = new Oci.ApiGateway.Inputs.DeploymentSpecificationRequestPoliciesMutualTlsArgs
                    {
                        AllowedSans = @var.Deployment_specification_request_policies_mutual_tls_allowed_sans,
                        IsVerifiedCertificateRequired = @var.Deployment_specification_request_policies_mutual_tls_is_verified_certificate_required,
                    },
                    RateLimiting = new Oci.ApiGateway.Inputs.DeploymentSpecificationRequestPoliciesRateLimitingArgs
                    {
                        RateInRequestsPerSecond = @var.Deployment_specification_request_policies_rate_limiting_rate_in_requests_per_second,
                        RateKey = @var.Deployment_specification_request_policies_rate_limiting_rate_key,
                    },
                },
                Routes = 
                {
                    new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteArgs
                    {
                        Backend = new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteBackendArgs
                        {
                            Type = @var.Deployment_specification_routes_backend_type,
                            Body = @var.Deployment_specification_routes_backend_body,
                            ConnectTimeoutInSeconds = @var.Deployment_specification_routes_backend_connect_timeout_in_seconds,
                            FunctionId = oci_functions_function.Test_function.Id,
                            Headers = 
                            {
                                new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteBackendHeaderArgs
                                {
                                    Name = @var.Deployment_specification_routes_backend_headers_name,
                                    Value = @var.Deployment_specification_routes_backend_headers_value,
                                },
                            },
                            IsSslVerifyDisabled = @var.Deployment_specification_routes_backend_is_ssl_verify_disabled,
                            ReadTimeoutInSeconds = @var.Deployment_specification_routes_backend_read_timeout_in_seconds,
                            SendTimeoutInSeconds = @var.Deployment_specification_routes_backend_send_timeout_in_seconds,
                            Status = @var.Deployment_specification_routes_backend_status,
                            Url = @var.Deployment_specification_routes_backend_url,
                        },
                        Path = @var.Deployment_specification_routes_path,
                        LoggingPolicies = new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteLoggingPoliciesArgs
                        {
                            AccessLog = new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteLoggingPoliciesAccessLogArgs
                            {
                                IsEnabled = @var.Deployment_specification_routes_logging_policies_access_log_is_enabled,
                            },
                            ExecutionLog = new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteLoggingPoliciesExecutionLogArgs
                            {
                                IsEnabled = @var.Deployment_specification_routes_logging_policies_execution_log_is_enabled,
                                LogLevel = @var.Deployment_specification_routes_logging_policies_execution_log_log_level,
                            },
                        },
                        Methods = @var.Deployment_specification_routes_methods,
                        RequestPolicies = new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteRequestPoliciesArgs
                        {
                            Authorization = new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteRequestPoliciesAuthorizationArgs
                            {
                                AllowedScopes = @var.Deployment_specification_routes_request_policies_authorization_allowed_scope,
                                Type = @var.Deployment_specification_routes_request_policies_authorization_type,
                            },
                            BodyValidation = new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteRequestPoliciesBodyValidationArgs
                            {
                                Contents = 
                                {
                                    new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteRequestPoliciesBodyValidationContentArgs
                                    {
                                        MediaType = @var.Deployment_specification_routes_request_policies_body_validation_content_media_type,
                                        ValidationType = @var.Deployment_specification_routes_request_policies_body_validation_content_validation_type,
                                    },
                                },
                                Required = @var.Deployment_specification_routes_request_policies_body_validation_required,
                                ValidationMode = @var.Deployment_specification_routes_request_policies_body_validation_validation_mode,
                            },
                            Cors = new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteRequestPoliciesCorsArgs
                            {
                                AllowedOrigins = @var.Deployment_specification_routes_request_policies_cors_allowed_origins,
                                AllowedHeaders = @var.Deployment_specification_routes_request_policies_cors_allowed_headers,
                                AllowedMethods = @var.Deployment_specification_routes_request_policies_cors_allowed_methods,
                                ExposedHeaders = @var.Deployment_specification_routes_request_policies_cors_exposed_headers,
                                IsAllowCredentialsEnabled = @var.Deployment_specification_routes_request_policies_cors_is_allow_credentials_enabled,
                                MaxAgeInSeconds = @var.Deployment_specification_routes_request_policies_cors_max_age_in_seconds,
                            },
                            HeaderTransformations = new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsArgs
                            {
                                FilterHeaders = new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeadersArgs
                                {
                                    Items = 
                                    {
                                        new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeadersItemArgs
                                        {
                                            Name = @var.Deployment_specification_routes_request_policies_header_transformations_filter_headers_items_name,
                                        },
                                    },
                                    Type = @var.Deployment_specification_routes_request_policies_header_transformations_filter_headers_type,
                                },
                                RenameHeaders = new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeadersArgs
                                {
                                    Items = 
                                    {
                                        new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeadersItemArgs
                                        {
                                            From = @var.Deployment_specification_routes_request_policies_header_transformations_rename_headers_items_from,
                                            To = @var.Deployment_specification_routes_request_policies_header_transformations_rename_headers_items_to,
                                        },
                                    },
                                },
                                SetHeaders = new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeadersArgs
                                {
                                    Items = 
                                    {
                                        new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeadersItemArgs
                                        {
                                            Name = @var.Deployment_specification_routes_request_policies_header_transformations_set_headers_items_name,
                                            Values = @var.Deployment_specification_routes_request_policies_header_transformations_set_headers_items_values,
                                            IfExists = @var.Deployment_specification_routes_request_policies_header_transformations_set_headers_items_if_exists,
                                        },
                                    },
                                },
                            },
                            HeaderValidations = new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteRequestPoliciesHeaderValidationsArgs
                            {
                                Headers = 
                                {
                                    new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteRequestPoliciesHeaderValidationsHeaderArgs
                                    {
                                        Name = @var.Deployment_specification_routes_request_policies_header_validations_headers_name,
                                        Required = @var.Deployment_specification_routes_request_policies_header_validations_headers_required,
                                    },
                                },
                                ValidationMode = @var.Deployment_specification_routes_request_policies_header_validations_validation_mode,
                            },
                            QueryParameterTransformations = new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsArgs
                            {
                                FilterQueryParameters = new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParametersArgs
                                {
                                    Items = 
                                    {
                                        new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParametersItemArgs
                                        {
                                            Name = @var.Deployment_specification_routes_request_policies_query_parameter_transformations_filter_query_parameters_items_name,
                                        },
                                    },
                                    Type = @var.Deployment_specification_routes_request_policies_query_parameter_transformations_filter_query_parameters_type,
                                },
                                RenameQueryParameters = new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParametersArgs
                                {
                                    Items = 
                                    {
                                        new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParametersItemArgs
                                        {
                                            From = @var.Deployment_specification_routes_request_policies_query_parameter_transformations_rename_query_parameters_items_from,
                                            To = @var.Deployment_specification_routes_request_policies_query_parameter_transformations_rename_query_parameters_items_to,
                                        },
                                    },
                                },
                                SetQueryParameters = new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParametersArgs
                                {
                                    Items = 
                                    {
                                        new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParametersItemArgs
                                        {
                                            Name = @var.Deployment_specification_routes_request_policies_query_parameter_transformations_set_query_parameters_items_name,
                                            Values = @var.Deployment_specification_routes_request_policies_query_parameter_transformations_set_query_parameters_items_values,
                                            IfExists = @var.Deployment_specification_routes_request_policies_query_parameter_transformations_set_query_parameters_items_if_exists,
                                        },
                                    },
                                },
                            },
                            QueryParameterValidations = new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteRequestPoliciesQueryParameterValidationsArgs
                            {
                                Parameters = 
                                {
                                    new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteRequestPoliciesQueryParameterValidationsParameterArgs
                                    {
                                        Name = @var.Deployment_specification_routes_request_policies_query_parameter_validations_parameters_name,
                                        Required = @var.Deployment_specification_routes_request_policies_query_parameter_validations_parameters_required,
                                    },
                                },
                                ValidationMode = @var.Deployment_specification_routes_request_policies_query_parameter_validations_validation_mode,
                            },
                            ResponseCacheLookup = new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteRequestPoliciesResponseCacheLookupArgs
                            {
                                Type = @var.Deployment_specification_routes_request_policies_response_cache_lookup_type,
                                CacheKeyAdditions = @var.Deployment_specification_routes_request_policies_response_cache_lookup_cache_key_additions,
                                IsEnabled = @var.Deployment_specification_routes_request_policies_response_cache_lookup_is_enabled,
                                IsPrivateCachingEnabled = @var.Deployment_specification_routes_request_policies_response_cache_lookup_is_private_caching_enabled,
                            },
                        },
                        ResponsePolicies = new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteResponsePoliciesArgs
                        {
                            HeaderTransformations = new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsArgs
                            {
                                FilterHeaders = new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeadersArgs
                                {
                                    Items = 
                                    {
                                        new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeadersItemArgs
                                        {
                                            Name = @var.Deployment_specification_routes_response_policies_header_transformations_filter_headers_items_name,
                                        },
                                    },
                                    Type = @var.Deployment_specification_routes_response_policies_header_transformations_filter_headers_type,
                                },
                                RenameHeaders = new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeadersArgs
                                {
                                    Items = 
                                    {
                                        new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeadersItemArgs
                                        {
                                            From = @var.Deployment_specification_routes_response_policies_header_transformations_rename_headers_items_from,
                                            To = @var.Deployment_specification_routes_response_policies_header_transformations_rename_headers_items_to,
                                        },
                                    },
                                },
                                SetHeaders = new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeadersArgs
                                {
                                    Items = 
                                    {
                                        new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeadersItemArgs
                                        {
                                            Name = @var.Deployment_specification_routes_response_policies_header_transformations_set_headers_items_name,
                                            Values = @var.Deployment_specification_routes_response_policies_header_transformations_set_headers_items_values,
                                            IfExists = @var.Deployment_specification_routes_response_policies_header_transformations_set_headers_items_if_exists,
                                        },
                                    },
                                },
                            },
                            ResponseCacheStore = new Oci.ApiGateway.Inputs.DeploymentSpecificationRouteResponsePoliciesResponseCacheStoreArgs
                            {
                                TimeToLiveInSeconds = @var.Deployment_specification_routes_response_policies_response_cache_store_time_to_live_in_seconds,
                                Type = @var.Deployment_specification_routes_response_policies_response_cache_store_type,
                            },
                        },
                    },
                },
            },
        });
    }

}
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.NewDeployment(ctx, "testDeployment", &ApiGateway.DeploymentArgs{
			CompartmentId: pulumi.Any(_var.Compartment_id),
			GatewayId:     pulumi.Any(oci_apigateway_gateway.Test_gateway.Id),
			PathPrefix:    pulumi.Any(_var.Deployment_path_prefix),
			DefinedTags: pulumi.AnyMap{
				"Operations.CostCenter": pulumi.Any("42"),
			},
			DisplayName: pulumi.Any(_var.Deployment_display_name),
			FreeformTags: pulumi.AnyMap{
				"Department": pulumi.Any("Finance"),
			},
			Specification: &apigateway.DeploymentSpecificationArgs{
				LoggingPolicies: &apigateway.DeploymentSpecificationLoggingPoliciesArgs{
					AccessLog: &apigateway.DeploymentSpecificationLoggingPoliciesAccessLogArgs{
						IsEnabled: pulumi.Any(_var.Deployment_specification_logging_policies_access_log_is_enabled),
					},
					ExecutionLog: &apigateway.DeploymentSpecificationLoggingPoliciesExecutionLogArgs{
						IsEnabled: pulumi.Any(_var.Deployment_specification_logging_policies_execution_log_is_enabled),
						LogLevel:  pulumi.Any(_var.Deployment_specification_logging_policies_execution_log_log_level),
					},
				},
				RequestPolicies: &apigateway.DeploymentSpecificationRequestPoliciesArgs{
					Authentication: &apigateway.DeploymentSpecificationRequestPoliciesAuthenticationArgs{
						Type:                     pulumi.Any(_var.Deployment_specification_request_policies_authentication_type),
						Audiences:                pulumi.Any(_var.Deployment_specification_request_policies_authentication_audiences),
						FunctionId:               pulumi.Any(oci_functions_function.Test_function.Id),
						IsAnonymousAccessAllowed: pulumi.Any(_var.Deployment_specification_request_policies_authentication_is_anonymous_access_allowed),
						Issuers:                  pulumi.Any(_var.Deployment_specification_request_policies_authentication_issuers),
						MaxClockSkewInSeconds:    pulumi.Any(_var.Deployment_specification_request_policies_authentication_max_clock_skew_in_seconds),
						PublicKeys: &apigateway.DeploymentSpecificationRequestPoliciesAuthenticationPublicKeysArgs{
							Type:                pulumi.Any(_var.Deployment_specification_request_policies_authentication_public_keys_type),
							IsSslVerifyDisabled: pulumi.Any(_var.Deployment_specification_request_policies_authentication_public_keys_is_ssl_verify_disabled),
							Keys: apigateway.DeploymentSpecificationRequestPoliciesAuthenticationPublicKeysKeyArray{
								&apigateway.DeploymentSpecificationRequestPoliciesAuthenticationPublicKeysKeyArgs{
									Format: pulumi.Any(_var.Deployment_specification_request_policies_authentication_public_keys_keys_format),
									Alg:    pulumi.Any(_var.Deployment_specification_request_policies_authentication_public_keys_keys_alg),
									E:      pulumi.Any(_var.Deployment_specification_request_policies_authentication_public_keys_keys_e),
									Key:    pulumi.Any(_var.Deployment_specification_request_policies_authentication_public_keys_keys_key),
									KeyOps: pulumi.Any(_var.Deployment_specification_request_policies_authentication_public_keys_keys_key_ops),
									Kid:    pulumi.Any(_var.Deployment_specification_request_policies_authentication_public_keys_keys_kid),
									Kty:    pulumi.Any(_var.Deployment_specification_request_policies_authentication_public_keys_keys_kty),
									N:      pulumi.Any(_var.Deployment_specification_request_policies_authentication_public_keys_keys_n),
									Use:    pulumi.Any(_var.Deployment_specification_request_policies_authentication_public_keys_keys_use),
								},
							},
							MaxCacheDurationInHours: pulumi.Any(_var.Deployment_specification_request_policies_authentication_public_keys_max_cache_duration_in_hours),
							Uri:                     pulumi.Any(_var.Deployment_specification_request_policies_authentication_public_keys_uri),
						},
						TokenAuthScheme: pulumi.Any(_var.Deployment_specification_request_policies_authentication_token_auth_scheme),
						TokenHeader:     pulumi.Any(_var.Deployment_specification_request_policies_authentication_token_header),
						TokenQueryParam: pulumi.Any(_var.Deployment_specification_request_policies_authentication_token_query_param),
						VerifyClaims: apigateway.DeploymentSpecificationRequestPoliciesAuthenticationVerifyClaimArray{
							&apigateway.DeploymentSpecificationRequestPoliciesAuthenticationVerifyClaimArgs{
								IsRequired: pulumi.Any(_var.Deployment_specification_request_policies_authentication_verify_claims_is_required),
								Key:        pulumi.Any(_var.Deployment_specification_request_policies_authentication_verify_claims_key),
								Values:     pulumi.Any(_var.Deployment_specification_request_policies_authentication_verify_claims_values),
							},
						},
					},
					Cors: &apigateway.DeploymentSpecificationRequestPoliciesCorsArgs{
						AllowedOrigins:            pulumi.Any(_var.Deployment_specification_request_policies_cors_allowed_origins),
						AllowedHeaders:            pulumi.Any(_var.Deployment_specification_request_policies_cors_allowed_headers),
						AllowedMethods:            pulumi.Any(_var.Deployment_specification_request_policies_cors_allowed_methods),
						ExposedHeaders:            pulumi.Any(_var.Deployment_specification_request_policies_cors_exposed_headers),
						IsAllowCredentialsEnabled: pulumi.Any(_var.Deployment_specification_request_policies_cors_is_allow_credentials_enabled),
						MaxAgeInSeconds:           pulumi.Any(_var.Deployment_specification_request_policies_cors_max_age_in_seconds),
					},
					MutualTls: &apigateway.DeploymentSpecificationRequestPoliciesMutualTlsArgs{
						AllowedSans:                   pulumi.Any(_var.Deployment_specification_request_policies_mutual_tls_allowed_sans),
						IsVerifiedCertificateRequired: pulumi.Any(_var.Deployment_specification_request_policies_mutual_tls_is_verified_certificate_required),
					},
					RateLimiting: &apigateway.DeploymentSpecificationRequestPoliciesRateLimitingArgs{
						RateInRequestsPerSecond: pulumi.Any(_var.Deployment_specification_request_policies_rate_limiting_rate_in_requests_per_second),
						RateKey:                 pulumi.Any(_var.Deployment_specification_request_policies_rate_limiting_rate_key),
					},
				},
				Routes: apigateway.DeploymentSpecificationRouteArray{
					&apigateway.DeploymentSpecificationRouteArgs{
						Backend: &apigateway.DeploymentSpecificationRouteBackendArgs{
							Type:                    pulumi.Any(_var.Deployment_specification_routes_backend_type),
							Body:                    pulumi.Any(_var.Deployment_specification_routes_backend_body),
							ConnectTimeoutInSeconds: pulumi.Any(_var.Deployment_specification_routes_backend_connect_timeout_in_seconds),
							FunctionId:              pulumi.Any(oci_functions_function.Test_function.Id),
							Headers: apigateway.DeploymentSpecificationRouteBackendHeaderArray{
								&apigateway.DeploymentSpecificationRouteBackendHeaderArgs{
									Name:  pulumi.Any(_var.Deployment_specification_routes_backend_headers_name),
									Value: pulumi.Any(_var.Deployment_specification_routes_backend_headers_value),
								},
							},
							IsSslVerifyDisabled:  pulumi.Any(_var.Deployment_specification_routes_backend_is_ssl_verify_disabled),
							ReadTimeoutInSeconds: pulumi.Any(_var.Deployment_specification_routes_backend_read_timeout_in_seconds),
							SendTimeoutInSeconds: pulumi.Any(_var.Deployment_specification_routes_backend_send_timeout_in_seconds),
							Status:               pulumi.Any(_var.Deployment_specification_routes_backend_status),
							Url:                  pulumi.Any(_var.Deployment_specification_routes_backend_url),
						},
						Path: pulumi.Any(_var.Deployment_specification_routes_path),
						LoggingPolicies: &apigateway.DeploymentSpecificationRouteLoggingPoliciesArgs{
							AccessLog: &apigateway.DeploymentSpecificationRouteLoggingPoliciesAccessLogArgs{
								IsEnabled: pulumi.Any(_var.Deployment_specification_routes_logging_policies_access_log_is_enabled),
							},
							ExecutionLog: &apigateway.DeploymentSpecificationRouteLoggingPoliciesExecutionLogArgs{
								IsEnabled: pulumi.Any(_var.Deployment_specification_routes_logging_policies_execution_log_is_enabled),
								LogLevel:  pulumi.Any(_var.Deployment_specification_routes_logging_policies_execution_log_log_level),
							},
						},
						Methods: pulumi.Any(_var.Deployment_specification_routes_methods),
						RequestPolicies: &apigateway.DeploymentSpecificationRouteRequestPoliciesArgs{
							Authorization: &apigateway.DeploymentSpecificationRouteRequestPoliciesAuthorizationArgs{
								AllowedScopes: pulumi.Any(_var.Deployment_specification_routes_request_policies_authorization_allowed_scope),
								Type:          pulumi.Any(_var.Deployment_specification_routes_request_policies_authorization_type),
							},
							BodyValidation: &apigateway.DeploymentSpecificationRouteRequestPoliciesBodyValidationArgs{
								Contents: apigateway.DeploymentSpecificationRouteRequestPoliciesBodyValidationContentArray{
									&apigateway.DeploymentSpecificationRouteRequestPoliciesBodyValidationContentArgs{
										MediaType:      pulumi.Any(_var.Deployment_specification_routes_request_policies_body_validation_content_media_type),
										ValidationType: pulumi.Any(_var.Deployment_specification_routes_request_policies_body_validation_content_validation_type),
									},
								},
								Required:       pulumi.Any(_var.Deployment_specification_routes_request_policies_body_validation_required),
								ValidationMode: pulumi.Any(_var.Deployment_specification_routes_request_policies_body_validation_validation_mode),
							},
							Cors: &apigateway.DeploymentSpecificationRouteRequestPoliciesCorsArgs{
								AllowedOrigins:            pulumi.Any(_var.Deployment_specification_routes_request_policies_cors_allowed_origins),
								AllowedHeaders:            pulumi.Any(_var.Deployment_specification_routes_request_policies_cors_allowed_headers),
								AllowedMethods:            pulumi.Any(_var.Deployment_specification_routes_request_policies_cors_allowed_methods),
								ExposedHeaders:            pulumi.Any(_var.Deployment_specification_routes_request_policies_cors_exposed_headers),
								IsAllowCredentialsEnabled: pulumi.Any(_var.Deployment_specification_routes_request_policies_cors_is_allow_credentials_enabled),
								MaxAgeInSeconds:           pulumi.Any(_var.Deployment_specification_routes_request_policies_cors_max_age_in_seconds),
							},
							HeaderTransformations: &apigateway.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsArgs{
								FilterHeaders: &apigateway.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeadersArgs{
									Items: apigateway.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeadersItemArray{
										&apigateway.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeadersItemArgs{
											Name: pulumi.Any(_var.Deployment_specification_routes_request_policies_header_transformations_filter_headers_items_name),
										},
									},
									Type: pulumi.Any(_var.Deployment_specification_routes_request_policies_header_transformations_filter_headers_type),
								},
								RenameHeaders: &apigateway.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeadersArgs{
									Items: apigateway.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeadersItemArray{
										&apigateway.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeadersItemArgs{
											From: pulumi.Any(_var.Deployment_specification_routes_request_policies_header_transformations_rename_headers_items_from),
											To:   pulumi.Any(_var.Deployment_specification_routes_request_policies_header_transformations_rename_headers_items_to),
										},
									},
								},
								SetHeaders: &apigateway.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeadersArgs{
									Items: apigateway.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeadersItemArray{
										&apigateway.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeadersItemArgs{
											Name:     pulumi.Any(_var.Deployment_specification_routes_request_policies_header_transformations_set_headers_items_name),
											Values:   pulumi.Any(_var.Deployment_specification_routes_request_policies_header_transformations_set_headers_items_values),
											IfExists: pulumi.Any(_var.Deployment_specification_routes_request_policies_header_transformations_set_headers_items_if_exists),
										},
									},
								},
							},
							HeaderValidations: &apigateway.DeploymentSpecificationRouteRequestPoliciesHeaderValidationsArgs{
								Headers: apigateway.DeploymentSpecificationRouteRequestPoliciesHeaderValidationsHeaderArray{
									&apigateway.DeploymentSpecificationRouteRequestPoliciesHeaderValidationsHeaderArgs{
										Name:     pulumi.Any(_var.Deployment_specification_routes_request_policies_header_validations_headers_name),
										Required: pulumi.Any(_var.Deployment_specification_routes_request_policies_header_validations_headers_required),
									},
								},
								ValidationMode: pulumi.Any(_var.Deployment_specification_routes_request_policies_header_validations_validation_mode),
							},
							QueryParameterTransformations: &apigateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsArgs{
								FilterQueryParameters: &apigateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParametersArgs{
									Items: apigateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParametersItemArray{
										&apigateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParametersItemArgs{
											Name: pulumi.Any(_var.Deployment_specification_routes_request_policies_query_parameter_transformations_filter_query_parameters_items_name),
										},
									},
									Type: pulumi.Any(_var.Deployment_specification_routes_request_policies_query_parameter_transformations_filter_query_parameters_type),
								},
								RenameQueryParameters: &apigateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParametersArgs{
									Items: apigateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParametersItemArray{
										&apigateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParametersItemArgs{
											From: pulumi.Any(_var.Deployment_specification_routes_request_policies_query_parameter_transformations_rename_query_parameters_items_from),
											To:   pulumi.Any(_var.Deployment_specification_routes_request_policies_query_parameter_transformations_rename_query_parameters_items_to),
										},
									},
								},
								SetQueryParameters: &apigateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParametersArgs{
									Items: apigateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParametersItemArray{
										&apigateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParametersItemArgs{
											Name:     pulumi.Any(_var.Deployment_specification_routes_request_policies_query_parameter_transformations_set_query_parameters_items_name),
											Values:   pulumi.Any(_var.Deployment_specification_routes_request_policies_query_parameter_transformations_set_query_parameters_items_values),
											IfExists: pulumi.Any(_var.Deployment_specification_routes_request_policies_query_parameter_transformations_set_query_parameters_items_if_exists),
										},
									},
								},
							},
							QueryParameterValidations: &apigateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterValidationsArgs{
								Parameters: apigateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterValidationsParameterArray{
									&apigateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterValidationsParameterArgs{
										Name:     pulumi.Any(_var.Deployment_specification_routes_request_policies_query_parameter_validations_parameters_name),
										Required: pulumi.Any(_var.Deployment_specification_routes_request_policies_query_parameter_validations_parameters_required),
									},
								},
								ValidationMode: pulumi.Any(_var.Deployment_specification_routes_request_policies_query_parameter_validations_validation_mode),
							},
							ResponseCacheLookup: &apigateway.DeploymentSpecificationRouteRequestPoliciesResponseCacheLookupArgs{
								Type:                    pulumi.Any(_var.Deployment_specification_routes_request_policies_response_cache_lookup_type),
								CacheKeyAdditions:       pulumi.Any(_var.Deployment_specification_routes_request_policies_response_cache_lookup_cache_key_additions),
								IsEnabled:               pulumi.Any(_var.Deployment_specification_routes_request_policies_response_cache_lookup_is_enabled),
								IsPrivateCachingEnabled: pulumi.Any(_var.Deployment_specification_routes_request_policies_response_cache_lookup_is_private_caching_enabled),
							},
						},
						ResponsePolicies: &apigateway.DeploymentSpecificationRouteResponsePoliciesArgs{
							HeaderTransformations: &apigateway.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsArgs{
								FilterHeaders: &apigateway.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeadersArgs{
									Items: apigateway.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeadersItemArray{
										&apigateway.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeadersItemArgs{
											Name: pulumi.Any(_var.Deployment_specification_routes_response_policies_header_transformations_filter_headers_items_name),
										},
									},
									Type: pulumi.Any(_var.Deployment_specification_routes_response_policies_header_transformations_filter_headers_type),
								},
								RenameHeaders: &apigateway.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeadersArgs{
									Items: apigateway.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeadersItemArray{
										&apigateway.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeadersItemArgs{
											From: pulumi.Any(_var.Deployment_specification_routes_response_policies_header_transformations_rename_headers_items_from),
											To:   pulumi.Any(_var.Deployment_specification_routes_response_policies_header_transformations_rename_headers_items_to),
										},
									},
								},
								SetHeaders: &apigateway.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeadersArgs{
									Items: apigateway.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeadersItemArray{
										&apigateway.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeadersItemArgs{
											Name:     pulumi.Any(_var.Deployment_specification_routes_response_policies_header_transformations_set_headers_items_name),
											Values:   pulumi.Any(_var.Deployment_specification_routes_response_policies_header_transformations_set_headers_items_values),
											IfExists: pulumi.Any(_var.Deployment_specification_routes_response_policies_header_transformations_set_headers_items_if_exists),
										},
									},
								},
							},
							ResponseCacheStore: &apigateway.DeploymentSpecificationRouteResponsePoliciesResponseCacheStoreArgs{
								TimeToLiveInSeconds: pulumi.Any(_var.Deployment_specification_routes_response_policies_response_cache_store_time_to_live_in_seconds),
								Type:                pulumi.Any(_var.Deployment_specification_routes_response_policies_response_cache_store_type),
							},
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_deployment = oci.api_gateway.Deployment("testDeployment",
    compartment_id=var["compartment_id"],
    gateway_id=oci_apigateway_gateway["test_gateway"]["id"],
    path_prefix=var["deployment_path_prefix"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    display_name=var["deployment_display_name"],
    freeform_tags={
        "Department": "Finance",
    },
    specification=oci.api.gateway.DeploymentSpecificationArgs(
        logging_policies=oci.api.gateway.DeploymentSpecificationLoggingPoliciesArgs(
            access_log=oci.api.gateway.DeploymentSpecificationLoggingPoliciesAccessLogArgs(
                is_enabled=var["deployment_specification_logging_policies_access_log_is_enabled"],
            ),
            execution_log=oci.api.gateway.DeploymentSpecificationLoggingPoliciesExecutionLogArgs(
                is_enabled=var["deployment_specification_logging_policies_execution_log_is_enabled"],
                log_level=var["deployment_specification_logging_policies_execution_log_log_level"],
            ),
        ),
        request_policies=oci.api.gateway.DeploymentSpecificationRequestPoliciesArgs(
            authentication=oci.api.gateway.DeploymentSpecificationRequestPoliciesAuthenticationArgs(
                type=var["deployment_specification_request_policies_authentication_type"],
                audiences=var["deployment_specification_request_policies_authentication_audiences"],
                function_id=oci_functions_function["test_function"]["id"],
                is_anonymous_access_allowed=var["deployment_specification_request_policies_authentication_is_anonymous_access_allowed"],
                issuers=var["deployment_specification_request_policies_authentication_issuers"],
                max_clock_skew_in_seconds=var["deployment_specification_request_policies_authentication_max_clock_skew_in_seconds"],
                public_keys=oci.api.gateway.DeploymentSpecificationRequestPoliciesAuthenticationPublicKeysArgs(
                    type=var["deployment_specification_request_policies_authentication_public_keys_type"],
                    is_ssl_verify_disabled=var["deployment_specification_request_policies_authentication_public_keys_is_ssl_verify_disabled"],
                    keys=[oci.api.gateway.DeploymentSpecificationRequestPoliciesAuthenticationPublicKeysKeyArgs(
                        format=var["deployment_specification_request_policies_authentication_public_keys_keys_format"],
                        alg=var["deployment_specification_request_policies_authentication_public_keys_keys_alg"],
                        e=var["deployment_specification_request_policies_authentication_public_keys_keys_e"],
                        key=var["deployment_specification_request_policies_authentication_public_keys_keys_key"],
                        key_ops=var["deployment_specification_request_policies_authentication_public_keys_keys_key_ops"],
                        kid=var["deployment_specification_request_policies_authentication_public_keys_keys_kid"],
                        kty=var["deployment_specification_request_policies_authentication_public_keys_keys_kty"],
                        n=var["deployment_specification_request_policies_authentication_public_keys_keys_n"],
                        use=var["deployment_specification_request_policies_authentication_public_keys_keys_use"],
                    )],
                    max_cache_duration_in_hours=var["deployment_specification_request_policies_authentication_public_keys_max_cache_duration_in_hours"],
                    uri=var["deployment_specification_request_policies_authentication_public_keys_uri"],
                ),
                token_auth_scheme=var["deployment_specification_request_policies_authentication_token_auth_scheme"],
                token_header=var["deployment_specification_request_policies_authentication_token_header"],
                token_query_param=var["deployment_specification_request_policies_authentication_token_query_param"],
                verify_claims=[oci.api.gateway.DeploymentSpecificationRequestPoliciesAuthenticationVerifyClaimArgs(
                    is_required=var["deployment_specification_request_policies_authentication_verify_claims_is_required"],
                    key=var["deployment_specification_request_policies_authentication_verify_claims_key"],
                    values=var["deployment_specification_request_policies_authentication_verify_claims_values"],
                )],
            ),
            cors=oci.api.gateway.DeploymentSpecificationRequestPoliciesCorsArgs(
                allowed_origins=var["deployment_specification_request_policies_cors_allowed_origins"],
                allowed_headers=var["deployment_specification_request_policies_cors_allowed_headers"],
                allowed_methods=var["deployment_specification_request_policies_cors_allowed_methods"],
                exposed_headers=var["deployment_specification_request_policies_cors_exposed_headers"],
                is_allow_credentials_enabled=var["deployment_specification_request_policies_cors_is_allow_credentials_enabled"],
                max_age_in_seconds=var["deployment_specification_request_policies_cors_max_age_in_seconds"],
            ),
            mutual_tls=oci.api.gateway.DeploymentSpecificationRequestPoliciesMutualTlsArgs(
                allowed_sans=var["deployment_specification_request_policies_mutual_tls_allowed_sans"],
                is_verified_certificate_required=var["deployment_specification_request_policies_mutual_tls_is_verified_certificate_required"],
            ),
            rate_limiting=oci.api.gateway.DeploymentSpecificationRequestPoliciesRateLimitingArgs(
                rate_in_requests_per_second=var["deployment_specification_request_policies_rate_limiting_rate_in_requests_per_second"],
                rate_key=var["deployment_specification_request_policies_rate_limiting_rate_key"],
            ),
        ),
        routes=[oci.api.gateway.DeploymentSpecificationRouteArgs(
            backend=oci.api.gateway.DeploymentSpecificationRouteBackendArgs(
                type=var["deployment_specification_routes_backend_type"],
                body=var["deployment_specification_routes_backend_body"],
                connect_timeout_in_seconds=var["deployment_specification_routes_backend_connect_timeout_in_seconds"],
                function_id=oci_functions_function["test_function"]["id"],
                headers=[oci.api.gateway.DeploymentSpecificationRouteBackendHeaderArgs(
                    name=var["deployment_specification_routes_backend_headers_name"],
                    value=var["deployment_specification_routes_backend_headers_value"],
                )],
                is_ssl_verify_disabled=var["deployment_specification_routes_backend_is_ssl_verify_disabled"],
                read_timeout_in_seconds=var["deployment_specification_routes_backend_read_timeout_in_seconds"],
                send_timeout_in_seconds=var["deployment_specification_routes_backend_send_timeout_in_seconds"],
                status=var["deployment_specification_routes_backend_status"],
                url=var["deployment_specification_routes_backend_url"],
            ),
            path=var["deployment_specification_routes_path"],
            logging_policies=oci.api.gateway.DeploymentSpecificationRouteLoggingPoliciesArgs(
                access_log=oci.api.gateway.DeploymentSpecificationRouteLoggingPoliciesAccessLogArgs(
                    is_enabled=var["deployment_specification_routes_logging_policies_access_log_is_enabled"],
                ),
                execution_log=oci.api.gateway.DeploymentSpecificationRouteLoggingPoliciesExecutionLogArgs(
                    is_enabled=var["deployment_specification_routes_logging_policies_execution_log_is_enabled"],
                    log_level=var["deployment_specification_routes_logging_policies_execution_log_log_level"],
                ),
            ),
            methods=var["deployment_specification_routes_methods"],
            request_policies=oci.api.gateway.DeploymentSpecificationRouteRequestPoliciesArgs(
                authorization=oci.api.gateway.DeploymentSpecificationRouteRequestPoliciesAuthorizationArgs(
                    allowed_scopes=var["deployment_specification_routes_request_policies_authorization_allowed_scope"],
                    type=var["deployment_specification_routes_request_policies_authorization_type"],
                ),
                body_validation=oci.api.gateway.DeploymentSpecificationRouteRequestPoliciesBodyValidationArgs(
                    contents=[oci.api.gateway.DeploymentSpecificationRouteRequestPoliciesBodyValidationContentArgs(
                        media_type=var["deployment_specification_routes_request_policies_body_validation_content_media_type"],
                        validation_type=var["deployment_specification_routes_request_policies_body_validation_content_validation_type"],
                    )],
                    required=var["deployment_specification_routes_request_policies_body_validation_required"],
                    validation_mode=var["deployment_specification_routes_request_policies_body_validation_validation_mode"],
                ),
                cors=oci.api.gateway.DeploymentSpecificationRouteRequestPoliciesCorsArgs(
                    allowed_origins=var["deployment_specification_routes_request_policies_cors_allowed_origins"],
                    allowed_headers=var["deployment_specification_routes_request_policies_cors_allowed_headers"],
                    allowed_methods=var["deployment_specification_routes_request_policies_cors_allowed_methods"],
                    exposed_headers=var["deployment_specification_routes_request_policies_cors_exposed_headers"],
                    is_allow_credentials_enabled=var["deployment_specification_routes_request_policies_cors_is_allow_credentials_enabled"],
                    max_age_in_seconds=var["deployment_specification_routes_request_policies_cors_max_age_in_seconds"],
                ),
                header_transformations=oci.api.gateway.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsArgs(
                    filter_headers=oci.api.gateway.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeadersArgs(
                        items=[oci.api.gateway.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeadersItemArgs(
                            name=var["deployment_specification_routes_request_policies_header_transformations_filter_headers_items_name"],
                        )],
                        type=var["deployment_specification_routes_request_policies_header_transformations_filter_headers_type"],
                    ),
                    rename_headers=oci.api.gateway.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeadersArgs(
                        items=[oci.api.gateway.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeadersItemArgs(
                            from_=var["deployment_specification_routes_request_policies_header_transformations_rename_headers_items_from"],
                            to=var["deployment_specification_routes_request_policies_header_transformations_rename_headers_items_to"],
                        )],
                    ),
                    set_headers=oci.api.gateway.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeadersArgs(
                        items=[oci.api.gateway.DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeadersItemArgs(
                            name=var["deployment_specification_routes_request_policies_header_transformations_set_headers_items_name"],
                            values=var["deployment_specification_routes_request_policies_header_transformations_set_headers_items_values"],
                            if_exists=var["deployment_specification_routes_request_policies_header_transformations_set_headers_items_if_exists"],
                        )],
                    ),
                ),
                header_validations=oci.api.gateway.DeploymentSpecificationRouteRequestPoliciesHeaderValidationsArgs(
                    headers=[oci.api.gateway.DeploymentSpecificationRouteRequestPoliciesHeaderValidationsHeaderArgs(
                        name=var["deployment_specification_routes_request_policies_header_validations_headers_name"],
                        required=var["deployment_specification_routes_request_policies_header_validations_headers_required"],
                    )],
                    validation_mode=var["deployment_specification_routes_request_policies_header_validations_validation_mode"],
                ),
                query_parameter_transformations=oci.api.gateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsArgs(
                    filter_query_parameters=oci.api.gateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParametersArgs(
                        items=[oci.api.gateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParametersItemArgs(
                            name=var["deployment_specification_routes_request_policies_query_parameter_transformations_filter_query_parameters_items_name"],
                        )],
                        type=var["deployment_specification_routes_request_policies_query_parameter_transformations_filter_query_parameters_type"],
                    ),
                    rename_query_parameters=oci.api.gateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParametersArgs(
                        items=[oci.api.gateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParametersItemArgs(
                            from_=var["deployment_specification_routes_request_policies_query_parameter_transformations_rename_query_parameters_items_from"],
                            to=var["deployment_specification_routes_request_policies_query_parameter_transformations_rename_query_parameters_items_to"],
                        )],
                    ),
                    set_query_parameters=oci.api.gateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParametersArgs(
                        items=[oci.api.gateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParametersItemArgs(
                            name=var["deployment_specification_routes_request_policies_query_parameter_transformations_set_query_parameters_items_name"],
                            values=var["deployment_specification_routes_request_policies_query_parameter_transformations_set_query_parameters_items_values"],
                            if_exists=var["deployment_specification_routes_request_policies_query_parameter_transformations_set_query_parameters_items_if_exists"],
                        )],
                    ),
                ),
                query_parameter_validations=oci.api.gateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterValidationsArgs(
                    parameters=[oci.api.gateway.DeploymentSpecificationRouteRequestPoliciesQueryParameterValidationsParameterArgs(
                        name=var["deployment_specification_routes_request_policies_query_parameter_validations_parameters_name"],
                        required=var["deployment_specification_routes_request_policies_query_parameter_validations_parameters_required"],
                    )],
                    validation_mode=var["deployment_specification_routes_request_policies_query_parameter_validations_validation_mode"],
                ),
                response_cache_lookup=oci.api.gateway.DeploymentSpecificationRouteRequestPoliciesResponseCacheLookupArgs(
                    type=var["deployment_specification_routes_request_policies_response_cache_lookup_type"],
                    cache_key_additions=var["deployment_specification_routes_request_policies_response_cache_lookup_cache_key_additions"],
                    is_enabled=var["deployment_specification_routes_request_policies_response_cache_lookup_is_enabled"],
                    is_private_caching_enabled=var["deployment_specification_routes_request_policies_response_cache_lookup_is_private_caching_enabled"],
                ),
            ),
            response_policies=oci.api.gateway.DeploymentSpecificationRouteResponsePoliciesArgs(
                header_transformations=oci.api.gateway.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsArgs(
                    filter_headers=oci.api.gateway.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeadersArgs(
                        items=[oci.api.gateway.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeadersItemArgs(
                            name=var["deployment_specification_routes_response_policies_header_transformations_filter_headers_items_name"],
                        )],
                        type=var["deployment_specification_routes_response_policies_header_transformations_filter_headers_type"],
                    ),
                    rename_headers=oci.api.gateway.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeadersArgs(
                        items=[oci.api.gateway.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeadersItemArgs(
                            from_=var["deployment_specification_routes_response_policies_header_transformations_rename_headers_items_from"],
                            to=var["deployment_specification_routes_response_policies_header_transformations_rename_headers_items_to"],
                        )],
                    ),
                    set_headers=oci.api.gateway.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeadersArgs(
                        items=[oci.api.gateway.DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeadersItemArgs(
                            name=var["deployment_specification_routes_response_policies_header_transformations_set_headers_items_name"],
                            values=var["deployment_specification_routes_response_policies_header_transformations_set_headers_items_values"],
                            if_exists=var["deployment_specification_routes_response_policies_header_transformations_set_headers_items_if_exists"],
                        )],
                    ),
                ),
                response_cache_store=oci.api.gateway.DeploymentSpecificationRouteResponsePoliciesResponseCacheStoreArgs(
                    time_to_live_in_seconds=var["deployment_specification_routes_response_policies_response_cache_store_time_to_live_in_seconds"],
                    type=var["deployment_specification_routes_response_policies_response_cache_store_type"],
                ),
            ),
        )],
    ))
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testDeployment = new oci.apigateway.Deployment("testDeployment", {
    compartmentId: _var.compartment_id,
    gatewayId: oci_apigateway_gateway.test_gateway.id,
    pathPrefix: _var.deployment_path_prefix,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    displayName: _var.deployment_display_name,
    freeformTags: {
        Department: "Finance",
    },
    specification: {
        loggingPolicies: {
            accessLog: {
                isEnabled: _var.deployment_specification_logging_policies_access_log_is_enabled,
            },
            executionLog: {
                isEnabled: _var.deployment_specification_logging_policies_execution_log_is_enabled,
                logLevel: _var.deployment_specification_logging_policies_execution_log_log_level,
            },
        },
        requestPolicies: {
            authentication: {
                type: _var.deployment_specification_request_policies_authentication_type,
                audiences: _var.deployment_specification_request_policies_authentication_audiences,
                functionId: oci_functions_function.test_function.id,
                isAnonymousAccessAllowed: _var.deployment_specification_request_policies_authentication_is_anonymous_access_allowed,
                issuers: _var.deployment_specification_request_policies_authentication_issuers,
                maxClockSkewInSeconds: _var.deployment_specification_request_policies_authentication_max_clock_skew_in_seconds,
                publicKeys: {
                    type: _var.deployment_specification_request_policies_authentication_public_keys_type,
                    isSslVerifyDisabled: _var.deployment_specification_request_policies_authentication_public_keys_is_ssl_verify_disabled,
                    keys: [{
                        format: _var.deployment_specification_request_policies_authentication_public_keys_keys_format,
                        alg: _var.deployment_specification_request_policies_authentication_public_keys_keys_alg,
                        e: _var.deployment_specification_request_policies_authentication_public_keys_keys_e,
                        key: _var.deployment_specification_request_policies_authentication_public_keys_keys_key,
                        keyOps: _var.deployment_specification_request_policies_authentication_public_keys_keys_key_ops,
                        kid: _var.deployment_specification_request_policies_authentication_public_keys_keys_kid,
                        kty: _var.deployment_specification_request_policies_authentication_public_keys_keys_kty,
                        n: _var.deployment_specification_request_policies_authentication_public_keys_keys_n,
                        use: _var.deployment_specification_request_policies_authentication_public_keys_keys_use,
                    }],
                    maxCacheDurationInHours: _var.deployment_specification_request_policies_authentication_public_keys_max_cache_duration_in_hours,
                    uri: _var.deployment_specification_request_policies_authentication_public_keys_uri,
                },
                tokenAuthScheme: _var.deployment_specification_request_policies_authentication_token_auth_scheme,
                tokenHeader: _var.deployment_specification_request_policies_authentication_token_header,
                tokenQueryParam: _var.deployment_specification_request_policies_authentication_token_query_param,
                verifyClaims: [{
                    isRequired: _var.deployment_specification_request_policies_authentication_verify_claims_is_required,
                    key: _var.deployment_specification_request_policies_authentication_verify_claims_key,
                    values: _var.deployment_specification_request_policies_authentication_verify_claims_values,
                }],
            },
            cors: {
                allowedOrigins: _var.deployment_specification_request_policies_cors_allowed_origins,
                allowedHeaders: _var.deployment_specification_request_policies_cors_allowed_headers,
                allowedMethods: _var.deployment_specification_request_policies_cors_allowed_methods,
                exposedHeaders: _var.deployment_specification_request_policies_cors_exposed_headers,
                isAllowCredentialsEnabled: _var.deployment_specification_request_policies_cors_is_allow_credentials_enabled,
                maxAgeInSeconds: _var.deployment_specification_request_policies_cors_max_age_in_seconds,
            },
            mutualTls: {
                allowedSans: _var.deployment_specification_request_policies_mutual_tls_allowed_sans,
                isVerifiedCertificateRequired: _var.deployment_specification_request_policies_mutual_tls_is_verified_certificate_required,
            },
            rateLimiting: {
                rateInRequestsPerSecond: _var.deployment_specification_request_policies_rate_limiting_rate_in_requests_per_second,
                rateKey: _var.deployment_specification_request_policies_rate_limiting_rate_key,
            },
        },
        routes: [{
            backend: {
                type: _var.deployment_specification_routes_backend_type,
                body: _var.deployment_specification_routes_backend_body,
                connectTimeoutInSeconds: _var.deployment_specification_routes_backend_connect_timeout_in_seconds,
                functionId: oci_functions_function.test_function.id,
                headers: [{
                    name: _var.deployment_specification_routes_backend_headers_name,
                    value: _var.deployment_specification_routes_backend_headers_value,
                }],
                isSslVerifyDisabled: _var.deployment_specification_routes_backend_is_ssl_verify_disabled,
                readTimeoutInSeconds: _var.deployment_specification_routes_backend_read_timeout_in_seconds,
                sendTimeoutInSeconds: _var.deployment_specification_routes_backend_send_timeout_in_seconds,
                status: _var.deployment_specification_routes_backend_status,
                url: _var.deployment_specification_routes_backend_url,
            },
            path: _var.deployment_specification_routes_path,
            loggingPolicies: {
                accessLog: {
                    isEnabled: _var.deployment_specification_routes_logging_policies_access_log_is_enabled,
                },
                executionLog: {
                    isEnabled: _var.deployment_specification_routes_logging_policies_execution_log_is_enabled,
                    logLevel: _var.deployment_specification_routes_logging_policies_execution_log_log_level,
                },
            },
            methods: _var.deployment_specification_routes_methods,
            requestPolicies: {
                authorization: {
                    allowedScopes: _var.deployment_specification_routes_request_policies_authorization_allowed_scope,
                    type: _var.deployment_specification_routes_request_policies_authorization_type,
                },
                bodyValidation: {
                    contents: [{
                        mediaType: _var.deployment_specification_routes_request_policies_body_validation_content_media_type,
                        validationType: _var.deployment_specification_routes_request_policies_body_validation_content_validation_type,
                    }],
                    required: _var.deployment_specification_routes_request_policies_body_validation_required,
                    validationMode: _var.deployment_specification_routes_request_policies_body_validation_validation_mode,
                },
                cors: {
                    allowedOrigins: _var.deployment_specification_routes_request_policies_cors_allowed_origins,
                    allowedHeaders: _var.deployment_specification_routes_request_policies_cors_allowed_headers,
                    allowedMethods: _var.deployment_specification_routes_request_policies_cors_allowed_methods,
                    exposedHeaders: _var.deployment_specification_routes_request_policies_cors_exposed_headers,
                    isAllowCredentialsEnabled: _var.deployment_specification_routes_request_policies_cors_is_allow_credentials_enabled,
                    maxAgeInSeconds: _var.deployment_specification_routes_request_policies_cors_max_age_in_seconds,
                },
                headerTransformations: {
                    filterHeaders: {
                        items: [{
                            name: _var.deployment_specification_routes_request_policies_header_transformations_filter_headers_items_name,
                        }],
                        type: _var.deployment_specification_routes_request_policies_header_transformations_filter_headers_type,
                    },
                    renameHeaders: {
                        items: [{
                            from: _var.deployment_specification_routes_request_policies_header_transformations_rename_headers_items_from,
                            to: _var.deployment_specification_routes_request_policies_header_transformations_rename_headers_items_to,
                        }],
                    },
                    setHeaders: {
                        items: [{
                            name: _var.deployment_specification_routes_request_policies_header_transformations_set_headers_items_name,
                            values: _var.deployment_specification_routes_request_policies_header_transformations_set_headers_items_values,
                            ifExists: _var.deployment_specification_routes_request_policies_header_transformations_set_headers_items_if_exists,
                        }],
                    },
                },
                headerValidations: {
                    headers: [{
                        name: _var.deployment_specification_routes_request_policies_header_validations_headers_name,
                        required: _var.deployment_specification_routes_request_policies_header_validations_headers_required,
                    }],
                    validationMode: _var.deployment_specification_routes_request_policies_header_validations_validation_mode,
                },
                queryParameterTransformations: {
                    filterQueryParameters: {
                        items: [{
                            name: _var.deployment_specification_routes_request_policies_query_parameter_transformations_filter_query_parameters_items_name,
                        }],
                        type: _var.deployment_specification_routes_request_policies_query_parameter_transformations_filter_query_parameters_type,
                    },
                    renameQueryParameters: {
                        items: [{
                            from: _var.deployment_specification_routes_request_policies_query_parameter_transformations_rename_query_parameters_items_from,
                            to: _var.deployment_specification_routes_request_policies_query_parameter_transformations_rename_query_parameters_items_to,
                        }],
                    },
                    setQueryParameters: {
                        items: [{
                            name: _var.deployment_specification_routes_request_policies_query_parameter_transformations_set_query_parameters_items_name,
                            values: _var.deployment_specification_routes_request_policies_query_parameter_transformations_set_query_parameters_items_values,
                            ifExists: _var.deployment_specification_routes_request_policies_query_parameter_transformations_set_query_parameters_items_if_exists,
                        }],
                    },
                },
                queryParameterValidations: {
                    parameters: [{
                        name: _var.deployment_specification_routes_request_policies_query_parameter_validations_parameters_name,
                        required: _var.deployment_specification_routes_request_policies_query_parameter_validations_parameters_required,
                    }],
                    validationMode: _var.deployment_specification_routes_request_policies_query_parameter_validations_validation_mode,
                },
                responseCacheLookup: {
                    type: _var.deployment_specification_routes_request_policies_response_cache_lookup_type,
                    cacheKeyAdditions: _var.deployment_specification_routes_request_policies_response_cache_lookup_cache_key_additions,
                    isEnabled: _var.deployment_specification_routes_request_policies_response_cache_lookup_is_enabled,
                    isPrivateCachingEnabled: _var.deployment_specification_routes_request_policies_response_cache_lookup_is_private_caching_enabled,
                },
            },
            responsePolicies: {
                headerTransformations: {
                    filterHeaders: {
                        items: [{
                            name: _var.deployment_specification_routes_response_policies_header_transformations_filter_headers_items_name,
                        }],
                        type: _var.deployment_specification_routes_response_policies_header_transformations_filter_headers_type,
                    },
                    renameHeaders: {
                        items: [{
                            from: _var.deployment_specification_routes_response_policies_header_transformations_rename_headers_items_from,
                            to: _var.deployment_specification_routes_response_policies_header_transformations_rename_headers_items_to,
                        }],
                    },
                    setHeaders: {
                        items: [{
                            name: _var.deployment_specification_routes_response_policies_header_transformations_set_headers_items_name,
                            values: _var.deployment_specification_routes_response_policies_header_transformations_set_headers_items_values,
                            ifExists: _var.deployment_specification_routes_response_policies_header_transformations_set_headers_items_if_exists,
                        }],
                    },
                },
                responseCacheStore: {
                    timeToLiveInSeconds: _var.deployment_specification_routes_response_policies_response_cache_store_time_to_live_in_seconds,
                    type: _var.deployment_specification_routes_response_policies_response_cache_store_type,
                },
            },
        }],
    },
});

Coming soon!

Create a Deployment Resource

new Deployment(name: string, args: DeploymentArgs, opts?: CustomResourceOptions);
@overload
def Deployment(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               compartment_id: Optional[str] = None,
               defined_tags: Optional[Mapping[str, Any]] = None,
               display_name: Optional[str] = None,
               freeform_tags: Optional[Mapping[str, Any]] = None,
               gateway_id: Optional[str] = None,
               path_prefix: Optional[str] = None,
               specification: Optional[_apigateway.DeploymentSpecificationArgs] = None)
@overload
def Deployment(resource_name: str,
               args: DeploymentArgs,
               opts: Optional[ResourceOptions] = None)
func NewDeployment(ctx *Context, name string, args DeploymentArgs, opts ...ResourceOption) (*Deployment, error)
public Deployment(string name, DeploymentArgs args, CustomResourceOptions? opts = null)
public Deployment(String name, DeploymentArgs args)
public Deployment(String name, DeploymentArgs args, CustomResourceOptions options)
type: oci:ApiGateway:Deployment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args DeploymentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args DeploymentArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args DeploymentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DeploymentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DeploymentArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Deployment Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Deployment resource accepts the following input properties:

CompartmentId string

(Updatable) The OCID of the compartment in which the resource is created.

GatewayId string

The OCID of the resource.

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.

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource

FreeformTags Dictionary<string, object>

(Updatable) 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"}

Specification DeploymentSpecificationArgs

(Updatable) The logical configuration of the API exposed by a deployment.

CompartmentId string

(Updatable) The OCID of the compartment in which the resource is created.

GatewayId string

The OCID of the resource.

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.

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource

FreeformTags map[string]interface{}

(Updatable) 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"}

Specification DeploymentSpecificationArgs

(Updatable) The logical configuration of the API exposed by a deployment.

compartmentId String

(Updatable) The OCID of the compartment in which the resource is created.

gatewayId String

The OCID of the resource.

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.

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource

freeformTags Map<String,Object>

(Updatable) 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"}

specification DeploymentSpecificationArgs

(Updatable) The logical configuration of the API exposed by a deployment.

compartmentId string

(Updatable) The OCID of the compartment in which the resource is created.

gatewayId string

The OCID of the resource.

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.

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName string

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource

freeformTags {[key: string]: any}

(Updatable) 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"}

specification DeploymentSpecificationArgs

(Updatable) The logical configuration of the API exposed by a deployment.

compartment_id str

(Updatable) The OCID of the compartment in which the resource is created.

gateway_id str

The OCID of the resource.

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.

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

display_name str

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource

freeform_tags Mapping[str, Any]

(Updatable) 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"}

specification DeploymentSpecificationArgs

(Updatable) The logical configuration of the API exposed by a deployment.

compartmentId String

(Updatable) The OCID of the compartment in which the resource is created.

gatewayId String

The OCID of the resource.

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.

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource

freeformTags Map<Any>

(Updatable) 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"}

specification Property Map

(Updatable) The logical configuration of the API exposed by a deployment.

Outputs

All input properties are implicitly available as output properties. Additionally, the Deployment resource produces the following output properties:

Endpoint string

The endpoint to access this deployment on the gateway.

Id string

The provider-assigned unique ID for this managed 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.

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.

Endpoint string

The endpoint to access this deployment on the gateway.

Id string

The provider-assigned unique ID for this managed 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.

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.

endpoint String

The endpoint to access this deployment on the gateway.

id String

The provider-assigned unique ID for this managed 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.

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.

endpoint string

The endpoint to access this deployment on the gateway.

id string

The provider-assigned unique ID for this managed 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.

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.

endpoint str

The endpoint to access this deployment on the gateway.

id str

The provider-assigned unique ID for this managed 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.

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.

endpoint String

The endpoint to access this deployment on the gateway.

id String

The provider-assigned unique ID for this managed 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.

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.

Look up an Existing Deployment Resource

Get an existing Deployment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DeploymentState, opts?: CustomResourceOptions): Deployment
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        display_name: Optional[str] = None,
        endpoint: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        gateway_id: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        path_prefix: Optional[str] = None,
        specification: Optional[_apigateway.DeploymentSpecificationArgs] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> Deployment
func GetDeployment(ctx *Context, name string, id IDInput, state *DeploymentState, opts ...ResourceOption) (*Deployment, error)
public static Deployment Get(string name, Input<string> id, DeploymentState? state, CustomResourceOptions? opts = null)
public static Deployment get(String name, Output<String> id, DeploymentState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CompartmentId string

(Updatable) The OCID of the compartment in which the resource is created.

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

(Updatable) 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>

(Updatable) 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.

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.

Specification DeploymentSpecificationArgs

(Updatable) 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

(Updatable) The OCID of the compartment in which the resource is created.

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

(Updatable) 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{}

(Updatable) 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.

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.

Specification DeploymentSpecificationArgs

(Updatable) 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

(Updatable) The OCID of the compartment in which the resource is created.

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

(Updatable) 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>

(Updatable) 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.

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.

specification DeploymentSpecificationArgs

(Updatable) 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

(Updatable) The OCID of the compartment in which the resource is created.

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName string

(Updatable) 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}

(Updatable) 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.

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.

specification DeploymentSpecificationArgs

(Updatable) 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

(Updatable) The OCID of the compartment in which the resource is created.

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

display_name str

(Updatable) 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]

(Updatable) 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.

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.

specification DeploymentSpecificationArgs

(Updatable) 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

(Updatable) The OCID of the compartment in which the resource is created.

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

(Updatable) 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>

(Updatable) 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.

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.

specification Property Map

(Updatable) 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

DeploymentSpecification

Routes List<DeploymentSpecificationRoute>

(Updatable) A list of routes that this API exposes.

LoggingPolicies DeploymentSpecificationLoggingPolicies

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

RequestPolicies DeploymentSpecificationRequestPolicies

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

Routes []DeploymentSpecificationRoute

(Updatable) A list of routes that this API exposes.

LoggingPolicies DeploymentSpecificationLoggingPolicies

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

RequestPolicies DeploymentSpecificationRequestPolicies

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

routes List<DeploymentSpecificationRoute>

(Updatable) A list of routes that this API exposes.

loggingPolicies DeploymentSpecificationLoggingPolicies

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

requestPolicies DeploymentSpecificationRequestPolicies

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

routes DeploymentSpecificationRoute[]

(Updatable) A list of routes that this API exposes.

loggingPolicies DeploymentSpecificationLoggingPolicies

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

requestPolicies DeploymentSpecificationRequestPolicies

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

routes DeploymentSpecificationRoute]

(Updatable) A list of routes that this API exposes.

logging_policies DeploymentSpecificationLoggingPolicies

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

request_policies DeploymentSpecificationRequestPolicies

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

routes List<Property Map>

(Updatable) A list of routes that this API exposes.

loggingPolicies Property Map

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

requestPolicies Property Map

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

DeploymentSpecificationLoggingPolicies

AccessLog DeploymentSpecificationLoggingPoliciesAccessLog

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

ExecutionLog DeploymentSpecificationLoggingPoliciesExecutionLog

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

AccessLog DeploymentSpecificationLoggingPoliciesAccessLog

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

ExecutionLog DeploymentSpecificationLoggingPoliciesExecutionLog

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

accessLog DeploymentSpecificationLoggingPoliciesAccessLog

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

executionLog DeploymentSpecificationLoggingPoliciesExecutionLog

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

accessLog DeploymentSpecificationLoggingPoliciesAccessLog

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

executionLog DeploymentSpecificationLoggingPoliciesExecutionLog

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

access_log DeploymentSpecificationLoggingPoliciesAccessLog

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

execution_log DeploymentSpecificationLoggingPoliciesExecutionLog

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

accessLog Property Map

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

executionLog Property Map

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

DeploymentSpecificationLoggingPoliciesAccessLog

IsEnabled bool

(Updatable) Whether this policy is currently enabled.

IsEnabled bool

(Updatable) Whether this policy is currently enabled.

isEnabled Boolean

(Updatable) Whether this policy is currently enabled.

isEnabled boolean

(Updatable) Whether this policy is currently enabled.

is_enabled bool

(Updatable) Whether this policy is currently enabled.

isEnabled Boolean

(Updatable) Whether this policy is currently enabled.

DeploymentSpecificationLoggingPoliciesExecutionLog

IsEnabled bool

(Updatable) Whether this policy is currently enabled.

LogLevel string

(Updatable) 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

(Updatable) Whether this policy is currently enabled.

LogLevel string

(Updatable) 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

(Updatable) Whether this policy is currently enabled.

logLevel String

(Updatable) 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

(Updatable) Whether this policy is currently enabled.

logLevel string

(Updatable) 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

(Updatable) Whether this policy is currently enabled.

log_level str

(Updatable) 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

(Updatable) Whether this policy is currently enabled.

logLevel String

(Updatable) 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.

DeploymentSpecificationRequestPolicies

Authentication DeploymentSpecificationRequestPoliciesAuthentication

(Updatable) Information on how to authenticate incoming requests.

Cors DeploymentSpecificationRequestPoliciesCors

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

MutualTls DeploymentSpecificationRequestPoliciesMutualTls

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

RateLimiting DeploymentSpecificationRequestPoliciesRateLimiting

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

Authentication DeploymentSpecificationRequestPoliciesAuthentication

(Updatable) Information on how to authenticate incoming requests.

Cors DeploymentSpecificationRequestPoliciesCors

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

MutualTls DeploymentSpecificationRequestPoliciesMutualTls

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

RateLimiting DeploymentSpecificationRequestPoliciesRateLimiting

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

authentication DeploymentSpecificationRequestPoliciesAuthentication

(Updatable) Information on how to authenticate incoming requests.

cors DeploymentSpecificationRequestPoliciesCors

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

mutualTls DeploymentSpecificationRequestPoliciesMutualTls

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

rateLimiting DeploymentSpecificationRequestPoliciesRateLimiting

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

authentication DeploymentSpecificationRequestPoliciesAuthentication

(Updatable) Information on how to authenticate incoming requests.

cors DeploymentSpecificationRequestPoliciesCors

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

mutualTls DeploymentSpecificationRequestPoliciesMutualTls

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

rateLimiting DeploymentSpecificationRequestPoliciesRateLimiting

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

authentication DeploymentSpecificationRequestPoliciesAuthentication

(Updatable) Information on how to authenticate incoming requests.

cors DeploymentSpecificationRequestPoliciesCors

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

mutual_tls DeploymentSpecificationRequestPoliciesMutualTls

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

rate_limiting DeploymentSpecificationRequestPoliciesRateLimiting

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

authentication Property Map

(Updatable) Information on how to authenticate incoming requests.

cors Property Map

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

mutualTls Property Map

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

rateLimiting Property Map

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

DeploymentSpecificationRequestPoliciesAuthentication

Type string

(Updatable) Type of the Response Cache Store Policy.

Audiences List<string>

(Updatable) The list of intended recipients for the token.

FunctionId string

(Updatable) The OCID of the Oracle Functions function resource.

IsAnonymousAccessAllowed bool

(Updatable) Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.

Issuers List<string>

(Updatable) A list of parties that could have issued the token.

MaxClockSkewInSeconds double

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

PublicKeys DeploymentSpecificationRequestPoliciesAuthenticationPublicKeys

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

TokenAuthScheme string

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

TokenHeader string

(Updatable) The name of the header containing the authentication token.

TokenQueryParam string

(Updatable) The name of the query parameter containing the authentication token.

VerifyClaims List<DeploymentSpecificationRequestPoliciesAuthenticationVerifyClaim>

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

Type string

(Updatable) Type of the Response Cache Store Policy.

Audiences []string

(Updatable) The list of intended recipients for the token.

FunctionId string

(Updatable) The OCID of the Oracle Functions function resource.

IsAnonymousAccessAllowed bool

(Updatable) Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.

Issuers []string

(Updatable) A list of parties that could have issued the token.

MaxClockSkewInSeconds float64

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

PublicKeys DeploymentSpecificationRequestPoliciesAuthenticationPublicKeys

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

TokenAuthScheme string

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

TokenHeader string

(Updatable) The name of the header containing the authentication token.

TokenQueryParam string

(Updatable) The name of the query parameter containing the authentication token.

VerifyClaims []DeploymentSpecificationRequestPoliciesAuthenticationVerifyClaim

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

type String

(Updatable) Type of the Response Cache Store Policy.

audiences List<String>

(Updatable) The list of intended recipients for the token.

functionId String

(Updatable) The OCID of the Oracle Functions function resource.

isAnonymousAccessAllowed Boolean

(Updatable) Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.

issuers List<String>

(Updatable) A list of parties that could have issued the token.

maxClockSkewInSeconds Double

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

publicKeys DeploymentSpecificationRequestPoliciesAuthenticationPublicKeys

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

tokenAuthScheme String

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

tokenHeader String

(Updatable) The name of the header containing the authentication token.

tokenQueryParam String

(Updatable) The name of the query parameter containing the authentication token.

verifyClaims List<DeploymentSpecificationRequestPoliciesAuthenticationVerifyClaim>

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

type string

(Updatable) Type of the Response Cache Store Policy.

audiences string[]

(Updatable) The list of intended recipients for the token.

functionId string

(Updatable) The OCID of the Oracle Functions function resource.

isAnonymousAccessAllowed boolean

(Updatable) Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.

issuers string[]

(Updatable) A list of parties that could have issued the token.

maxClockSkewInSeconds number

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

publicKeys DeploymentSpecificationRequestPoliciesAuthenticationPublicKeys

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

tokenAuthScheme string

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

tokenHeader string

(Updatable) The name of the header containing the authentication token.

tokenQueryParam string

(Updatable) The name of the query parameter containing the authentication token.

verifyClaims DeploymentSpecificationRequestPoliciesAuthenticationVerifyClaim[]

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

type str

(Updatable) Type of the Response Cache Store Policy.

audiences Sequence[str]

(Updatable) The list of intended recipients for the token.

function_id str

(Updatable) The OCID of the Oracle Functions function resource.

is_anonymous_access_allowed bool

(Updatable) Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.

issuers Sequence[str]

(Updatable) A list of parties that could have issued the token.

max_clock_skew_in_seconds float

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

public_keys DeploymentSpecificationRequestPoliciesAuthenticationPublicKeys

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

token_auth_scheme str

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

token_header str

(Updatable) The name of the header containing the authentication token.

token_query_param str

(Updatable) The name of the query parameter containing the authentication token.

verify_claims DeploymentSpecificationRequestPoliciesAuthenticationVerifyClaim]

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

type String

(Updatable) Type of the Response Cache Store Policy.

audiences List<String>

(Updatable) The list of intended recipients for the token.

functionId String

(Updatable) The OCID of the Oracle Functions function resource.

isAnonymousAccessAllowed Boolean

(Updatable) Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS route authorization.

issuers List<String>

(Updatable) A list of parties that could have issued the token.

maxClockSkewInSeconds Number

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

publicKeys Property Map

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

tokenAuthScheme String

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

tokenHeader String

(Updatable) The name of the header containing the authentication token.

tokenQueryParam String

(Updatable) The name of the query parameter containing the authentication token.

verifyClaims List<Property Map>

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

DeploymentSpecificationRequestPoliciesAuthenticationPublicKeys

Type string

(Updatable) Type of the Response Cache Store Policy.

IsSslVerifyDisabled bool

(Updatable) Defines whether or not to uphold SSL verification.

Keys List<DeploymentSpecificationRequestPoliciesAuthenticationPublicKeysKey>

(Updatable) The set of static public keys.

MaxCacheDurationInHours int

(Updatable) The duration for which the JWKS should be cached before it is fetched again.

Uri string

(Updatable) The uri from which to retrieve the key. It must be accessible without authentication.

Type string

(Updatable) Type of the Response Cache Store Policy.

IsSslVerifyDisabled bool

(Updatable) Defines whether or not to uphold SSL verification.

Keys []DeploymentSpecificationRequestPoliciesAuthenticationPublicKeysKey

(Updatable) The set of static public keys.

MaxCacheDurationInHours int

(Updatable) The duration for which the JWKS should be cached before it is fetched again.

Uri string

(Updatable) The uri from which to retrieve the key. It must be accessible without authentication.

type String

(Updatable) Type of the Response Cache Store Policy.

isSslVerifyDisabled Boolean

(Updatable) Defines whether or not to uphold SSL verification.

keys List<DeploymentSpecificationRequestPoliciesAuthenticationPublicKeysKey>

(Updatable) The set of static public keys.

maxCacheDurationInHours Integer

(Updatable) The duration for which the JWKS should be cached before it is fetched again.

uri String

(Updatable) The uri from which to retrieve the key. It must be accessible without authentication.

type string

(Updatable) Type of the Response Cache Store Policy.

isSslVerifyDisabled boolean

(Updatable) Defines whether or not to uphold SSL verification.

keys DeploymentSpecificationRequestPoliciesAuthenticationPublicKeysKey[]

(Updatable) The set of static public keys.

maxCacheDurationInHours number

(Updatable) The duration for which the JWKS should be cached before it is fetched again.

uri string

(Updatable) The uri from which to retrieve the key. It must be accessible without authentication.

type str

(Updatable) Type of the Response Cache Store Policy.

is_ssl_verify_disabled bool

(Updatable) Defines whether or not to uphold SSL verification.

keys DeploymentSpecificationRequestPoliciesAuthenticationPublicKeysKey]

(Updatable) The set of static public keys.

max_cache_duration_in_hours int

(Updatable) The duration for which the JWKS should be cached before it is fetched again.

uri str

(Updatable) The uri from which to retrieve the key. It must be accessible without authentication.

type String

(Updatable) Type of the Response Cache Store Policy.

isSslVerifyDisabled Boolean

(Updatable) Defines whether or not to uphold SSL verification.

keys List<Property Map>

(Updatable) The set of static public keys.

maxCacheDurationInHours Number

(Updatable) The duration for which the JWKS should be cached before it is fetched again.

uri String

(Updatable) The uri from which to retrieve the key. It must be accessible without authentication.

DeploymentSpecificationRequestPoliciesAuthenticationPublicKeysKey

Format string

(Updatable) The format of the public key.

Alg string

(Updatable) The algorithm intended for use with this key.

E string

(Updatable) The base64 url encoded exponent of the RSA public key represented by this key.

Key string

(Updatable) Name of the claim.

KeyOps List<string>

(Updatable) The operations for which this key is to be used.

Kid string

(Updatable) A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

Kty string

(Updatable) The key type.

N string

(Updatable) The base64 url encoded modulus of the RSA public key represented by this key.

Use string

(Updatable) The intended use of the public key.

Format string

(Updatable) The format of the public key.

Alg string

(Updatable) The algorithm intended for use with this key.

E string

(Updatable) The base64 url encoded exponent of the RSA public key represented by this key.

Key string

(Updatable) Name of the claim.

KeyOps []string

(Updatable) The operations for which this key is to be used.

Kid string

(Updatable) A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

Kty string

(Updatable) The key type.

N string

(Updatable) The base64 url encoded modulus of the RSA public key represented by this key.

Use string

(Updatable) The intended use of the public key.

format String

(Updatable) The format of the public key.

alg String

(Updatable) The algorithm intended for use with this key.

e String

(Updatable) The base64 url encoded exponent of the RSA public key represented by this key.

key String

(Updatable) Name of the claim.

keyOps List<String>

(Updatable) The operations for which this key is to be used.

kid String

(Updatable) A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

kty String

(Updatable) The key type.

n String

(Updatable) The base64 url encoded modulus of the RSA public key represented by this key.

use String

(Updatable) The intended use of the public key.

format string

(Updatable) The format of the public key.

alg string

(Updatable) The algorithm intended for use with this key.

e string

(Updatable) The base64 url encoded exponent of the RSA public key represented by this key.

key string

(Updatable) Name of the claim.

keyOps string[]

(Updatable) The operations for which this key is to be used.

kid string

(Updatable) A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

kty string

(Updatable) The key type.

n string

(Updatable) The base64 url encoded modulus of the RSA public key represented by this key.

use string

(Updatable) The intended use of the public key.

format str

(Updatable) The format of the public key.

alg str

(Updatable) The algorithm intended for use with this key.

e str

(Updatable) The base64 url encoded exponent of the RSA public key represented by this key.

key str

(Updatable) Name of the claim.

key_ops Sequence[str]

(Updatable) The operations for which this key is to be used.

kid str

(Updatable) A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

kty str

(Updatable) The key type.

n str

(Updatable) The base64 url encoded modulus of the RSA public key represented by this key.

use str

(Updatable) The intended use of the public key.

format String

(Updatable) The format of the public key.

alg String

(Updatable) The algorithm intended for use with this key.

e String

(Updatable) The base64 url encoded exponent of the RSA public key represented by this key.

key String

(Updatable) Name of the claim.

keyOps List<String>

(Updatable) The operations for which this key is to be used.

kid String

(Updatable) A unique key ID. This key will be used to verify the signature of a JWT with matching "kid".

kty String

(Updatable) The key type.

n String

(Updatable) The base64 url encoded modulus of the RSA public key represented by this key.

use String

(Updatable) The intended use of the public key.

DeploymentSpecificationRequestPoliciesAuthenticationVerifyClaim

IsRequired bool

(Updatable) 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

(Updatable) Name of the claim.

Values List<string>

(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

IsRequired bool

(Updatable) 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

(Updatable) Name of the claim.

Values []string

(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

isRequired Boolean

(Updatable) 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

(Updatable) Name of the claim.

values List<String>

(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

isRequired boolean

(Updatable) 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

(Updatable) Name of the claim.

values string[]

(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

is_required bool

(Updatable) 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

(Updatable) Name of the claim.

values Sequence[str]

(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

isRequired Boolean

(Updatable) 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

(Updatable) Name of the claim.

values List<String>

(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

DeploymentSpecificationRequestPoliciesCors

AllowedOrigins List<string>

(Updatable) 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.

AllowedHeaders List<string>

(Updatable) 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>

(Updatable) 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.

ExposedHeaders List<string>

(Updatable) 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

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

MaxAgeInSeconds int

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

AllowedOrigins []string

(Updatable) 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.

AllowedHeaders []string

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

AllowedMethods []string

(Updatable) 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.

ExposedHeaders []string

(Updatable) 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

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

MaxAgeInSeconds int

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

allowedOrigins List<String>

(Updatable) 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.

allowedHeaders List<String>

(Updatable) 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>

(Updatable) 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.

exposedHeaders List<String>

(Updatable) 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

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

maxAgeInSeconds Integer

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

allowedOrigins string[]

(Updatable) 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.

allowedHeaders string[]

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

allowedMethods string[]

(Updatable) 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.

exposedHeaders string[]

(Updatable) 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

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

maxAgeInSeconds number

(Updatable) 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_origins Sequence[str]

(Updatable) 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.

allowed_headers Sequence[str]

(Updatable) 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]

(Updatable) 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.

exposed_headers Sequence[str]

(Updatable) 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

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

max_age_in_seconds int

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

allowedOrigins List<String>

(Updatable) 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.

allowedHeaders List<String>

(Updatable) 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>

(Updatable) 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.

exposedHeaders List<String>

(Updatable) 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

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

maxAgeInSeconds Number

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

DeploymentSpecificationRequestPoliciesMutualTls

AllowedSans List<string>

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

IsVerifiedCertificateRequired bool

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

AllowedSans []string

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

IsVerifiedCertificateRequired bool

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

allowedSans List<String>

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

isVerifiedCertificateRequired Boolean

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

allowedSans string[]

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

isVerifiedCertificateRequired boolean

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

allowed_sans Sequence[str]

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

is_verified_certificate_required bool

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

allowedSans List<String>

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

isVerifiedCertificateRequired Boolean

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

DeploymentSpecificationRequestPoliciesRateLimiting

RateInRequestsPerSecond int

(Updatable) The maximum number of requests per second to allow.

RateKey string

(Updatable) The key used to group requests together.

RateInRequestsPerSecond int

(Updatable) The maximum number of requests per second to allow.

RateKey string

(Updatable) The key used to group requests together.

rateInRequestsPerSecond Integer

(Updatable) The maximum number of requests per second to allow.

rateKey String

(Updatable) The key used to group requests together.

rateInRequestsPerSecond number

(Updatable) The maximum number of requests per second to allow.

rateKey string

(Updatable) The key used to group requests together.

rate_in_requests_per_second int

(Updatable) The maximum number of requests per second to allow.

rate_key str

(Updatable) The key used to group requests together.

rateInRequestsPerSecond Number

(Updatable) The maximum number of requests per second to allow.

rateKey String

(Updatable) The key used to group requests together.

DeploymentSpecificationRoute

Backend DeploymentSpecificationRouteBackend

(Updatable) The backend to forward requests to.

Path string

(Updatable) 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.

LoggingPolicies DeploymentSpecificationRouteLoggingPolicies

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

Methods List<string>

(Updatable) A list of allowed methods on this route.

RequestPolicies DeploymentSpecificationRouteRequestPolicies

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

ResponsePolicies DeploymentSpecificationRouteResponsePolicies

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

Backend DeploymentSpecificationRouteBackend

(Updatable) The backend to forward requests to.

Path string

(Updatable) 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.

LoggingPolicies DeploymentSpecificationRouteLoggingPolicies

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

Methods []string

(Updatable) A list of allowed methods on this route.

RequestPolicies DeploymentSpecificationRouteRequestPolicies

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

ResponsePolicies DeploymentSpecificationRouteResponsePolicies

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

backend DeploymentSpecificationRouteBackend

(Updatable) The backend to forward requests to.

path String

(Updatable) 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.

loggingPolicies DeploymentSpecificationRouteLoggingPolicies

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

methods List<String>

(Updatable) A list of allowed methods on this route.

requestPolicies DeploymentSpecificationRouteRequestPolicies

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

responsePolicies DeploymentSpecificationRouteResponsePolicies

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

backend DeploymentSpecificationRouteBackend

(Updatable) The backend to forward requests to.

path string

(Updatable) 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.

loggingPolicies DeploymentSpecificationRouteLoggingPolicies

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

methods string[]

(Updatable) A list of allowed methods on this route.

requestPolicies DeploymentSpecificationRouteRequestPolicies

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

responsePolicies DeploymentSpecificationRouteResponsePolicies

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

backend DeploymentSpecificationRouteBackend

(Updatable) The backend to forward requests to.

path str

(Updatable) 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.

logging_policies DeploymentSpecificationRouteLoggingPolicies

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

methods Sequence[str]

(Updatable) A list of allowed methods on this route.

request_policies DeploymentSpecificationRouteRequestPolicies

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

response_policies DeploymentSpecificationRouteResponsePolicies

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

backend Property Map

(Updatable) The backend to forward requests to.

path String

(Updatable) 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.

loggingPolicies Property Map

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

methods List<String>

(Updatable) A list of allowed methods on this route.

requestPolicies Property Map

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

responsePolicies Property Map

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

DeploymentSpecificationRouteBackend

Type string

(Updatable) Type of the Response Cache Store Policy.

Body string

(Updatable) The body of the stock response from the mock backend.

ConnectTimeoutInSeconds double

(Updatable) Defines a timeout for establishing a connection with a proxied server.

FunctionId string

(Updatable) The OCID of the Oracle Functions function resource.

Headers List<DeploymentSpecificationRouteBackendHeader>

(Updatable)

IsSslVerifyDisabled bool

(Updatable) Defines whether or not to uphold SSL verification.

ReadTimeoutInSeconds double

(Updatable) Defines a timeout for reading a response from the proxied server.

SendTimeoutInSeconds double

(Updatable) Defines a timeout for transmitting a request to the proxied server.

Status int

(Updatable) The status code of the stock response from the mock backend.

Url string

(Updatable)

Type string

(Updatable) Type of the Response Cache Store Policy.

Body string

(Updatable) The body of the stock response from the mock backend.

ConnectTimeoutInSeconds float64

(Updatable) Defines a timeout for establishing a connection with a proxied server.

FunctionId string

(Updatable) The OCID of the Oracle Functions function resource.

Headers []DeploymentSpecificationRouteBackendHeader

(Updatable)

IsSslVerifyDisabled bool

(Updatable) Defines whether or not to uphold SSL verification.

ReadTimeoutInSeconds float64

(Updatable) Defines a timeout for reading a response from the proxied server.

SendTimeoutInSeconds float64

(Updatable) Defines a timeout for transmitting a request to the proxied server.

Status int

(Updatable) The status code of the stock response from the mock backend.

Url string

(Updatable)

type String

(Updatable) Type of the Response Cache Store Policy.

body String

(Updatable) The body of the stock response from the mock backend.

connectTimeoutInSeconds Double

(Updatable) Defines a timeout for establishing a connection with a proxied server.

functionId String

(Updatable) The OCID of the Oracle Functions function resource.

headers List<DeploymentSpecificationRouteBackendHeader>

(Updatable)

isSslVerifyDisabled Boolean

(Updatable) Defines whether or not to uphold SSL verification.

readTimeoutInSeconds Double

(Updatable) Defines a timeout for reading a response from the proxied server.

sendTimeoutInSeconds Double

(Updatable) Defines a timeout for transmitting a request to the proxied server.

status Integer

(Updatable) The status code of the stock response from the mock backend.

url String

(Updatable)

type string

(Updatable) Type of the Response Cache Store Policy.

body string

(Updatable) The body of the stock response from the mock backend.

connectTimeoutInSeconds number

(Updatable) Defines a timeout for establishing a connection with a proxied server.

functionId string

(Updatable) The OCID of the Oracle Functions function resource.

headers DeploymentSpecificationRouteBackendHeader[]

(Updatable)

isSslVerifyDisabled boolean

(Updatable) Defines whether or not to uphold SSL verification.

readTimeoutInSeconds number

(Updatable) Defines a timeout for reading a response from the proxied server.

sendTimeoutInSeconds number

(Updatable) Defines a timeout for transmitting a request to the proxied server.

status number

(Updatable) The status code of the stock response from the mock backend.

url string

(Updatable)

type str

(Updatable) Type of the Response Cache Store Policy.

body str

(Updatable) The body of the stock response from the mock backend.

connect_timeout_in_seconds float

(Updatable) Defines a timeout for establishing a connection with a proxied server.

function_id str

(Updatable) The OCID of the Oracle Functions function resource.

headers DeploymentSpecificationRouteBackendHeader]

(Updatable)

is_ssl_verify_disabled bool

(Updatable) Defines whether or not to uphold SSL verification.

read_timeout_in_seconds float

(Updatable) Defines a timeout for reading a response from the proxied server.

send_timeout_in_seconds float

(Updatable) Defines a timeout for transmitting a request to the proxied server.

status int

(Updatable) The status code of the stock response from the mock backend.

url str

(Updatable)

type String

(Updatable) Type of the Response Cache Store Policy.

body String

(Updatable) The body of the stock response from the mock backend.

connectTimeoutInSeconds Number

(Updatable) Defines a timeout for establishing a connection with a proxied server.

functionId String

(Updatable) The OCID of the Oracle Functions function resource.

headers List<Property Map>

(Updatable)

isSslVerifyDisabled Boolean

(Updatable) Defines whether or not to uphold SSL verification.

readTimeoutInSeconds Number

(Updatable) Defines a timeout for reading a response from the proxied server.

sendTimeoutInSeconds Number

(Updatable) Defines a timeout for transmitting a request to the proxied server.

status Number

(Updatable) The status code of the stock response from the mock backend.

url String

(Updatable)

DeploymentSpecificationRouteBackendHeader

Name string

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

Value string

(Updatable) Value of the header.

Name string

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

Value string

(Updatable) Value of the header.

name String

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

value String

(Updatable) Value of the header.

name string

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

value string

(Updatable) Value of the header.

name str

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

value str

(Updatable) Value of the header.

name String

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

value String

(Updatable) Value of the header.

DeploymentSpecificationRouteLoggingPolicies

AccessLog DeploymentSpecificationRouteLoggingPoliciesAccessLog

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

ExecutionLog DeploymentSpecificationRouteLoggingPoliciesExecutionLog

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

AccessLog DeploymentSpecificationRouteLoggingPoliciesAccessLog

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

ExecutionLog DeploymentSpecificationRouteLoggingPoliciesExecutionLog

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

accessLog DeploymentSpecificationRouteLoggingPoliciesAccessLog

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

executionLog DeploymentSpecificationRouteLoggingPoliciesExecutionLog

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

accessLog DeploymentSpecificationRouteLoggingPoliciesAccessLog

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

executionLog DeploymentSpecificationRouteLoggingPoliciesExecutionLog

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

access_log DeploymentSpecificationRouteLoggingPoliciesAccessLog

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

execution_log DeploymentSpecificationRouteLoggingPoliciesExecutionLog

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

accessLog Property Map

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

executionLog Property Map

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

DeploymentSpecificationRouteLoggingPoliciesAccessLog

IsEnabled bool

(Updatable) Whether this policy is currently enabled.

IsEnabled bool

(Updatable) Whether this policy is currently enabled.

isEnabled Boolean

(Updatable) Whether this policy is currently enabled.

isEnabled boolean

(Updatable) Whether this policy is currently enabled.

is_enabled bool

(Updatable) Whether this policy is currently enabled.

isEnabled Boolean

(Updatable) Whether this policy is currently enabled.

DeploymentSpecificationRouteLoggingPoliciesExecutionLog

IsEnabled bool

(Updatable) Whether this policy is currently enabled.

LogLevel string

(Updatable) 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

(Updatable) Whether this policy is currently enabled.

LogLevel string

(Updatable) 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

(Updatable) Whether this policy is currently enabled.

logLevel String

(Updatable) 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

(Updatable) Whether this policy is currently enabled.

logLevel string

(Updatable) 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

(Updatable) Whether this policy is currently enabled.

log_level str

(Updatable) 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

(Updatable) Whether this policy is currently enabled.

logLevel String

(Updatable) 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.

DeploymentSpecificationRouteRequestPolicies

Authorization DeploymentSpecificationRouteRequestPoliciesAuthorization

(Updatable) 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.

BodyValidation DeploymentSpecificationRouteRequestPoliciesBodyValidation

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

Cors DeploymentSpecificationRouteRequestPoliciesCors

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

HeaderTransformations DeploymentSpecificationRouteRequestPoliciesHeaderTransformations

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

HeaderValidations DeploymentSpecificationRouteRequestPoliciesHeaderValidations

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

QueryParameterTransformations DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformations

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

QueryParameterValidations DeploymentSpecificationRouteRequestPoliciesQueryParameterValidations

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

ResponseCacheLookup DeploymentSpecificationRouteRequestPoliciesResponseCacheLookup

(Updatable) Base policy for Response Cache lookup.

Authorization DeploymentSpecificationRouteRequestPoliciesAuthorization

(Updatable) 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.

BodyValidation DeploymentSpecificationRouteRequestPoliciesBodyValidation

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

Cors DeploymentSpecificationRouteRequestPoliciesCors

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

HeaderTransformations DeploymentSpecificationRouteRequestPoliciesHeaderTransformations

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

HeaderValidations DeploymentSpecificationRouteRequestPoliciesHeaderValidations

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

QueryParameterTransformations DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformations

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

QueryParameterValidations DeploymentSpecificationRouteRequestPoliciesQueryParameterValidations

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

ResponseCacheLookup DeploymentSpecificationRouteRequestPoliciesResponseCacheLookup

(Updatable) Base policy for Response Cache lookup.

authorization DeploymentSpecificationRouteRequestPoliciesAuthorization

(Updatable) 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.

bodyValidation DeploymentSpecificationRouteRequestPoliciesBodyValidation

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

cors DeploymentSpecificationRouteRequestPoliciesCors

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

headerTransformations DeploymentSpecificationRouteRequestPoliciesHeaderTransformations

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

headerValidations DeploymentSpecificationRouteRequestPoliciesHeaderValidations

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

queryParameterTransformations DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformations

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

queryParameterValidations DeploymentSpecificationRouteRequestPoliciesQueryParameterValidations

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

responseCacheLookup DeploymentSpecificationRouteRequestPoliciesResponseCacheLookup

(Updatable) Base policy for Response Cache lookup.

authorization DeploymentSpecificationRouteRequestPoliciesAuthorization

(Updatable) 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.

bodyValidation DeploymentSpecificationRouteRequestPoliciesBodyValidation

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

cors DeploymentSpecificationRouteRequestPoliciesCors

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

headerTransformations DeploymentSpecificationRouteRequestPoliciesHeaderTransformations

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

headerValidations DeploymentSpecificationRouteRequestPoliciesHeaderValidations

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

queryParameterTransformations DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformations

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

queryParameterValidations DeploymentSpecificationRouteRequestPoliciesQueryParameterValidations

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

responseCacheLookup DeploymentSpecificationRouteRequestPoliciesResponseCacheLookup

(Updatable) Base policy for Response Cache lookup.

authorization DeploymentSpecificationRouteRequestPoliciesAuthorization

(Updatable) 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_validation DeploymentSpecificationRouteRequestPoliciesBodyValidation

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

cors DeploymentSpecificationRouteRequestPoliciesCors

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

header_transformations DeploymentSpecificationRouteRequestPoliciesHeaderTransformations

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

header_validations DeploymentSpecificationRouteRequestPoliciesHeaderValidations

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

query_parameter_transformations DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformations

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

query_parameter_validations DeploymentSpecificationRouteRequestPoliciesQueryParameterValidations

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

response_cache_lookup DeploymentSpecificationRouteRequestPoliciesResponseCacheLookup

(Updatable) Base policy for Response Cache lookup.

authorization Property Map

(Updatable) 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.

bodyValidation Property Map

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

cors Property Map

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

headerTransformations Property Map

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

headerValidations Property Map

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

queryParameterTransformations Property Map

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

queryParameterValidations Property Map

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

responseCacheLookup Property Map

(Updatable) Base policy for Response Cache lookup.

DeploymentSpecificationRouteRequestPoliciesAuthorization

AllowedScopes List<string>

(Updatable) A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.

Type string

(Updatable) Type of the Response Cache Store Policy.

AllowedScopes []string

(Updatable) A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.

Type string

(Updatable) Type of the Response Cache Store Policy.

allowedScopes List<String>

(Updatable) A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.

type String

(Updatable) Type of the Response Cache Store Policy.

allowedScopes string[]

(Updatable) A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.

type string

(Updatable) Type of the Response Cache Store Policy.

allowed_scopes Sequence[str]

(Updatable) A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.

type str

(Updatable) Type of the Response Cache Store Policy.

allowedScopes List<String>

(Updatable) A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.

type String

(Updatable) Type of the Response Cache Store Policy.

DeploymentSpecificationRouteRequestPoliciesBodyValidation

Contents List<DeploymentSpecificationRouteRequestPoliciesBodyValidationContent>

(Updatable) The content of the request body.

Required bool

(Updatable) Determines if the parameter is required in the request.

ValidationMode string

(Updatable) Validation behavior mode.

Contents []DeploymentSpecificationRouteRequestPoliciesBodyValidationContent

(Updatable) The content of the request body.

Required bool

(Updatable) Determines if the parameter is required in the request.

ValidationMode string

(Updatable) Validation behavior mode.

contents List<DeploymentSpecificationRouteRequestPoliciesBodyValidationContent>

(Updatable) The content of the request body.

required Boolean

(Updatable) Determines if the parameter is required in the request.

validationMode String

(Updatable) Validation behavior mode.

contents DeploymentSpecificationRouteRequestPoliciesBodyValidationContent[]

(Updatable) The content of the request body.

required boolean

(Updatable) Determines if the parameter is required in the request.

validationMode string

(Updatable) Validation behavior mode.

contents DeploymentSpecificationRouteRequestPoliciesBodyValidationContent]

(Updatable) The content of the request body.

required bool

(Updatable) Determines if the parameter is required in the request.

validation_mode str

(Updatable) Validation behavior mode.

contents List<Property Map>

(Updatable) The content of the request body.

required Boolean

(Updatable) Determines if the parameter is required in the request.

validationMode String

(Updatable) Validation behavior mode.

DeploymentSpecificationRouteRequestPoliciesBodyValidationContent

MediaType string

(Updatable) The media_type is a media type range subset restricted to the following schema

ValidationType string

(Updatable) Validation type defines the content validation method.

MediaType string

(Updatable) The media_type is a media type range subset restricted to the following schema

ValidationType string

(Updatable) Validation type defines the content validation method.

mediaType String

(Updatable) The media_type is a media type range subset restricted to the following schema

validationType String

(Updatable) Validation type defines the content validation method.

mediaType string

(Updatable) The media_type is a media type range subset restricted to the following schema

validationType string

(Updatable) Validation type defines the content validation method.

media_type str

(Updatable) The media_type is a media type range subset restricted to the following schema

validation_type str

(Updatable) Validation type defines the content validation method.

mediaType String

(Updatable) The media_type is a media type range subset restricted to the following schema

validationType String

(Updatable) Validation type defines the content validation method.

DeploymentSpecificationRouteRequestPoliciesCors

AllowedOrigins List<string>

(Updatable) 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.

AllowedHeaders List<string>

(Updatable) 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>

(Updatable) 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.

ExposedHeaders List<string>

(Updatable) 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

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

MaxAgeInSeconds int

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

AllowedOrigins []string

(Updatable) 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.

AllowedHeaders []string

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

AllowedMethods []string

(Updatable) 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.

ExposedHeaders []string

(Updatable) 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

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

MaxAgeInSeconds int

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

allowedOrigins List<String>

(Updatable) 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.

allowedHeaders List<String>

(Updatable) 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>

(Updatable) 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.

exposedHeaders List<String>

(Updatable) 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

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

maxAgeInSeconds Integer

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

allowedOrigins string[]

(Updatable) 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.

allowedHeaders string[]

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

allowedMethods string[]

(Updatable) 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.

exposedHeaders string[]

(Updatable) 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

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

maxAgeInSeconds number

(Updatable) 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_origins Sequence[str]

(Updatable) 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.

allowed_headers Sequence[str]

(Updatable) 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]

(Updatable) 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.

exposed_headers Sequence[str]

(Updatable) 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

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

max_age_in_seconds int

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

allowedOrigins List<String>

(Updatable) 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.

allowedHeaders List<String>

(Updatable) 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>

(Updatable) 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.

exposedHeaders List<String>

(Updatable) 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

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

maxAgeInSeconds Number

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

DeploymentSpecificationRouteRequestPoliciesHeaderTransformations

FilterHeaders DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeaders

(Updatable) Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.

RenameHeaders DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeaders

(Updatable) Rename HTTP headers as they pass through the gateway.

SetHeaders DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeaders

(Updatable) Set HTTP headers as they pass through the gateway.

FilterHeaders DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeaders

(Updatable) Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.

RenameHeaders DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeaders

(Updatable) Rename HTTP headers as they pass through the gateway.

SetHeaders DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeaders

(Updatable) Set HTTP headers as they pass through the gateway.

filterHeaders DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeaders

(Updatable) Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.

renameHeaders DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeaders

(Updatable) Rename HTTP headers as they pass through the gateway.

setHeaders DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeaders

(Updatable) Set HTTP headers as they pass through the gateway.

filterHeaders DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeaders

(Updatable) Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.

renameHeaders DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeaders

(Updatable) Rename HTTP headers as they pass through the gateway.

setHeaders DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeaders

(Updatable) Set HTTP headers as they pass through the gateway.

filter_headers DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeaders

(Updatable) 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 DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeaders

(Updatable) Rename HTTP headers as they pass through the gateway.

set_headers DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeaders

(Updatable) Set HTTP headers as they pass through the gateway.

filterHeaders Property Map

(Updatable) Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.

renameHeaders Property Map

(Updatable) Rename HTTP headers as they pass through the gateway.

setHeaders Property Map

(Updatable) Set HTTP headers as they pass through the gateway.

DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeaders

Items List<DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeadersItem>

(Updatable) The list of headers.

Type string

(Updatable) Type of the Response Cache Store Policy.

Items []DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeadersItem

(Updatable) The list of headers.

Type string

(Updatable) Type of the Response Cache Store Policy.

items List<DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeadersItem>

(Updatable) The list of headers.

type String

(Updatable) Type of the Response Cache Store Policy.

items DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeadersItem[]

(Updatable) The list of headers.

type string

(Updatable) Type of the Response Cache Store Policy.

items DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeadersItem]

(Updatable) The list of headers.

type str

(Updatable) Type of the Response Cache Store Policy.

items List<Property Map>

(Updatable) The list of headers.

type String

(Updatable) Type of the Response Cache Store Policy.

DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeadersItem

Name string

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

Name string

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

name String

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

name string

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

name str

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

name String

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

DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeaders

items List<Property Map>

(Updatable) The list of headers.

DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeadersItem

From string

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

To string

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

From string

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

To string

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

from String

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

to String

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

from string

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

to string

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

from_ str

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

to str

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

from String

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

to String

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

DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeaders

items List<Property Map>

(Updatable) The list of headers.

DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeadersItem

Name string

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

Values List<string>

(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

IfExists string

(Updatable) 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

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

Values []string

(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

IfExists string

(Updatable) 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

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

values List<String>

(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

ifExists String

(Updatable) 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

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

values string[]

(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

ifExists string

(Updatable) 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

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

values Sequence[str]

(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

if_exists str

(Updatable) 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

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

values List<String>

(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

ifExists String

(Updatable) 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.

DeploymentSpecificationRouteRequestPoliciesHeaderValidations

headers List<Property Map>

(Updatable)

validationMode String

(Updatable) Validation behavior mode.

DeploymentSpecificationRouteRequestPoliciesHeaderValidationsHeader

Name string

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

Required bool

(Updatable) Determines if the parameter is required in the request.

Name string

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

Required bool

(Updatable) Determines if the parameter is required in the request.

name String

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

required Boolean

(Updatable) Determines if the parameter is required in the request.

name string

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

required boolean

(Updatable) Determines if the parameter is required in the request.

name str

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

required bool

(Updatable) Determines if the parameter is required in the request.

name String

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

required Boolean

(Updatable) Determines if the parameter is required in the request.

DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformations

FilterQueryParameters DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParameters

(Updatable) Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.

RenameQueryParameters DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParameters

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

SetQueryParameters DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParameters

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

FilterQueryParameters DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParameters

(Updatable) Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.

RenameQueryParameters DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParameters

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

SetQueryParameters DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParameters

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

filterQueryParameters DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParameters

(Updatable) Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.

renameQueryParameters DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParameters

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

setQueryParameters DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParameters

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

filterQueryParameters DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParameters

(Updatable) Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.

renameQueryParameters DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParameters

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

setQueryParameters DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParameters

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

filter_query_parameters DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParameters

(Updatable) Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.

rename_query_parameters DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParameters

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

set_query_parameters DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParameters

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

filterQueryParameters Property Map

(Updatable) Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.

renameQueryParameters Property Map

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

setQueryParameters Property Map

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

DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParameters

Items List<DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParametersItem>

(Updatable) The list of headers.

Type string

(Updatable) Type of the Response Cache Store Policy.

Items []DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParametersItem

(Updatable) The list of headers.

Type string

(Updatable) Type of the Response Cache Store Policy.

items List<DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParametersItem>

(Updatable) The list of headers.

type String

(Updatable) Type of the Response Cache Store Policy.

items DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParametersItem[]

(Updatable) The list of headers.

type string

(Updatable) Type of the Response Cache Store Policy.

items DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParametersItem]

(Updatable) The list of headers.

type str

(Updatable) Type of the Response Cache Store Policy.

items List<Property Map>

(Updatable) The list of headers.

type String

(Updatable) Type of the Response Cache Store Policy.

DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParametersItem

Name string

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

Name string

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

name String

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

name string

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

name str

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

name String

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

DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParameters

items List<Property Map>

(Updatable) The list of headers.

DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParametersItem

From string

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

To string

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

From string

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

To string

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

from String

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

to String

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

from string

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

to string

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

from_ str

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

to str

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

from String

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

to String

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

DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParameters

items List<Property Map>

(Updatable) The list of headers.

DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParametersItem

Name string

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

Values List<string>

(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

IfExists string

(Updatable) 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

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

Values []string

(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

IfExists string

(Updatable) 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

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

values List<String>

(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

ifExists String

(Updatable) 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

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

values string[]

(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

ifExists string

(Updatable) 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

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

values Sequence[str]

(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

if_exists str

(Updatable) 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

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

values List<String>

(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

ifExists String

(Updatable) 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.

DeploymentSpecificationRouteRequestPoliciesQueryParameterValidations

parameters List<Property Map>

(Updatable)

validationMode String

(Updatable) Validation behavior mode.

DeploymentSpecificationRouteRequestPoliciesQueryParameterValidationsParameter

Name string

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

Required bool

(Updatable) Determines if the parameter is required in the request.

Name string

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

Required bool

(Updatable) Determines if the parameter is required in the request.

name String

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

required Boolean

(Updatable) Determines if the parameter is required in the request.

name string

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

required boolean

(Updatable) Determines if the parameter is required in the request.

name str

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

required bool

(Updatable) Determines if the parameter is required in the request.

name String

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

required Boolean

(Updatable) Determines if the parameter is required in the request.

DeploymentSpecificationRouteRequestPoliciesResponseCacheLookup

Type string

(Updatable) Type of the Response Cache Store Policy.

CacheKeyAdditions List<string>

(Updatable) A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available.

IsEnabled bool

(Updatable) Whether this policy is currently enabled.

IsPrivateCachingEnabled bool

(Updatable) 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

(Updatable) Type of the Response Cache Store Policy.

CacheKeyAdditions []string

(Updatable) A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available.

IsEnabled bool

(Updatable) Whether this policy is currently enabled.

IsPrivateCachingEnabled bool

(Updatable) 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

(Updatable) Type of the Response Cache Store Policy.

cacheKeyAdditions List<String>

(Updatable) A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available.

isEnabled Boolean

(Updatable) Whether this policy is currently enabled.

isPrivateCachingEnabled Boolean

(Updatable) 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

(Updatable) Type of the Response Cache Store Policy.

cacheKeyAdditions string[]

(Updatable) A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available.

isEnabled boolean

(Updatable) Whether this policy is currently enabled.

isPrivateCachingEnabled boolean

(Updatable) 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

(Updatable) Type of the Response Cache Store Policy.

cache_key_additions Sequence[str]

(Updatable) 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

(Updatable) Whether this policy is currently enabled.

is_private_caching_enabled bool

(Updatable) 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

(Updatable) Type of the Response Cache Store Policy.

cacheKeyAdditions List<String>

(Updatable) A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available.

isEnabled Boolean

(Updatable) Whether this policy is currently enabled.

isPrivateCachingEnabled Boolean

(Updatable) 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.

DeploymentSpecificationRouteResponsePolicies

HeaderTransformations DeploymentSpecificationRouteResponsePoliciesHeaderTransformations

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

ResponseCacheStore DeploymentSpecificationRouteResponsePoliciesResponseCacheStore

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

HeaderTransformations DeploymentSpecificationRouteResponsePoliciesHeaderTransformations

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

ResponseCacheStore DeploymentSpecificationRouteResponsePoliciesResponseCacheStore

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

headerTransformations DeploymentSpecificationRouteResponsePoliciesHeaderTransformations

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

responseCacheStore DeploymentSpecificationRouteResponsePoliciesResponseCacheStore

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

headerTransformations DeploymentSpecificationRouteResponsePoliciesHeaderTransformations

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

responseCacheStore DeploymentSpecificationRouteResponsePoliciesResponseCacheStore

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

header_transformations DeploymentSpecificationRouteResponsePoliciesHeaderTransformations

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

response_cache_store DeploymentSpecificationRouteResponsePoliciesResponseCacheStore

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

headerTransformations Property Map

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

responseCacheStore Property Map

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

DeploymentSpecificationRouteResponsePoliciesHeaderTransformations

FilterHeaders DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeaders

(Updatable) Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.

RenameHeaders DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeaders

(Updatable) Rename HTTP headers as they pass through the gateway.

SetHeaders DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeaders

(Updatable) Set HTTP headers as they pass through the gateway.

FilterHeaders DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeaders

(Updatable) Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.

RenameHeaders DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeaders

(Updatable) Rename HTTP headers as they pass through the gateway.

SetHeaders DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeaders

(Updatable) Set HTTP headers as they pass through the gateway.

filterHeaders DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeaders

(Updatable) Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.

renameHeaders DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeaders

(Updatable) Rename HTTP headers as they pass through the gateway.

setHeaders DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeaders

(Updatable) Set HTTP headers as they pass through the gateway.

filterHeaders DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeaders

(Updatable) Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.

renameHeaders DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeaders

(Updatable) Rename HTTP headers as they pass through the gateway.

setHeaders DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeaders

(Updatable) Set HTTP headers as they pass through the gateway.

filter_headers DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeaders

(Updatable) 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 DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeaders

(Updatable) Rename HTTP headers as they pass through the gateway.

set_headers DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeaders

(Updatable) Set HTTP headers as they pass through the gateway.

filterHeaders Property Map

(Updatable) Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.

renameHeaders Property Map

(Updatable) Rename HTTP headers as they pass through the gateway.

setHeaders Property Map

(Updatable) Set HTTP headers as they pass through the gateway.

DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeaders

Items List<DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeadersItem>

(Updatable) The list of headers.

Type string

(Updatable) Type of the Response Cache Store Policy.

Items []DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeadersItem

(Updatable) The list of headers.

Type string

(Updatable) Type of the Response Cache Store Policy.

items List<DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeadersItem>

(Updatable) The list of headers.

type String

(Updatable) Type of the Response Cache Store Policy.

items DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeadersItem[]

(Updatable) The list of headers.

type string

(Updatable) Type of the Response Cache Store Policy.

items DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeadersItem]

(Updatable) The list of headers.

type str

(Updatable) Type of the Response Cache Store Policy.

items List<Property Map>

(Updatable) The list of headers.

type String

(Updatable) Type of the Response Cache Store Policy.

DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeadersItem

Name string

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

Name string

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

name String

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

name string

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

name str

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

name String

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

DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeaders

items List<Property Map>

(Updatable) The list of headers.

DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeadersItem

From string

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

To string

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

From string

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

To string

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

from String

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

to String

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

from string

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

to string

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

from_ str

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

to str

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

from String

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

to String

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

DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeaders

items List<Property Map>

(Updatable) The list of headers.

DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeadersItem

Name string

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

Values List<string>

(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

IfExists string

(Updatable) 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

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

Values []string

(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

IfExists string

(Updatable) 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

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

values List<String>

(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

ifExists String

(Updatable) 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

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

values string[]

(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

ifExists string

(Updatable) 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

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

values Sequence[str]

(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

if_exists str

(Updatable) 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

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

values List<String>

(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.

ifExists String

(Updatable) 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.

DeploymentSpecificationRouteResponsePoliciesResponseCacheStore

TimeToLiveInSeconds int

(Updatable) Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.

Type string

(Updatable) Type of the Response Cache Store Policy.

TimeToLiveInSeconds int

(Updatable) Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.

Type string

(Updatable) Type of the Response Cache Store Policy.

timeToLiveInSeconds Integer

(Updatable) Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.

type String

(Updatable) Type of the Response Cache Store Policy.

timeToLiveInSeconds number

(Updatable) Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.

type string

(Updatable) Type of the Response Cache Store Policy.

time_to_live_in_seconds int

(Updatable) Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.

type str

(Updatable) Type of the Response Cache Store Policy.

timeToLiveInSeconds Number

(Updatable) Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.

type String

(Updatable) Type of the Response Cache Store Policy.

Import

Deployments can be imported using the id, e.g.

 $ pulumi import oci:ApiGateway/deployment:Deployment test_deployment "id"

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.