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

vcd.ExternalEndpoint

Explore with Pulumi AI

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

Create ExternalEndpoint Resource

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

Constructor syntax

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

@overload
def ExternalEndpoint(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     enabled: Optional[bool] = None,
                     root_url: Optional[str] = None,
                     vendor: Optional[str] = None,
                     version: Optional[str] = None,
                     description: Optional[str] = None,
                     disable_on_removal: Optional[bool] = None,
                     external_endpoint_id: Optional[str] = None,
                     name: Optional[str] = None)
func NewExternalEndpoint(ctx *Context, name string, args ExternalEndpointArgs, opts ...ResourceOption) (*ExternalEndpoint, error)
public ExternalEndpoint(string name, ExternalEndpointArgs args, CustomResourceOptions? opts = null)
public ExternalEndpoint(String name, ExternalEndpointArgs args)
public ExternalEndpoint(String name, ExternalEndpointArgs args, CustomResourceOptions options)

type: vcd:ExternalEndpoint
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. ExternalEndpointArgs
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. ExternalEndpointArgs
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. ExternalEndpointArgs
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. ExternalEndpointArgs
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. ExternalEndpointArgs
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 externalEndpointResource = new Vcd.ExternalEndpoint("externalEndpointResource", new()
{
    Enabled = false,
    RootUrl = "string",
    Vendor = "string",
    Version = "string",
    Description = "string",
    DisableOnRemoval = false,
    ExternalEndpointId = "string",
    Name = "string",
});
Copy
example, err := vcd.NewExternalEndpoint(ctx, "externalEndpointResource", &vcd.ExternalEndpointArgs{
	Enabled:            pulumi.Bool(false),
	RootUrl:            pulumi.String("string"),
	Vendor:             pulumi.String("string"),
	Version:            pulumi.String("string"),
	Description:        pulumi.String("string"),
	DisableOnRemoval:   pulumi.Bool(false),
	ExternalEndpointId: pulumi.String("string"),
	Name:               pulumi.String("string"),
})
Copy
var externalEndpointResource = new ExternalEndpoint("externalEndpointResource", ExternalEndpointArgs.builder()
    .enabled(false)
    .rootUrl("string")
    .vendor("string")
    .version("string")
    .description("string")
    .disableOnRemoval(false)
    .externalEndpointId("string")
    .name("string")
    .build());
Copy
external_endpoint_resource = vcd.ExternalEndpoint("externalEndpointResource",
    enabled=False,
    root_url="string",
    vendor="string",
    version="string",
    description="string",
    disable_on_removal=False,
    external_endpoint_id="string",
    name="string")
Copy
const externalEndpointResource = new vcd.ExternalEndpoint("externalEndpointResource", {
    enabled: false,
    rootUrl: "string",
    vendor: "string",
    version: "string",
    description: "string",
    disableOnRemoval: false,
    externalEndpointId: "string",
    name: "string",
});
Copy
type: vcd:ExternalEndpoint
properties:
    description: string
    disableOnRemoval: false
    enabled: false
    externalEndpointId: string
    name: string
    rootUrl: string
    vendor: string
    version: string
Copy

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

Enabled This property is required. bool
Whether the External Endpoint is enabled or not. Must be false before removing this resource, otherwise deletion will fail. To disable it automatically on removal, set disable_on_removal=true (see below)
RootUrl This property is required. string
The endpoint which requests will be redirected to. Must use HTTPS protocol
Vendor This property is required. string
The vendor name of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
Version This property is required. string
The version of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
Description string
Description of the External Endpoint
DisableOnRemoval bool
Whether the External Endpoint should be disabled before a delete operation, to flawlessly remove it even if it is enabled. It is false by default
ExternalEndpointId string
Name string
The name of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
Enabled This property is required. bool
Whether the External Endpoint is enabled or not. Must be false before removing this resource, otherwise deletion will fail. To disable it automatically on removal, set disable_on_removal=true (see below)
RootUrl This property is required. string
The endpoint which requests will be redirected to. Must use HTTPS protocol
Vendor This property is required. string
The vendor name of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
Version This property is required. string
The version of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
Description string
Description of the External Endpoint
DisableOnRemoval bool
Whether the External Endpoint should be disabled before a delete operation, to flawlessly remove it even if it is enabled. It is false by default
ExternalEndpointId string
Name string
The name of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
enabled This property is required. Boolean
Whether the External Endpoint is enabled or not. Must be false before removing this resource, otherwise deletion will fail. To disable it automatically on removal, set disable_on_removal=true (see below)
rootUrl This property is required. String
The endpoint which requests will be redirected to. Must use HTTPS protocol
vendor This property is required. String
The vendor name of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
version This property is required. String
The version of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
description String
Description of the External Endpoint
disableOnRemoval Boolean
Whether the External Endpoint should be disabled before a delete operation, to flawlessly remove it even if it is enabled. It is false by default
externalEndpointId String
name String
The name of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
enabled This property is required. boolean
Whether the External Endpoint is enabled or not. Must be false before removing this resource, otherwise deletion will fail. To disable it automatically on removal, set disable_on_removal=true (see below)
rootUrl This property is required. string
The endpoint which requests will be redirected to. Must use HTTPS protocol
vendor This property is required. string
The vendor name of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
version This property is required. string
The version of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
description string
Description of the External Endpoint
disableOnRemoval boolean
Whether the External Endpoint should be disabled before a delete operation, to flawlessly remove it even if it is enabled. It is false by default
externalEndpointId string
name string
The name of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
enabled This property is required. bool
Whether the External Endpoint is enabled or not. Must be false before removing this resource, otherwise deletion will fail. To disable it automatically on removal, set disable_on_removal=true (see below)
root_url This property is required. str
The endpoint which requests will be redirected to. Must use HTTPS protocol
vendor This property is required. str
The vendor name of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
version This property is required. str
The version of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
description str
Description of the External Endpoint
disable_on_removal bool
Whether the External Endpoint should be disabled before a delete operation, to flawlessly remove it even if it is enabled. It is false by default
external_endpoint_id str
name str
The name of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
enabled This property is required. Boolean
Whether the External Endpoint is enabled or not. Must be false before removing this resource, otherwise deletion will fail. To disable it automatically on removal, set disable_on_removal=true (see below)
rootUrl This property is required. String
The endpoint which requests will be redirected to. Must use HTTPS protocol
vendor This property is required. String
The vendor name of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
version This property is required. String
The version of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
description String
Description of the External Endpoint
disableOnRemoval Boolean
Whether the External Endpoint should be disabled before a delete operation, to flawlessly remove it even if it is enabled. It is false by default
externalEndpointId String
name String
The name of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation

Outputs

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

Get an existing ExternalEndpoint 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?: ExternalEndpointState, opts?: CustomResourceOptions): ExternalEndpoint
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        disable_on_removal: Optional[bool] = None,
        enabled: Optional[bool] = None,
        external_endpoint_id: Optional[str] = None,
        name: Optional[str] = None,
        root_url: Optional[str] = None,
        vendor: Optional[str] = None,
        version: Optional[str] = None) -> ExternalEndpoint
func GetExternalEndpoint(ctx *Context, name string, id IDInput, state *ExternalEndpointState, opts ...ResourceOption) (*ExternalEndpoint, error)
public static ExternalEndpoint Get(string name, Input<string> id, ExternalEndpointState? state, CustomResourceOptions? opts = null)
public static ExternalEndpoint get(String name, Output<String> id, ExternalEndpointState state, CustomResourceOptions options)
resources:  _:    type: vcd:ExternalEndpoint    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:
Description string
Description of the External Endpoint
DisableOnRemoval bool
Whether the External Endpoint should be disabled before a delete operation, to flawlessly remove it even if it is enabled. It is false by default
Enabled bool
Whether the External Endpoint is enabled or not. Must be false before removing this resource, otherwise deletion will fail. To disable it automatically on removal, set disable_on_removal=true (see below)
ExternalEndpointId string
Name string
The name of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
RootUrl string
The endpoint which requests will be redirected to. Must use HTTPS protocol
Vendor string
The vendor name of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
Version string
The version of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
Description string
Description of the External Endpoint
DisableOnRemoval bool
Whether the External Endpoint should be disabled before a delete operation, to flawlessly remove it even if it is enabled. It is false by default
Enabled bool
Whether the External Endpoint is enabled or not. Must be false before removing this resource, otherwise deletion will fail. To disable it automatically on removal, set disable_on_removal=true (see below)
ExternalEndpointId string
Name string
The name of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
RootUrl string
The endpoint which requests will be redirected to. Must use HTTPS protocol
Vendor string
The vendor name of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
Version string
The version of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
description String
Description of the External Endpoint
disableOnRemoval Boolean
Whether the External Endpoint should be disabled before a delete operation, to flawlessly remove it even if it is enabled. It is false by default
enabled Boolean
Whether the External Endpoint is enabled or not. Must be false before removing this resource, otherwise deletion will fail. To disable it automatically on removal, set disable_on_removal=true (see below)
externalEndpointId String
name String
The name of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
rootUrl String
The endpoint which requests will be redirected to. Must use HTTPS protocol
vendor String
The vendor name of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
version String
The version of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
description string
Description of the External Endpoint
disableOnRemoval boolean
Whether the External Endpoint should be disabled before a delete operation, to flawlessly remove it even if it is enabled. It is false by default
enabled boolean
Whether the External Endpoint is enabled or not. Must be false before removing this resource, otherwise deletion will fail. To disable it automatically on removal, set disable_on_removal=true (see below)
externalEndpointId string
name string
The name of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
rootUrl string
The endpoint which requests will be redirected to. Must use HTTPS protocol
vendor string
The vendor name of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
version string
The version of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
description str
Description of the External Endpoint
disable_on_removal bool
Whether the External Endpoint should be disabled before a delete operation, to flawlessly remove it even if it is enabled. It is false by default
enabled bool
Whether the External Endpoint is enabled or not. Must be false before removing this resource, otherwise deletion will fail. To disable it automatically on removal, set disable_on_removal=true (see below)
external_endpoint_id str
name str
The name of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
root_url str
The endpoint which requests will be redirected to. Must use HTTPS protocol
vendor str
The vendor name of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
version str
The version of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
description String
Description of the External Endpoint
disableOnRemoval Boolean
Whether the External Endpoint should be disabled before a delete operation, to flawlessly remove it even if it is enabled. It is false by default
enabled Boolean
Whether the External Endpoint is enabled or not. Must be false before removing this resource, otherwise deletion will fail. To disable it automatically on removal, set disable_on_removal=true (see below)
externalEndpointId String
name String
The name of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
rootUrl String
The endpoint which requests will be redirected to. Must use HTTPS protocol
vendor String
The vendor name of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation
version String
The version of the External Endpoint. The combination of vendor + name + version must be unique. Can't be modified after creation

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