@pulumi/consul
Version:
A Pulumi package for creating and managing consul resources.
218 lines (217 loc) • 8.85 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as consul from "@pulumi/consul";
*
* const web = new consul.ConfigEntryServiceResolver("web", {
* name: "web",
* defaultSubset: "v1",
* connectTimeout: "15s",
* subsets: [
* {
* name: "v1",
* filter: "Service.Meta.version == v1",
* },
* {
* name: "v2",
* filter: "Service.Meta.version == v2",
* },
* ],
* redirects: [{
* service: "web",
* datacenter: "dc2",
* }],
* failovers: [
* {
* subsetName: "v2",
* datacenters: ["dc2"],
* },
* {
* subsetName: "*",
* datacenters: [
* "dc3",
* "dc4",
* ],
* },
* ],
* });
* ```
*/
export declare class ConfigEntryServiceResolver extends pulumi.CustomResource {
/**
* Get an existing ConfigEntryServiceResolver resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ConfigEntryServiceResolverState, opts?: pulumi.CustomResourceOptions): ConfigEntryServiceResolver;
/**
* Returns true if the given object is an instance of ConfigEntryServiceResolver. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ConfigEntryServiceResolver;
/**
* Specifies the timeout duration for establishing new network connections to this service.
*/
readonly connectTimeout: pulumi.Output<string | undefined>;
/**
* Specifies a defined subset of service instances to use when no explicit subset is requested. If this parameter is not specified, Consul uses the unnamed default subset.
*/
readonly defaultSubset: pulumi.Output<string | undefined>;
/**
* Specifies controls for rerouting traffic to an alternate pool of service instances if the target service fails.
*/
readonly failovers: pulumi.Output<outputs.ConfigEntryServiceResolverFailover[] | undefined>;
/**
* Specifies the load balancing policy and configuration for services issuing requests to this upstream.
*/
readonly loadBalancers: pulumi.Output<outputs.ConfigEntryServiceResolverLoadBalancer[] | undefined>;
/**
* Specifies key-value pairs to add to the KV store.
*/
readonly meta: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Specifies a name for the configuration entry.
*/
readonly name: pulumi.Output<string>;
/**
* Specifies the namespace that the service resolver applies to.
*/
readonly namespace: pulumi.Output<string | undefined>;
/**
* Specifies the admin partition that the service resolver applies to.
*/
readonly partition: pulumi.Output<string | undefined>;
/**
* Specifies redirect instructions for local service traffic so that services deployed to a different network location resolve the upstream request instead.
*/
readonly redirects: pulumi.Output<outputs.ConfigEntryServiceResolverRedirect[] | undefined>;
/**
* Specifies the timeout duration for receiving an HTTP response from this service.
*/
readonly requestTimeout: pulumi.Output<string | undefined>;
/**
* Specifies names for custom service subsets and the conditions under which service instances belong to each subset.
*/
readonly subsets: pulumi.Output<outputs.ConfigEntryServiceResolverSubset[] | undefined>;
/**
* Create a ConfigEntryServiceResolver resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: ConfigEntryServiceResolverArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ConfigEntryServiceResolver resources.
*/
export interface ConfigEntryServiceResolverState {
/**
* Specifies the timeout duration for establishing new network connections to this service.
*/
connectTimeout?: pulumi.Input<string>;
/**
* Specifies a defined subset of service instances to use when no explicit subset is requested. If this parameter is not specified, Consul uses the unnamed default subset.
*/
defaultSubset?: pulumi.Input<string>;
/**
* Specifies controls for rerouting traffic to an alternate pool of service instances if the target service fails.
*/
failovers?: pulumi.Input<pulumi.Input<inputs.ConfigEntryServiceResolverFailover>[]>;
/**
* Specifies the load balancing policy and configuration for services issuing requests to this upstream.
*/
loadBalancers?: pulumi.Input<pulumi.Input<inputs.ConfigEntryServiceResolverLoadBalancer>[]>;
/**
* Specifies key-value pairs to add to the KV store.
*/
meta?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Specifies a name for the configuration entry.
*/
name?: pulumi.Input<string>;
/**
* Specifies the namespace that the service resolver applies to.
*/
namespace?: pulumi.Input<string>;
/**
* Specifies the admin partition that the service resolver applies to.
*/
partition?: pulumi.Input<string>;
/**
* Specifies redirect instructions for local service traffic so that services deployed to a different network location resolve the upstream request instead.
*/
redirects?: pulumi.Input<pulumi.Input<inputs.ConfigEntryServiceResolverRedirect>[]>;
/**
* Specifies the timeout duration for receiving an HTTP response from this service.
*/
requestTimeout?: pulumi.Input<string>;
/**
* Specifies names for custom service subsets and the conditions under which service instances belong to each subset.
*/
subsets?: pulumi.Input<pulumi.Input<inputs.ConfigEntryServiceResolverSubset>[]>;
}
/**
* The set of arguments for constructing a ConfigEntryServiceResolver resource.
*/
export interface ConfigEntryServiceResolverArgs {
/**
* Specifies the timeout duration for establishing new network connections to this service.
*/
connectTimeout?: pulumi.Input<string>;
/**
* Specifies a defined subset of service instances to use when no explicit subset is requested. If this parameter is not specified, Consul uses the unnamed default subset.
*/
defaultSubset?: pulumi.Input<string>;
/**
* Specifies controls for rerouting traffic to an alternate pool of service instances if the target service fails.
*/
failovers?: pulumi.Input<pulumi.Input<inputs.ConfigEntryServiceResolverFailover>[]>;
/**
* Specifies the load balancing policy and configuration for services issuing requests to this upstream.
*/
loadBalancers?: pulumi.Input<pulumi.Input<inputs.ConfigEntryServiceResolverLoadBalancer>[]>;
/**
* Specifies key-value pairs to add to the KV store.
*/
meta?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Specifies a name for the configuration entry.
*/
name?: pulumi.Input<string>;
/**
* Specifies the namespace that the service resolver applies to.
*/
namespace?: pulumi.Input<string>;
/**
* Specifies the admin partition that the service resolver applies to.
*/
partition?: pulumi.Input<string>;
/**
* Specifies redirect instructions for local service traffic so that services deployed to a different network location resolve the upstream request instead.
*/
redirects?: pulumi.Input<pulumi.Input<inputs.ConfigEntryServiceResolverRedirect>[]>;
/**
* Specifies the timeout duration for receiving an HTTP response from this service.
*/
requestTimeout?: pulumi.Input<string>;
/**
* Specifies names for custom service subsets and the conditions under which service instances belong to each subset.
*/
subsets?: pulumi.Input<pulumi.Input<inputs.ConfigEntryServiceResolverSubset>[]>;
}