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

vcd.Rde

Explore with Pulumi AI

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

Create Rde Resource

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

Constructor syntax

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

@overload
def Rde(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        rde_type_id: Optional[str] = None,
        resolve: Optional[bool] = None,
        external_id: Optional[str] = None,
        input_entity: Optional[str] = None,
        input_entity_url: Optional[str] = None,
        metadata_entries: Optional[Sequence[RdeMetadataEntryArgs]] = None,
        name: Optional[str] = None,
        org: Optional[str] = None,
        rde_id: Optional[str] = None,
        resolve_on_removal: Optional[bool] = None)
func NewRde(ctx *Context, name string, args RdeArgs, opts ...ResourceOption) (*Rde, error)
public Rde(string name, RdeArgs args, CustomResourceOptions? opts = null)
public Rde(String name, RdeArgs args)
public Rde(String name, RdeArgs args, CustomResourceOptions options)

type: vcd:Rde
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. RdeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. RdeArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. RdeArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. RdeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. RdeArgs
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 rdeResource = new Vcd.Rde("rdeResource", new()
{
    RdeTypeId = "string",
    Resolve = false,
    ExternalId = "string",
    InputEntity = "string",
    InputEntityUrl = "string",
    MetadataEntries = new[]
    {
        new Vcd.Inputs.RdeMetadataEntryArgs
        {
            Key = "string",
            Value = "string",
            Domain = "string",
            Id = "string",
            Namespace = "string",
            Persistent = false,
            Readonly = false,
            Type = "string",
        },
    },
    Name = "string",
    Org = "string",
    RdeId = "string",
    ResolveOnRemoval = false,
});
Copy
example, err := vcd.NewRde(ctx, "rdeResource", &vcd.RdeArgs{
RdeTypeId: pulumi.String("string"),
Resolve: pulumi.Bool(false),
ExternalId: pulumi.String("string"),
InputEntity: pulumi.String("string"),
InputEntityUrl: pulumi.String("string"),
MetadataEntries: .RdeMetadataEntryArray{
&.RdeMetadataEntryArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
Domain: pulumi.String("string"),
Id: pulumi.String("string"),
Namespace: pulumi.String("string"),
Persistent: pulumi.Bool(false),
Readonly: pulumi.Bool(false),
Type: pulumi.String("string"),
},
},
Name: pulumi.String("string"),
Org: pulumi.String("string"),
RdeId: pulumi.String("string"),
ResolveOnRemoval: pulumi.Bool(false),
})
Copy
var rdeResource = new Rde("rdeResource", RdeArgs.builder()
    .rdeTypeId("string")
    .resolve(false)
    .externalId("string")
    .inputEntity("string")
    .inputEntityUrl("string")
    .metadataEntries(RdeMetadataEntryArgs.builder()
        .key("string")
        .value("string")
        .domain("string")
        .id("string")
        .namespace("string")
        .persistent(false)
        .readonly(false)
        .type("string")
        .build())
    .name("string")
    .org("string")
    .rdeId("string")
    .resolveOnRemoval(false)
    .build());
Copy
rde_resource = vcd.Rde("rdeResource",
    rde_type_id="string",
    resolve=False,
    external_id="string",
    input_entity="string",
    input_entity_url="string",
    metadata_entries=[{
        "key": "string",
        "value": "string",
        "domain": "string",
        "id": "string",
        "namespace": "string",
        "persistent": False,
        "readonly": False,
        "type": "string",
    }],
    name="string",
    org="string",
    rde_id="string",
    resolve_on_removal=False)
Copy
const rdeResource = new vcd.Rde("rdeResource", {
    rdeTypeId: "string",
    resolve: false,
    externalId: "string",
    inputEntity: "string",
    inputEntityUrl: "string",
    metadataEntries: [{
        key: "string",
        value: "string",
        domain: "string",
        id: "string",
        namespace: "string",
        persistent: false,
        readonly: false,
        type: "string",
    }],
    name: "string",
    org: "string",
    rdeId: "string",
    resolveOnRemoval: false,
});
Copy
type: vcd:Rde
properties:
    externalId: string
    inputEntity: string
    inputEntityUrl: string
    metadataEntries:
        - domain: string
          id: string
          key: string
          namespace: string
          persistent: false
          readonly: false
          type: string
          value: string
    name: string
    org: string
    rdeId: string
    rdeTypeId: string
    resolve: false
    resolveOnRemoval: false
Copy

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

RdeTypeId This property is required. string
The ID of the RDE Type to instantiate. It only supports updating to a newer/lower version of the same RDE Type.
Resolve This property is required. bool
If true, the Runtime Defined Entity will be resolved by this provider. If false, it won't be resolved and must be done either by an external component action or by an update. The Runtime Defined Entity can't be deleted until the input_entity is resolved by either party, unless resolve_on_removal=true. See RDE resolution for more details.
ExternalId string
An external input_entity's ID that this Runtime Defined Entity may have a relation to.
InputEntity string
A string that specifies a valid JSON for the RDE. It can be retrieved with functions such as file, templatefile... Either input_entity or input_entity_url is required.
InputEntityUrl string
URL that should point to a JSON representation of the Runtime Defined Entity and is used to initialize/override its contents
MetadataEntries List<RdeMetadataEntry>
A set of metadata entries to assign. See Metadata section for details.
Name string
The name of the Runtime Defined Entity. It can be non-unique.
Org string
Name of the Organization that will own the RDE, optional if defined at provider level.
RdeId string
ResolveOnRemoval bool
If true, the Runtime Defined Entity will be resolved before it gets deleted, to ensure forced deletion. Destroy will fail if it is not resolved. It is false by default.
RdeTypeId This property is required. string
The ID of the RDE Type to instantiate. It only supports updating to a newer/lower version of the same RDE Type.
Resolve This property is required. bool
If true, the Runtime Defined Entity will be resolved by this provider. If false, it won't be resolved and must be done either by an external component action or by an update. The Runtime Defined Entity can't be deleted until the input_entity is resolved by either party, unless resolve_on_removal=true. See RDE resolution for more details.
ExternalId string
An external input_entity's ID that this Runtime Defined Entity may have a relation to.
InputEntity string
A string that specifies a valid JSON for the RDE. It can be retrieved with functions such as file, templatefile... Either input_entity or input_entity_url is required.
InputEntityUrl string
URL that should point to a JSON representation of the Runtime Defined Entity and is used to initialize/override its contents
MetadataEntries []RdeMetadataEntryArgs
A set of metadata entries to assign. See Metadata section for details.
Name string
The name of the Runtime Defined Entity. It can be non-unique.
Org string
Name of the Organization that will own the RDE, optional if defined at provider level.
RdeId string
ResolveOnRemoval bool
If true, the Runtime Defined Entity will be resolved before it gets deleted, to ensure forced deletion. Destroy will fail if it is not resolved. It is false by default.
rdeTypeId This property is required. String
The ID of the RDE Type to instantiate. It only supports updating to a newer/lower version of the same RDE Type.
resolve This property is required. Boolean
If true, the Runtime Defined Entity will be resolved by this provider. If false, it won't be resolved and must be done either by an external component action or by an update. The Runtime Defined Entity can't be deleted until the input_entity is resolved by either party, unless resolve_on_removal=true. See RDE resolution for more details.
externalId String
An external input_entity's ID that this Runtime Defined Entity may have a relation to.
inputEntity String
A string that specifies a valid JSON for the RDE. It can be retrieved with functions such as file, templatefile... Either input_entity or input_entity_url is required.
inputEntityUrl String
URL that should point to a JSON representation of the Runtime Defined Entity and is used to initialize/override its contents
metadataEntries List<RdeMetadataEntry>
A set of metadata entries to assign. See Metadata section for details.
name String
The name of the Runtime Defined Entity. It can be non-unique.
org String
Name of the Organization that will own the RDE, optional if defined at provider level.
rdeId String
resolveOnRemoval Boolean
If true, the Runtime Defined Entity will be resolved before it gets deleted, to ensure forced deletion. Destroy will fail if it is not resolved. It is false by default.
rdeTypeId This property is required. string
The ID of the RDE Type to instantiate. It only supports updating to a newer/lower version of the same RDE Type.
resolve This property is required. boolean
If true, the Runtime Defined Entity will be resolved by this provider. If false, it won't be resolved and must be done either by an external component action or by an update. The Runtime Defined Entity can't be deleted until the input_entity is resolved by either party, unless resolve_on_removal=true. See RDE resolution for more details.
externalId string
An external input_entity's ID that this Runtime Defined Entity may have a relation to.
inputEntity string
A string that specifies a valid JSON for the RDE. It can be retrieved with functions such as file, templatefile... Either input_entity or input_entity_url is required.
inputEntityUrl string
URL that should point to a JSON representation of the Runtime Defined Entity and is used to initialize/override its contents
metadataEntries RdeMetadataEntry[]
A set of metadata entries to assign. See Metadata section for details.
name string
The name of the Runtime Defined Entity. It can be non-unique.
org string
Name of the Organization that will own the RDE, optional if defined at provider level.
rdeId string
resolveOnRemoval boolean
If true, the Runtime Defined Entity will be resolved before it gets deleted, to ensure forced deletion. Destroy will fail if it is not resolved. It is false by default.
rde_type_id This property is required. str
The ID of the RDE Type to instantiate. It only supports updating to a newer/lower version of the same RDE Type.
resolve This property is required. bool
If true, the Runtime Defined Entity will be resolved by this provider. If false, it won't be resolved and must be done either by an external component action or by an update. The Runtime Defined Entity can't be deleted until the input_entity is resolved by either party, unless resolve_on_removal=true. See RDE resolution for more details.
external_id str
An external input_entity's ID that this Runtime Defined Entity may have a relation to.
input_entity str
A string that specifies a valid JSON for the RDE. It can be retrieved with functions such as file, templatefile... Either input_entity or input_entity_url is required.
input_entity_url str
URL that should point to a JSON representation of the Runtime Defined Entity and is used to initialize/override its contents
metadata_entries Sequence[RdeMetadataEntryArgs]
A set of metadata entries to assign. See Metadata section for details.
name str
The name of the Runtime Defined Entity. It can be non-unique.
org str
Name of the Organization that will own the RDE, optional if defined at provider level.
rde_id str
resolve_on_removal bool
If true, the Runtime Defined Entity will be resolved before it gets deleted, to ensure forced deletion. Destroy will fail if it is not resolved. It is false by default.
rdeTypeId This property is required. String
The ID of the RDE Type to instantiate. It only supports updating to a newer/lower version of the same RDE Type.
resolve This property is required. Boolean
If true, the Runtime Defined Entity will be resolved by this provider. If false, it won't be resolved and must be done either by an external component action or by an update. The Runtime Defined Entity can't be deleted until the input_entity is resolved by either party, unless resolve_on_removal=true. See RDE resolution for more details.
externalId String
An external input_entity's ID that this Runtime Defined Entity may have a relation to.
inputEntity String
A string that specifies a valid JSON for the RDE. It can be retrieved with functions such as file, templatefile... Either input_entity or input_entity_url is required.
inputEntityUrl String
URL that should point to a JSON representation of the Runtime Defined Entity and is used to initialize/override its contents
metadataEntries List<Property Map>
A set of metadata entries to assign. See Metadata section for details.
name String
The name of the Runtime Defined Entity. It can be non-unique.
org String
Name of the Organization that will own the RDE, optional if defined at provider level.
rdeId String
resolveOnRemoval Boolean
If true, the Runtime Defined Entity will be resolved before it gets deleted, to ensure forced deletion. Destroy will fail if it is not resolved. It is false by default.

Outputs

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

ComputedEntity string
The real state of this RDE in VCD. See Input entity vs Computed entity below for details.
EntityInSync bool
It's true when computed_entity is equal to either input_entity or the contents of input_entity_url, meaning that the computed RDE retrieved from VCD is synchronized with the input RDE.
Id string
The provider-assigned unique ID for this managed resource.
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.
State string
Specifies whether the entity is correctly resolved or not. When created it will be in PRE_CREATED state. If the entity is correctly validated against its RDE Type schema, the state will be RESOLVED, otherwise it will be RESOLUTION_ERROR.
ComputedEntity string
The real state of this RDE in VCD. See Input entity vs Computed entity below for details.
EntityInSync bool
It's true when computed_entity is equal to either input_entity or the contents of input_entity_url, meaning that the computed RDE retrieved from VCD is synchronized with the input RDE.
Id string
The provider-assigned unique ID for this managed resource.
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.
State string
Specifies whether the entity is correctly resolved or not. When created it will be in PRE_CREATED state. If the entity is correctly validated against its RDE Type schema, the state will be RESOLVED, otherwise it will be RESOLUTION_ERROR.
computedEntity String
The real state of this RDE in VCD. See Input entity vs Computed entity below for details.
entityInSync Boolean
It's true when computed_entity is equal to either input_entity or the contents of input_entity_url, meaning that the computed RDE retrieved from VCD is synchronized with the input RDE.
id String
The provider-assigned unique ID for this managed resource.
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.
state String
Specifies whether the entity is correctly resolved or not. When created it will be in PRE_CREATED state. If the entity is correctly validated against its RDE Type schema, the state will be RESOLVED, otherwise it will be RESOLUTION_ERROR.
computedEntity string
The real state of this RDE in VCD. See Input entity vs Computed entity below for details.
entityInSync boolean
It's true when computed_entity is equal to either input_entity or the contents of input_entity_url, meaning that the computed RDE retrieved from VCD is synchronized with the input RDE.
id string
The provider-assigned unique ID for this managed resource.
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.
state string
Specifies whether the entity is correctly resolved or not. When created it will be in PRE_CREATED state. If the entity is correctly validated against its RDE Type schema, the state will be RESOLVED, otherwise it will be RESOLUTION_ERROR.
computed_entity str
The real state of this RDE in VCD. See Input entity vs Computed entity below for details.
entity_in_sync bool
It's true when computed_entity is equal to either input_entity or the contents of input_entity_url, meaning that the computed RDE retrieved from VCD is synchronized with the input RDE.
id str
The provider-assigned unique ID for this managed resource.
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.
state str
Specifies whether the entity is correctly resolved or not. When created it will be in PRE_CREATED state. If the entity is correctly validated against its RDE Type schema, the state will be RESOLVED, otherwise it will be RESOLUTION_ERROR.
computedEntity String
The real state of this RDE in VCD. See Input entity vs Computed entity below for details.
entityInSync Boolean
It's true when computed_entity is equal to either input_entity or the contents of input_entity_url, meaning that the computed RDE retrieved from VCD is synchronized with the input RDE.
id String
The provider-assigned unique ID for this managed resource.
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.
state String
Specifies whether the entity is correctly resolved or not. When created it will be in PRE_CREATED state. If the entity is correctly validated against its RDE Type schema, the state will be RESOLVED, otherwise it will be RESOLUTION_ERROR.

Look up Existing Rde Resource

Get an existing Rde 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?: RdeState, opts?: CustomResourceOptions): Rde
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        computed_entity: Optional[str] = None,
        entity_in_sync: Optional[bool] = None,
        external_id: Optional[str] = None,
        input_entity: Optional[str] = None,
        input_entity_url: Optional[str] = None,
        metadata_entries: Optional[Sequence[RdeMetadataEntryArgs]] = None,
        name: Optional[str] = None,
        org: Optional[str] = None,
        org_id: Optional[str] = None,
        owner_user_id: Optional[str] = None,
        rde_id: Optional[str] = None,
        rde_type_id: Optional[str] = None,
        resolve: Optional[bool] = None,
        resolve_on_removal: Optional[bool] = None,
        state: Optional[str] = None) -> Rde
func GetRde(ctx *Context, name string, id IDInput, state *RdeState, opts ...ResourceOption) (*Rde, error)
public static Rde Get(string name, Input<string> id, RdeState? state, CustomResourceOptions? opts = null)
public static Rde get(String name, Output<String> id, RdeState state, CustomResourceOptions options)
resources:  _:    type: vcd:Rde    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ComputedEntity string
The real state of this RDE in VCD. See Input entity vs Computed entity below for details.
EntityInSync bool
It's true when computed_entity is equal to either input_entity or the contents of input_entity_url, meaning that the computed RDE retrieved from VCD is synchronized with the input RDE.
ExternalId string
An external input_entity's ID that this Runtime Defined Entity may have a relation to.
InputEntity string
A string that specifies a valid JSON for the RDE. It can be retrieved with functions such as file, templatefile... Either input_entity or input_entity_url is required.
InputEntityUrl string
URL that should point to a JSON representation of the Runtime Defined Entity and is used to initialize/override its contents
MetadataEntries List<RdeMetadataEntry>
A set of metadata entries to assign. See Metadata section for details.
Name string
The name of the Runtime Defined Entity. It can be non-unique.
Org string
Name of the Organization that will own the RDE, optional if defined at provider level.
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.
RdeId string
RdeTypeId string
The ID of the RDE Type to instantiate. It only supports updating to a newer/lower version of the same RDE Type.
Resolve bool
If true, the Runtime Defined Entity will be resolved by this provider. If false, it won't be resolved and must be done either by an external component action or by an update. The Runtime Defined Entity can't be deleted until the input_entity is resolved by either party, unless resolve_on_removal=true. See RDE resolution for more details.
ResolveOnRemoval bool
If true, the Runtime Defined Entity will be resolved before it gets deleted, to ensure forced deletion. Destroy will fail if it is not resolved. It is false by default.
State string
Specifies whether the entity is correctly resolved or not. When created it will be in PRE_CREATED state. If the entity is correctly validated against its RDE Type schema, the state will be RESOLVED, otherwise it will be RESOLUTION_ERROR.
ComputedEntity string
The real state of this RDE in VCD. See Input entity vs Computed entity below for details.
EntityInSync bool
It's true when computed_entity is equal to either input_entity or the contents of input_entity_url, meaning that the computed RDE retrieved from VCD is synchronized with the input RDE.
ExternalId string
An external input_entity's ID that this Runtime Defined Entity may have a relation to.
InputEntity string
A string that specifies a valid JSON for the RDE. It can be retrieved with functions such as file, templatefile... Either input_entity or input_entity_url is required.
InputEntityUrl string
URL that should point to a JSON representation of the Runtime Defined Entity and is used to initialize/override its contents
MetadataEntries []RdeMetadataEntryArgs
A set of metadata entries to assign. See Metadata section for details.
Name string
The name of the Runtime Defined Entity. It can be non-unique.
Org string
Name of the Organization that will own the RDE, optional if defined at provider level.
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.
RdeId string
RdeTypeId string
The ID of the RDE Type to instantiate. It only supports updating to a newer/lower version of the same RDE Type.
Resolve bool
If true, the Runtime Defined Entity will be resolved by this provider. If false, it won't be resolved and must be done either by an external component action or by an update. The Runtime Defined Entity can't be deleted until the input_entity is resolved by either party, unless resolve_on_removal=true. See RDE resolution for more details.
ResolveOnRemoval bool
If true, the Runtime Defined Entity will be resolved before it gets deleted, to ensure forced deletion. Destroy will fail if it is not resolved. It is false by default.
State string
Specifies whether the entity is correctly resolved or not. When created it will be in PRE_CREATED state. If the entity is correctly validated against its RDE Type schema, the state will be RESOLVED, otherwise it will be RESOLUTION_ERROR.
computedEntity String
The real state of this RDE in VCD. See Input entity vs Computed entity below for details.
entityInSync Boolean
It's true when computed_entity is equal to either input_entity or the contents of input_entity_url, meaning that the computed RDE retrieved from VCD is synchronized with the input RDE.
externalId String
An external input_entity's ID that this Runtime Defined Entity may have a relation to.
inputEntity String
A string that specifies a valid JSON for the RDE. It can be retrieved with functions such as file, templatefile... Either input_entity or input_entity_url is required.
inputEntityUrl String
URL that should point to a JSON representation of the Runtime Defined Entity and is used to initialize/override its contents
metadataEntries List<RdeMetadataEntry>
A set of metadata entries to assign. See Metadata section for details.
name String
The name of the Runtime Defined Entity. It can be non-unique.
org String
Name of the Organization that will own the RDE, optional if defined at provider level.
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.
rdeId String
rdeTypeId String
The ID of the RDE Type to instantiate. It only supports updating to a newer/lower version of the same RDE Type.
resolve Boolean
If true, the Runtime Defined Entity will be resolved by this provider. If false, it won't be resolved and must be done either by an external component action or by an update. The Runtime Defined Entity can't be deleted until the input_entity is resolved by either party, unless resolve_on_removal=true. See RDE resolution for more details.
resolveOnRemoval Boolean
If true, the Runtime Defined Entity will be resolved before it gets deleted, to ensure forced deletion. Destroy will fail if it is not resolved. It is false by default.
state String
Specifies whether the entity is correctly resolved or not. When created it will be in PRE_CREATED state. If the entity is correctly validated against its RDE Type schema, the state will be RESOLVED, otherwise it will be RESOLUTION_ERROR.
computedEntity string
The real state of this RDE in VCD. See Input entity vs Computed entity below for details.
entityInSync boolean
It's true when computed_entity is equal to either input_entity or the contents of input_entity_url, meaning that the computed RDE retrieved from VCD is synchronized with the input RDE.
externalId string
An external input_entity's ID that this Runtime Defined Entity may have a relation to.
inputEntity string
A string that specifies a valid JSON for the RDE. It can be retrieved with functions such as file, templatefile... Either input_entity or input_entity_url is required.
inputEntityUrl string
URL that should point to a JSON representation of the Runtime Defined Entity and is used to initialize/override its contents
metadataEntries RdeMetadataEntry[]
A set of metadata entries to assign. See Metadata section for details.
name string
The name of the Runtime Defined Entity. It can be non-unique.
org string
Name of the Organization that will own the RDE, optional if defined at provider level.
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.
rdeId string
rdeTypeId string
The ID of the RDE Type to instantiate. It only supports updating to a newer/lower version of the same RDE Type.
resolve boolean
If true, the Runtime Defined Entity will be resolved by this provider. If false, it won't be resolved and must be done either by an external component action or by an update. The Runtime Defined Entity can't be deleted until the input_entity is resolved by either party, unless resolve_on_removal=true. See RDE resolution for more details.
resolveOnRemoval boolean
If true, the Runtime Defined Entity will be resolved before it gets deleted, to ensure forced deletion. Destroy will fail if it is not resolved. It is false by default.
state string
Specifies whether the entity is correctly resolved or not. When created it will be in PRE_CREATED state. If the entity is correctly validated against its RDE Type schema, the state will be RESOLVED, otherwise it will be RESOLUTION_ERROR.
computed_entity str
The real state of this RDE in VCD. See Input entity vs Computed entity below for details.
entity_in_sync bool
It's true when computed_entity is equal to either input_entity or the contents of input_entity_url, meaning that the computed RDE retrieved from VCD is synchronized with the input RDE.
external_id str
An external input_entity's ID that this Runtime Defined Entity may have a relation to.
input_entity str
A string that specifies a valid JSON for the RDE. It can be retrieved with functions such as file, templatefile... Either input_entity or input_entity_url is required.
input_entity_url str
URL that should point to a JSON representation of the Runtime Defined Entity and is used to initialize/override its contents
metadata_entries Sequence[RdeMetadataEntryArgs]
A set of metadata entries to assign. See Metadata section for details.
name str
The name of the Runtime Defined Entity. It can be non-unique.
org str
Name of the Organization that will own the RDE, optional if defined at provider level.
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_id str
rde_type_id str
The ID of the RDE Type to instantiate. It only supports updating to a newer/lower version of the same RDE Type.
resolve bool
If true, the Runtime Defined Entity will be resolved by this provider. If false, it won't be resolved and must be done either by an external component action or by an update. The Runtime Defined Entity can't be deleted until the input_entity is resolved by either party, unless resolve_on_removal=true. See RDE resolution for more details.
resolve_on_removal bool
If true, the Runtime Defined Entity will be resolved before it gets deleted, to ensure forced deletion. Destroy will fail if it is not resolved. It is false by default.
state str
Specifies whether the entity is correctly resolved or not. When created it will be in PRE_CREATED state. If the entity is correctly validated against its RDE Type schema, the state will be RESOLVED, otherwise it will be RESOLUTION_ERROR.
computedEntity String
The real state of this RDE in VCD. See Input entity vs Computed entity below for details.
entityInSync Boolean
It's true when computed_entity is equal to either input_entity or the contents of input_entity_url, meaning that the computed RDE retrieved from VCD is synchronized with the input RDE.
externalId String
An external input_entity's ID that this Runtime Defined Entity may have a relation to.
inputEntity String
A string that specifies a valid JSON for the RDE. It can be retrieved with functions such as file, templatefile... Either input_entity or input_entity_url is required.
inputEntityUrl String
URL that should point to a JSON representation of the Runtime Defined Entity and is used to initialize/override its contents
metadataEntries List<Property Map>
A set of metadata entries to assign. See Metadata section for details.
name String
The name of the Runtime Defined Entity. It can be non-unique.
org String
Name of the Organization that will own the RDE, optional if defined at provider level.
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.
rdeId String
rdeTypeId String
The ID of the RDE Type to instantiate. It only supports updating to a newer/lower version of the same RDE Type.
resolve Boolean
If true, the Runtime Defined Entity will be resolved by this provider. If false, it won't be resolved and must be done either by an external component action or by an update. The Runtime Defined Entity can't be deleted until the input_entity is resolved by either party, unless resolve_on_removal=true. See RDE resolution for more details.
resolveOnRemoval Boolean
If true, the Runtime Defined Entity will be resolved before it gets deleted, to ensure forced deletion. Destroy will fail if it is not resolved. It is false by default.
state String
Specifies whether the entity is correctly resolved or not. When created it will be in PRE_CREATED state. If the entity is correctly validated against its RDE Type schema, the state will be RESOLVED, otherwise it will be RESOLUTION_ERROR.

Supporting Types

RdeMetadataEntry
, RdeMetadataEntryArgs

Key This property is required. string
Key of this metadata entry. Required if the metadata entry is not empty
Value This property is required. string
Value of this metadata entry. Required if the metadata entry is not empty
Domain string
Only meaningful for providers. Allows them to share entries with their tenants. Currently, accepted values are: TENANT, PROVIDER
Id string
ID of the metadata entry
Namespace string
Namespace of the metadata entry
Persistent bool
Persistent metadata entries can be copied over on some entity operation
Readonly bool
True if the metadata entry is read only
Type string
Type of this metadata entry. One of: 'StringEntry', 'NumberEntry', 'BoolEntry'
Key This property is required. string
Key of this metadata entry. Required if the metadata entry is not empty
Value This property is required. string
Value of this metadata entry. Required if the metadata entry is not empty
Domain string
Only meaningful for providers. Allows them to share entries with their tenants. Currently, accepted values are: TENANT, PROVIDER
Id string
ID of the metadata entry
Namespace string
Namespace of the metadata entry
Persistent bool
Persistent metadata entries can be copied over on some entity operation
Readonly bool
True if the metadata entry is read only
Type string
Type of this metadata entry. One of: 'StringEntry', 'NumberEntry', 'BoolEntry'
key This property is required. String
Key of this metadata entry. Required if the metadata entry is not empty
value This property is required. String
Value of this metadata entry. Required if the metadata entry is not empty
domain String
Only meaningful for providers. Allows them to share entries with their tenants. Currently, accepted values are: TENANT, PROVIDER
id String
ID of the metadata entry
namespace String
Namespace of the metadata entry
persistent Boolean
Persistent metadata entries can be copied over on some entity operation
readonly Boolean
True if the metadata entry is read only
type String
Type of this metadata entry. One of: 'StringEntry', 'NumberEntry', 'BoolEntry'
key This property is required. string
Key of this metadata entry. Required if the metadata entry is not empty
value This property is required. string
Value of this metadata entry. Required if the metadata entry is not empty
domain string
Only meaningful for providers. Allows them to share entries with their tenants. Currently, accepted values are: TENANT, PROVIDER
id string
ID of the metadata entry
namespace string
Namespace of the metadata entry
persistent boolean
Persistent metadata entries can be copied over on some entity operation
readonly boolean
True if the metadata entry is read only
type string
Type of this metadata entry. One of: 'StringEntry', 'NumberEntry', 'BoolEntry'
key This property is required. str
Key of this metadata entry. Required if the metadata entry is not empty
value This property is required. str
Value of this metadata entry. Required if the metadata entry is not empty
domain str
Only meaningful for providers. Allows them to share entries with their tenants. Currently, accepted values are: TENANT, PROVIDER
id str
ID of the metadata entry
namespace str
Namespace of the metadata entry
persistent bool
Persistent metadata entries can be copied over on some entity operation
readonly bool
True if the metadata entry is read only
type str
Type of this metadata entry. One of: 'StringEntry', 'NumberEntry', 'BoolEntry'
key This property is required. String
Key of this metadata entry. Required if the metadata entry is not empty
value This property is required. String
Value of this metadata entry. Required if the metadata entry is not empty
domain String
Only meaningful for providers. Allows them to share entries with their tenants. Currently, accepted values are: TENANT, PROVIDER
id String
ID of the metadata entry
namespace String
Namespace of the metadata entry
persistent Boolean
Persistent metadata entries can be copied over on some entity operation
readonly Boolean
True if the metadata entry is read only
type String
Type of this metadata entry. One of: 'StringEntry', 'NumberEntry', 'BoolEntry'

Package Details

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