We recommend new projects start with resources from the AWS provider.
aws-native.efs.AccessPoint
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
The AWS::EFS::AccessPoint
resource creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point’s root directory. Applications using the access point can only access data in its own directory and below. To learn more, see Mounting a file system using EFS access points.
This operation requires permissions for the elasticfilesystem:CreateAccessPoint
action.
Create AccessPoint Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AccessPoint(name: string, args: AccessPointArgs, opts?: CustomResourceOptions);
@overload
def AccessPoint(resource_name: str,
args: AccessPointArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AccessPoint(resource_name: str,
opts: Optional[ResourceOptions] = None,
file_system_id: Optional[str] = None,
access_point_tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
client_token: Optional[str] = None,
posix_user: Optional[AccessPointPosixUserArgs] = None,
root_directory: Optional[AccessPointRootDirectoryArgs] = 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-native:efs:AccessPoint
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 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The AccessPoint resource accepts the following input properties:
- File
System stringId - The ID of the EFS file system that the access point applies to. Accepts only the ID format for input when specifying a file system, for example
fs-0123456789abcedf2
. - List<Pulumi.
Aws Native. Inputs. Tag> - An array of key-value pairs to apply to this resource. For more information, see Tag.
- Client
Token string - The opaque string specified in the request to ensure idempotent creation.
- Posix
User Pulumi.Aws Native. Efs. Inputs. Access Point Posix User - The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.
- Root
Directory Pulumi.Aws Native. Efs. Inputs. Access Point Root Directory - The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.
- File
System stringId - The ID of the EFS file system that the access point applies to. Accepts only the ID format for input when specifying a file system, for example
fs-0123456789abcedf2
. - Tag
Args - An array of key-value pairs to apply to this resource. For more information, see Tag.
- Client
Token string - The opaque string specified in the request to ensure idempotent creation.
- Posix
User AccessPoint Posix User Args - The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.
- Root
Directory AccessPoint Root Directory Args - The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.
- file
System StringId - The ID of the EFS file system that the access point applies to. Accepts only the ID format for input when specifying a file system, for example
fs-0123456789abcedf2
. - List<Tag>
- An array of key-value pairs to apply to this resource. For more information, see Tag.
- client
Token String - The opaque string specified in the request to ensure idempotent creation.
- posix
User AccessPoint Posix User - The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.
- root
Directory AccessPoint Root Directory - The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.
- file
System stringId - The ID of the EFS file system that the access point applies to. Accepts only the ID format for input when specifying a file system, for example
fs-0123456789abcedf2
. - Tag[]
- An array of key-value pairs to apply to this resource. For more information, see Tag.
- client
Token string - The opaque string specified in the request to ensure idempotent creation.
- posix
User AccessPoint Posix User - The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.
- root
Directory AccessPoint Root Directory - The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.
- file_
system_ strid - The ID of the EFS file system that the access point applies to. Accepts only the ID format for input when specifying a file system, for example
fs-0123456789abcedf2
. - Sequence[Tag
Args] - An array of key-value pairs to apply to this resource. For more information, see Tag.
- client_
token str - The opaque string specified in the request to ensure idempotent creation.
- posix_
user AccessPoint Posix User Args - The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.
- root_
directory AccessPoint Root Directory Args - The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.
- file
System StringId - The ID of the EFS file system that the access point applies to. Accepts only the ID format for input when specifying a file system, for example
fs-0123456789abcedf2
. - List<Property Map>
- An array of key-value pairs to apply to this resource. For more information, see Tag.
- client
Token String - The opaque string specified in the request to ensure idempotent creation.
- posix
User Property Map - The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.
- root
Directory Property Map - The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.
Outputs
All input properties are implicitly available as output properties. Additionally, the AccessPoint resource produces the following output properties:
- Access
Point stringId - The ID of the EFS access point.
- Arn string
- The Amazon Resource Name (ARN) of the access point.
- Id string
- The provider-assigned unique ID for this managed resource.
- Access
Point stringId - The ID of the EFS access point.
- Arn string
- The Amazon Resource Name (ARN) of the access point.
- Id string
- The provider-assigned unique ID for this managed resource.
- access
Point StringId - The ID of the EFS access point.
- arn String
- The Amazon Resource Name (ARN) of the access point.
- id String
- The provider-assigned unique ID for this managed resource.
- access
Point stringId - The ID of the EFS access point.
- arn string
- The Amazon Resource Name (ARN) of the access point.
- id string
- The provider-assigned unique ID for this managed resource.
- access_
point_ strid - The ID of the EFS access point.
- arn str
- The Amazon Resource Name (ARN) of the access point.
- id str
- The provider-assigned unique ID for this managed resource.
- access
Point StringId - The ID of the EFS access point.
- arn String
- The Amazon Resource Name (ARN) of the access point.
- id String
- The provider-assigned unique ID for this managed resource.
Supporting Types
AccessPointCreationInfo, AccessPointCreationInfoArgs
- Owner
Gid string - Specifies the POSIX group ID to apply to the
RootDirectory
. Accepts values from 0 to 2^32 (4294967295). - Owner
Uid string - Specifies the POSIX user ID to apply to the
RootDirectory
. Accepts values from 0 to 2^32 (4294967295). - Permissions string
- Specifies the POSIX permissions to apply to the
RootDirectory
, in the format of an octal number representing the file's mode bits.
- Owner
Gid string - Specifies the POSIX group ID to apply to the
RootDirectory
. Accepts values from 0 to 2^32 (4294967295). - Owner
Uid string - Specifies the POSIX user ID to apply to the
RootDirectory
. Accepts values from 0 to 2^32 (4294967295). - Permissions string
- Specifies the POSIX permissions to apply to the
RootDirectory
, in the format of an octal number representing the file's mode bits.
- owner
Gid String - Specifies the POSIX group ID to apply to the
RootDirectory
. Accepts values from 0 to 2^32 (4294967295). - owner
Uid String - Specifies the POSIX user ID to apply to the
RootDirectory
. Accepts values from 0 to 2^32 (4294967295). - permissions String
- Specifies the POSIX permissions to apply to the
RootDirectory
, in the format of an octal number representing the file's mode bits.
- owner
Gid string - Specifies the POSIX group ID to apply to the
RootDirectory
. Accepts values from 0 to 2^32 (4294967295). - owner
Uid string - Specifies the POSIX user ID to apply to the
RootDirectory
. Accepts values from 0 to 2^32 (4294967295). - permissions string
- Specifies the POSIX permissions to apply to the
RootDirectory
, in the format of an octal number representing the file's mode bits.
- owner_
gid str - Specifies the POSIX group ID to apply to the
RootDirectory
. Accepts values from 0 to 2^32 (4294967295). - owner_
uid str - Specifies the POSIX user ID to apply to the
RootDirectory
. Accepts values from 0 to 2^32 (4294967295). - permissions str
- Specifies the POSIX permissions to apply to the
RootDirectory
, in the format of an octal number representing the file's mode bits.
- owner
Gid String - Specifies the POSIX group ID to apply to the
RootDirectory
. Accepts values from 0 to 2^32 (4294967295). - owner
Uid String - Specifies the POSIX user ID to apply to the
RootDirectory
. Accepts values from 0 to 2^32 (4294967295). - permissions String
- Specifies the POSIX permissions to apply to the
RootDirectory
, in the format of an octal number representing the file's mode bits.
AccessPointPosixUser, AccessPointPosixUserArgs
- Gid string
- The POSIX group ID used for all file system operations using this access point.
- Uid string
- The POSIX user ID used for all file system operations using this access point.
- Secondary
Gids List<string> - Secondary POSIX group IDs used for all file system operations using this access point.
- Gid string
- The POSIX group ID used for all file system operations using this access point.
- Uid string
- The POSIX user ID used for all file system operations using this access point.
- Secondary
Gids []string - Secondary POSIX group IDs used for all file system operations using this access point.
- gid String
- The POSIX group ID used for all file system operations using this access point.
- uid String
- The POSIX user ID used for all file system operations using this access point.
- secondary
Gids List<String> - Secondary POSIX group IDs used for all file system operations using this access point.
- gid string
- The POSIX group ID used for all file system operations using this access point.
- uid string
- The POSIX user ID used for all file system operations using this access point.
- secondary
Gids string[] - Secondary POSIX group IDs used for all file system operations using this access point.
- gid str
- The POSIX group ID used for all file system operations using this access point.
- uid str
- The POSIX user ID used for all file system operations using this access point.
- secondary_
gids Sequence[str] - Secondary POSIX group IDs used for all file system operations using this access point.
- gid String
- The POSIX group ID used for all file system operations using this access point.
- uid String
- The POSIX user ID used for all file system operations using this access point.
- secondary
Gids List<String> - Secondary POSIX group IDs used for all file system operations using this access point.
AccessPointRootDirectory, AccessPointRootDirectoryArgs
- Creation
Info Pulumi.Aws Native. Efs. Inputs. Access Point Creation Info - (Optional) Specifies the POSIX IDs and permissions to apply to the access point's
RootDirectory
. If theRootDirectory
>Path
specified does not exist, EFS creates the root directory using theCreationInfo
settings when a client connects to an access point. When specifying theCreationInfo
, you must provide values for all properties. If you do not provideCreationInfo
and the specifiedRootDirectory
>Path
does not exist, attempts to mount the file system using the access point will fail. - 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 the
CreationInfo
.
- Creation
Info AccessPoint Creation Info - (Optional) Specifies the POSIX IDs and permissions to apply to the access point's
RootDirectory
. If theRootDirectory
>Path
specified does not exist, EFS creates the root directory using theCreationInfo
settings when a client connects to an access point. When specifying theCreationInfo
, you must provide values for all properties. If you do not provideCreationInfo
and the specifiedRootDirectory
>Path
does not exist, attempts to mount the file system using the access point will fail. - 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 the
CreationInfo
.
- creation
Info AccessPoint Creation Info - (Optional) Specifies the POSIX IDs and permissions to apply to the access point's
RootDirectory
. If theRootDirectory
>Path
specified does not exist, EFS creates the root directory using theCreationInfo
settings when a client connects to an access point. When specifying theCreationInfo
, you must provide values for all properties. If you do not provideCreationInfo
and the specifiedRootDirectory
>Path
does not exist, attempts to mount the file system using the access point will fail. - 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 the
CreationInfo
.
- creation
Info AccessPoint Creation Info - (Optional) Specifies the POSIX IDs and permissions to apply to the access point's
RootDirectory
. If theRootDirectory
>Path
specified does not exist, EFS creates the root directory using theCreationInfo
settings when a client connects to an access point. When specifying theCreationInfo
, you must provide values for all properties. If you do not provideCreationInfo
and the specifiedRootDirectory
>Path
does not exist, attempts to mount the file system using the access point will fail. - 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 the
CreationInfo
.
- creation_
info AccessPoint Creation Info - (Optional) Specifies the POSIX IDs and permissions to apply to the access point's
RootDirectory
. If theRootDirectory
>Path
specified does not exist, EFS creates the root directory using theCreationInfo
settings when a client connects to an access point. When specifying theCreationInfo
, you must provide values for all properties. If you do not provideCreationInfo
and the specifiedRootDirectory
>Path
does not exist, attempts to mount the file system using the access point will fail. - 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 the
CreationInfo
.
- creation
Info Property Map - (Optional) Specifies the POSIX IDs and permissions to apply to the access point's
RootDirectory
. If theRootDirectory
>Path
specified does not exist, EFS creates the root directory using theCreationInfo
settings when a client connects to an access point. When specifying theCreationInfo
, you must provide values for all properties. If you do not provideCreationInfo
and the specifiedRootDirectory
>Path
does not exist, attempts to mount the file system using the access point will fail. - 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 the
CreationInfo
.
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.