1. Packages
  2. Vcd Provider
  3. API Docs
  4. OrgVdcTemplateInstance
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

vcd.OrgVdcTemplateInstance

Explore with Pulumi AI

vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

    Create OrgVdcTemplateInstance Resource

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

    Constructor syntax

    new OrgVdcTemplateInstance(name: string, args: OrgVdcTemplateInstanceArgs, opts?: CustomResourceOptions);
    @overload
    def OrgVdcTemplateInstance(resource_name: str,
                               args: OrgVdcTemplateInstanceArgs,
                               opts: Optional[ResourceOptions] = None)
    
    @overload
    def OrgVdcTemplateInstance(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               delete_instantiated_vdc_on_removal: Optional[bool] = None,
                               org_id: Optional[str] = None,
                               org_vdc_template_id: Optional[str] = None,
                               delete_force: Optional[bool] = None,
                               delete_recursive: Optional[bool] = None,
                               description: Optional[str] = None,
                               name: Optional[str] = None,
                               org_vdc_template_instance_id: Optional[str] = None)
    func NewOrgVdcTemplateInstance(ctx *Context, name string, args OrgVdcTemplateInstanceArgs, opts ...ResourceOption) (*OrgVdcTemplateInstance, error)
    public OrgVdcTemplateInstance(string name, OrgVdcTemplateInstanceArgs args, CustomResourceOptions? opts = null)
    public OrgVdcTemplateInstance(String name, OrgVdcTemplateInstanceArgs args)
    public OrgVdcTemplateInstance(String name, OrgVdcTemplateInstanceArgs args, CustomResourceOptions options)
    
    type: vcd:OrgVdcTemplateInstance
    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 OrgVdcTemplateInstanceArgs
    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 OrgVdcTemplateInstanceArgs
    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 OrgVdcTemplateInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OrgVdcTemplateInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OrgVdcTemplateInstanceArgs
    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 orgVdcTemplateInstanceResource = new Vcd.OrgVdcTemplateInstance("orgVdcTemplateInstanceResource", new()
    {
        DeleteInstantiatedVdcOnRemoval = false,
        OrgId = "string",
        OrgVdcTemplateId = "string",
        DeleteForce = false,
        DeleteRecursive = false,
        Description = "string",
        Name = "string",
        OrgVdcTemplateInstanceId = "string",
    });
    
    example, err := vcd.NewOrgVdcTemplateInstance(ctx, "orgVdcTemplateInstanceResource", &vcd.OrgVdcTemplateInstanceArgs{
    	DeleteInstantiatedVdcOnRemoval: pulumi.Bool(false),
    	OrgId:                          pulumi.String("string"),
    	OrgVdcTemplateId:               pulumi.String("string"),
    	DeleteForce:                    pulumi.Bool(false),
    	DeleteRecursive:                pulumi.Bool(false),
    	Description:                    pulumi.String("string"),
    	Name:                           pulumi.String("string"),
    	OrgVdcTemplateInstanceId:       pulumi.String("string"),
    })
    
    var orgVdcTemplateInstanceResource = new OrgVdcTemplateInstance("orgVdcTemplateInstanceResource", OrgVdcTemplateInstanceArgs.builder()
        .deleteInstantiatedVdcOnRemoval(false)
        .orgId("string")
        .orgVdcTemplateId("string")
        .deleteForce(false)
        .deleteRecursive(false)
        .description("string")
        .name("string")
        .orgVdcTemplateInstanceId("string")
        .build());
    
    org_vdc_template_instance_resource = vcd.OrgVdcTemplateInstance("orgVdcTemplateInstanceResource",
        delete_instantiated_vdc_on_removal=False,
        org_id="string",
        org_vdc_template_id="string",
        delete_force=False,
        delete_recursive=False,
        description="string",
        name="string",
        org_vdc_template_instance_id="string")
    
    const orgVdcTemplateInstanceResource = new vcd.OrgVdcTemplateInstance("orgVdcTemplateInstanceResource", {
        deleteInstantiatedVdcOnRemoval: false,
        orgId: "string",
        orgVdcTemplateId: "string",
        deleteForce: false,
        deleteRecursive: false,
        description: "string",
        name: "string",
        orgVdcTemplateInstanceId: "string",
    });
    
    type: vcd:OrgVdcTemplateInstance
    properties:
        deleteForce: false
        deleteInstantiatedVdcOnRemoval: false
        deleteRecursive: false
        description: string
        name: string
        orgId: string
        orgVdcTemplateId: string
        orgVdcTemplateInstanceId: string
    

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

    DeleteInstantiatedVdcOnRemoval bool
    If this flag is set to true, removing this resource will attempt to delete the instantiated VDC
    OrgId string
    ID of the Organization where the VDC will be instantiated
    OrgVdcTemplateId string
    The ID of the VDC Template to instantiate
    DeleteForce bool
    Defaults to false. If this flag is set to true, it forcefully deletes the VDC, only when delete_instantiated_vdc_on_removal=true
    DeleteRecursive bool
    Defaults to false. If this flag is set to true, it recursively deletes the VDC, only when delete_instantiated_vdc_on_removal=true
    Description string
    Description of the instantiated Organization VDC
    Name string
    Name to give to the instantiated Organization VDC
    OrgVdcTemplateInstanceId string
    DeleteInstantiatedVdcOnRemoval bool
    If this flag is set to true, removing this resource will attempt to delete the instantiated VDC
    OrgId string
    ID of the Organization where the VDC will be instantiated
    OrgVdcTemplateId string
    The ID of the VDC Template to instantiate
    DeleteForce bool
    Defaults to false. If this flag is set to true, it forcefully deletes the VDC, only when delete_instantiated_vdc_on_removal=true
    DeleteRecursive bool
    Defaults to false. If this flag is set to true, it recursively deletes the VDC, only when delete_instantiated_vdc_on_removal=true
    Description string
    Description of the instantiated Organization VDC
    Name string
    Name to give to the instantiated Organization VDC
    OrgVdcTemplateInstanceId string
    deleteInstantiatedVdcOnRemoval Boolean
    If this flag is set to true, removing this resource will attempt to delete the instantiated VDC
    orgId String
    ID of the Organization where the VDC will be instantiated
    orgVdcTemplateId String
    The ID of the VDC Template to instantiate
    deleteForce Boolean
    Defaults to false. If this flag is set to true, it forcefully deletes the VDC, only when delete_instantiated_vdc_on_removal=true
    deleteRecursive Boolean
    Defaults to false. If this flag is set to true, it recursively deletes the VDC, only when delete_instantiated_vdc_on_removal=true
    description String
    Description of the instantiated Organization VDC
    name String
    Name to give to the instantiated Organization VDC
    orgVdcTemplateInstanceId String
    deleteInstantiatedVdcOnRemoval boolean
    If this flag is set to true, removing this resource will attempt to delete the instantiated VDC
    orgId string
    ID of the Organization where the VDC will be instantiated
    orgVdcTemplateId string
    The ID of the VDC Template to instantiate
    deleteForce boolean
    Defaults to false. If this flag is set to true, it forcefully deletes the VDC, only when delete_instantiated_vdc_on_removal=true
    deleteRecursive boolean
    Defaults to false. If this flag is set to true, it recursively deletes the VDC, only when delete_instantiated_vdc_on_removal=true
    description string
    Description of the instantiated Organization VDC
    name string
    Name to give to the instantiated Organization VDC
    orgVdcTemplateInstanceId string
    delete_instantiated_vdc_on_removal bool
    If this flag is set to true, removing this resource will attempt to delete the instantiated VDC
    org_id str
    ID of the Organization where the VDC will be instantiated
    org_vdc_template_id str
    The ID of the VDC Template to instantiate
    delete_force bool
    Defaults to false. If this flag is set to true, it forcefully deletes the VDC, only when delete_instantiated_vdc_on_removal=true
    delete_recursive bool
    Defaults to false. If this flag is set to true, it recursively deletes the VDC, only when delete_instantiated_vdc_on_removal=true
    description str
    Description of the instantiated Organization VDC
    name str
    Name to give to the instantiated Organization VDC
    org_vdc_template_instance_id str
    deleteInstantiatedVdcOnRemoval Boolean
    If this flag is set to true, removing this resource will attempt to delete the instantiated VDC
    orgId String
    ID of the Organization where the VDC will be instantiated
    orgVdcTemplateId String
    The ID of the VDC Template to instantiate
    deleteForce Boolean
    Defaults to false. If this flag is set to true, it forcefully deletes the VDC, only when delete_instantiated_vdc_on_removal=true
    deleteRecursive Boolean
    Defaults to false. If this flag is set to true, it recursively deletes the VDC, only when delete_instantiated_vdc_on_removal=true
    description String
    Description of the instantiated Organization VDC
    name String
    Name to give to the instantiated Organization VDC
    orgVdcTemplateInstanceId String

    Outputs

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

    Get an existing OrgVdcTemplateInstance 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?: OrgVdcTemplateInstanceState, opts?: CustomResourceOptions): OrgVdcTemplateInstance
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            delete_force: Optional[bool] = None,
            delete_instantiated_vdc_on_removal: Optional[bool] = None,
            delete_recursive: Optional[bool] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            org_id: Optional[str] = None,
            org_vdc_template_id: Optional[str] = None,
            org_vdc_template_instance_id: Optional[str] = None) -> OrgVdcTemplateInstance
    func GetOrgVdcTemplateInstance(ctx *Context, name string, id IDInput, state *OrgVdcTemplateInstanceState, opts ...ResourceOption) (*OrgVdcTemplateInstance, error)
    public static OrgVdcTemplateInstance Get(string name, Input<string> id, OrgVdcTemplateInstanceState? state, CustomResourceOptions? opts = null)
    public static OrgVdcTemplateInstance get(String name, Output<String> id, OrgVdcTemplateInstanceState state, CustomResourceOptions options)
    resources:  _:    type: vcd:OrgVdcTemplateInstance    get:      id: ${id}
    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:
    DeleteForce bool
    Defaults to false. If this flag is set to true, it forcefully deletes the VDC, only when delete_instantiated_vdc_on_removal=true
    DeleteInstantiatedVdcOnRemoval bool
    If this flag is set to true, removing this resource will attempt to delete the instantiated VDC
    DeleteRecursive bool
    Defaults to false. If this flag is set to true, it recursively deletes the VDC, only when delete_instantiated_vdc_on_removal=true
    Description string
    Description of the instantiated Organization VDC
    Name string
    Name to give to the instantiated Organization VDC
    OrgId string
    ID of the Organization where the VDC will be instantiated
    OrgVdcTemplateId string
    The ID of the VDC Template to instantiate
    OrgVdcTemplateInstanceId string
    DeleteForce bool
    Defaults to false. If this flag is set to true, it forcefully deletes the VDC, only when delete_instantiated_vdc_on_removal=true
    DeleteInstantiatedVdcOnRemoval bool
    If this flag is set to true, removing this resource will attempt to delete the instantiated VDC
    DeleteRecursive bool
    Defaults to false. If this flag is set to true, it recursively deletes the VDC, only when delete_instantiated_vdc_on_removal=true
    Description string
    Description of the instantiated Organization VDC
    Name string
    Name to give to the instantiated Organization VDC
    OrgId string
    ID of the Organization where the VDC will be instantiated
    OrgVdcTemplateId string
    The ID of the VDC Template to instantiate
    OrgVdcTemplateInstanceId string
    deleteForce Boolean
    Defaults to false. If this flag is set to true, it forcefully deletes the VDC, only when delete_instantiated_vdc_on_removal=true
    deleteInstantiatedVdcOnRemoval Boolean
    If this flag is set to true, removing this resource will attempt to delete the instantiated VDC
    deleteRecursive Boolean
    Defaults to false. If this flag is set to true, it recursively deletes the VDC, only when delete_instantiated_vdc_on_removal=true
    description String
    Description of the instantiated Organization VDC
    name String
    Name to give to the instantiated Organization VDC
    orgId String
    ID of the Organization where the VDC will be instantiated
    orgVdcTemplateId String
    The ID of the VDC Template to instantiate
    orgVdcTemplateInstanceId String
    deleteForce boolean
    Defaults to false. If this flag is set to true, it forcefully deletes the VDC, only when delete_instantiated_vdc_on_removal=true
    deleteInstantiatedVdcOnRemoval boolean
    If this flag is set to true, removing this resource will attempt to delete the instantiated VDC
    deleteRecursive boolean
    Defaults to false. If this flag is set to true, it recursively deletes the VDC, only when delete_instantiated_vdc_on_removal=true
    description string
    Description of the instantiated Organization VDC
    name string
    Name to give to the instantiated Organization VDC
    orgId string
    ID of the Organization where the VDC will be instantiated
    orgVdcTemplateId string
    The ID of the VDC Template to instantiate
    orgVdcTemplateInstanceId string
    delete_force bool
    Defaults to false. If this flag is set to true, it forcefully deletes the VDC, only when delete_instantiated_vdc_on_removal=true
    delete_instantiated_vdc_on_removal bool
    If this flag is set to true, removing this resource will attempt to delete the instantiated VDC
    delete_recursive bool
    Defaults to false. If this flag is set to true, it recursively deletes the VDC, only when delete_instantiated_vdc_on_removal=true
    description str
    Description of the instantiated Organization VDC
    name str
    Name to give to the instantiated Organization VDC
    org_id str
    ID of the Organization where the VDC will be instantiated
    org_vdc_template_id str
    The ID of the VDC Template to instantiate
    org_vdc_template_instance_id str
    deleteForce Boolean
    Defaults to false. If this flag is set to true, it forcefully deletes the VDC, only when delete_instantiated_vdc_on_removal=true
    deleteInstantiatedVdcOnRemoval Boolean
    If this flag is set to true, removing this resource will attempt to delete the instantiated VDC
    deleteRecursive Boolean
    Defaults to false. If this flag is set to true, it recursively deletes the VDC, only when delete_instantiated_vdc_on_removal=true
    description String
    Description of the instantiated Organization VDC
    name String
    Name to give to the instantiated Organization VDC
    orgId String
    ID of the Organization where the VDC will be instantiated
    orgVdcTemplateId String
    The ID of the VDC Template to instantiate
    orgVdcTemplateInstanceId String

    Package Details

    Repository
    vcd vmware/terraform-provider-vcd
    License
    Notes
    This Pulumi package is based on the vcd Terraform Provider.
    vcd logo
    vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware