1. Packages
  2. Nutanix
  3. API Docs
  4. NdbTmsCluster
Nutanix v0.5.0 published on Monday, Nov 4, 2024 by Piers Karsenbarg

nutanix.NdbTmsCluster

Explore with Pulumi AI

nutanix logo
Nutanix v0.5.0 published on Monday, Nov 4, 2024 by Piers Karsenbarg

    Provides a resource to manage time machine data availability across all the registered Nutanix clusters in NDB.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as nutanix from "@pierskarsenbarg/nutanix";
    
    const cls = new nutanix.NdbTmsCluster("cls", {
        nxClusterId: "{{ cluster_id }}",
        slaId: "{{ sla_id }}",
        timeMachineId: "{{ tms_id }}",
    });
    
    import pulumi
    import pulumi_nutanix as nutanix
    
    cls = nutanix.NdbTmsCluster("cls",
        nx_cluster_id="{{ cluster_id }}",
        sla_id="{{ sla_id }}",
        time_machine_id="{{ tms_id }}")
    
    package main
    
    import (
    	"github.com/pierskarsenbarg/pulumi-nutanix/sdk/go/nutanix"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := nutanix.NewNdbTmsCluster(ctx, "cls", &nutanix.NdbTmsClusterArgs{
    			NxClusterId:   pulumi.String("{{ cluster_id }}"),
    			SlaId:         pulumi.String("{{ sla_id }}"),
    			TimeMachineId: pulumi.String("{{ tms_id }}"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nutanix = PiersKarsenbarg.Nutanix;
    
    return await Deployment.RunAsync(() => 
    {
        var cls = new Nutanix.NdbTmsCluster("cls", new()
        {
            NxClusterId = "{{ cluster_id }}",
            SlaId = "{{ sla_id }}",
            TimeMachineId = "{{ tms_id }}",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.nutanix.NdbTmsCluster;
    import com.pulumi.nutanix.NdbTmsClusterArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var cls = new NdbTmsCluster("cls", NdbTmsClusterArgs.builder()
                .nxClusterId("{{ cluster_id }}")
                .slaId("{{ sla_id }}")
                .timeMachineId("{{ tms_id }}")
                .build());
    
        }
    }
    
    resources:
      cls:
        type: nutanix:NdbTmsCluster
        properties:
          nxClusterId: '{{ cluster_id }}'
          slaId: '{{ sla_id }}'
          timeMachineId: '{{ tms_id }}'
    

    Create NdbTmsCluster Resource

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

    Constructor syntax

    new NdbTmsCluster(name: string, args: NdbTmsClusterArgs, opts?: CustomResourceOptions);
    @overload
    def NdbTmsCluster(resource_name: str,
                      args: NdbTmsClusterArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def NdbTmsCluster(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      nx_cluster_id: Optional[str] = None,
                      sla_id: Optional[str] = None,
                      time_machine_id: Optional[str] = None,
                      type: Optional[str] = None)
    func NewNdbTmsCluster(ctx *Context, name string, args NdbTmsClusterArgs, opts ...ResourceOption) (*NdbTmsCluster, error)
    public NdbTmsCluster(string name, NdbTmsClusterArgs args, CustomResourceOptions? opts = null)
    public NdbTmsCluster(String name, NdbTmsClusterArgs args)
    public NdbTmsCluster(String name, NdbTmsClusterArgs args, CustomResourceOptions options)
    
    type: nutanix:NdbTmsCluster
    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 NdbTmsClusterArgs
    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 NdbTmsClusterArgs
    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 NdbTmsClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NdbTmsClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NdbTmsClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var ndbTmsClusterResource = new Nutanix.NdbTmsCluster("ndbTmsClusterResource", new()
    {
        NxClusterId = "string",
        SlaId = "string",
        TimeMachineId = "string",
        Type = "string",
    });
    
    example, err := nutanix.NewNdbTmsCluster(ctx, "ndbTmsClusterResource", &nutanix.NdbTmsClusterArgs{
    	NxClusterId:   pulumi.String("string"),
    	SlaId:         pulumi.String("string"),
    	TimeMachineId: pulumi.String("string"),
    	Type:          pulumi.String("string"),
    })
    
    var ndbTmsClusterResource = new NdbTmsCluster("ndbTmsClusterResource", NdbTmsClusterArgs.builder()
        .nxClusterId("string")
        .slaId("string")
        .timeMachineId("string")
        .type("string")
        .build());
    
    ndb_tms_cluster_resource = nutanix.NdbTmsCluster("ndbTmsClusterResource",
        nx_cluster_id="string",
        sla_id="string",
        time_machine_id="string",
        type="string")
    
    const ndbTmsClusterResource = new nutanix.NdbTmsCluster("ndbTmsClusterResource", {
        nxClusterId: "string",
        slaId: "string",
        timeMachineId: "string",
        type: "string",
    });
    
    type: nutanix:NdbTmsCluster
    properties:
        nxClusterId: string
        slaId: string
        timeMachineId: string
        type: string
    

    NdbTmsCluster Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The NdbTmsCluster resource accepts the following input properties:

    NxClusterId string
    Nutanix cluster id on the associated registered clusters.
    SlaId string
    SLA id for the associated cluster.
    TimeMachineId string
    time machine id
    Type string
    Default value is "OTHER"
    NxClusterId string
    Nutanix cluster id on the associated registered clusters.
    SlaId string
    SLA id for the associated cluster.
    TimeMachineId string
    time machine id
    Type string
    Default value is "OTHER"
    nxClusterId String
    Nutanix cluster id on the associated registered clusters.
    slaId String
    SLA id for the associated cluster.
    timeMachineId String
    time machine id
    type String
    Default value is "OTHER"
    nxClusterId string
    Nutanix cluster id on the associated registered clusters.
    slaId string
    SLA id for the associated cluster.
    timeMachineId string
    time machine id
    type string
    Default value is "OTHER"
    nx_cluster_id str
    Nutanix cluster id on the associated registered clusters.
    sla_id str
    SLA id for the associated cluster.
    time_machine_id str
    time machine id
    type str
    Default value is "OTHER"
    nxClusterId String
    Nutanix cluster id on the associated registered clusters.
    slaId String
    SLA id for the associated cluster.
    timeMachineId String
    time machine id
    type String
    Default value is "OTHER"

    Outputs

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

    DateCreated string
    created date of time machine associated with cluster
    DateModified string
    modified date of time machine associated with cluster
    Description string
    description of nutanix cluster associated with time machine
    Id string
    The provider-assigned unique ID for this managed resource.
    LogDriveId string
    log drive id
    LogDriveStatus string
    log drive status of time machine
    OwnerId string
    owner id
    ScheduleId string
    schedule id of the data associated with time machine
    Source bool
    source is present or not
    SourceClusters List<string>
    source clusters in time machines
    Status string
    status of the cluster associated with time machine
    DateCreated string
    created date of time machine associated with cluster
    DateModified string
    modified date of time machine associated with cluster
    Description string
    description of nutanix cluster associated with time machine
    Id string
    The provider-assigned unique ID for this managed resource.
    LogDriveId string
    log drive id
    LogDriveStatus string
    log drive status of time machine
    OwnerId string
    owner id
    ScheduleId string
    schedule id of the data associated with time machine
    Source bool
    source is present or not
    SourceClusters []string
    source clusters in time machines
    Status string
    status of the cluster associated with time machine
    dateCreated String
    created date of time machine associated with cluster
    dateModified String
    modified date of time machine associated with cluster
    description String
    description of nutanix cluster associated with time machine
    id String
    The provider-assigned unique ID for this managed resource.
    logDriveId String
    log drive id
    logDriveStatus String
    log drive status of time machine
    ownerId String
    owner id
    scheduleId String
    schedule id of the data associated with time machine
    source Boolean
    source is present or not
    sourceClusters List<String>
    source clusters in time machines
    status String
    status of the cluster associated with time machine
    dateCreated string
    created date of time machine associated with cluster
    dateModified string
    modified date of time machine associated with cluster
    description string
    description of nutanix cluster associated with time machine
    id string
    The provider-assigned unique ID for this managed resource.
    logDriveId string
    log drive id
    logDriveStatus string
    log drive status of time machine
    ownerId string
    owner id
    scheduleId string
    schedule id of the data associated with time machine
    source boolean
    source is present or not
    sourceClusters string[]
    source clusters in time machines
    status string
    status of the cluster associated with time machine
    date_created str
    created date of time machine associated with cluster
    date_modified str
    modified date of time machine associated with cluster
    description str
    description of nutanix cluster associated with time machine
    id str
    The provider-assigned unique ID for this managed resource.
    log_drive_id str
    log drive id
    log_drive_status str
    log drive status of time machine
    owner_id str
    owner id
    schedule_id str
    schedule id of the data associated with time machine
    source bool
    source is present or not
    source_clusters Sequence[str]
    source clusters in time machines
    status str
    status of the cluster associated with time machine
    dateCreated String
    created date of time machine associated with cluster
    dateModified String
    modified date of time machine associated with cluster
    description String
    description of nutanix cluster associated with time machine
    id String
    The provider-assigned unique ID for this managed resource.
    logDriveId String
    log drive id
    logDriveStatus String
    log drive status of time machine
    ownerId String
    owner id
    scheduleId String
    schedule id of the data associated with time machine
    source Boolean
    source is present or not
    sourceClusters List<String>
    source clusters in time machines
    status String
    status of the cluster associated with time machine

    Look up Existing NdbTmsCluster Resource

    Get an existing NdbTmsCluster 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?: NdbTmsClusterState, opts?: CustomResourceOptions): NdbTmsCluster
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            date_created: Optional[str] = None,
            date_modified: Optional[str] = None,
            description: Optional[str] = None,
            log_drive_id: Optional[str] = None,
            log_drive_status: Optional[str] = None,
            nx_cluster_id: Optional[str] = None,
            owner_id: Optional[str] = None,
            schedule_id: Optional[str] = None,
            sla_id: Optional[str] = None,
            source: Optional[bool] = None,
            source_clusters: Optional[Sequence[str]] = None,
            status: Optional[str] = None,
            time_machine_id: Optional[str] = None,
            type: Optional[str] = None) -> NdbTmsCluster
    func GetNdbTmsCluster(ctx *Context, name string, id IDInput, state *NdbTmsClusterState, opts ...ResourceOption) (*NdbTmsCluster, error)
    public static NdbTmsCluster Get(string name, Input<string> id, NdbTmsClusterState? state, CustomResourceOptions? opts = null)
    public static NdbTmsCluster get(String name, Output<String> id, NdbTmsClusterState 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:
    DateCreated string
    created date of time machine associated with cluster
    DateModified string
    modified date of time machine associated with cluster
    Description string
    description of nutanix cluster associated with time machine
    LogDriveId string
    log drive id
    LogDriveStatus string
    log drive status of time machine
    NxClusterId string
    Nutanix cluster id on the associated registered clusters.
    OwnerId string
    owner id
    ScheduleId string
    schedule id of the data associated with time machine
    SlaId string
    SLA id for the associated cluster.
    Source bool
    source is present or not
    SourceClusters List<string>
    source clusters in time machines
    Status string
    status of the cluster associated with time machine
    TimeMachineId string
    time machine id
    Type string
    Default value is "OTHER"
    DateCreated string
    created date of time machine associated with cluster
    DateModified string
    modified date of time machine associated with cluster
    Description string
    description of nutanix cluster associated with time machine
    LogDriveId string
    log drive id
    LogDriveStatus string
    log drive status of time machine
    NxClusterId string
    Nutanix cluster id on the associated registered clusters.
    OwnerId string
    owner id
    ScheduleId string
    schedule id of the data associated with time machine
    SlaId string
    SLA id for the associated cluster.
    Source bool
    source is present or not
    SourceClusters []string
    source clusters in time machines
    Status string
    status of the cluster associated with time machine
    TimeMachineId string
    time machine id
    Type string
    Default value is "OTHER"
    dateCreated String
    created date of time machine associated with cluster
    dateModified String
    modified date of time machine associated with cluster
    description String
    description of nutanix cluster associated with time machine
    logDriveId String
    log drive id
    logDriveStatus String
    log drive status of time machine
    nxClusterId String
    Nutanix cluster id on the associated registered clusters.
    ownerId String
    owner id
    scheduleId String
    schedule id of the data associated with time machine
    slaId String
    SLA id for the associated cluster.
    source Boolean
    source is present or not
    sourceClusters List<String>
    source clusters in time machines
    status String
    status of the cluster associated with time machine
    timeMachineId String
    time machine id
    type String
    Default value is "OTHER"
    dateCreated string
    created date of time machine associated with cluster
    dateModified string
    modified date of time machine associated with cluster
    description string
    description of nutanix cluster associated with time machine
    logDriveId string
    log drive id
    logDriveStatus string
    log drive status of time machine
    nxClusterId string
    Nutanix cluster id on the associated registered clusters.
    ownerId string
    owner id
    scheduleId string
    schedule id of the data associated with time machine
    slaId string
    SLA id for the associated cluster.
    source boolean
    source is present or not
    sourceClusters string[]
    source clusters in time machines
    status string
    status of the cluster associated with time machine
    timeMachineId string
    time machine id
    type string
    Default value is "OTHER"
    date_created str
    created date of time machine associated with cluster
    date_modified str
    modified date of time machine associated with cluster
    description str
    description of nutanix cluster associated with time machine
    log_drive_id str
    log drive id
    log_drive_status str
    log drive status of time machine
    nx_cluster_id str
    Nutanix cluster id on the associated registered clusters.
    owner_id str
    owner id
    schedule_id str
    schedule id of the data associated with time machine
    sla_id str
    SLA id for the associated cluster.
    source bool
    source is present or not
    source_clusters Sequence[str]
    source clusters in time machines
    status str
    status of the cluster associated with time machine
    time_machine_id str
    time machine id
    type str
    Default value is "OTHER"
    dateCreated String
    created date of time machine associated with cluster
    dateModified String
    modified date of time machine associated with cluster
    description String
    description of nutanix cluster associated with time machine
    logDriveId String
    log drive id
    logDriveStatus String
    log drive status of time machine
    nxClusterId String
    Nutanix cluster id on the associated registered clusters.
    ownerId String
    owner id
    scheduleId String
    schedule id of the data associated with time machine
    slaId String
    SLA id for the associated cluster.
    source Boolean
    source is present or not
    sourceClusters List<String>
    source clusters in time machines
    status String
    status of the cluster associated with time machine
    timeMachineId String
    time machine id
    type String
    Default value is "OTHER"

    Package Details

    Repository
    nutanix pierskarsenbarg/pulumi-nutanix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nutanix Terraform Provider.
    nutanix logo
    Nutanix v0.5.0 published on Monday, Nov 4, 2024 by Piers Karsenbarg