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

vcd.getRde

Explore with Pulumi AI

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

    Provides the capability of reading an existing Runtime Defined Entity in VMware Cloud Director.

    VCD allows to have multiple RDEs of the same RDE Type with the same name, meaning that the data source will not be able to fetch a RDE in this situation, as this data source can only retrieve unique RDEs.

    Supported in provider v3.9+

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vcd.VcdFunctions;
import com.pulumi.vcd.inputs.GetRdeTypeArgs;
import com.pulumi.vcd.inputs.GetRdeArgs;
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) {
        final var myType = VcdFunctions.getRdeType(GetRdeTypeArgs.builder()
            .vendor("bigcorp")
            .namespace("tech1")
            .version("1.2.3")
            .build());

        final var myRde = VcdFunctions.getRde(GetRdeArgs.builder()
            .org("my-org")
            .rdeTypeId(data.vcd_rde_type().my-type().id())
            .name("My custom RDE")
            .build());

        ctx.export("rdeOutput", vcd_rde.my_rde().entity());
    }
}

    variables:
  myType:
    fn::invoke:
      function: vcd:getRdeType
      arguments:
        vendor: bigcorp
        namespace: tech1
        version: 1.2.3
  myRde:
    fn::invoke:
      function: vcd:getRde
      arguments:
        org: my-org
        rdeTypeId: ${data.vcd_rde_type"my-type"[%!s(MISSING)].id}
        name: My custom RDE
outputs:
  rdeOutput: ${vcd_rde.my_rde.entity}

    Using getRde

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRde(args: GetRdeArgs, opts?: InvokeOptions): Promise<GetRdeResult>
function getRdeOutput(args: GetRdeOutputArgs, opts?: InvokeOptions): Output<GetRdeResult>
    def get_rde(id: Optional[str] = None,
            name: Optional[str] = None,
            org: Optional[str] = None,
            rde_type_id: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetRdeResult
def get_rde_output(id: Optional[pulumi.Input[str]] = None,
            name: Optional[pulumi.Input[str]] = None,
            org: Optional[pulumi.Input[str]] = None,
            rde_type_id: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetRdeResult]
    func LookupRde(ctx *Context, args *LookupRdeArgs, opts ...InvokeOption) (*LookupRdeResult, error)
func LookupRdeOutput(ctx *Context, args *LookupRdeOutputArgs, opts ...InvokeOption) LookupRdeResultOutput

    > Note: This function is named LookupRde in the Go SDK.

    public static class GetRde 
{
    public static Task<GetRdeResult> InvokeAsync(GetRdeArgs args, InvokeOptions? opts = null)
    public static Output<GetRdeResult> Invoke(GetRdeInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRdeResult> getRde(GetRdeArgs args, InvokeOptions options)
public static Output<GetRdeResult> getRde(GetRdeArgs args, InvokeOptions options)

    fn::invoke:
  function: vcd:index/getRde:getRde
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the Runtime Defined Entity.
    RdeTypeId string
    The ID of the RDE Type of the RDE to fetch.
    Id string
    Org string
    Name of the Organization that owns the RDE, optional if defined at provider level.
    Name string
    The name of the Runtime Defined Entity.
    RdeTypeId string
    The ID of the RDE Type of the RDE to fetch.
    Id string
    Org string
    Name of the Organization that owns the RDE, optional if defined at provider level.
    name String
    The name of the Runtime Defined Entity.
    rdeTypeId String
    The ID of the RDE Type of the RDE to fetch.
    id String
    org String
    Name of the Organization that owns the RDE, optional if defined at provider level.
    name string
    The name of the Runtime Defined Entity.
    rdeTypeId string
    The ID of the RDE Type of the RDE to fetch.
    id string
    org string
    Name of the Organization that owns the RDE, optional if defined at provider level.
    name str
    The name of the Runtime Defined Entity.
    rde_type_id str
    The ID of the RDE Type of the RDE to fetch.
    id str
    org str
    Name of the Organization that owns the RDE, optional if defined at provider level.
    name String
    The name of the Runtime Defined Entity.
    rdeTypeId String
    The ID of the RDE Type of the RDE to fetch.
    id String
    org String
    Name of the Organization that owns the RDE, optional if defined at provider level.

    getRde Result

    The following output properties are available:

    Entity string
    The entity JSON.
    ExternalId string
    Id string
    MetadataEntries List<GetRdeMetadataEntry>
    A set of metadata entries that belong to the RDE. Read the resource documentation for the details of the sub-attributes.
    Name string
    OrgId string
    The ID of the Organization to which the Runtime Defined Entity belongs.
    OwnerUserId string
    The ID of the Organization user that owns this Runtime Defined Entity.
    RdeTypeId string
    State string
    It can be RESOLVED, RESOLUTION_ERROR or PRE_CREATED.
    Org string
    Entity string
    The entity JSON.
    ExternalId string
    Id string
    MetadataEntries []GetRdeMetadataEntry
    A set of metadata entries that belong to the RDE. Read the resource documentation for the details of the sub-attributes.
    Name string
    OrgId string
    The ID of the Organization to which the Runtime Defined Entity belongs.
    OwnerUserId string
    The ID of the Organization user that owns this Runtime Defined Entity.
    RdeTypeId string
    State string
    It can be RESOLVED, RESOLUTION_ERROR or PRE_CREATED.
    Org string
    entity String
    The entity JSON.
    externalId String
    id String
    metadataEntries List<GetRdeMetadataEntry>
    A set of metadata entries that belong to the RDE. Read the resource documentation for the details of the sub-attributes.
    name String
    orgId String
    The ID of the Organization to which the Runtime Defined Entity belongs.
    ownerUserId String
    The ID of the Organization user that owns this Runtime Defined Entity.
    rdeTypeId String
    state String
    It can be RESOLVED, RESOLUTION_ERROR or PRE_CREATED.
    org String
    entity string
    The entity JSON.
    externalId string
    id string
    metadataEntries GetRdeMetadataEntry[]
    A set of metadata entries that belong to the RDE. Read the resource documentation for the details of the sub-attributes.
    name string
    orgId string
    The ID of the Organization to which the Runtime Defined Entity belongs.
    ownerUserId string
    The ID of the Organization user that owns this Runtime Defined Entity.
    rdeTypeId string
    state string
    It can be RESOLVED, RESOLUTION_ERROR or PRE_CREATED.
    org string
    entity str
    The entity JSON.
    external_id str
    id str
    metadata_entries Sequence[GetRdeMetadataEntry]
    A set of metadata entries that belong to the RDE. Read the resource documentation for the details of the sub-attributes.
    name str
    org_id str
    The ID of the Organization to which the Runtime Defined Entity belongs.
    owner_user_id str
    The ID of the Organization user that owns this Runtime Defined Entity.
    rde_type_id str
    state str
    It can be RESOLVED, RESOLUTION_ERROR or PRE_CREATED.
    org str
    entity String
    The entity JSON.
    externalId String
    id String
    metadataEntries List<Property Map>
    A set of metadata entries that belong to the RDE. Read the resource documentation for the details of the sub-attributes.
    name String
    orgId String
    The ID of the Organization to which the Runtime Defined Entity belongs.
    ownerUserId String
    The ID of the Organization user that owns this Runtime Defined Entity.
    rdeTypeId String
    state String
    It can be RESOLVED, RESOLUTION_ERROR or PRE_CREATED.
    org String

    Supporting Types

    GetRdeMetadataEntry

    Domain string
    Id string
    Key string
    Namespace string
    Persistent bool
    Readonly bool
    Type string
    Value string
    Domain string
    Id string
    Key string
    Namespace string
    Persistent bool
    Readonly bool
    Type string
    Value string
    domain String
    id String
    key String
    namespace String
    persistent Boolean
    readonly Boolean
    type String
    value String
    domain string
    id string
    key string
    namespace string
    persistent boolean
    readonly boolean
    type string
    value string
    domain str
    id str
    key str
    namespace str
    persistent bool
    readonly bool
    type str
    value str
    domain String
    id String
    key String
    namespace String
    persistent Boolean
    readonly Boolean
    type String
    value 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
    vmware/terraform-provider-vcd