UNPKG

@pulumiverse/cockroach

Version:

A Pulumi package to create and managed Cockroach DB resources in Pulumi programs.

101 lines (100 loc) 3.74 kB
import * as pulumi from "@pulumi/pulumi"; /** * Maintenance window configuration for a cluster. Maintenance Windows are supported for Advanced clusters only. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as cockroach from "@pulumiverse/cockroach"; * * const config = new pulumi.Config(); * const clusterId = config.require("clusterId"); * const offsetDuration = config.getNumber("offsetDuration") || 172800; * const windowDuration = config.getNumber("windowDuration") || 21600; * const example = new cockroach.MaintenanceWindow("example", { * clusterId: clusterId, * offsetDuration: offsetDuration, * windowDuration: windowDuration, * }); * ``` * * ## Import * * format: <cluster id> * * ```sh * $ pulumi import cockroach:index/maintenanceWindow:MaintenanceWindow example 1f69fdd2-600a-4cfc-a9ba-16995df0d77d * ``` */ export declare class MaintenanceWindow extends pulumi.CustomResource { /** * Get an existing MaintenanceWindow 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?: MaintenanceWindowState, opts?: pulumi.CustomResourceOptions): MaintenanceWindow; /** * Returns true if the given object is an instance of MaintenanceWindow. 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 MaintenanceWindow; /** * Cluster ID. */ readonly clusterId: pulumi.Output<string>; /** * Duration in seconds from the beginning of each Monday (UTC) after which the maintenance window starts. */ readonly offsetDuration: pulumi.Output<number>; /** * Duration in seconds that the maintenance window will remain active for after it starts. */ readonly windowDuration: pulumi.Output<number>; /** * Create a MaintenanceWindow 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: MaintenanceWindowArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering MaintenanceWindow resources. */ export interface MaintenanceWindowState { /** * Cluster ID. */ clusterId?: pulumi.Input<string>; /** * Duration in seconds from the beginning of each Monday (UTC) after which the maintenance window starts. */ offsetDuration?: pulumi.Input<number>; /** * Duration in seconds that the maintenance window will remain active for after it starts. */ windowDuration?: pulumi.Input<number>; } /** * The set of arguments for constructing a MaintenanceWindow resource. */ export interface MaintenanceWindowArgs { /** * Cluster ID. */ clusterId: pulumi.Input<string>; /** * Duration in seconds from the beginning of each Monday (UTC) after which the maintenance window starts. */ offsetDuration: pulumi.Input<number>; /** * Duration in seconds that the maintenance window will remain active for after it starts. */ windowDuration: pulumi.Input<number>; }