AWS Classic

v5.21.1 published on Thursday, Nov 17, 2022 by Pulumi

getAccessPoint

Provides information about an Elastic File System (EFS) Access Point.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = Aws.Efs.GetAccessPoint.Invoke(new()
    {
        AccessPointId = "fsap-12345678",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/efs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := efs.LookupAccessPoint(ctx, &efs.LookupAccessPointArgs{
			AccessPointId: "fsap-12345678",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.efs.EfsFunctions;
import com.pulumi.aws.efs.inputs.GetAccessPointArgs;
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 test = EfsFunctions.getAccessPoint(GetAccessPointArgs.builder()
            .accessPointId("fsap-12345678")
            .build());

    }
}
import pulumi
import pulumi_aws as aws

test = aws.efs.get_access_point(access_point_id="fsap-12345678")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = pulumi.output(aws.efs.getAccessPoint({
    accessPointId: "fsap-12345678",
}));
variables:
  test:
    Fn::Invoke:
      Function: aws:efs:getAccessPoint
      Arguments:
        accessPointId: fsap-12345678

Using getAccessPoint

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 getAccessPoint(args: GetAccessPointArgs, opts?: InvokeOptions): Promise<GetAccessPointResult>
function getAccessPointOutput(args: GetAccessPointOutputArgs, opts?: InvokeOptions): Output<GetAccessPointResult>
def get_access_point(access_point_id: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None,
                     opts: Optional[InvokeOptions] = None) -> GetAccessPointResult
def get_access_point_output(access_point_id: Optional[pulumi.Input[str]] = None,
                     tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetAccessPointResult]
func LookupAccessPoint(ctx *Context, args *LookupAccessPointArgs, opts ...InvokeOption) (*LookupAccessPointResult, error)
func LookupAccessPointOutput(ctx *Context, args *LookupAccessPointOutputArgs, opts ...InvokeOption) LookupAccessPointResultOutput

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

public static class GetAccessPoint 
{
    public static Task<GetAccessPointResult> InvokeAsync(GetAccessPointArgs args, InvokeOptions? opts = null)
    public static Output<GetAccessPointResult> Invoke(GetAccessPointInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAccessPointResult> getAccessPoint(GetAccessPointArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: aws:efs/getAccessPoint:getAccessPoint
  arguments:
    # arguments dictionary

The following arguments are supported:

AccessPointId string

ID that identifies the file system.

Tags Dictionary<string, string>

Key-value mapping of resource tags.

AccessPointId string

ID that identifies the file system.

Tags map[string]string

Key-value mapping of resource tags.

accessPointId String

ID that identifies the file system.

tags Map<String,String>

Key-value mapping of resource tags.

accessPointId string

ID that identifies the file system.

tags {[key: string]: string}

Key-value mapping of resource tags.

access_point_id str

ID that identifies the file system.

tags Mapping[str, str]

Key-value mapping of resource tags.

accessPointId String

ID that identifies the file system.

tags Map<String>

Key-value mapping of resource tags.

getAccessPoint Result

The following output properties are available:

AccessPointId string
Arn string

Amazon Resource Name of the file system.

FileSystemArn string

Amazon Resource Name of the file system.

FileSystemId string

ID of the file system for which the access point is intended.

Id string

The provider-assigned unique ID for this managed resource.

OwnerId string
PosixUsers List<Pulumi.Aws.Efs.Outputs.GetAccessPointPosixUser>

Single element list containing operating system user and group applied to all file system requests made using the access point.

RootDirectories List<Pulumi.Aws.Efs.Outputs.GetAccessPointRootDirectory>
Tags Dictionary<string, string>

Key-value mapping of resource tags.

AccessPointId string
Arn string

Amazon Resource Name of the file system.

FileSystemArn string

Amazon Resource Name of the file system.

FileSystemId string

ID of the file system for which the access point is intended.

Id string

The provider-assigned unique ID for this managed resource.

OwnerId string
PosixUsers []GetAccessPointPosixUser

Single element list containing operating system user and group applied to all file system requests made using the access point.

RootDirectories []GetAccessPointRootDirectory
Tags map[string]string

Key-value mapping of resource tags.

accessPointId String
arn String

Amazon Resource Name of the file system.

fileSystemArn String

Amazon Resource Name of the file system.

fileSystemId String

ID of the file system for which the access point is intended.

id String

The provider-assigned unique ID for this managed resource.

ownerId String
posixUsers List<GetAccessPointPosixUser>

Single element list containing operating system user and group applied to all file system requests made using the access point.

rootDirectories List<GetAccessPointRootDirectory>
tags Map<String,String>

Key-value mapping of resource tags.

accessPointId string
arn string

Amazon Resource Name of the file system.

fileSystemArn string

Amazon Resource Name of the file system.

fileSystemId string

ID of the file system for which the access point is intended.

id string

The provider-assigned unique ID for this managed resource.

ownerId string
posixUsers GetAccessPointPosixUser[]

Single element list containing operating system user and group applied to all file system requests made using the access point.

rootDirectories GetAccessPointRootDirectory[]
tags {[key: string]: string}

Key-value mapping of resource tags.

access_point_id str
arn str

Amazon Resource Name of the file system.

file_system_arn str

Amazon Resource Name of the file system.

file_system_id str

ID of the file system for which the access point is intended.

id str

The provider-assigned unique ID for this managed resource.

owner_id str
posix_users Sequence[GetAccessPointPosixUser]

Single element list containing operating system user and group applied to all file system requests made using the access point.

root_directories Sequence[GetAccessPointRootDirectory]
tags Mapping[str, str]

Key-value mapping of resource tags.

accessPointId String
arn String

Amazon Resource Name of the file system.

fileSystemArn String

Amazon Resource Name of the file system.

fileSystemId String

ID of the file system for which the access point is intended.

id String

The provider-assigned unique ID for this managed resource.

ownerId String
posixUsers List<Property Map>

Single element list containing operating system user and group applied to all file system requests made using the access point.

rootDirectories List<Property Map>
tags Map<String>

Key-value mapping of resource tags.

Supporting Types

GetAccessPointPosixUser

Gid int

Group ID

SecondaryGids List<int>

Secondary group IDs

Uid int

User Id

  • root_directory- Single element list containing information on the directory on the Amazon EFS file system that the access point provides access to.
Gid int

Group ID

SecondaryGids []int

Secondary group IDs

Uid int

User Id

  • root_directory- Single element list containing information on the directory on the Amazon EFS file system that the access point provides access to.
gid Integer

Group ID

secondaryGids List<Integer>

Secondary group IDs

uid Integer

User Id

  • root_directory- Single element list containing information on the directory on the Amazon EFS file system that the access point provides access to.
gid number

Group ID

secondaryGids number[]

Secondary group IDs

uid number

User Id

  • root_directory- Single element list containing information on the directory on the Amazon EFS file system that the access point provides access to.
gid int

Group ID

secondary_gids Sequence[int]

Secondary group IDs

uid int

User Id

  • root_directory- Single element list containing information on the directory on the Amazon EFS file system that the access point provides access to.
gid Number

Group ID

secondaryGids List<Number>

Secondary group IDs

uid Number

User Id

  • root_directory- Single element list containing information on the directory on the Amazon EFS file system that the access point provides access to.

GetAccessPointRootDirectory

CreationInfos List<Pulumi.Aws.Efs.Inputs.GetAccessPointRootDirectoryCreationInfo>

Single element list containing information on the creation permissions of the directory

Path string

Path exposed as the root directory

CreationInfos []GetAccessPointRootDirectoryCreationInfo

Single element list containing information on the creation permissions of the directory

Path string

Path exposed as the root directory

creationInfos List<GetAccessPointRootDirectoryCreationInfo>

Single element list containing information on the creation permissions of the directory

path String

Path exposed as the root directory

creationInfos GetAccessPointRootDirectoryCreationInfo[]

Single element list containing information on the creation permissions of the directory

path string

Path exposed as the root directory

creation_infos Sequence[GetAccessPointRootDirectoryCreationInfo]

Single element list containing information on the creation permissions of the directory

path str

Path exposed as the root directory

creationInfos List<Property Map>

Single element list containing information on the creation permissions of the directory

path String

Path exposed as the root directory

GetAccessPointRootDirectoryCreationInfo

OwnerGid int

POSIX owner group ID

OwnerUid int

POSIX owner user ID

Permissions string

POSIX permissions mode

OwnerGid int

POSIX owner group ID

OwnerUid int

POSIX owner user ID

Permissions string

POSIX permissions mode

ownerGid Integer

POSIX owner group ID

ownerUid Integer

POSIX owner user ID

permissions String

POSIX permissions mode

ownerGid number

POSIX owner group ID

ownerUid number

POSIX owner user ID

permissions string

POSIX permissions mode

owner_gid int

POSIX owner group ID

owner_uid int

POSIX owner user ID

permissions str

POSIX permissions mode

ownerGid Number

POSIX owner group ID

ownerUid Number

POSIX owner user ID

permissions String

POSIX permissions mode

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.