UNPKG

@pulumi/consul

Version:

A Pulumi package for creating and managing consul resources.

86 lines (85 loc) 2.96 kB
import * as pulumi from "@pulumi/pulumi"; /** * > **NOTE:** This feature requires Consul Enterprise. * * The `consul.AdminPartition` resource manages [Consul Enterprise Admin Partitions](https://www.consul.io/docs/enterprise/admin-partitions). * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as consul from "@pulumi/consul"; * * const naWest = new consul.AdminPartition("na_west", { * name: "na-west", * description: "Partition for North America West", * }); * ``` * * ## Import * * `consul_admin_partition` can be imported: * * ```sh * $ pulumi import consul:index/adminPartition:AdminPartition na_west na-west * ``` */ export declare class AdminPartition extends pulumi.CustomResource { /** * Get an existing AdminPartition 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?: AdminPartitionState, opts?: pulumi.CustomResourceOptions): AdminPartition; /** * Returns true if the given object is an instance of AdminPartition. 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 AdminPartition; /** * Free form partition description. */ readonly description: pulumi.Output<string | undefined>; /** * The partition name. This must be a valid DNS hostname label. */ readonly name: pulumi.Output<string>; /** * Create a AdminPartition 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?: AdminPartitionArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering AdminPartition resources. */ export interface AdminPartitionState { /** * Free form partition description. */ description?: pulumi.Input<string>; /** * The partition name. This must be a valid DNS hostname label. */ name?: pulumi.Input<string>; } /** * The set of arguments for constructing a AdminPartition resource. */ export interface AdminPartitionArgs { /** * Free form partition description. */ description?: pulumi.Input<string>; /** * The partition name. This must be a valid DNS hostname label. */ name?: pulumi.Input<string>; }