AccessPoint

Provides an Elastic File System (EFS) access point.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var test = new Aws.Efs.AccessPoint("test", new Aws.Efs.AccessPointArgs
        {
            FileSystemId = aws_efs_file_system.Foo.Id,
        });
    }

}

package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := efs.NewAccessPoint(ctx, "test", &efs.AccessPointArgs{
            FileSystemId: pulumi.String(aws_efs_file_system.Foo.Id),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

test = aws.efs.AccessPoint("test", file_system_id=aws_efs_file_system["foo"]["id"])

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

const test = new aws.efs.AccessPoint("test", {
    fileSystemId: aws_efs_file_system_foo.id,
});

Create a AccessPoint Resource

new AccessPoint(name: string, args: AccessPointArgs, opts?: CustomResourceOptions);

def AccessPoint(resource_name, opts=None, file_system_id=None, posix_user=None, root_directory=None, tags=None, __props__=None);

func NewAccessPoint(ctx *Context, name string, args AccessPointArgs, opts ...ResourceOption) (*AccessPoint, error)

public AccessPoint(string name, AccessPointArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args AccessPointArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args AccessPointArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AccessPointArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

AccessPoint Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The AccessPoint resource accepts the following input properties:

FileSystemId string: The ID of the file system for which the access point is intended.
PosixUser AccessPointPosixUserArgs: The operating system user and group applied to all file system requests made using the access point. See Posix User below.
RootDirectory AccessPointRootDirectoryArgs: Specifies the directory on the Amazon EFS file system that the access point provides access to. See Root Directory below.
Tags Dictionary<string, string>: Key-value mapping of resource tags.

FileSystemId string: The ID of the file system for which the access point is intended.
PosixUser AccessPointPosixUser: The operating system user and group applied to all file system requests made using the access point. See Posix User below.
RootDirectory AccessPointRootDirectory: Specifies the directory on the Amazon EFS file system that the access point provides access to. See Root Directory below.
Tags map[string]string: Key-value mapping of resource tags.

fileSystemId string: The ID of the file system for which the access point is intended.
posixUser AccessPointPosixUser: The operating system user and group applied to all file system requests made using the access point. See Posix User below.
rootDirectory AccessPointRootDirectory: Specifies the directory on the Amazon EFS file system that the access point provides access to. See Root Directory below.
tags {[key: string]: string}: Key-value mapping of resource tags.

file_system_id str: The ID of the file system for which the access point is intended.
posix_user Dict[AccessPointPosixUser]: The operating system user and group applied to all file system requests made using the access point. See Posix User below.
root_directory Dict[AccessPointRootDirectory]: Specifies the directory on the Amazon EFS file system that the access point provides access to. See Root Directory below.
tags Dict[str, str]: Key-value mapping of resource tags.

Outputs

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

Arn string: Amazon Resource Name of the access point.
FileSystemArn string: Amazon Resource Name of the file system.
Id string: The provider-assigned unique ID for this managed resource.
OwnerId string

Arn string: Amazon Resource Name of the access point.
FileSystemArn string: Amazon Resource Name of the file system.
Id string: The provider-assigned unique ID for this managed resource.
OwnerId string

arn string: Amazon Resource Name of the access point.
fileSystemArn string: Amazon Resource Name of the file system.
id string: The provider-assigned unique ID for this managed resource.
ownerId string

arn str: Amazon Resource Name of the access point.
file_system_arn str: Amazon Resource Name of the file system.
id str: The provider-assigned unique ID for this managed resource.
owner_id str

Look up an Existing AccessPoint Resource

Get an existing AccessPoint 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?: AccessPointState, opts?: CustomResourceOptions): AccessPoint

static get(resource_name, id, opts=None, arn=None, file_system_arn=None, file_system_id=None, owner_id=None, posix_user=None, root_directory=None, tags=None, __props__=None);

func GetAccessPoint(ctx *Context, name string, id IDInput, state *AccessPointState, opts ...ResourceOption) (*AccessPoint, error)

public static AccessPoint Get(string name, Input<string> id, AccessPointState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

Arn string: Amazon Resource Name of the access point.
FileSystemArn string: Amazon Resource Name of the file system.
FileSystemId string: The ID of the file system for which the access point is intended.
OwnerId string
PosixUser AccessPointPosixUserArgs: The operating system user and group applied to all file system requests made using the access point. See Posix User below.
RootDirectory AccessPointRootDirectoryArgs: Specifies the directory on the Amazon EFS file system that the access point provides access to. See Root Directory below.
Tags Dictionary<string, string>: Key-value mapping of resource tags.

Arn string: Amazon Resource Name of the access point.
FileSystemArn string: Amazon Resource Name of the file system.
FileSystemId string: The ID of the file system for which the access point is intended.
OwnerId string
PosixUser AccessPointPosixUser: The operating system user and group applied to all file system requests made using the access point. See Posix User below.
RootDirectory AccessPointRootDirectory: Specifies the directory on the Amazon EFS file system that the access point provides access to. See Root Directory below.
Tags map[string]string: Key-value mapping of resource tags.

arn string: Amazon Resource Name of the access point.
fileSystemArn string: Amazon Resource Name of the file system.
fileSystemId string: The ID of the file system for which the access point is intended.
ownerId string
posixUser AccessPointPosixUser: The operating system user and group applied to all file system requests made using the access point. See Posix User below.
rootDirectory AccessPointRootDirectory: Specifies the directory on the Amazon EFS file system that the access point provides access to. See Root Directory below.
tags {[key: string]: string}: Key-value mapping of resource tags.

arn str: Amazon Resource Name of the access point.
file_system_arn str: Amazon Resource Name of the file system.
file_system_id str: The ID of the file system for which the access point is intended.
owner_id str
posix_user Dict[AccessPointPosixUser]: The operating system user and group applied to all file system requests made using the access point. See Posix User below.
root_directory Dict[AccessPointRootDirectory]: Specifies the directory on the Amazon EFS file system that the access point provides access to. See Root Directory below.
tags Dict[str, str]: Key-value mapping of resource tags.

Supporting Types

AccessPointPosixUser

See the input and output API doc for this type.

Gid int: The POSIX group ID used for all file system operations using this access point.
Uid int: The POSIX user ID used for all file system operations using this access point.
SecondaryGids List<int>: Secondary POSIX group IDs used for all file system operations using this access point.

Gid int: The POSIX group ID used for all file system operations using this access point.
Uid int: The POSIX user ID used for all file system operations using this access point.
SecondaryGids []int: Secondary POSIX group IDs used for all file system operations using this access point.

gid number: The POSIX group ID used for all file system operations using this access point.
uid number: The POSIX user ID used for all file system operations using this access point.
secondaryGids number[]: Secondary POSIX group IDs used for all file system operations using this access point.

gid float: The POSIX group ID used for all file system operations using this access point.
uid float: The POSIX user ID used for all file system operations using this access point.
secondaryGids List[Integer]: Secondary POSIX group IDs used for all file system operations using this access point.

AccessPointRootDirectory

See the input and output API doc for this type.

CreationInfo AccessPointRootDirectoryCreationInfoArgs: Specifies the POSIX IDs and permissions to apply to the access point’s Root Directory. See Creation Info below.
Path string: Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide creation_info.

CreationInfo AccessPointRootDirectoryCreationInfo: Specifies the POSIX IDs and permissions to apply to the access point’s Root Directory. See Creation Info below.
Path string: Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide creation_info.

creationInfo AccessPointRootDirectoryCreationInfo: Specifies the POSIX IDs and permissions to apply to the access point’s Root Directory. See Creation Info below.
path string: Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide creation_info.

creationInfo Dict[AccessPointRootDirectoryCreationInfo]: Specifies the POSIX IDs and permissions to apply to the access point’s Root Directory. See Creation Info below.
path str: Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide creation_info.

AccessPointRootDirectoryCreationInfo

See the input and output API doc for this type.

OwnerGid int: Specifies the POSIX group ID to apply to the root_directory.
OwnerUid int: Specifies the POSIX user ID to apply to the root_directory.
Permissions string: Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file’s mode bits.

OwnerGid int: Specifies the POSIX group ID to apply to the root_directory.
OwnerUid int: Specifies the POSIX user ID to apply to the root_directory.
Permissions string: Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file’s mode bits.

ownerGid number: Specifies the POSIX group ID to apply to the root_directory.
ownerUid number: Specifies the POSIX user ID to apply to the root_directory.
permissions string: Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file’s mode bits.

ownerGid float: Specifies the POSIX group ID to apply to the root_directory.
ownerUid float: Specifies the POSIX user ID to apply to the root_directory.
permissions str: Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file’s mode bits.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

AccessPoint

Example Usage

Create a AccessPoint Resource

AccessPoint Resource Properties

Inputs

Outputs

Look up an Existing AccessPoint Resource

Supporting Types

AccessPointPosixUser

AccessPointRootDirectory

AccessPointRootDirectoryCreationInfo

Package Details

On This Page