Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vcd Provider
  3. API Docs
  4. UiPlugin
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

vcd.UiPlugin

Explore with Pulumi AI

vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

    Create UiPlugin Resource

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

    Constructor syntax

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

@overload
def UiPlugin(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             enabled: Optional[bool] = None,
             plugin_path: Optional[str] = None,
             provider_scoped: Optional[bool] = None,
             tenant_ids: Optional[Sequence[str]] = None,
             tenant_scoped: Optional[bool] = None,
             ui_plugin_id: Optional[str] = None)
    func NewUiPlugin(ctx *Context, name string, args UiPluginArgs, opts ...ResourceOption) (*UiPlugin, error)
    public UiPlugin(string name, UiPluginArgs args, CustomResourceOptions? opts = null)
    public UiPlugin(String name, UiPluginArgs args)
public UiPlugin(String name, UiPluginArgs args, CustomResourceOptions options)

    type: vcd:UiPlugin
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 UiPluginArgs
    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 UiPluginArgs
    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 UiPluginArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UiPluginArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UiPluginArgs
    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 uiPluginResource = new Vcd.UiPlugin("uiPluginResource", new()
{
    Enabled = false,
    PluginPath = "string",
    ProviderScoped = false,
    TenantIds = new[]
    {
        "string",
    },
    TenantScoped = false,
    UiPluginId = "string",
});

    example, err := vcd.NewUiPlugin(ctx, "uiPluginResource", &vcd.UiPluginArgs{
	Enabled:        pulumi.Bool(false),
	PluginPath:     pulumi.String("string"),
	ProviderScoped: pulumi.Bool(false),
	TenantIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	TenantScoped: pulumi.Bool(false),
	UiPluginId:   pulumi.String("string"),
})

    var uiPluginResource = new UiPlugin("uiPluginResource", UiPluginArgs.builder()
    .enabled(false)
    .pluginPath("string")
    .providerScoped(false)
    .tenantIds("string")
    .tenantScoped(false)
    .uiPluginId("string")
    .build());

    ui_plugin_resource = vcd.UiPlugin("uiPluginResource",
    enabled=False,
    plugin_path="string",
    provider_scoped=False,
    tenant_ids=["string"],
    tenant_scoped=False,
    ui_plugin_id="string")

    const uiPluginResource = new vcd.UiPlugin("uiPluginResource", {
    enabled: false,
    pluginPath: "string",
    providerScoped: false,
    tenantIds: ["string"],
    tenantScoped: false,
    uiPluginId: "string",
});

    type: vcd:UiPlugin
properties:
    enabled: false
    pluginPath: string
    providerScoped: false
    tenantIds:
        - string
    tenantScoped: false
    uiPluginId: string

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

    Enabled bool
    Whether the UI Plugin will be enabled (true) or not (false)
    PluginPath string
    Path to a .zip file that contains the bundled UI Plugin
    ProviderScoped bool
    Can only be set on updates, the initial value is taken from the JSON manifest. Changes the scope of the UI Plugin for System providers. It should be set to true when the UI Plugin is published to the System organization, to prevent unwanted updates-in-place.
    TenantIds List<string>
    The identifiers of the Organizations that will be able to use the UI Plugin if enabled. If not set, it doesn't publish to any Organization.
    TenantScoped bool
    Can only be set on updates, the initial value is taken from the JSON manifest. Changes the scope of the UI Plugin for Organization users. It should be set to true when the UI Plugin is published to any organization, to prevent unwanted updates-in-place.
    UiPluginId string
    Enabled bool
    Whether the UI Plugin will be enabled (true) or not (false)
    PluginPath string
    Path to a .zip file that contains the bundled UI Plugin
    ProviderScoped bool
    Can only be set on updates, the initial value is taken from the JSON manifest. Changes the scope of the UI Plugin for System providers. It should be set to true when the UI Plugin is published to the System organization, to prevent unwanted updates-in-place.
    TenantIds []string
    The identifiers of the Organizations that will be able to use the UI Plugin if enabled. If not set, it doesn't publish to any Organization.
    TenantScoped bool
    Can only be set on updates, the initial value is taken from the JSON manifest. Changes the scope of the UI Plugin for Organization users. It should be set to true when the UI Plugin is published to any organization, to prevent unwanted updates-in-place.
    UiPluginId string
    enabled Boolean
    Whether the UI Plugin will be enabled (true) or not (false)
    pluginPath String
    Path to a .zip file that contains the bundled UI Plugin
    providerScoped Boolean
    Can only be set on updates, the initial value is taken from the JSON manifest. Changes the scope of the UI Plugin for System providers. It should be set to true when the UI Plugin is published to the System organization, to prevent unwanted updates-in-place.
    tenantIds List<String>
    The identifiers of the Organizations that will be able to use the UI Plugin if enabled. If not set, it doesn't publish to any Organization.
    tenantScoped Boolean
    Can only be set on updates, the initial value is taken from the JSON manifest. Changes the scope of the UI Plugin for Organization users. It should be set to true when the UI Plugin is published to any organization, to prevent unwanted updates-in-place.
    uiPluginId String
    enabled boolean
    Whether the UI Plugin will be enabled (true) or not (false)
    pluginPath string
    Path to a .zip file that contains the bundled UI Plugin
    providerScoped boolean
    Can only be set on updates, the initial value is taken from the JSON manifest. Changes the scope of the UI Plugin for System providers. It should be set to true when the UI Plugin is published to the System organization, to prevent unwanted updates-in-place.
    tenantIds string[]
    The identifiers of the Organizations that will be able to use the UI Plugin if enabled. If not set, it doesn't publish to any Organization.
    tenantScoped boolean
    Can only be set on updates, the initial value is taken from the JSON manifest. Changes the scope of the UI Plugin for Organization users. It should be set to true when the UI Plugin is published to any organization, to prevent unwanted updates-in-place.
    uiPluginId string
    enabled bool
    Whether the UI Plugin will be enabled (true) or not (false)
    plugin_path str
    Path to a .zip file that contains the bundled UI Plugin
    provider_scoped bool
    Can only be set on updates, the initial value is taken from the JSON manifest. Changes the scope of the UI Plugin for System providers. It should be set to true when the UI Plugin is published to the System organization, to prevent unwanted updates-in-place.
    tenant_ids Sequence[str]
    The identifiers of the Organizations that will be able to use the UI Plugin if enabled. If not set, it doesn't publish to any Organization.
    tenant_scoped bool
    Can only be set on updates, the initial value is taken from the JSON manifest. Changes the scope of the UI Plugin for Organization users. It should be set to true when the UI Plugin is published to any organization, to prevent unwanted updates-in-place.
    ui_plugin_id str
    enabled Boolean
    Whether the UI Plugin will be enabled (true) or not (false)
    pluginPath String
    Path to a .zip file that contains the bundled UI Plugin
    providerScoped Boolean
    Can only be set on updates, the initial value is taken from the JSON manifest. Changes the scope of the UI Plugin for System providers. It should be set to true when the UI Plugin is published to the System organization, to prevent unwanted updates-in-place.
    tenantIds List<String>
    The identifiers of the Organizations that will be able to use the UI Plugin if enabled. If not set, it doesn't publish to any Organization.
    tenantScoped Boolean
    Can only be set on updates, the initial value is taken from the JSON manifest. Changes the scope of the UI Plugin for Organization users. It should be set to true when the UI Plugin is published to any organization, to prevent unwanted updates-in-place.
    uiPluginId String

    Outputs

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

    Description string
    The description of the UI Plugin
    Id string
    The provider-assigned unique ID for this managed resource.
    License string
    The license of the UI Plugin
    Link string
    The website or custom URL of the UI Plugin
    Name string
    The name of the UI Plugin
    Status string
    The status of the UI Plugin (for example, ready, unavailable, etc)
    Vendor string
    The vendor of the UI Plugin
    Version string
    The version of the UI Plugin
    Description string
    The description of the UI Plugin
    Id string
    The provider-assigned unique ID for this managed resource.
    License string
    The license of the UI Plugin
    Link string
    The website or custom URL of the UI Plugin
    Name string
    The name of the UI Plugin
    Status string
    The status of the UI Plugin (for example, ready, unavailable, etc)
    Vendor string
    The vendor of the UI Plugin
    Version string
    The version of the UI Plugin
    description String
    The description of the UI Plugin
    id String
    The provider-assigned unique ID for this managed resource.
    license String
    The license of the UI Plugin
    link String
    The website or custom URL of the UI Plugin
    name String
    The name of the UI Plugin
    status String
    The status of the UI Plugin (for example, ready, unavailable, etc)
    vendor String
    The vendor of the UI Plugin
    version String
    The version of the UI Plugin
    description string
    The description of the UI Plugin
    id string
    The provider-assigned unique ID for this managed resource.
    license string
    The license of the UI Plugin
    link string
    The website or custom URL of the UI Plugin
    name string
    The name of the UI Plugin
    status string
    The status of the UI Plugin (for example, ready, unavailable, etc)
    vendor string
    The vendor of the UI Plugin
    version string
    The version of the UI Plugin
    description str
    The description of the UI Plugin
    id str
    The provider-assigned unique ID for this managed resource.
    license str
    The license of the UI Plugin
    link str
    The website or custom URL of the UI Plugin
    name str
    The name of the UI Plugin
    status str
    The status of the UI Plugin (for example, ready, unavailable, etc)
    vendor str
    The vendor of the UI Plugin
    version str
    The version of the UI Plugin
    description String
    The description of the UI Plugin
    id String
    The provider-assigned unique ID for this managed resource.
    license String
    The license of the UI Plugin
    link String
    The website or custom URL of the UI Plugin
    name String
    The name of the UI Plugin
    status String
    The status of the UI Plugin (for example, ready, unavailable, etc)
    vendor String
    The vendor of the UI Plugin
    version String
    The version of the UI Plugin

    Look up Existing UiPlugin Resource

    Get an existing UiPlugin 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?: UiPluginState, opts?: CustomResourceOptions): UiPlugin
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        license: Optional[str] = None,
        link: Optional[str] = None,
        name: Optional[str] = None,
        plugin_path: Optional[str] = None,
        provider_scoped: Optional[bool] = None,
        status: Optional[str] = None,
        tenant_ids: Optional[Sequence[str]] = None,
        tenant_scoped: Optional[bool] = None,
        ui_plugin_id: Optional[str] = None,
        vendor: Optional[str] = None,
        version: Optional[str] = None) -> UiPlugin
    func GetUiPlugin(ctx *Context, name string, id IDInput, state *UiPluginState, opts ...ResourceOption) (*UiPlugin, error)
    public static UiPlugin Get(string name, Input<string> id, UiPluginState? state, CustomResourceOptions? opts = null)
    public static UiPlugin get(String name, Output<String> id, UiPluginState state, CustomResourceOptions options)
    resources:  _:    type: vcd:UiPlugin    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:
    Description string
    The description of the UI Plugin
    Enabled bool
    Whether the UI Plugin will be enabled (true) or not (false)
    License string
    The license of the UI Plugin
    Link string
    The website or custom URL of the UI Plugin
    Name string
    The name of the UI Plugin
    PluginPath string
    Path to a .zip file that contains the bundled UI Plugin
    ProviderScoped bool
    Can only be set on updates, the initial value is taken from the JSON manifest. Changes the scope of the UI Plugin for System providers. It should be set to true when the UI Plugin is published to the System organization, to prevent unwanted updates-in-place.
    Status string
    The status of the UI Plugin (for example, ready, unavailable, etc)
    TenantIds List<string>
    The identifiers of the Organizations that will be able to use the UI Plugin if enabled. If not set, it doesn't publish to any Organization.
    TenantScoped bool
    Can only be set on updates, the initial value is taken from the JSON manifest. Changes the scope of the UI Plugin for Organization users. It should be set to true when the UI Plugin is published to any organization, to prevent unwanted updates-in-place.
    UiPluginId string
    Vendor string
    The vendor of the UI Plugin
    Version string
    The version of the UI Plugin
    Description string
    The description of the UI Plugin
    Enabled bool
    Whether the UI Plugin will be enabled (true) or not (false)
    License string
    The license of the UI Plugin
    Link string
    The website or custom URL of the UI Plugin
    Name string
    The name of the UI Plugin
    PluginPath string
    Path to a .zip file that contains the bundled UI Plugin
    ProviderScoped bool
    Can only be set on updates, the initial value is taken from the JSON manifest. Changes the scope of the UI Plugin for System providers. It should be set to true when the UI Plugin is published to the System organization, to prevent unwanted updates-in-place.
    Status string
    The status of the UI Plugin (for example, ready, unavailable, etc)
    TenantIds []string
    The identifiers of the Organizations that will be able to use the UI Plugin if enabled. If not set, it doesn't publish to any Organization.
    TenantScoped bool
    Can only be set on updates, the initial value is taken from the JSON manifest. Changes the scope of the UI Plugin for Organization users. It should be set to true when the UI Plugin is published to any organization, to prevent unwanted updates-in-place.
    UiPluginId string
    Vendor string
    The vendor of the UI Plugin
    Version string
    The version of the UI Plugin
    description String
    The description of the UI Plugin
    enabled Boolean
    Whether the UI Plugin will be enabled (true) or not (false)
    license String
    The license of the UI Plugin
    link String
    The website or custom URL of the UI Plugin
    name String
    The name of the UI Plugin
    pluginPath String
    Path to a .zip file that contains the bundled UI Plugin
    providerScoped Boolean
    Can only be set on updates, the initial value is taken from the JSON manifest. Changes the scope of the UI Plugin for System providers. It should be set to true when the UI Plugin is published to the System organization, to prevent unwanted updates-in-place.
    status String
    The status of the UI Plugin (for example, ready, unavailable, etc)
    tenantIds List<String>
    The identifiers of the Organizations that will be able to use the UI Plugin if enabled. If not set, it doesn't publish to any Organization.
    tenantScoped Boolean
    Can only be set on updates, the initial value is taken from the JSON manifest. Changes the scope of the UI Plugin for Organization users. It should be set to true when the UI Plugin is published to any organization, to prevent unwanted updates-in-place.
    uiPluginId String
    vendor String
    The vendor of the UI Plugin
    version String
    The version of the UI Plugin
    description string
    The description of the UI Plugin
    enabled boolean
    Whether the UI Plugin will be enabled (true) or not (false)
    license string
    The license of the UI Plugin
    link string
    The website or custom URL of the UI Plugin
    name string
    The name of the UI Plugin
    pluginPath string
    Path to a .zip file that contains the bundled UI Plugin
    providerScoped boolean
    Can only be set on updates, the initial value is taken from the JSON manifest. Changes the scope of the UI Plugin for System providers. It should be set to true when the UI Plugin is published to the System organization, to prevent unwanted updates-in-place.
    status string
    The status of the UI Plugin (for example, ready, unavailable, etc)
    tenantIds string[]
    The identifiers of the Organizations that will be able to use the UI Plugin if enabled. If not set, it doesn't publish to any Organization.
    tenantScoped boolean
    Can only be set on updates, the initial value is taken from the JSON manifest. Changes the scope of the UI Plugin for Organization users. It should be set to true when the UI Plugin is published to any organization, to prevent unwanted updates-in-place.
    uiPluginId string
    vendor string
    The vendor of the UI Plugin
    version string
    The version of the UI Plugin
    description str
    The description of the UI Plugin
    enabled bool
    Whether the UI Plugin will be enabled (true) or not (false)
    license str
    The license of the UI Plugin
    link str
    The website or custom URL of the UI Plugin
    name str
    The name of the UI Plugin
    plugin_path str
    Path to a .zip file that contains the bundled UI Plugin
    provider_scoped bool
    Can only be set on updates, the initial value is taken from the JSON manifest. Changes the scope of the UI Plugin for System providers. It should be set to true when the UI Plugin is published to the System organization, to prevent unwanted updates-in-place.
    status str
    The status of the UI Plugin (for example, ready, unavailable, etc)
    tenant_ids Sequence[str]
    The identifiers of the Organizations that will be able to use the UI Plugin if enabled. If not set, it doesn't publish to any Organization.
    tenant_scoped bool
    Can only be set on updates, the initial value is taken from the JSON manifest. Changes the scope of the UI Plugin for Organization users. It should be set to true when the UI Plugin is published to any organization, to prevent unwanted updates-in-place.
    ui_plugin_id str
    vendor str
    The vendor of the UI Plugin
    version str
    The version of the UI Plugin
    description String
    The description of the UI Plugin
    enabled Boolean
    Whether the UI Plugin will be enabled (true) or not (false)
    license String
    The license of the UI Plugin
    link String
    The website or custom URL of the UI Plugin
    name String
    The name of the UI Plugin
    pluginPath String
    Path to a .zip file that contains the bundled UI Plugin
    providerScoped Boolean
    Can only be set on updates, the initial value is taken from the JSON manifest. Changes the scope of the UI Plugin for System providers. It should be set to true when the UI Plugin is published to the System organization, to prevent unwanted updates-in-place.
    status String
    The status of the UI Plugin (for example, ready, unavailable, etc)
    tenantIds List<String>
    The identifiers of the Organizations that will be able to use the UI Plugin if enabled. If not set, it doesn't publish to any Organization.
    tenantScoped Boolean
    Can only be set on updates, the initial value is taken from the JSON manifest. Changes the scope of the UI Plugin for Organization users. It should be set to true when the UI Plugin is published to any organization, to prevent unwanted updates-in-place.
    uiPluginId String
    vendor String
    The vendor of the UI Plugin
    version String
    The version of the UI Plugin

    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
    vmware/terraform-provider-vcd