1. Packages
  2. vSphere
  3. API Docs
  4. ComputeClusterVmDependencyRule
vSphere v4.10.0 published on Tuesday, Mar 12, 2024 by Pulumi

vsphere.ComputeClusterVmDependencyRule

Explore with Pulumi AI

vsphere logo
vSphere v4.10.0 published on Tuesday, Mar 12, 2024 by Pulumi

    Create ComputeClusterVmDependencyRule Resource

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

    Constructor syntax

    new ComputeClusterVmDependencyRule(name: string, args: ComputeClusterVmDependencyRuleArgs, opts?: CustomResourceOptions);
    @overload
    def ComputeClusterVmDependencyRule(resource_name: str,
                                       args: ComputeClusterVmDependencyRuleArgs,
                                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def ComputeClusterVmDependencyRule(resource_name: str,
                                       opts: Optional[ResourceOptions] = None,
                                       compute_cluster_id: Optional[str] = None,
                                       dependency_vm_group_name: Optional[str] = None,
                                       vm_group_name: Optional[str] = None,
                                       enabled: Optional[bool] = None,
                                       mandatory: Optional[bool] = None,
                                       name: Optional[str] = None)
    func NewComputeClusterVmDependencyRule(ctx *Context, name string, args ComputeClusterVmDependencyRuleArgs, opts ...ResourceOption) (*ComputeClusterVmDependencyRule, error)
    public ComputeClusterVmDependencyRule(string name, ComputeClusterVmDependencyRuleArgs args, CustomResourceOptions? opts = null)
    public ComputeClusterVmDependencyRule(String name, ComputeClusterVmDependencyRuleArgs args)
    public ComputeClusterVmDependencyRule(String name, ComputeClusterVmDependencyRuleArgs args, CustomResourceOptions options)
    
    type: vsphere:ComputeClusterVmDependencyRule
    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 ComputeClusterVmDependencyRuleArgs
    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 ComputeClusterVmDependencyRuleArgs
    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 ComputeClusterVmDependencyRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ComputeClusterVmDependencyRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ComputeClusterVmDependencyRuleArgs
    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 computeClusterVmDependencyRuleResource = new VSphere.ComputeClusterVmDependencyRule("computeClusterVmDependencyRuleResource", new()
    {
        ComputeClusterId = "string",
        DependencyVmGroupName = "string",
        VmGroupName = "string",
        Enabled = false,
        Mandatory = false,
        Name = "string",
    });
    
    example, err := vsphere.NewComputeClusterVmDependencyRule(ctx, "computeClusterVmDependencyRuleResource", &vsphere.ComputeClusterVmDependencyRuleArgs{
    	ComputeClusterId:      pulumi.String("string"),
    	DependencyVmGroupName: pulumi.String("string"),
    	VmGroupName:           pulumi.String("string"),
    	Enabled:               pulumi.Bool(false),
    	Mandatory:             pulumi.Bool(false),
    	Name:                  pulumi.String("string"),
    })
    
    var computeClusterVmDependencyRuleResource = new ComputeClusterVmDependencyRule("computeClusterVmDependencyRuleResource", ComputeClusterVmDependencyRuleArgs.builder()        
        .computeClusterId("string")
        .dependencyVmGroupName("string")
        .vmGroupName("string")
        .enabled(false)
        .mandatory(false)
        .name("string")
        .build());
    
    compute_cluster_vm_dependency_rule_resource = vsphere.ComputeClusterVmDependencyRule("computeClusterVmDependencyRuleResource",
        compute_cluster_id="string",
        dependency_vm_group_name="string",
        vm_group_name="string",
        enabled=False,
        mandatory=False,
        name="string")
    
    const computeClusterVmDependencyRuleResource = new vsphere.ComputeClusterVmDependencyRule("computeClusterVmDependencyRuleResource", {
        computeClusterId: "string",
        dependencyVmGroupName: "string",
        vmGroupName: "string",
        enabled: false,
        mandatory: false,
        name: "string",
    });
    
    type: vsphere:ComputeClusterVmDependencyRule
    properties:
        computeClusterId: string
        dependencyVmGroupName: string
        enabled: false
        mandatory: false
        name: string
        vmGroupName: string
    

    ComputeClusterVmDependencyRule 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 ComputeClusterVmDependencyRule resource accepts the following input properties:

    ComputeClusterId string
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    DependencyVmGroupName string
    The name of the VM group that this rule depends on. The VMs defined in the group specified by vm_group_name will not be started until the VMs in this group are started.
    VmGroupName string
    The name of the VM group that is the subject of this rule. The VMs defined in this group will not be started until the VMs in the group specified by dependency_vm_group_name are started.
    Enabled bool
    Enable this rule in the cluster. Default: true.
    Mandatory bool

    When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

    NOTE: The namespace for rule names on this resource (defined by the name argument) is shared with all rules in the cluster - consider this when naming your rules.

    Name string
    The name of the rule. This must be unique in the cluster.
    ComputeClusterId string
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    DependencyVmGroupName string
    The name of the VM group that this rule depends on. The VMs defined in the group specified by vm_group_name will not be started until the VMs in this group are started.
    VmGroupName string
    The name of the VM group that is the subject of this rule. The VMs defined in this group will not be started until the VMs in the group specified by dependency_vm_group_name are started.
    Enabled bool
    Enable this rule in the cluster. Default: true.
    Mandatory bool

    When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

    NOTE: The namespace for rule names on this resource (defined by the name argument) is shared with all rules in the cluster - consider this when naming your rules.

    Name string
    The name of the rule. This must be unique in the cluster.
    computeClusterId String
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    dependencyVmGroupName String
    The name of the VM group that this rule depends on. The VMs defined in the group specified by vm_group_name will not be started until the VMs in this group are started.
    vmGroupName String
    The name of the VM group that is the subject of this rule. The VMs defined in this group will not be started until the VMs in the group specified by dependency_vm_group_name are started.
    enabled Boolean
    Enable this rule in the cluster. Default: true.
    mandatory Boolean

    When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

    NOTE: The namespace for rule names on this resource (defined by the name argument) is shared with all rules in the cluster - consider this when naming your rules.

    name String
    The name of the rule. This must be unique in the cluster.
    computeClusterId string
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    dependencyVmGroupName string
    The name of the VM group that this rule depends on. The VMs defined in the group specified by vm_group_name will not be started until the VMs in this group are started.
    vmGroupName string
    The name of the VM group that is the subject of this rule. The VMs defined in this group will not be started until the VMs in the group specified by dependency_vm_group_name are started.
    enabled boolean
    Enable this rule in the cluster. Default: true.
    mandatory boolean

    When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

    NOTE: The namespace for rule names on this resource (defined by the name argument) is shared with all rules in the cluster - consider this when naming your rules.

    name string
    The name of the rule. This must be unique in the cluster.
    compute_cluster_id str
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    dependency_vm_group_name str
    The name of the VM group that this rule depends on. The VMs defined in the group specified by vm_group_name will not be started until the VMs in this group are started.
    vm_group_name str
    The name of the VM group that is the subject of this rule. The VMs defined in this group will not be started until the VMs in the group specified by dependency_vm_group_name are started.
    enabled bool
    Enable this rule in the cluster. Default: true.
    mandatory bool

    When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

    NOTE: The namespace for rule names on this resource (defined by the name argument) is shared with all rules in the cluster - consider this when naming your rules.

    name str
    The name of the rule. This must be unique in the cluster.
    computeClusterId String
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    dependencyVmGroupName String
    The name of the VM group that this rule depends on. The VMs defined in the group specified by vm_group_name will not be started until the VMs in this group are started.
    vmGroupName String
    The name of the VM group that is the subject of this rule. The VMs defined in this group will not be started until the VMs in the group specified by dependency_vm_group_name are started.
    enabled Boolean
    Enable this rule in the cluster. Default: true.
    mandatory Boolean

    When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

    NOTE: The namespace for rule names on this resource (defined by the name argument) is shared with all rules in the cluster - consider this when naming your rules.

    name String
    The name of the rule. This must be unique in the cluster.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ComputeClusterVmDependencyRule 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 ComputeClusterVmDependencyRule Resource

    Get an existing ComputeClusterVmDependencyRule 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?: ComputeClusterVmDependencyRuleState, opts?: CustomResourceOptions): ComputeClusterVmDependencyRule
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            compute_cluster_id: Optional[str] = None,
            dependency_vm_group_name: Optional[str] = None,
            enabled: Optional[bool] = None,
            mandatory: Optional[bool] = None,
            name: Optional[str] = None,
            vm_group_name: Optional[str] = None) -> ComputeClusterVmDependencyRule
    func GetComputeClusterVmDependencyRule(ctx *Context, name string, id IDInput, state *ComputeClusterVmDependencyRuleState, opts ...ResourceOption) (*ComputeClusterVmDependencyRule, error)
    public static ComputeClusterVmDependencyRule Get(string name, Input<string> id, ComputeClusterVmDependencyRuleState? state, CustomResourceOptions? opts = null)
    public static ComputeClusterVmDependencyRule get(String name, Output<String> id, ComputeClusterVmDependencyRuleState 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:
    ComputeClusterId string
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    DependencyVmGroupName string
    The name of the VM group that this rule depends on. The VMs defined in the group specified by vm_group_name will not be started until the VMs in this group are started.
    Enabled bool
    Enable this rule in the cluster. Default: true.
    Mandatory bool

    When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

    NOTE: The namespace for rule names on this resource (defined by the name argument) is shared with all rules in the cluster - consider this when naming your rules.

    Name string
    The name of the rule. This must be unique in the cluster.
    VmGroupName string
    The name of the VM group that is the subject of this rule. The VMs defined in this group will not be started until the VMs in the group specified by dependency_vm_group_name are started.
    ComputeClusterId string
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    DependencyVmGroupName string
    The name of the VM group that this rule depends on. The VMs defined in the group specified by vm_group_name will not be started until the VMs in this group are started.
    Enabled bool
    Enable this rule in the cluster. Default: true.
    Mandatory bool

    When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

    NOTE: The namespace for rule names on this resource (defined by the name argument) is shared with all rules in the cluster - consider this when naming your rules.

    Name string
    The name of the rule. This must be unique in the cluster.
    VmGroupName string
    The name of the VM group that is the subject of this rule. The VMs defined in this group will not be started until the VMs in the group specified by dependency_vm_group_name are started.
    computeClusterId String
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    dependencyVmGroupName String
    The name of the VM group that this rule depends on. The VMs defined in the group specified by vm_group_name will not be started until the VMs in this group are started.
    enabled Boolean
    Enable this rule in the cluster. Default: true.
    mandatory Boolean

    When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

    NOTE: The namespace for rule names on this resource (defined by the name argument) is shared with all rules in the cluster - consider this when naming your rules.

    name String
    The name of the rule. This must be unique in the cluster.
    vmGroupName String
    The name of the VM group that is the subject of this rule. The VMs defined in this group will not be started until the VMs in the group specified by dependency_vm_group_name are started.
    computeClusterId string
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    dependencyVmGroupName string
    The name of the VM group that this rule depends on. The VMs defined in the group specified by vm_group_name will not be started until the VMs in this group are started.
    enabled boolean
    Enable this rule in the cluster. Default: true.
    mandatory boolean

    When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

    NOTE: The namespace for rule names on this resource (defined by the name argument) is shared with all rules in the cluster - consider this when naming your rules.

    name string
    The name of the rule. This must be unique in the cluster.
    vmGroupName string
    The name of the VM group that is the subject of this rule. The VMs defined in this group will not be started until the VMs in the group specified by dependency_vm_group_name are started.
    compute_cluster_id str
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    dependency_vm_group_name str
    The name of the VM group that this rule depends on. The VMs defined in the group specified by vm_group_name will not be started until the VMs in this group are started.
    enabled bool
    Enable this rule in the cluster. Default: true.
    mandatory bool

    When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

    NOTE: The namespace for rule names on this resource (defined by the name argument) is shared with all rules in the cluster - consider this when naming your rules.

    name str
    The name of the rule. This must be unique in the cluster.
    vm_group_name str
    The name of the VM group that is the subject of this rule. The VMs defined in this group will not be started until the VMs in the group specified by dependency_vm_group_name are started.
    computeClusterId String
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    dependencyVmGroupName String
    The name of the VM group that this rule depends on. The VMs defined in the group specified by vm_group_name will not be started until the VMs in this group are started.
    enabled Boolean
    Enable this rule in the cluster. Default: true.
    mandatory Boolean

    When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

    NOTE: The namespace for rule names on this resource (defined by the name argument) is shared with all rules in the cluster - consider this when naming your rules.

    name String
    The name of the rule. This must be unique in the cluster.
    vmGroupName String
    The name of the VM group that is the subject of this rule. The VMs defined in this group will not be started until the VMs in the group specified by dependency_vm_group_name are started.

    Package Details

    Repository
    vSphere pulumi/pulumi-vsphere
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vsphere Terraform Provider.
    vsphere logo
    vSphere v4.10.0 published on Tuesday, Mar 12, 2024 by Pulumi