Docs Packages
  1. Packages
  2. CockroachDB Cloud
  3. API Docs
  4. MaintenanceWindow
CockroachDB v0.2.3 published on Monday, May 27, 2024 by pulumiverse
pulumiverse/pulumi-cockroach

cockroach.MaintenanceWindow

Explore with Pulumi AI

cockroach logo
CockroachDB v0.2.3 published on Monday, May 27, 2024 by pulumiverse
pulumiverse/pulumi-cockroach

    Maintenance window configuration for a cluster.

    Create MaintenanceWindow Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new MaintenanceWindow(name: string, args: MaintenanceWindowArgs, opts?: CustomResourceOptions);
    @overload
def MaintenanceWindow(resource_name: str,
                      args: MaintenanceWindowArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def MaintenanceWindow(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      cluster_id: Optional[str] = None,
                      offset_duration: Optional[int] = None,
                      window_duration: Optional[int] = None)
    func NewMaintenanceWindow(ctx *Context, name string, args MaintenanceWindowArgs, opts ...ResourceOption) (*MaintenanceWindow, error)
    public MaintenanceWindow(string name, MaintenanceWindowArgs args, CustomResourceOptions? opts = null)
    public MaintenanceWindow(String name, MaintenanceWindowArgs args)
public MaintenanceWindow(String name, MaintenanceWindowArgs args, CustomResourceOptions options)

    type: cockroach:MaintenanceWindow
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args MaintenanceWindowArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args MaintenanceWindowArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args MaintenanceWindowArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MaintenanceWindowArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MaintenanceWindowArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var maintenanceWindowResource = new Cockroach.MaintenanceWindow("maintenanceWindowResource", new()
{
    ClusterId = "string",
    OffsetDuration = 0,
    WindowDuration = 0,
});

    example, err := cockroach.NewMaintenanceWindow(ctx, "maintenanceWindowResource", &cockroach.MaintenanceWindowArgs{
	ClusterId:      pulumi.String("string"),
	OffsetDuration: pulumi.Int(0),
	WindowDuration: pulumi.Int(0),
})

    var maintenanceWindowResource = new MaintenanceWindow("maintenanceWindowResource", MaintenanceWindowArgs.builder()
    .clusterId("string")
    .offsetDuration(0)
    .windowDuration(0)
    .build());

    maintenance_window_resource = cockroach.MaintenanceWindow("maintenanceWindowResource",
    cluster_id="string",
    offset_duration=0,
    window_duration=0)

    const maintenanceWindowResource = new cockroach.MaintenanceWindow("maintenanceWindowResource", {
    clusterId: "string",
    offsetDuration: 0,
    windowDuration: 0,
});

    type: cockroach:MaintenanceWindow
properties:
    clusterId: string
    offsetDuration: 0
    windowDuration: 0

    MaintenanceWindow Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The MaintenanceWindow resource accepts the following input properties:

    ClusterId string
    Cluster ID.
    OffsetDuration int
    Duration in seconds from the beginning of each Monday (UTC) after which the maintenance window starts.
    WindowDuration int
    Duration in seconds that the maintenance window will remain active for after it starts.
    ClusterId string
    Cluster ID.
    OffsetDuration int
    Duration in seconds from the beginning of each Monday (UTC) after which the maintenance window starts.
    WindowDuration int
    Duration in seconds that the maintenance window will remain active for after it starts.
    clusterId String
    Cluster ID.
    offsetDuration Integer
    Duration in seconds from the beginning of each Monday (UTC) after which the maintenance window starts.
    windowDuration Integer
    Duration in seconds that the maintenance window will remain active for after it starts.
    clusterId string
    Cluster ID.
    offsetDuration number
    Duration in seconds from the beginning of each Monday (UTC) after which the maintenance window starts.
    windowDuration number
    Duration in seconds that the maintenance window will remain active for after it starts.
    cluster_id str
    Cluster ID.
    offset_duration int
    Duration in seconds from the beginning of each Monday (UTC) after which the maintenance window starts.
    window_duration int
    Duration in seconds that the maintenance window will remain active for after it starts.
    clusterId String
    Cluster ID.
    offsetDuration Number
    Duration in seconds from the beginning of each Monday (UTC) after which the maintenance window starts.
    windowDuration Number
    Duration in seconds that the maintenance window will remain active for after it starts.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the MaintenanceWindow resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing MaintenanceWindow Resource

    Get an existing MaintenanceWindow resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: MaintenanceWindowState, opts?: CustomResourceOptions): MaintenanceWindow
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_id: Optional[str] = None,
        offset_duration: Optional[int] = None,
        window_duration: Optional[int] = None) -> MaintenanceWindow
    func GetMaintenanceWindow(ctx *Context, name string, id IDInput, state *MaintenanceWindowState, opts ...ResourceOption) (*MaintenanceWindow, error)
    public static MaintenanceWindow Get(string name, Input<string> id, MaintenanceWindowState? state, CustomResourceOptions? opts = null)
    public static MaintenanceWindow get(String name, Output<String> id, MaintenanceWindowState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ClusterId string
    Cluster ID.
    OffsetDuration int
    Duration in seconds from the beginning of each Monday (UTC) after which the maintenance window starts.
    WindowDuration int
    Duration in seconds that the maintenance window will remain active for after it starts.
    ClusterId string
    Cluster ID.
    OffsetDuration int
    Duration in seconds from the beginning of each Monday (UTC) after which the maintenance window starts.
    WindowDuration int
    Duration in seconds that the maintenance window will remain active for after it starts.
    clusterId String
    Cluster ID.
    offsetDuration Integer
    Duration in seconds from the beginning of each Monday (UTC) after which the maintenance window starts.
    windowDuration Integer
    Duration in seconds that the maintenance window will remain active for after it starts.
    clusterId string
    Cluster ID.
    offsetDuration number
    Duration in seconds from the beginning of each Monday (UTC) after which the maintenance window starts.
    windowDuration number
    Duration in seconds that the maintenance window will remain active for after it starts.
    cluster_id str
    Cluster ID.
    offset_duration int
    Duration in seconds from the beginning of each Monday (UTC) after which the maintenance window starts.
    window_duration int
    Duration in seconds that the maintenance window will remain active for after it starts.
    clusterId String
    Cluster ID.
    offsetDuration Number
    Duration in seconds from the beginning of each Monday (UTC) after which the maintenance window starts.
    windowDuration Number
    Duration in seconds that the maintenance window will remain active for after it starts.

    Package Details

    Repository
    cockroach pulumiverse/pulumi-cockroach
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cockroach Terraform Provider.
    cockroach logo
    CockroachDB v0.2.3 published on Monday, May 27, 2024 by pulumiverse
    pulumiverse/pulumi-cockroach