@pulumi/consul
Version:
A Pulumi package for creating and managing consul resources.
163 lines (162 loc) • 5.17 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* > **NOTE:** This feature requires [Consul Enterprise](https://www.consul.io/docs/enterprise/index.html).
*
* The `consul.License` resource provides datacenter-level management of
* the Consul Enterprise license. If ACLs are enabled then a token with operator
* privileges may be required in order to use this command.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as consul from "@pulumi/consul";
* import * as std from "@pulumi/std";
*
* const license = new consul.License("license", {license: std.file({
* input: "license.hclic",
* }).then(invoke => invoke.result)});
* ```
*/
export declare class License extends pulumi.CustomResource {
/**
* Get an existing License 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?: LicenseState, opts?: pulumi.CustomResourceOptions): License;
/**
* Returns true if the given object is an instance of License. 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 License;
/**
* The ID of the customer the license is attached to.
*/
readonly customerId: pulumi.Output<string>;
/**
* The datacenter to use. This overrides the
* agent's default datacenter and the datacenter in the provider setup.
*/
readonly datacenter: pulumi.Output<string | undefined>;
/**
* The expiration time of the license.
*/
readonly expirationTime: pulumi.Output<string>;
/**
* The features for which the license is valid.
*/
readonly features: pulumi.Output<string[]>;
/**
* The ID of the current installation.
*/
readonly installationId: pulumi.Output<string>;
/**
* The date the license was issued.
*/
readonly issueTime: pulumi.Output<string>;
/**
* The Consul license to use.
*/
readonly license: pulumi.Output<string>;
/**
* The ID of the license used.
*/
readonly licenseId: pulumi.Output<string>;
/**
* The product for which the license is valid.
*/
readonly product: pulumi.Output<string>;
/**
* The start time of the license.
*/
readonly startTime: pulumi.Output<string>;
/**
* Whether the license is valid.
*/
readonly valid: pulumi.Output<boolean>;
/**
* A list of warning messages regarding the license validity.
*/
readonly warnings: pulumi.Output<string[]>;
/**
* Create a License 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: LicenseArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering License resources.
*/
export interface LicenseState {
/**
* The ID of the customer the license is attached to.
*/
customerId?: pulumi.Input<string>;
/**
* The datacenter to use. This overrides the
* agent's default datacenter and the datacenter in the provider setup.
*/
datacenter?: pulumi.Input<string>;
/**
* The expiration time of the license.
*/
expirationTime?: pulumi.Input<string>;
/**
* The features for which the license is valid.
*/
features?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The ID of the current installation.
*/
installationId?: pulumi.Input<string>;
/**
* The date the license was issued.
*/
issueTime?: pulumi.Input<string>;
/**
* The Consul license to use.
*/
license?: pulumi.Input<string>;
/**
* The ID of the license used.
*/
licenseId?: pulumi.Input<string>;
/**
* The product for which the license is valid.
*/
product?: pulumi.Input<string>;
/**
* The start time of the license.
*/
startTime?: pulumi.Input<string>;
/**
* Whether the license is valid.
*/
valid?: pulumi.Input<boolean>;
/**
* A list of warning messages regarding the license validity.
*/
warnings?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a License resource.
*/
export interface LicenseArgs {
/**
* The datacenter to use. This overrides the
* agent's default datacenter and the datacenter in the provider setup.
*/
datacenter?: pulumi.Input<string>;
/**
* The Consul license to use.
*/
license: pulumi.Input<string>;
}