@pulumi/consul
Version:
A Pulumi package for creating and managing consul resources.
187 lines (186 loc) • 6.06 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.ConfigEntry("web", {
* name: "web",
* kind: "service-defaults",
* configJson: JSON.stringify({
* Protocol: "http",
* Expose: {},
* MeshGateway: {},
* TransparentProxy: {},
* }),
* });
* const serviceResolver = new consul.ConfigEntryServiceResolver("service_resolver", {
* name: "service-resolver",
* defaultSubset: "v1",
* subsets: [
* {
* name: "v1",
* filter: "Service.Meta.version == v1",
* },
* {
* name: "v2",
* filter: "Service.Meta.version == v2",
* },
* ],
* });
* const foo = new consul.ConfigEntryServiceSplitter("foo", {
* name: serviceResolver.name,
* meta: {
* key: "value",
* },
* splits: [
* {
* weight: 80,
* service: "web",
* serviceSubset: "v1",
* requestHeaders: {
* set: {
* "x-web-version": "from-v1",
* },
* },
* responseHeaders: {
* set: {
* "x-web-version": "to-v1",
* },
* },
* },
* {
* weight: 10,
* service: "web",
* serviceSubset: "v2",
* requestHeaders: {
* set: {
* "x-web-version": "from-v2",
* },
* },
* responseHeaders: {
* set: {
* "x-web-version": "to-v2",
* },
* },
* },
* {
* weight: 10,
* service: "web",
* serviceSubset: "v2",
* },
* ],
* });
* ```
*
* ## Import
*
* ```sh
* $ pulumi import consul:index/configEntryServiceSplitter:ConfigEntryServiceSplitter foo web
* ```
*/
export declare class ConfigEntryServiceSplitter extends pulumi.CustomResource {
/**
* Get an existing ConfigEntryServiceSplitter 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?: ConfigEntryServiceSplitterState, opts?: pulumi.CustomResourceOptions): ConfigEntryServiceSplitter;
/**
* Returns true if the given object is an instance of ConfigEntryServiceSplitter. 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 ConfigEntryServiceSplitter;
/**
* 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 to apply the configuration entry.
*/
readonly namespace: pulumi.Output<string | undefined>;
/**
* Specifies the admin partition to apply the configuration entry.
*/
readonly partition: pulumi.Output<string | undefined>;
/**
* Defines how much traffic to send to sets of service instances during a traffic split.
*/
readonly splits: pulumi.Output<outputs.ConfigEntryServiceSplitterSplit[]>;
/**
* Create a ConfigEntryServiceSplitter 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: ConfigEntryServiceSplitterArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ConfigEntryServiceSplitter resources.
*/
export interface ConfigEntryServiceSplitterState {
/**
* 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 to apply the configuration entry.
*/
namespace?: pulumi.Input<string>;
/**
* Specifies the admin partition to apply the configuration entry.
*/
partition?: pulumi.Input<string>;
/**
* Defines how much traffic to send to sets of service instances during a traffic split.
*/
splits?: pulumi.Input<pulumi.Input<inputs.ConfigEntryServiceSplitterSplit>[]>;
}
/**
* The set of arguments for constructing a ConfigEntryServiceSplitter resource.
*/
export interface ConfigEntryServiceSplitterArgs {
/**
* 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 to apply the configuration entry.
*/
namespace?: pulumi.Input<string>;
/**
* Specifies the admin partition to apply the configuration entry.
*/
partition?: pulumi.Input<string>;
/**
* Defines how much traffic to send to sets of service instances during a traffic split.
*/
splits: pulumi.Input<pulumi.Input<inputs.ConfigEntryServiceSplitterSplit>[]>;
}