1. Packages
  2. Nsxt Provider
  3. API Docs
  4. VpcExternalAddress
nsxt 3.9.0 published on Friday, Jun 20, 2025 by vmware

nsxt.VpcExternalAddress

Explore with Pulumi AI

nsxt logo
nsxt 3.9.0 published on Friday, Jun 20, 2025 by vmware

    Create VpcExternalAddress Resource

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

    Constructor syntax

    new VpcExternalAddress(name: string, args: VpcExternalAddressArgs, opts?: CustomResourceOptions);
    @overload
    def VpcExternalAddress(resource_name: str,
                           args: VpcExternalAddressArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def VpcExternalAddress(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           allocated_external_ip_path: Optional[str] = None,
                           parent_path: Optional[str] = None,
                           vpc_external_address_id: Optional[str] = None)
    func NewVpcExternalAddress(ctx *Context, name string, args VpcExternalAddressArgs, opts ...ResourceOption) (*VpcExternalAddress, error)
    public VpcExternalAddress(string name, VpcExternalAddressArgs args, CustomResourceOptions? opts = null)
    public VpcExternalAddress(String name, VpcExternalAddressArgs args)
    public VpcExternalAddress(String name, VpcExternalAddressArgs args, CustomResourceOptions options)
    
    type: nsxt:VpcExternalAddress
    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 VpcExternalAddressArgs
    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 VpcExternalAddressArgs
    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 VpcExternalAddressArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VpcExternalAddressArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VpcExternalAddressArgs
    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 vpcExternalAddressResource = new Nsxt.VpcExternalAddress("vpcExternalAddressResource", new()
    {
        AllocatedExternalIpPath = "string",
        ParentPath = "string",
        VpcExternalAddressId = "string",
    });
    
    example, err := nsxt.NewVpcExternalAddress(ctx, "vpcExternalAddressResource", &nsxt.VpcExternalAddressArgs{
    	AllocatedExternalIpPath: pulumi.String("string"),
    	ParentPath:              pulumi.String("string"),
    	VpcExternalAddressId:    pulumi.String("string"),
    })
    
    var vpcExternalAddressResource = new VpcExternalAddress("vpcExternalAddressResource", VpcExternalAddressArgs.builder()
        .allocatedExternalIpPath("string")
        .parentPath("string")
        .vpcExternalAddressId("string")
        .build());
    
    vpc_external_address_resource = nsxt.VpcExternalAddress("vpcExternalAddressResource",
        allocated_external_ip_path="string",
        parent_path="string",
        vpc_external_address_id="string")
    
    const vpcExternalAddressResource = new nsxt.VpcExternalAddress("vpcExternalAddressResource", {
        allocatedExternalIpPath: "string",
        parentPath: "string",
        vpcExternalAddressId: "string",
    });
    
    type: nsxt:VpcExternalAddress
    properties:
        allocatedExternalIpPath: string
        parentPath: string
        vpcExternalAddressId: string
    

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

    AllocatedExternalIpPath string
    Policy path for an external IP address allocation object.
    ParentPath string
    Policy path for the Subnet Port.
    VpcExternalAddressId string
    AllocatedExternalIpPath string
    Policy path for an external IP address allocation object.
    ParentPath string
    Policy path for the Subnet Port.
    VpcExternalAddressId string
    allocatedExternalIpPath String
    Policy path for an external IP address allocation object.
    parentPath String
    Policy path for the Subnet Port.
    vpcExternalAddressId String
    allocatedExternalIpPath string
    Policy path for an external IP address allocation object.
    parentPath string
    Policy path for the Subnet Port.
    vpcExternalAddressId string
    allocated_external_ip_path str
    Policy path for an external IP address allocation object.
    parent_path str
    Policy path for the Subnet Port.
    vpc_external_address_id str
    allocatedExternalIpPath String
    Policy path for an external IP address allocation object.
    parentPath String
    Policy path for the Subnet Port.
    vpcExternalAddressId String

    Outputs

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

    ExternalIpAddress string
    The actual IP address that was allocated with allocated_external_ip_path.
    Id string
    The provider-assigned unique ID for this managed resource.
    ExternalIpAddress string
    The actual IP address that was allocated with allocated_external_ip_path.
    Id string
    The provider-assigned unique ID for this managed resource.
    externalIpAddress String
    The actual IP address that was allocated with allocated_external_ip_path.
    id String
    The provider-assigned unique ID for this managed resource.
    externalIpAddress string
    The actual IP address that was allocated with allocated_external_ip_path.
    id string
    The provider-assigned unique ID for this managed resource.
    external_ip_address str
    The actual IP address that was allocated with allocated_external_ip_path.
    id str
    The provider-assigned unique ID for this managed resource.
    externalIpAddress String
    The actual IP address that was allocated with allocated_external_ip_path.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing VpcExternalAddress Resource

    Get an existing VpcExternalAddress 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?: VpcExternalAddressState, opts?: CustomResourceOptions): VpcExternalAddress
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            allocated_external_ip_path: Optional[str] = None,
            external_ip_address: Optional[str] = None,
            parent_path: Optional[str] = None,
            vpc_external_address_id: Optional[str] = None) -> VpcExternalAddress
    func GetVpcExternalAddress(ctx *Context, name string, id IDInput, state *VpcExternalAddressState, opts ...ResourceOption) (*VpcExternalAddress, error)
    public static VpcExternalAddress Get(string name, Input<string> id, VpcExternalAddressState? state, CustomResourceOptions? opts = null)
    public static VpcExternalAddress get(String name, Output<String> id, VpcExternalAddressState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:VpcExternalAddress    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:
    AllocatedExternalIpPath string
    Policy path for an external IP address allocation object.
    ExternalIpAddress string
    The actual IP address that was allocated with allocated_external_ip_path.
    ParentPath string
    Policy path for the Subnet Port.
    VpcExternalAddressId string
    AllocatedExternalIpPath string
    Policy path for an external IP address allocation object.
    ExternalIpAddress string
    The actual IP address that was allocated with allocated_external_ip_path.
    ParentPath string
    Policy path for the Subnet Port.
    VpcExternalAddressId string
    allocatedExternalIpPath String
    Policy path for an external IP address allocation object.
    externalIpAddress String
    The actual IP address that was allocated with allocated_external_ip_path.
    parentPath String
    Policy path for the Subnet Port.
    vpcExternalAddressId String
    allocatedExternalIpPath string
    Policy path for an external IP address allocation object.
    externalIpAddress string
    The actual IP address that was allocated with allocated_external_ip_path.
    parentPath string
    Policy path for the Subnet Port.
    vpcExternalAddressId string
    allocated_external_ip_path str
    Policy path for an external IP address allocation object.
    external_ip_address str
    The actual IP address that was allocated with allocated_external_ip_path.
    parent_path str
    Policy path for the Subnet Port.
    vpc_external_address_id str
    allocatedExternalIpPath String
    Policy path for an external IP address allocation object.
    externalIpAddress String
    The actual IP address that was allocated with allocated_external_ip_path.
    parentPath String
    Policy path for the Subnet Port.
    vpcExternalAddressId String

    Package Details

    Repository
    nsxt vmware/terraform-provider-nsxt
    License
    Notes
    This Pulumi package is based on the nsxt Terraform Provider.
    nsxt logo
    nsxt 3.9.0 published on Friday, Jun 20, 2025 by vmware