1. Packages
  2. Consul Provider
  3. API Docs
  4. ConfigEntryServiceRouter
Consul v3.12.4 published on Wednesday, Feb 12, 2025 by Pulumi

consul.ConfigEntryServiceRouter

Explore with Pulumi AI

Example Usage

Create ConfigEntryServiceRouter Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ConfigEntryServiceRouter(name: string, args?: ConfigEntryServiceRouterArgs, opts?: CustomResourceOptions);
@overload
def ConfigEntryServiceRouter(resource_name: str,
                             args: Optional[ConfigEntryServiceRouterArgs] = None,
                             opts: Optional[ResourceOptions] = None)

@overload
def ConfigEntryServiceRouter(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             meta: Optional[Mapping[str, str]] = None,
                             name: Optional[str] = None,
                             namespace: Optional[str] = None,
                             partition: Optional[str] = None,
                             routes: Optional[Sequence[ConfigEntryServiceRouterRouteArgs]] = None)
func NewConfigEntryServiceRouter(ctx *Context, name string, args *ConfigEntryServiceRouterArgs, opts ...ResourceOption) (*ConfigEntryServiceRouter, error)
public ConfigEntryServiceRouter(string name, ConfigEntryServiceRouterArgs? args = null, CustomResourceOptions? opts = null)
public ConfigEntryServiceRouter(String name, ConfigEntryServiceRouterArgs args)
public ConfigEntryServiceRouter(String name, ConfigEntryServiceRouterArgs args, CustomResourceOptions options)
type: consul:ConfigEntryServiceRouter
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

Constructor example

The following reference example uses placeholder values for all input properties.

var configEntryServiceRouterResource = new Consul.ConfigEntryServiceRouter("configEntryServiceRouterResource", new()
{
    Meta = 
    {
        { "string", "string" },
    },
    Name = "string",
    Namespace = "string",
    Partition = "string",
    Routes = new[]
    {
        new Consul.Inputs.ConfigEntryServiceRouterRouteArgs
        {
            Destination = new Consul.Inputs.ConfigEntryServiceRouterRouteDestinationArgs
            {
                IdleTimeout = "string",
                Namespace = "string",
                NumRetries = 0,
                Partition = "string",
                PrefixRewrite = "string",
                RequestHeaders = new Consul.Inputs.ConfigEntryServiceRouterRouteDestinationRequestHeadersArgs
                {
                    Add = 
                    {
                        { "string", "string" },
                    },
                    Removes = new[]
                    {
                        "string",
                    },
                    Set = 
                    {
                        { "string", "string" },
                    },
                },
                RequestTimeout = "string",
                ResponseHeaders = new Consul.Inputs.ConfigEntryServiceRouterRouteDestinationResponseHeadersArgs
                {
                    Add = 
                    {
                        { "string", "string" },
                    },
                    Removes = new[]
                    {
                        "string",
                    },
                    Set = 
                    {
                        { "string", "string" },
                    },
                },
                RetryOnConnectFailure = false,
                RetryOnStatusCodes = new[]
                {
                    0,
                },
                RetryOns = new[]
                {
                    "string",
                },
                Service = "string",
                ServiceSubset = "string",
            },
            Match = new Consul.Inputs.ConfigEntryServiceRouterRouteMatchArgs
            {
                Http = new Consul.Inputs.ConfigEntryServiceRouterRouteMatchHttpArgs
                {
                    Headers = new[]
                    {
                        new Consul.Inputs.ConfigEntryServiceRouterRouteMatchHttpHeaderArgs
                        {
                            Exact = "string",
                            Invert = false,
                            Name = "string",
                            Prefix = "string",
                            Present = false,
                            Regex = "string",
                            Suffix = "string",
                        },
                    },
                    Methods = new[]
                    {
                        "string",
                    },
                    PathExact = "string",
                    PathPrefix = "string",
                    PathRegex = "string",
                    QueryParams = new[]
                    {
                        new Consul.Inputs.ConfigEntryServiceRouterRouteMatchHttpQueryParamArgs
                        {
                            Exact = "string",
                            Name = "string",
                            Present = false,
                            Regex = "string",
                        },
                    },
                },
            },
        },
    },
});
Copy
example, err := consul.NewConfigEntryServiceRouter(ctx, "configEntryServiceRouterResource", &consul.ConfigEntryServiceRouterArgs{
	Meta: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:      pulumi.String("string"),
	Namespace: pulumi.String("string"),
	Partition: pulumi.String("string"),
	Routes: consul.ConfigEntryServiceRouterRouteArray{
		&consul.ConfigEntryServiceRouterRouteArgs{
			Destination: &consul.ConfigEntryServiceRouterRouteDestinationArgs{
				IdleTimeout:   pulumi.String("string"),
				Namespace:     pulumi.String("string"),
				NumRetries:    pulumi.Int(0),
				Partition:     pulumi.String("string"),
				PrefixRewrite: pulumi.String("string"),
				RequestHeaders: &consul.ConfigEntryServiceRouterRouteDestinationRequestHeadersArgs{
					Add: pulumi.StringMap{
						"string": pulumi.String("string"),
					},
					Removes: pulumi.StringArray{
						pulumi.String("string"),
					},
					Set: pulumi.StringMap{
						"string": pulumi.String("string"),
					},
				},
				RequestTimeout: pulumi.String("string"),
				ResponseHeaders: &consul.ConfigEntryServiceRouterRouteDestinationResponseHeadersArgs{
					Add: pulumi.StringMap{
						"string": pulumi.String("string"),
					},
					Removes: pulumi.StringArray{
						pulumi.String("string"),
					},
					Set: pulumi.StringMap{
						"string": pulumi.String("string"),
					},
				},
				RetryOnConnectFailure: pulumi.Bool(false),
				RetryOnStatusCodes: pulumi.IntArray{
					pulumi.Int(0),
				},
				RetryOns: pulumi.StringArray{
					pulumi.String("string"),
				},
				Service:       pulumi.String("string"),
				ServiceSubset: pulumi.String("string"),
			},
			Match: &consul.ConfigEntryServiceRouterRouteMatchArgs{
				Http: &consul.ConfigEntryServiceRouterRouteMatchHttpArgs{
					Headers: consul.ConfigEntryServiceRouterRouteMatchHttpHeaderArray{
						&consul.ConfigEntryServiceRouterRouteMatchHttpHeaderArgs{
							Exact:   pulumi.String("string"),
							Invert:  pulumi.Bool(false),
							Name:    pulumi.String("string"),
							Prefix:  pulumi.String("string"),
							Present: pulumi.Bool(false),
							Regex:   pulumi.String("string"),
							Suffix:  pulumi.String("string"),
						},
					},
					Methods: pulumi.StringArray{
						pulumi.String("string"),
					},
					PathExact:  pulumi.String("string"),
					PathPrefix: pulumi.String("string"),
					PathRegex:  pulumi.String("string"),
					QueryParams: consul.ConfigEntryServiceRouterRouteMatchHttpQueryParamArray{
						&consul.ConfigEntryServiceRouterRouteMatchHttpQueryParamArgs{
							Exact:   pulumi.String("string"),
							Name:    pulumi.String("string"),
							Present: pulumi.Bool(false),
							Regex:   pulumi.String("string"),
						},
					},
				},
			},
		},
	},
})
Copy
var configEntryServiceRouterResource = new ConfigEntryServiceRouter("configEntryServiceRouterResource", ConfigEntryServiceRouterArgs.builder()
    .meta(Map.of("string", "string"))
    .name("string")
    .namespace("string")
    .partition("string")
    .routes(ConfigEntryServiceRouterRouteArgs.builder()
        .destination(ConfigEntryServiceRouterRouteDestinationArgs.builder()
            .idleTimeout("string")
            .namespace("string")
            .numRetries(0)
            .partition("string")
            .prefixRewrite("string")
            .requestHeaders(ConfigEntryServiceRouterRouteDestinationRequestHeadersArgs.builder()
                .add(Map.of("string", "string"))
                .removes("string")
                .set(Map.of("string", "string"))
                .build())
            .requestTimeout("string")
            .responseHeaders(ConfigEntryServiceRouterRouteDestinationResponseHeadersArgs.builder()
                .add(Map.of("string", "string"))
                .removes("string")
                .set(Map.of("string", "string"))
                .build())
            .retryOnConnectFailure(false)
            .retryOnStatusCodes(0)
            .retryOns("string")
            .service("string")
            .serviceSubset("string")
            .build())
        .match(ConfigEntryServiceRouterRouteMatchArgs.builder()
            .http(ConfigEntryServiceRouterRouteMatchHttpArgs.builder()
                .headers(ConfigEntryServiceRouterRouteMatchHttpHeaderArgs.builder()
                    .exact("string")
                    .invert(false)
                    .name("string")
                    .prefix("string")
                    .present(false)
                    .regex("string")
                    .suffix("string")
                    .build())
                .methods("string")
                .pathExact("string")
                .pathPrefix("string")
                .pathRegex("string")
                .queryParams(ConfigEntryServiceRouterRouteMatchHttpQueryParamArgs.builder()
                    .exact("string")
                    .name("string")
                    .present(false)
                    .regex("string")
                    .build())
                .build())
            .build())
        .build())
    .build());
Copy
config_entry_service_router_resource = consul.ConfigEntryServiceRouter("configEntryServiceRouterResource",
    meta={
        "string": "string",
    },
    name="string",
    namespace="string",
    partition="string",
    routes=[{
        "destination": {
            "idle_timeout": "string",
            "namespace": "string",
            "num_retries": 0,
            "partition": "string",
            "prefix_rewrite": "string",
            "request_headers": {
                "add": {
                    "string": "string",
                },
                "removes": ["string"],
                "set": {
                    "string": "string",
                },
            },
            "request_timeout": "string",
            "response_headers": {
                "add": {
                    "string": "string",
                },
                "removes": ["string"],
                "set": {
                    "string": "string",
                },
            },
            "retry_on_connect_failure": False,
            "retry_on_status_codes": [0],
            "retry_ons": ["string"],
            "service": "string",
            "service_subset": "string",
        },
        "match": {
            "http": {
                "headers": [{
                    "exact": "string",
                    "invert": False,
                    "name": "string",
                    "prefix": "string",
                    "present": False,
                    "regex": "string",
                    "suffix": "string",
                }],
                "methods": ["string"],
                "path_exact": "string",
                "path_prefix": "string",
                "path_regex": "string",
                "query_params": [{
                    "exact": "string",
                    "name": "string",
                    "present": False,
                    "regex": "string",
                }],
            },
        },
    }])
Copy
const configEntryServiceRouterResource = new consul.ConfigEntryServiceRouter("configEntryServiceRouterResource", {
    meta: {
        string: "string",
    },
    name: "string",
    namespace: "string",
    partition: "string",
    routes: [{
        destination: {
            idleTimeout: "string",
            namespace: "string",
            numRetries: 0,
            partition: "string",
            prefixRewrite: "string",
            requestHeaders: {
                add: {
                    string: "string",
                },
                removes: ["string"],
                set: {
                    string: "string",
                },
            },
            requestTimeout: "string",
            responseHeaders: {
                add: {
                    string: "string",
                },
                removes: ["string"],
                set: {
                    string: "string",
                },
            },
            retryOnConnectFailure: false,
            retryOnStatusCodes: [0],
            retryOns: ["string"],
            service: "string",
            serviceSubset: "string",
        },
        match: {
            http: {
                headers: [{
                    exact: "string",
                    invert: false,
                    name: "string",
                    prefix: "string",
                    present: false,
                    regex: "string",
                    suffix: "string",
                }],
                methods: ["string"],
                pathExact: "string",
                pathPrefix: "string",
                pathRegex: "string",
                queryParams: [{
                    exact: "string",
                    name: "string",
                    present: false,
                    regex: "string",
                }],
            },
        },
    }],
});
Copy
type: consul:ConfigEntryServiceRouter
properties:
    meta:
        string: string
    name: string
    namespace: string
    partition: string
    routes:
        - destination:
            idleTimeout: string
            namespace: string
            numRetries: 0
            partition: string
            prefixRewrite: string
            requestHeaders:
                add:
                    string: string
                removes:
                    - string
                set:
                    string: string
            requestTimeout: string
            responseHeaders:
                add:
                    string: string
                removes:
                    - string
                set:
                    string: string
            retryOnConnectFailure: false
            retryOnStatusCodes:
                - 0
            retryOns:
                - string
            service: string
            serviceSubset: string
          match:
            http:
                headers:
                    - exact: string
                      invert: false
                      name: string
                      prefix: string
                      present: false
                      regex: string
                      suffix: string
                methods:
                    - string
                pathExact: string
                pathPrefix: string
                pathRegex: string
                queryParams:
                    - exact: string
                      name: string
                      present: false
                      regex: string
Copy

ConfigEntryServiceRouter Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ConfigEntryServiceRouter resource accepts the following input properties:

Meta Dictionary<string, string>
Specifies key-value pairs to add to the KV store.
Name Changes to this property will trigger replacement. string
Specifies a name for the configuration entry.
Namespace Changes to this property will trigger replacement. string
Specifies the namespace to apply the configuration entry.
Partition Changes to this property will trigger replacement. string
Specifies the admin partition to apply the configuration entry.
Routes List<ConfigEntryServiceRouterRoute>
Defines the possible routes for L7 requests.
Meta map[string]string
Specifies key-value pairs to add to the KV store.
Name Changes to this property will trigger replacement. string
Specifies a name for the configuration entry.
Namespace Changes to this property will trigger replacement. string
Specifies the namespace to apply the configuration entry.
Partition Changes to this property will trigger replacement. string
Specifies the admin partition to apply the configuration entry.
Routes []ConfigEntryServiceRouterRouteArgs
Defines the possible routes for L7 requests.
meta Map<String,String>
Specifies key-value pairs to add to the KV store.
name Changes to this property will trigger replacement. String
Specifies a name for the configuration entry.
namespace Changes to this property will trigger replacement. String
Specifies the namespace to apply the configuration entry.
partition Changes to this property will trigger replacement. String
Specifies the admin partition to apply the configuration entry.
routes List<ConfigEntryServiceRouterRoute>
Defines the possible routes for L7 requests.
meta {[key: string]: string}
Specifies key-value pairs to add to the KV store.
name Changes to this property will trigger replacement. string
Specifies a name for the configuration entry.
namespace Changes to this property will trigger replacement. string
Specifies the namespace to apply the configuration entry.
partition Changes to this property will trigger replacement. string
Specifies the admin partition to apply the configuration entry.
routes ConfigEntryServiceRouterRoute[]
Defines the possible routes for L7 requests.
meta Mapping[str, str]
Specifies key-value pairs to add to the KV store.
name Changes to this property will trigger replacement. str
Specifies a name for the configuration entry.
namespace Changes to this property will trigger replacement. str
Specifies the namespace to apply the configuration entry.
partition Changes to this property will trigger replacement. str
Specifies the admin partition to apply the configuration entry.
routes Sequence[ConfigEntryServiceRouterRouteArgs]
Defines the possible routes for L7 requests.
meta Map<String>
Specifies key-value pairs to add to the KV store.
name Changes to this property will trigger replacement. String
Specifies a name for the configuration entry.
namespace Changes to this property will trigger replacement. String
Specifies the namespace to apply the configuration entry.
partition Changes to this property will trigger replacement. String
Specifies the admin partition to apply the configuration entry.
routes List<Property Map>
Defines the possible routes for L7 requests.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing ConfigEntryServiceRouter Resource

Get an existing ConfigEntryServiceRouter 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?: ConfigEntryServiceRouterState, opts?: CustomResourceOptions): ConfigEntryServiceRouter
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        meta: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        namespace: Optional[str] = None,
        partition: Optional[str] = None,
        routes: Optional[Sequence[ConfigEntryServiceRouterRouteArgs]] = None) -> ConfigEntryServiceRouter
func GetConfigEntryServiceRouter(ctx *Context, name string, id IDInput, state *ConfigEntryServiceRouterState, opts ...ResourceOption) (*ConfigEntryServiceRouter, error)
public static ConfigEntryServiceRouter Get(string name, Input<string> id, ConfigEntryServiceRouterState? state, CustomResourceOptions? opts = null)
public static ConfigEntryServiceRouter get(String name, Output<String> id, ConfigEntryServiceRouterState state, CustomResourceOptions options)
resources:  _:    type: consul:ConfigEntryServiceRouter    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Meta Dictionary<string, string>
Specifies key-value pairs to add to the KV store.
Name Changes to this property will trigger replacement. string
Specifies a name for the configuration entry.
Namespace Changes to this property will trigger replacement. string
Specifies the namespace to apply the configuration entry.
Partition Changes to this property will trigger replacement. string
Specifies the admin partition to apply the configuration entry.
Routes List<ConfigEntryServiceRouterRoute>
Defines the possible routes for L7 requests.
Meta map[string]string
Specifies key-value pairs to add to the KV store.
Name Changes to this property will trigger replacement. string
Specifies a name for the configuration entry.
Namespace Changes to this property will trigger replacement. string
Specifies the namespace to apply the configuration entry.
Partition Changes to this property will trigger replacement. string
Specifies the admin partition to apply the configuration entry.
Routes []ConfigEntryServiceRouterRouteArgs
Defines the possible routes for L7 requests.
meta Map<String,String>
Specifies key-value pairs to add to the KV store.
name Changes to this property will trigger replacement. String
Specifies a name for the configuration entry.
namespace Changes to this property will trigger replacement. String
Specifies the namespace to apply the configuration entry.
partition Changes to this property will trigger replacement. String
Specifies the admin partition to apply the configuration entry.
routes List<ConfigEntryServiceRouterRoute>
Defines the possible routes for L7 requests.
meta {[key: string]: string}
Specifies key-value pairs to add to the KV store.
name Changes to this property will trigger replacement. string
Specifies a name for the configuration entry.
namespace Changes to this property will trigger replacement. string
Specifies the namespace to apply the configuration entry.
partition Changes to this property will trigger replacement. string
Specifies the admin partition to apply the configuration entry.
routes ConfigEntryServiceRouterRoute[]
Defines the possible routes for L7 requests.
meta Mapping[str, str]
Specifies key-value pairs to add to the KV store.
name Changes to this property will trigger replacement. str
Specifies a name for the configuration entry.
namespace Changes to this property will trigger replacement. str
Specifies the namespace to apply the configuration entry.
partition Changes to this property will trigger replacement. str
Specifies the admin partition to apply the configuration entry.
routes Sequence[ConfigEntryServiceRouterRouteArgs]
Defines the possible routes for L7 requests.
meta Map<String>
Specifies key-value pairs to add to the KV store.
name Changes to this property will trigger replacement. String
Specifies a name for the configuration entry.
namespace Changes to this property will trigger replacement. String
Specifies the namespace to apply the configuration entry.
partition Changes to this property will trigger replacement. String
Specifies the admin partition to apply the configuration entry.
routes List<Property Map>
Defines the possible routes for L7 requests.

Supporting Types

ConfigEntryServiceRouterRoute
, ConfigEntryServiceRouterRouteArgs

Destination ConfigEntryServiceRouterRouteDestination
Specifies the target service to route matching requests to, as well as behavior for the request to follow when routed.
Match ConfigEntryServiceRouterRouteMatch
Describes a set of criteria that Consul compares incoming L7 traffic with.
Destination ConfigEntryServiceRouterRouteDestination
Specifies the target service to route matching requests to, as well as behavior for the request to follow when routed.
Match ConfigEntryServiceRouterRouteMatch
Describes a set of criteria that Consul compares incoming L7 traffic with.
destination ConfigEntryServiceRouterRouteDestination
Specifies the target service to route matching requests to, as well as behavior for the request to follow when routed.
match ConfigEntryServiceRouterRouteMatch
Describes a set of criteria that Consul compares incoming L7 traffic with.
destination ConfigEntryServiceRouterRouteDestination
Specifies the target service to route matching requests to, as well as behavior for the request to follow when routed.
match ConfigEntryServiceRouterRouteMatch
Describes a set of criteria that Consul compares incoming L7 traffic with.
destination ConfigEntryServiceRouterRouteDestination
Specifies the target service to route matching requests to, as well as behavior for the request to follow when routed.
match ConfigEntryServiceRouterRouteMatch
Describes a set of criteria that Consul compares incoming L7 traffic with.
destination Property Map
Specifies the target service to route matching requests to, as well as behavior for the request to follow when routed.
match Property Map
Describes a set of criteria that Consul compares incoming L7 traffic with.

ConfigEntryServiceRouterRouteDestination
, ConfigEntryServiceRouterRouteDestinationArgs

IdleTimeout string
Specifies the total amount of time permitted for the request stream to be idle.
Namespace string
Specifies the Consul namespace to resolve the service from instead of the current namespace.
NumRetries int
Specifies the number of times to retry the request when a retry condition occurs.
Partition string
Specifies the Consul admin partition to resolve the service from instead of the current partition.
PrefixRewrite string
Specifies rewrites to the HTTP request path before proxying it to its final destination.
RequestHeaders ConfigEntryServiceRouterRouteDestinationRequestHeaders
Specifies a set of HTTP-specific header modification rules applied to requests routed with the service router.
RequestTimeout string
Specifies the total amount of time permitted for the entire downstream request to be processed, including retry attempts.
ResponseHeaders ConfigEntryServiceRouterRouteDestinationResponseHeaders
Specifies a set of HTTP-specific header modification rules applied to responses routed with the service router.
RetryOnConnectFailure bool
Specifies that connection failure errors that trigger a retry request.
RetryOnStatusCodes List<int>
Specifies a list of integers for HTTP response status codes that trigger a retry request.
RetryOns List<string>
Specifies a list of conditions for Consul to retry requests based on the response from an upstream service.
Service string
Specifies the name of the service to resolve.
ServiceSubset string
Specifies a named subset of the given service to resolve instead of the one defined as that service's default_subset in the service resolver configuration entry.
IdleTimeout string
Specifies the total amount of time permitted for the request stream to be idle.
Namespace string
Specifies the Consul namespace to resolve the service from instead of the current namespace.
NumRetries int
Specifies the number of times to retry the request when a retry condition occurs.
Partition string
Specifies the Consul admin partition to resolve the service from instead of the current partition.
PrefixRewrite string
Specifies rewrites to the HTTP request path before proxying it to its final destination.
RequestHeaders ConfigEntryServiceRouterRouteDestinationRequestHeaders
Specifies a set of HTTP-specific header modification rules applied to requests routed with the service router.
RequestTimeout string
Specifies the total amount of time permitted for the entire downstream request to be processed, including retry attempts.
ResponseHeaders ConfigEntryServiceRouterRouteDestinationResponseHeaders
Specifies a set of HTTP-specific header modification rules applied to responses routed with the service router.
RetryOnConnectFailure bool
Specifies that connection failure errors that trigger a retry request.
RetryOnStatusCodes []int
Specifies a list of integers for HTTP response status codes that trigger a retry request.
RetryOns []string
Specifies a list of conditions for Consul to retry requests based on the response from an upstream service.
Service string
Specifies the name of the service to resolve.
ServiceSubset string
Specifies a named subset of the given service to resolve instead of the one defined as that service's default_subset in the service resolver configuration entry.
idleTimeout String
Specifies the total amount of time permitted for the request stream to be idle.
namespace String
Specifies the Consul namespace to resolve the service from instead of the current namespace.
numRetries Integer
Specifies the number of times to retry the request when a retry condition occurs.
partition String
Specifies the Consul admin partition to resolve the service from instead of the current partition.
prefixRewrite String
Specifies rewrites to the HTTP request path before proxying it to its final destination.
requestHeaders ConfigEntryServiceRouterRouteDestinationRequestHeaders
Specifies a set of HTTP-specific header modification rules applied to requests routed with the service router.
requestTimeout String
Specifies the total amount of time permitted for the entire downstream request to be processed, including retry attempts.
responseHeaders ConfigEntryServiceRouterRouteDestinationResponseHeaders
Specifies a set of HTTP-specific header modification rules applied to responses routed with the service router.
retryOnConnectFailure Boolean
Specifies that connection failure errors that trigger a retry request.
retryOnStatusCodes List<Integer>
Specifies a list of integers for HTTP response status codes that trigger a retry request.
retryOns List<String>
Specifies a list of conditions for Consul to retry requests based on the response from an upstream service.
service String
Specifies the name of the service to resolve.
serviceSubset String
Specifies a named subset of the given service to resolve instead of the one defined as that service's default_subset in the service resolver configuration entry.
idleTimeout string
Specifies the total amount of time permitted for the request stream to be idle.
namespace string
Specifies the Consul namespace to resolve the service from instead of the current namespace.
numRetries number
Specifies the number of times to retry the request when a retry condition occurs.
partition string
Specifies the Consul admin partition to resolve the service from instead of the current partition.
prefixRewrite string
Specifies rewrites to the HTTP request path before proxying it to its final destination.
requestHeaders ConfigEntryServiceRouterRouteDestinationRequestHeaders
Specifies a set of HTTP-specific header modification rules applied to requests routed with the service router.
requestTimeout string
Specifies the total amount of time permitted for the entire downstream request to be processed, including retry attempts.
responseHeaders ConfigEntryServiceRouterRouteDestinationResponseHeaders
Specifies a set of HTTP-specific header modification rules applied to responses routed with the service router.
retryOnConnectFailure boolean
Specifies that connection failure errors that trigger a retry request.
retryOnStatusCodes number[]
Specifies a list of integers for HTTP response status codes that trigger a retry request.
retryOns string[]
Specifies a list of conditions for Consul to retry requests based on the response from an upstream service.
service string
Specifies the name of the service to resolve.
serviceSubset string
Specifies a named subset of the given service to resolve instead of the one defined as that service's default_subset in the service resolver configuration entry.
idle_timeout str
Specifies the total amount of time permitted for the request stream to be idle.
namespace str
Specifies the Consul namespace to resolve the service from instead of the current namespace.
num_retries int
Specifies the number of times to retry the request when a retry condition occurs.
partition str
Specifies the Consul admin partition to resolve the service from instead of the current partition.
prefix_rewrite str
Specifies rewrites to the HTTP request path before proxying it to its final destination.
request_headers ConfigEntryServiceRouterRouteDestinationRequestHeaders
Specifies a set of HTTP-specific header modification rules applied to requests routed with the service router.
request_timeout str
Specifies the total amount of time permitted for the entire downstream request to be processed, including retry attempts.
response_headers ConfigEntryServiceRouterRouteDestinationResponseHeaders
Specifies a set of HTTP-specific header modification rules applied to responses routed with the service router.
retry_on_connect_failure bool
Specifies that connection failure errors that trigger a retry request.
retry_on_status_codes Sequence[int]
Specifies a list of integers for HTTP response status codes that trigger a retry request.
retry_ons Sequence[str]
Specifies a list of conditions for Consul to retry requests based on the response from an upstream service.
service str
Specifies the name of the service to resolve.
service_subset str
Specifies a named subset of the given service to resolve instead of the one defined as that service's default_subset in the service resolver configuration entry.
idleTimeout String
Specifies the total amount of time permitted for the request stream to be idle.
namespace String
Specifies the Consul namespace to resolve the service from instead of the current namespace.
numRetries Number
Specifies the number of times to retry the request when a retry condition occurs.
partition String
Specifies the Consul admin partition to resolve the service from instead of the current partition.
prefixRewrite String
Specifies rewrites to the HTTP request path before proxying it to its final destination.
requestHeaders Property Map
Specifies a set of HTTP-specific header modification rules applied to requests routed with the service router.
requestTimeout String
Specifies the total amount of time permitted for the entire downstream request to be processed, including retry attempts.
responseHeaders Property Map
Specifies a set of HTTP-specific header modification rules applied to responses routed with the service router.
retryOnConnectFailure Boolean
Specifies that connection failure errors that trigger a retry request.
retryOnStatusCodes List<Number>
Specifies a list of integers for HTTP response status codes that trigger a retry request.
retryOns List<String>
Specifies a list of conditions for Consul to retry requests based on the response from an upstream service.
service String
Specifies the name of the service to resolve.
serviceSubset String
Specifies a named subset of the given service to resolve instead of the one defined as that service's default_subset in the service resolver configuration entry.

ConfigEntryServiceRouterRouteDestinationRequestHeaders
, ConfigEntryServiceRouterRouteDestinationRequestHeadersArgs

Add Dictionary<string, string>
Defines a set of key-value pairs to add to the header. Use header names as the keys.
Removes List<string>
Defines a list of headers to remove.
Set Dictionary<string, string>
Defines a set of key-value pairs to add to the request header or to replace existing header values with.
Add map[string]string
Defines a set of key-value pairs to add to the header. Use header names as the keys.
Removes []string
Defines a list of headers to remove.
Set map[string]string
Defines a set of key-value pairs to add to the request header or to replace existing header values with.
add Map<String,String>
Defines a set of key-value pairs to add to the header. Use header names as the keys.
removes List<String>
Defines a list of headers to remove.
set Map<String,String>
Defines a set of key-value pairs to add to the request header or to replace existing header values with.
add {[key: string]: string}
Defines a set of key-value pairs to add to the header. Use header names as the keys.
removes string[]
Defines a list of headers to remove.
set {[key: string]: string}
Defines a set of key-value pairs to add to the request header or to replace existing header values with.
add Mapping[str, str]
Defines a set of key-value pairs to add to the header. Use header names as the keys.
removes Sequence[str]
Defines a list of headers to remove.
set Mapping[str, str]
Defines a set of key-value pairs to add to the request header or to replace existing header values with.
add Map<String>
Defines a set of key-value pairs to add to the header. Use header names as the keys.
removes List<String>
Defines a list of headers to remove.
set Map<String>
Defines a set of key-value pairs to add to the request header or to replace existing header values with.

ConfigEntryServiceRouterRouteDestinationResponseHeaders
, ConfigEntryServiceRouterRouteDestinationResponseHeadersArgs

Add Dictionary<string, string>
Defines a set of key-value pairs to add to the header. Use header names as the keys
Removes List<string>
Defines a list of headers to remove.
Set Dictionary<string, string>
Defines a set of key-value pairs to add to the response header or to replace existing header values with
Add map[string]string
Defines a set of key-value pairs to add to the header. Use header names as the keys
Removes []string
Defines a list of headers to remove.
Set map[string]string
Defines a set of key-value pairs to add to the response header or to replace existing header values with
add Map<String,String>
Defines a set of key-value pairs to add to the header. Use header names as the keys
removes List<String>
Defines a list of headers to remove.
set Map<String,String>
Defines a set of key-value pairs to add to the response header or to replace existing header values with
add {[key: string]: string}
Defines a set of key-value pairs to add to the header. Use header names as the keys
removes string[]
Defines a list of headers to remove.
set {[key: string]: string}
Defines a set of key-value pairs to add to the response header or to replace existing header values with
add Mapping[str, str]
Defines a set of key-value pairs to add to the header. Use header names as the keys
removes Sequence[str]
Defines a list of headers to remove.
set Mapping[str, str]
Defines a set of key-value pairs to add to the response header or to replace existing header values with
add Map<String>
Defines a set of key-value pairs to add to the header. Use header names as the keys
removes List<String>
Defines a list of headers to remove.
set Map<String>
Defines a set of key-value pairs to add to the response header or to replace existing header values with

ConfigEntryServiceRouterRouteMatch
, ConfigEntryServiceRouterRouteMatchArgs

Http ConfigEntryServiceRouterRouteMatchHttp
Specifies a set of HTTP criteria used to evaluate incoming L7 traffic for matches.
Http ConfigEntryServiceRouterRouteMatchHttp
Specifies a set of HTTP criteria used to evaluate incoming L7 traffic for matches.
http ConfigEntryServiceRouterRouteMatchHttp
Specifies a set of HTTP criteria used to evaluate incoming L7 traffic for matches.
http ConfigEntryServiceRouterRouteMatchHttp
Specifies a set of HTTP criteria used to evaluate incoming L7 traffic for matches.
http ConfigEntryServiceRouterRouteMatchHttp
Specifies a set of HTTP criteria used to evaluate incoming L7 traffic for matches.
http Property Map
Specifies a set of HTTP criteria used to evaluate incoming L7 traffic for matches.

ConfigEntryServiceRouterRouteMatchHttp
, ConfigEntryServiceRouterRouteMatchHttpArgs

Headers List<ConfigEntryServiceRouterRouteMatchHttpHeader>
Specifies information in the HTTP request header to match with.
Methods List<string>
Specifies HTTP methods that the match applies to.
PathExact string
Specifies the exact path to match on the HTTP request path.
PathPrefix string
Specifies the path prefix to match on the HTTP request path.
PathRegex string
Specifies a regular expression to match on the HTTP request path.
QueryParams List<ConfigEntryServiceRouterRouteMatchHttpQueryParam>
Specifies information to match to on HTTP query parameters.
Headers []ConfigEntryServiceRouterRouteMatchHttpHeader
Specifies information in the HTTP request header to match with.
Methods []string
Specifies HTTP methods that the match applies to.
PathExact string
Specifies the exact path to match on the HTTP request path.
PathPrefix string
Specifies the path prefix to match on the HTTP request path.
PathRegex string
Specifies a regular expression to match on the HTTP request path.
QueryParams []ConfigEntryServiceRouterRouteMatchHttpQueryParam
Specifies information to match to on HTTP query parameters.
headers List<ConfigEntryServiceRouterRouteMatchHttpHeader>
Specifies information in the HTTP request header to match with.
methods List<String>
Specifies HTTP methods that the match applies to.
pathExact String
Specifies the exact path to match on the HTTP request path.
pathPrefix String
Specifies the path prefix to match on the HTTP request path.
pathRegex String
Specifies a regular expression to match on the HTTP request path.
queryParams List<ConfigEntryServiceRouterRouteMatchHttpQueryParam>
Specifies information to match to on HTTP query parameters.
headers ConfigEntryServiceRouterRouteMatchHttpHeader[]
Specifies information in the HTTP request header to match with.
methods string[]
Specifies HTTP methods that the match applies to.
pathExact string
Specifies the exact path to match on the HTTP request path.
pathPrefix string
Specifies the path prefix to match on the HTTP request path.
pathRegex string
Specifies a regular expression to match on the HTTP request path.
queryParams ConfigEntryServiceRouterRouteMatchHttpQueryParam[]
Specifies information to match to on HTTP query parameters.
headers Sequence[ConfigEntryServiceRouterRouteMatchHttpHeader]
Specifies information in the HTTP request header to match with.
methods Sequence[str]
Specifies HTTP methods that the match applies to.
path_exact str
Specifies the exact path to match on the HTTP request path.
path_prefix str
Specifies the path prefix to match on the HTTP request path.
path_regex str
Specifies a regular expression to match on the HTTP request path.
query_params Sequence[ConfigEntryServiceRouterRouteMatchHttpQueryParam]
Specifies information to match to on HTTP query parameters.
headers List<Property Map>
Specifies information in the HTTP request header to match with.
methods List<String>
Specifies HTTP methods that the match applies to.
pathExact String
Specifies the exact path to match on the HTTP request path.
pathPrefix String
Specifies the path prefix to match on the HTTP request path.
pathRegex String
Specifies a regular expression to match on the HTTP request path.
queryParams List<Property Map>
Specifies information to match to on HTTP query parameters.

ConfigEntryServiceRouterRouteMatchHttpHeader
, ConfigEntryServiceRouterRouteMatchHttpHeaderArgs

Exact string
Specifies that a request matches when the header with the given name is this exact value.
Invert bool
Specifies that the logic for the HTTP header match should be inverted.
Name string
Specifies the name of the HTTP header to match.
Prefix string
Specifies that a request matches when the header with the given name has this prefix.
Present bool
Specifies that a request matches when the value in the name argument is present anywhere in the HTTP header.
Regex string
Specifies that a request matches when the header with the given name matches this regular expression.
Suffix string
Specifies that a request matches when the header with the given name has this suffix.
Exact string
Specifies that a request matches when the header with the given name is this exact value.
Invert bool
Specifies that the logic for the HTTP header match should be inverted.
Name string
Specifies the name of the HTTP header to match.
Prefix string
Specifies that a request matches when the header with the given name has this prefix.
Present bool
Specifies that a request matches when the value in the name argument is present anywhere in the HTTP header.
Regex string
Specifies that a request matches when the header with the given name matches this regular expression.
Suffix string
Specifies that a request matches when the header with the given name has this suffix.
exact String
Specifies that a request matches when the header with the given name is this exact value.
invert Boolean
Specifies that the logic for the HTTP header match should be inverted.
name String
Specifies the name of the HTTP header to match.
prefix String
Specifies that a request matches when the header with the given name has this prefix.
present Boolean
Specifies that a request matches when the value in the name argument is present anywhere in the HTTP header.
regex String
Specifies that a request matches when the header with the given name matches this regular expression.
suffix String
Specifies that a request matches when the header with the given name has this suffix.
exact string
Specifies that a request matches when the header with the given name is this exact value.
invert boolean
Specifies that the logic for the HTTP header match should be inverted.
name string
Specifies the name of the HTTP header to match.
prefix string
Specifies that a request matches when the header with the given name has this prefix.
present boolean
Specifies that a request matches when the value in the name argument is present anywhere in the HTTP header.
regex string
Specifies that a request matches when the header with the given name matches this regular expression.
suffix string
Specifies that a request matches when the header with the given name has this suffix.
exact str
Specifies that a request matches when the header with the given name is this exact value.
invert bool
Specifies that the logic for the HTTP header match should be inverted.
name str
Specifies the name of the HTTP header to match.
prefix str
Specifies that a request matches when the header with the given name has this prefix.
present bool
Specifies that a request matches when the value in the name argument is present anywhere in the HTTP header.
regex str
Specifies that a request matches when the header with the given name matches this regular expression.
suffix str
Specifies that a request matches when the header with the given name has this suffix.
exact String
Specifies that a request matches when the header with the given name is this exact value.
invert Boolean
Specifies that the logic for the HTTP header match should be inverted.
name String
Specifies the name of the HTTP header to match.
prefix String
Specifies that a request matches when the header with the given name has this prefix.
present Boolean
Specifies that a request matches when the value in the name argument is present anywhere in the HTTP header.
regex String
Specifies that a request matches when the header with the given name matches this regular expression.
suffix String
Specifies that a request matches when the header with the given name has this suffix.

ConfigEntryServiceRouterRouteMatchHttpQueryParam
, ConfigEntryServiceRouterRouteMatchHttpQueryParamArgs

Exact string
Specifies that a request matches when the query parameter with the given name is this exact value.
Name string
Specifies the name of the HTTP query parameter to match.
Present bool
Specifies that a request matches when the value in the name argument is present anywhere in the HTTP query parameter.
Regex string
Specifies that a request matches when the query parameter with the given name matches this regular expression.
Exact string
Specifies that a request matches when the query parameter with the given name is this exact value.
Name string
Specifies the name of the HTTP query parameter to match.
Present bool
Specifies that a request matches when the value in the name argument is present anywhere in the HTTP query parameter.
Regex string
Specifies that a request matches when the query parameter with the given name matches this regular expression.
exact String
Specifies that a request matches when the query parameter with the given name is this exact value.
name String
Specifies the name of the HTTP query parameter to match.
present Boolean
Specifies that a request matches when the value in the name argument is present anywhere in the HTTP query parameter.
regex String
Specifies that a request matches when the query parameter with the given name matches this regular expression.
exact string
Specifies that a request matches when the query parameter with the given name is this exact value.
name string
Specifies the name of the HTTP query parameter to match.
present boolean
Specifies that a request matches when the value in the name argument is present anywhere in the HTTP query parameter.
regex string
Specifies that a request matches when the query parameter with the given name matches this regular expression.
exact str
Specifies that a request matches when the query parameter with the given name is this exact value.
name str
Specifies the name of the HTTP query parameter to match.
present bool
Specifies that a request matches when the value in the name argument is present anywhere in the HTTP query parameter.
regex str
Specifies that a request matches when the query parameter with the given name matches this regular expression.
exact String
Specifies that a request matches when the query parameter with the given name is this exact value.
name String
Specifies the name of the HTTP query parameter to match.
present Boolean
Specifies that a request matches when the value in the name argument is present anywhere in the HTTP query parameter.
regex String
Specifies that a request matches when the query parameter with the given name matches this regular expression.

Package Details

Repository
HashiCorp Consul pulumi/pulumi-consul
License
Apache-2.0
Notes
This Pulumi package is based on the consul Terraform Provider.