@komminarlabs/cratedb/cluster.d.ts

A Pulumi package for creating and managing CrateDB resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * Creates and manages a cluster.
 */
export declare class Cluster extends pulumi.CustomResource {
    /**
     * Get an existing Cluster 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?: ClusterState, opts?: pulumi.CustomResourceOptions): Cluster;
    /**
     * Returns true if the given object is an instance of Cluster.  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 Cluster;
    /**
     * The allow custom storage flag.
     */
    readonly allowCustomStorage: pulumi.Output<boolean>;
    /**
     * The allow suspend flag.
     */
    readonly allowSuspend: pulumi.Output<boolean>;
    /**
     * The backup schedule.
     */
    readonly backupSchedule: pulumi.Output<string>;
    /**
     * The channel of the cluster. Default is `stable`.
     */
    readonly channel: pulumi.Output<string>;
    /**
     * The CrateDB version of the cluster.
     */
    readonly crateVersion: pulumi.Output<string>;
    /**
     * The DublinCore of the cluster.
     */
    readonly dc: pulumi.Output<outputs.ClusterDc>;
    /**
     * The deletion protected flag.
     */
    readonly deletionProtected: pulumi.Output<boolean>;
    /**
     * The external IP address.
     */
    readonly externalIp: pulumi.Output<string>;
    /**
     * The Fully Qualified Domain Name.
     */
    readonly fqdn: pulumi.Output<string>;
    /**
     * The garbage collection available flag.
     */
    readonly gcAvailable: pulumi.Output<boolean>;
    /**
     * The hardware specs of the cluster.
     */
    readonly hardwareSpecs: pulumi.Output<outputs.ClusterHardwareSpecs>;
    /**
     * The health of the cluster.
     */
    readonly health: pulumi.Output<outputs.ClusterHealth>;
    /**
     * The IP whitelist of the cluster.
     */
    readonly ipWhitelists: pulumi.Output<outputs.ClusterIpWhitelist[]>;
    /**
     * The name of the cluster.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The number of nodes in the cluster.
     */
    readonly numNodes: pulumi.Output<number>;
    /**
     * The organization id of the cluster.
     */
    readonly organizationId: pulumi.Output<string>;
    /**
     * The origin of the cluster.
     */
    readonly origin: pulumi.Output<string>;
    /**
     * The password of the cluster.
     */
    readonly password: pulumi.Output<string>;
    /**
     * The product name of the cluster.
     */
    readonly productName: pulumi.Output<string>;
    /**
     * The product tier of the cluster.
     */
    readonly productTier: pulumi.Output<string>;
    /**
     * The product unit of the cluster. Default is `0`.
     */
    readonly productUnit: pulumi.Output<number>;
    /**
     * The project id of the cluster.
     */
    readonly projectId: pulumi.Output<string>;
    /**
     * The subscription id of the cluster.
     */
    readonly subscriptionId: pulumi.Output<string>;
    /**
     * The suspended flag.
     */
    readonly suspended: pulumi.Output<boolean>;
    /**
     * The URL of the cluster.
     */
    readonly url: pulumi.Output<string>;
    /**
     * The username of the cluster.
     */
    readonly username: pulumi.Output<string>;
    /**
     * Create a Cluster 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: ClusterArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Cluster resources.
 */
export interface ClusterState {
    /**
     * The allow custom storage flag.
     */
    allowCustomStorage?: pulumi.Input<boolean>;
    /**
     * The allow suspend flag.
     */
    allowSuspend?: pulumi.Input<boolean>;
    /**
     * The backup schedule.
     */
    backupSchedule?: pulumi.Input<string>;
    /**
     * The channel of the cluster. Default is `stable`.
     */
    channel?: pulumi.Input<string>;
    /**
     * The CrateDB version of the cluster.
     */
    crateVersion?: pulumi.Input<string>;
    /**
     * The DublinCore of the cluster.
     */
    dc?: pulumi.Input<inputs.ClusterDc>;
    /**
     * The deletion protected flag.
     */
    deletionProtected?: pulumi.Input<boolean>;
    /**
     * The external IP address.
     */
    externalIp?: pulumi.Input<string>;
    /**
     * The Fully Qualified Domain Name.
     */
    fqdn?: pulumi.Input<string>;
    /**
     * The garbage collection available flag.
     */
    gcAvailable?: pulumi.Input<boolean>;
    /**
     * The hardware specs of the cluster.
     */
    hardwareSpecs?: pulumi.Input<inputs.ClusterHardwareSpecs>;
    /**
     * The health of the cluster.
     */
    health?: pulumi.Input<inputs.ClusterHealth>;
    /**
     * The IP whitelist of the cluster.
     */
    ipWhitelists?: pulumi.Input<pulumi.Input<inputs.ClusterIpWhitelist>[]>;
    /**
     * The name of the cluster.
     */
    name?: pulumi.Input<string>;
    /**
     * The number of nodes in the cluster.
     */
    numNodes?: pulumi.Input<number>;
    /**
     * The organization id of the cluster.
     */
    organizationId?: pulumi.Input<string>;
    /**
     * The origin of the cluster.
     */
    origin?: pulumi.Input<string>;
    /**
     * The password of the cluster.
     */
    password?: pulumi.Input<string>;
    /**
     * The product name of the cluster.
     */
    productName?: pulumi.Input<string>;
    /**
     * The product tier of the cluster.
     */
    productTier?: pulumi.Input<string>;
    /**
     * The product unit of the cluster. Default is `0`.
     */
    productUnit?: pulumi.Input<number>;
    /**
     * The project id of the cluster.
     */
    projectId?: pulumi.Input<string>;
    /**
     * The subscription id of the cluster.
     */
    subscriptionId?: pulumi.Input<string>;
    /**
     * The suspended flag.
     */
    suspended?: pulumi.Input<boolean>;
    /**
     * The URL of the cluster.
     */
    url?: pulumi.Input<string>;
    /**
     * The username of the cluster.
     */
    username?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Cluster resource.
 */
export interface ClusterArgs {
    /**
     * The channel of the cluster. Default is `stable`.
     */
    channel?: pulumi.Input<string>;
    /**
     * The CrateDB version of the cluster.
     */
    crateVersion: pulumi.Input<string>;
    /**
     * The hardware specs of the cluster.
     */
    hardwareSpecs?: pulumi.Input<inputs.ClusterHardwareSpecs>;
    /**
     * The name of the cluster.
     */
    name?: pulumi.Input<string>;
    /**
     * The organization id of the cluster.
     */
    organizationId: pulumi.Input<string>;
    /**
     * The password of the cluster.
     */
    password: pulumi.Input<string>;
    /**
     * The product name of the cluster.
     */
    productName: pulumi.Input<string>;
    /**
     * The product tier of the cluster.
     */
    productTier: pulumi.Input<string>;
    /**
     * The product unit of the cluster. Default is `0`.
     */
    productUnit?: pulumi.Input<number>;
    /**
     * The project id of the cluster.
     */
    projectId: pulumi.Input<string>;
    /**
     * The subscription id of the cluster.
     */
    subscriptionId: pulumi.Input<string>;
    /**
     * The username of the cluster.
     */
    username: pulumi.Input<string>;
}