@pulumi/consul
Version:
A Pulumi package for creating and managing consul resources.
140 lines (139 loc) • 4.76 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 app = new consul.Keys("app", {
* datacenter: "nyc1",
* token: "abcd",
* keys: [{
* path: "service/app/elb_address",
* value: appAwsElb.dnsName,
* }],
* });
* ```
*/
export declare class Keys extends pulumi.CustomResource {
/**
* Get an existing Keys 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?: KeysState, opts?: pulumi.CustomResourceOptions): Keys;
/**
* Returns true if the given object is an instance of Keys. 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 Keys;
/**
* The datacenter to use. This overrides the
* agent's default datacenter and the datacenter in the provider setup.
*/
readonly datacenter: pulumi.Output<string>;
/**
* Specifies a key in Consul to be written.
* Supported values documented below.
*/
readonly keys: pulumi.Output<outputs.KeysKey[] | undefined>;
/**
* The namespace to create the keys within.
*/
readonly namespace: pulumi.Output<string | undefined>;
/**
* The partition to create the keys within.
*/
readonly partition: pulumi.Output<string | undefined>;
/**
* The ACL token to use. This overrides the
* token that the agent provides by default.
*
* @deprecated The token argument has been deprecated and will be removed in a future release.
Please use the token argument in the provider configuration
*/
readonly token: pulumi.Output<string | undefined>;
readonly var: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a Keys 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?: KeysArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Keys resources.
*/
export interface KeysState {
/**
* The datacenter to use. This overrides the
* agent's default datacenter and the datacenter in the provider setup.
*/
datacenter?: pulumi.Input<string>;
/**
* Specifies a key in Consul to be written.
* Supported values documented below.
*/
keys?: pulumi.Input<pulumi.Input<inputs.KeysKey>[]>;
/**
* The namespace to create the keys within.
*/
namespace?: pulumi.Input<string>;
/**
* The partition to create the keys within.
*/
partition?: pulumi.Input<string>;
/**
* The ACL token to use. This overrides the
* token that the agent provides by default.
*
* @deprecated The token argument has been deprecated and will be removed in a future release.
Please use the token argument in the provider configuration
*/
token?: pulumi.Input<string>;
var?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}
/**
* The set of arguments for constructing a Keys resource.
*/
export interface KeysArgs {
/**
* The datacenter to use. This overrides the
* agent's default datacenter and the datacenter in the provider setup.
*/
datacenter?: pulumi.Input<string>;
/**
* Specifies a key in Consul to be written.
* Supported values documented below.
*/
keys?: pulumi.Input<pulumi.Input<inputs.KeysKey>[]>;
/**
* The namespace to create the keys within.
*/
namespace?: pulumi.Input<string>;
/**
* The partition to create the keys within.
*/
partition?: pulumi.Input<string>;
/**
* The ACL token to use. This overrides the
* token that the agent provides by default.
*
* @deprecated The token argument has been deprecated and will be removed in a future release.
Please use the token argument in the provider configuration
*/
token?: pulumi.Input<string>;
}