1. Packages
  2. AWS Native
  3. API Docs
  4. efs
  5. AccessPoint

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

aws-native.efs.AccessPoint

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

    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.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const accessPointResource = new aws_native.efs.AccessPoint("accessPointResource", {
        fileSystemId: "string",
        accessPointTags: [{
            key: "string",
            value: "string",
        }],
        clientToken: "string",
        posixUser: {
            gid: "string",
            uid: "string",
            secondaryGids: ["string"],
        },
        rootDirectory: {
            creationInfo: {
                ownerGid: "string",
                ownerUid: "string",
                permissions: "string",
            },
            path: "string",
        },
    });
    
    Coming soon!
    

    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
    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.
    AccessPointTags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource. For more information, see Tag.
    ClientToken string
    The opaque string specified in the request to ensure idempotent creation.
    PosixUser Pulumi.AwsNative.Efs.Inputs.AccessPointPosixUser
    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.
    RootDirectory Pulumi.AwsNative.Efs.Inputs.AccessPointRootDirectory
    The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.
    FileSystemId string
    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.
    AccessPointTags TagArgs
    An array of key-value pairs to apply to this resource. For more information, see Tag.
    ClientToken string
    The opaque string specified in the request to ensure idempotent creation.
    PosixUser AccessPointPosixUserArgs
    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.
    RootDirectory AccessPointRootDirectoryArgs
    The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.
    fileSystemId String
    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.
    accessPointTags List<Tag>
    An array of key-value pairs to apply to this resource. For more information, see Tag.
    clientToken String
    The opaque string specified in the request to ensure idempotent creation.
    posixUser AccessPointPosixUser
    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.
    rootDirectory AccessPointRootDirectory
    The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.
    fileSystemId string
    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.
    accessPointTags Tag[]
    An array of key-value pairs to apply to this resource. For more information, see Tag.
    clientToken string
    The opaque string specified in the request to ensure idempotent creation.
    posixUser AccessPointPosixUser
    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.
    rootDirectory AccessPointRootDirectory
    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_id str
    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.
    access_point_tags Sequence[TagArgs]
    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 AccessPointPosixUserArgs
    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 AccessPointRootDirectoryArgs
    The directory on the EFS file system that the access point exposes as the root directory to NFS clients using the access point.
    fileSystemId String
    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.
    accessPointTags List<Property Map>
    An array of key-value pairs to apply to this resource. For more information, see Tag.
    clientToken String
    The opaque string specified in the request to ensure idempotent creation.
    posixUser 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.
    rootDirectory 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:

    AccessPointId string
    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.
    AccessPointId string
    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.
    accessPointId String
    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.
    accessPointId string
    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_id str
    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.
    accessPointId String
    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

    OwnerGid string
    Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).
    OwnerUid 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.
    OwnerGid string
    Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).
    OwnerUid 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.
    ownerGid String
    Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).
    ownerUid 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.
    ownerGid string
    Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).
    ownerUid 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.
    ownerGid String
    Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).
    ownerUid 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.
    SecondaryGids 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.
    SecondaryGids []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.
    secondaryGids 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.
    secondaryGids 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.
    secondaryGids List<String>
    Secondary POSIX group IDs used for all file system operations using this access point.

    AccessPointRootDirectory, AccessPointRootDirectoryArgs

    CreationInfo Pulumi.AwsNative.Efs.Inputs.AccessPointCreationInfo
    (Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory. If the RootDirectory > Path specified does not exist, EFS creates the root directory using the CreationInfo settings when a client connects to an access point. When specifying the CreationInfo, you must provide values for all properties. If you do not provide CreationInfo and the specified RootDirectory > 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.
    CreationInfo AccessPointCreationInfo
    (Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory. If the RootDirectory > Path specified does not exist, EFS creates the root directory using the CreationInfo settings when a client connects to an access point. When specifying the CreationInfo, you must provide values for all properties. If you do not provide CreationInfo and the specified RootDirectory > 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.
    creationInfo AccessPointCreationInfo
    (Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory. If the RootDirectory > Path specified does not exist, EFS creates the root directory using the CreationInfo settings when a client connects to an access point. When specifying the CreationInfo, you must provide values for all properties. If you do not provide CreationInfo and the specified RootDirectory > 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.
    creationInfo AccessPointCreationInfo
    (Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory. If the RootDirectory > Path specified does not exist, EFS creates the root directory using the CreationInfo settings when a client connects to an access point. When specifying the CreationInfo, you must provide values for all properties. If you do not provide CreationInfo and the specified RootDirectory > 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 AccessPointCreationInfo
    (Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory. If the RootDirectory > Path specified does not exist, EFS creates the root directory using the CreationInfo settings when a client connects to an access point. When specifying the CreationInfo, you must provide values for all properties. If you do not provide CreationInfo and the specified RootDirectory > 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.
    creationInfo Property Map
    (Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory. If the RootDirectory > Path specified does not exist, EFS creates the root directory using the CreationInfo settings when a client connects to an access point. When specifying the CreationInfo, you must provide values for all properties. If you do not provide CreationInfo and the specified RootDirectory > 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

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi