Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. DigitalOcean Provider
  4. API Docs
  5. getNfsAccessPoint
Viewing docs for DigitalOcean v4.73.0
published on Friday, Jul 3, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-digitalocean

digitalocean.getNfsAccessPoint

digitalocean logo
Viewing docs for DigitalOcean v4.73.0
published on Friday, Jul 3, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-digitalocean

    Get information about a DigitalOcean NFS access point.

    Example Usage

    Get the NFS access point by ID:

    import * as pulumi from "@pulumi/pulumi";
import * as digitalocean from "@pulumi/digitalocean";

const example = digitalocean.getNfsAccessPoint({
    id: "506f78a4-e098-11e5-ad9f-000f53306ae1",
});

    import pulumi
import pulumi_digitalocean as digitalocean

example = digitalocean.get_nfs_access_point(id="506f78a4-e098-11e5-ad9f-000f53306ae1")

    package main

import (
	"github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := digitalocean.GetNfsAccessPoint(ctx, &digitalocean.LookupNfsAccessPointArgs{
			Id: pulumi.StringRef("506f78a4-e098-11e5-ad9f-000f53306ae1"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;

return await Deployment.RunAsync(() => 
{
    var example = DigitalOcean.GetNfsAccessPoint.Invoke(new()
    {
        Id = "506f78a4-e098-11e5-ad9f-000f53306ae1",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.digitalocean.DigitaloceanFunctions;
import com.pulumi.digitalocean.inputs.GetNfsAccessPointArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 example = DigitaloceanFunctions.getNfsAccessPoint(GetNfsAccessPointArgs.builder()
            .id("506f78a4-e098-11e5-ad9f-000f53306ae1")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: digitalocean:getNfsAccessPoint
      arguments:
        id: 506f78a4-e098-11e5-ad9f-000f53306ae1

    pulumi {
  required_providers {
    digitalocean = {
      source = "pulumi/digitalocean"
    }
  }
}

data "digitalocean_getnfsaccesspoint" "example" {
  id = "506f78a4-e098-11e5-ad9f-000f53306ae1"
}

    Get the NFS access point by name and share ID:

    import * as pulumi from "@pulumi/pulumi";
import * as digitalocean from "@pulumi/digitalocean";

const example = digitalocean.getNfsAccessPoint({
    name: "example-access-point",
    shareId: foobar.id,
    vpcId: foobarDigitaloceanVpc.id,
});

    import pulumi
import pulumi_digitalocean as digitalocean

example = digitalocean.get_nfs_access_point(name="example-access-point",
    share_id=foobar["id"],
    vpc_id=foobar_digitalocean_vpc["id"])

    package main

import (
	"github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := digitalocean.GetNfsAccessPoint(ctx, &digitalocean.LookupNfsAccessPointArgs{
			Name:    pulumi.StringRef("example-access-point"),
			ShareId: pulumi.StringRef(foobar.Id),
			VpcId:   pulumi.StringRef(foobarDigitaloceanVpc.Id),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;

return await Deployment.RunAsync(() => 
{
    var example = DigitalOcean.GetNfsAccessPoint.Invoke(new()
    {
        Name = "example-access-point",
        ShareId = foobar.Id,
        VpcId = foobarDigitaloceanVpc.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.digitalocean.DigitaloceanFunctions;
import com.pulumi.digitalocean.inputs.GetNfsAccessPointArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 example = DigitaloceanFunctions.getNfsAccessPoint(GetNfsAccessPointArgs.builder()
            .name("example-access-point")
            .shareId(foobar.id())
            .vpcId(foobarDigitaloceanVpc.id())
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: digitalocean:getNfsAccessPoint
      arguments:
        name: example-access-point
        shareId: ${foobar.id}
        vpcId: ${foobarDigitaloceanVpc.id}

    pulumi {
  required_providers {
    digitalocean = {
      source = "pulumi/digitalocean"
    }
  }
}

data "digitalocean_getnfsaccesspoint" "example" {
  name     = "example-access-point"
  share_id = foobar.id
  vpc_id   = foobarDigitaloceanVpc.id
}

    Using getNfsAccessPoint

    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 getNfsAccessPoint(args: GetNfsAccessPointArgs, opts?: InvokeOptions): Promise<GetNfsAccessPointResult>
function getNfsAccessPointOutput(args: GetNfsAccessPointOutputArgs, opts?: InvokeOptions): Output<GetNfsAccessPointResult>
    def get_nfs_access_point(id: Optional[str] = None,
                         name: Optional[str] = None,
                         share_id: Optional[str] = None,
                         vpc_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetNfsAccessPointResult
def get_nfs_access_point_output(id: pulumi.Input[Optional[str]] = None,
                         name: pulumi.Input[Optional[str]] = None,
                         share_id: pulumi.Input[Optional[str]] = None,
                         vpc_id: pulumi.Input[Optional[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetNfsAccessPointResult]
    func LookupNfsAccessPoint(ctx *Context, args *LookupNfsAccessPointArgs, opts ...InvokeOption) (*LookupNfsAccessPointResult, error)
func LookupNfsAccessPointOutput(ctx *Context, args *LookupNfsAccessPointOutputArgs, opts ...InvokeOption) LookupNfsAccessPointResultOutput

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

    public static class GetNfsAccessPoint 
{
    public static Task<GetNfsAccessPointResult> InvokeAsync(GetNfsAccessPointArgs args, InvokeOptions? opts = null)
    public static Output<GetNfsAccessPointResult> Invoke(GetNfsAccessPointInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetNfsAccessPointResult> getNfsAccessPoint(GetNfsAccessPointArgs args, InvokeOptions options)
public static Output<GetNfsAccessPointResult> getNfsAccessPoint(GetNfsAccessPointArgs args, InvokeOptions options)

    fn::invoke:
  function: digitalocean:index/getNfsAccessPoint:getNfsAccessPoint
  arguments:
    # arguments dictionary
    data "digitalocean_getnfsaccesspoint" "name" {
    # arguments
}

    The following arguments are supported:

    Id string
    The ID of the NFS access point. Conflicts with name, shareId, and vpcId.
    Name string
    The name of the NFS access point. Must be used with shareId. Conflicts with id.
    ShareId string
    The ID of the NFS share. Must be used with name. Conflicts with id.
    VpcId string
    When looking up by name and shareId, optionally filter to the access point attached to this VPC. Conflicts with id.
    Id string
    The ID of the NFS access point. Conflicts with name, shareId, and vpcId.
    Name string
    The name of the NFS access point. Must be used with shareId. Conflicts with id.
    ShareId string
    The ID of the NFS share. Must be used with name. Conflicts with id.
    VpcId string
    When looking up by name and shareId, optionally filter to the access point attached to this VPC. Conflicts with id.
    id string
    The ID of the NFS access point. Conflicts with name, shareId, and vpcId.
    name string
    The name of the NFS access point. Must be used with shareId. Conflicts with id.
    share_id string
    The ID of the NFS share. Must be used with name. Conflicts with id.
    vpc_id string
    When looking up by name and shareId, optionally filter to the access point attached to this VPC. Conflicts with id.
    id String
    The ID of the NFS access point. Conflicts with name, shareId, and vpcId.
    name String
    The name of the NFS access point. Must be used with shareId. Conflicts with id.
    shareId String
    The ID of the NFS share. Must be used with name. Conflicts with id.
    vpcId String
    When looking up by name and shareId, optionally filter to the access point attached to this VPC. Conflicts with id.
    id string
    The ID of the NFS access point. Conflicts with name, shareId, and vpcId.
    name string
    The name of the NFS access point. Must be used with shareId. Conflicts with id.
    shareId string
    The ID of the NFS share. Must be used with name. Conflicts with id.
    vpcId string
    When looking up by name and shareId, optionally filter to the access point attached to this VPC. Conflicts with id.
    id str
    The ID of the NFS access point. Conflicts with name, shareId, and vpcId.
    name str
    The name of the NFS access point. Must be used with shareId. Conflicts with id.
    share_id str
    The ID of the NFS share. Must be used with name. Conflicts with id.
    vpc_id str
    When looking up by name and shareId, optionally filter to the access point attached to this VPC. Conflicts with id.
    id String
    The ID of the NFS access point. Conflicts with name, shareId, and vpcId.
    name String
    The name of the NFS access point. Must be used with shareId. Conflicts with id.
    shareId String
    The ID of the NFS share. Must be used with name. Conflicts with id.
    vpcId String
    When looking up by name and shareId, optionally filter to the access point attached to this VPC. Conflicts with id.

    getNfsAccessPoint Result

    The following output properties are available:

    access_policies list(object)
    created_at string
    is_default bool
    path string
    status string
    updated_at string
    vpc_id string
    id string
    name string
    share_id string
    accessPolicies List<Property Map>
    createdAt String
    isDefault Boolean
    path String
    status String
    updatedAt String
    vpcId String
    id String
    name String
    shareId String

    Supporting Types

    GetNfsAccessPointAccessPolicy

    anongid Integer
    anonuid Integer
    identityEnforcementEnabled Boolean
    protocols List<String>
    squashConfig String
    anongid Number
    anonuid Number
    identityEnforcementEnabled Boolean
    protocols List<String>
    squashConfig String

    Package Details

    Repository
    DigitalOcean pulumi/pulumi-digitalocean
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the digitalocean Terraform Provider.
    digitalocean logo
    Viewing docs for DigitalOcean v4.73.0
    published on Friday, Jul 3, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-digitalocean

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial