AWS Classic

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

AccessPoint

Provides 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 = new Aws.Efs.AccessPoint("test", new()
    {
        FileSystemId = aws_efs_file_system.Foo.Id,
    });

});
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.NewAccessPoint(ctx, "test", &efs.AccessPointArgs{
			FileSystemId: pulumi.Any(aws_efs_file_system.Foo.Id),
		})
		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.AccessPoint;
import com.pulumi.aws.efs.AccessPointArgs;
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) {
        var test = new AccessPoint("test", AccessPointArgs.builder()        
            .fileSystemId(aws_efs_file_system.foo().id())
            .build());

    }
}
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});
resources:
  test:
    type: aws:efs:AccessPoint
    properties:
      fileSystemId: ${aws_efs_file_system.foo.id}

Create AccessPoint Resource

new AccessPoint(name: string, args: AccessPointArgs, opts?: CustomResourceOptions);
@overload
def AccessPoint(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                file_system_id: Optional[str] = None,
                posix_user: Optional[AccessPointPosixUserArgs] = None,
                root_directory: Optional[AccessPointRootDirectoryArgs] = None,
                tags: Optional[Mapping[str, str]] = None)
@overload
def AccessPoint(resource_name: str,
                args: AccessPointArgs,
                opts: Optional[ResourceOptions] = None)
func NewAccessPoint(ctx *Context, name string, args AccessPointArgs, opts ...ResourceOption) (*AccessPoint, error)
public AccessPoint(string name, AccessPointArgs args, CustomResourceOptions? opts = null)
public AccessPoint(String name, AccessPointArgs args)
public AccessPoint(String name, AccessPointArgs args, CustomResourceOptions options)
type: aws:efs:AccessPoint
properties: # The arguments to resource properties.
options: # 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.
resource_name str
The unique name of the resource.
args AccessPointArgs
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 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.
name String
The unique name of the resource.
args AccessPointArgs
The arguments to resource properties.
options 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 Architecture and Concepts docs.

Inputs

The AccessPoint resource accepts the following input properties:

FileSystemId string

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

PosixUser Pulumi.Aws.Efs.Inputs.AccessPointPosixUserArgs

Operating system user and group applied to all file system requests made using the access point. Detailed below.

RootDirectory Pulumi.Aws.Efs.Inputs.AccessPointRootDirectoryArgs

Directory on the Amazon EFS file system that the access point provides access to. Detailed below.

Tags Dictionary<string, string>

Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level

FileSystemId string

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

PosixUser AccessPointPosixUserArgs

Operating system user and group applied to all file system requests made using the access point. Detailed below.

RootDirectory AccessPointRootDirectoryArgs

Directory on the Amazon EFS file system that the access point provides access to. Detailed below.

Tags map[string]string

Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level

fileSystemId String

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

posixUser AccessPointPosixUserArgs

Operating system user and group applied to all file system requests made using the access point. Detailed below.

rootDirectory AccessPointRootDirectoryArgs

Directory on the Amazon EFS file system that the access point provides access to. Detailed below.

tags Map<String,String>

Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level

fileSystemId string

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

posixUser AccessPointPosixUserArgs

Operating system user and group applied to all file system requests made using the access point. Detailed below.

rootDirectory AccessPointRootDirectoryArgs

Directory on the Amazon EFS file system that the access point provides access to. Detailed below.

tags {[key: string]: string}

Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level

file_system_id str

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

posix_user AccessPointPosixUserArgs

Operating system user and group applied to all file system requests made using the access point. Detailed below.

root_directory AccessPointRootDirectoryArgs

Directory on the Amazon EFS file system that the access point provides access to. Detailed below.

tags Mapping[str, str]

Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level

fileSystemId String

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

posixUser Property Map

Operating system user and group applied to all file system requests made using the access point. Detailed below.

rootDirectory Property Map

Directory on the Amazon EFS file system that the access point provides access to. Detailed below.

tags Map<String>

Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level

Outputs

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

Arn string

ARN of the access point.

FileSystemArn string

ARN of the file system.

Id string

The provider-assigned unique ID for this managed resource.

OwnerId string
TagsAll Dictionary<string, string>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string

ARN of the access point.

FileSystemArn string

ARN of the file system.

Id string

The provider-assigned unique ID for this managed resource.

OwnerId string
TagsAll map[string]string

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

ARN of the access point.

fileSystemArn String

ARN of the file system.

id String

The provider-assigned unique ID for this managed resource.

ownerId String
tagsAll Map<String,String>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string

ARN of the access point.

fileSystemArn string

ARN of the file system.

id string

The provider-assigned unique ID for this managed resource.

ownerId string
tagsAll {[key: string]: string}

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str

ARN of the access point.

file_system_arn str

ARN of the file system.

id str

The provider-assigned unique ID for this managed resource.

owner_id str
tags_all Mapping[str, str]

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

ARN of the access point.

fileSystemArn String

ARN of the file system.

id String

The provider-assigned unique ID for this managed resource.

ownerId String
tagsAll Map<String>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Look up 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
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        file_system_arn: Optional[str] = None,
        file_system_id: Optional[str] = None,
        owner_id: Optional[str] = None,
        posix_user: Optional[AccessPointPosixUserArgs] = None,
        root_directory: Optional[AccessPointRootDirectoryArgs] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> AccessPoint
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)
public static AccessPoint get(String name, Output<String> id, AccessPointState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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:
Arn string

ARN of the access point.

FileSystemArn string

ARN of the file system.

FileSystemId string

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

OwnerId string
PosixUser Pulumi.Aws.Efs.Inputs.AccessPointPosixUserArgs

Operating system user and group applied to all file system requests made using the access point. Detailed below.

RootDirectory Pulumi.Aws.Efs.Inputs.AccessPointRootDirectoryArgs

Directory on the Amazon EFS file system that the access point provides access to. Detailed below.

Tags Dictionary<string, string>

Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level

TagsAll Dictionary<string, string>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string

ARN of the access point.

FileSystemArn string

ARN of the file system.

FileSystemId string

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

OwnerId string
PosixUser AccessPointPosixUserArgs

Operating system user and group applied to all file system requests made using the access point. Detailed below.

RootDirectory AccessPointRootDirectoryArgs

Directory on the Amazon EFS file system that the access point provides access to. Detailed below.

Tags map[string]string

Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level

TagsAll map[string]string

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

ARN of the access point.

fileSystemArn String

ARN of the file system.

fileSystemId String

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

ownerId String
posixUser AccessPointPosixUserArgs

Operating system user and group applied to all file system requests made using the access point. Detailed below.

rootDirectory AccessPointRootDirectoryArgs

Directory on the Amazon EFS file system that the access point provides access to. Detailed below.

tags Map<String,String>

Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level

tagsAll Map<String,String>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string

ARN of the access point.

fileSystemArn string

ARN of the file system.

fileSystemId string

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

ownerId string
posixUser AccessPointPosixUserArgs

Operating system user and group applied to all file system requests made using the access point. Detailed below.

rootDirectory AccessPointRootDirectoryArgs

Directory on the Amazon EFS file system that the access point provides access to. Detailed below.

tags {[key: string]: string}

Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level

tagsAll {[key: string]: string}

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str

ARN of the access point.

file_system_arn str

ARN of the file system.

file_system_id str

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

owner_id str
posix_user AccessPointPosixUserArgs

Operating system user and group applied to all file system requests made using the access point. Detailed below.

root_directory AccessPointRootDirectoryArgs

Directory on the Amazon EFS file system that the access point provides access to. Detailed below.

tags Mapping[str, str]

Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level

tags_all Mapping[str, str]

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

ARN of the access point.

fileSystemArn String

ARN of the file system.

fileSystemId String

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

ownerId String
posixUser Property Map

Operating system user and group applied to all file system requests made using the access point. Detailed below.

rootDirectory Property Map

Directory on the Amazon EFS file system that the access point provides access to. Detailed below.

tags Map<String>

Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level

tagsAll Map<String>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Supporting Types

AccessPointPosixUser

Gid int

POSIX group ID used for all file system operations using this access point.

Uid int

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

POSIX group ID used for all file system operations using this access point.

Uid int

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 Integer

POSIX group ID used for all file system operations using this access point.

uid Integer

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.

gid number

POSIX group ID used for all file system operations using this access point.

uid number

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 int

POSIX group ID used for all file system operations using this access point.

uid int

POSIX user ID used for all file system operations using this access point.

secondary_gids Sequence[int]

Secondary POSIX group IDs used for all file system operations using this access point.

gid Number

POSIX group ID used for all file system operations using this access point.

uid Number

POSIX user ID used for all file system operations using this access point.

secondaryGids List<Number>

Secondary POSIX group IDs used for all file system operations using this access point.

AccessPointRootDirectory

CreationInfo Pulumi.Aws.Efs.Inputs.AccessPointRootDirectoryCreationInfo

POSIX IDs and permissions to apply to the access point's Root Directory. See Creation Info below.

Path string

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

POSIX IDs and permissions to apply to the access point's Root Directory. See Creation Info below.

Path string

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

POSIX IDs and permissions to apply to the access point's Root Directory. See Creation Info below.

path String

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

POSIX IDs and permissions to apply to the access point's Root Directory. See Creation Info below.

path string

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.

creation_info AccessPointRootDirectoryCreationInfo

POSIX IDs and permissions to apply to the access point's Root Directory. See Creation Info below.

path str

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 Property Map

POSIX IDs and permissions to apply to the access point's Root Directory. See Creation Info below.

path String

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

OwnerGid int

POSIX group ID to apply to the root_directory.

OwnerUid int

POSIX user ID to apply to the root_directory.

Permissions string

POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file's mode bits.

OwnerGid int

POSIX group ID to apply to the root_directory.

OwnerUid int

POSIX user ID to apply to the root_directory.

Permissions string

POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file's mode bits.

ownerGid Integer

POSIX group ID to apply to the root_directory.

ownerUid Integer

POSIX user ID to apply to the root_directory.

permissions String

POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file's mode bits.

ownerGid number

POSIX group ID to apply to the root_directory.

ownerUid number

POSIX user ID to apply to the root_directory.

permissions string

POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file's mode bits.

owner_gid int

POSIX group ID to apply to the root_directory.

owner_uid int

POSIX user ID to apply to the root_directory.

permissions str

POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file's mode bits.

ownerGid Number

POSIX group ID to apply to the root_directory.

ownerUid Number

POSIX user ID to apply to the root_directory.

permissions String

POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file's mode bits.

Import

The EFS access points can be imported using the id, e.g.,

 $ pulumi import aws:efs/accessPoint:AccessPoint test fsap-52a643fb

Package Details

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

This Pulumi package is based on the aws Terraform Provider.