You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EFS::Types::CreateAccessPointRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateAccessPointRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  client_token: "ClientToken", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  file_system_id: "FileSystemId", # required
  posix_user: {
    uid: 1, # required
    gid: 1, # required
    secondary_gids: [1],
  },
  root_directory: {
    path: "Path",
    creation_info: {
      owner_uid: 1, # required
      owner_gid: 1, # required
      permissions: "Permissions", # required
    },
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.

Returns:

  • (String)

    A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.

#file_system_idString

The ID of the EFS file system that the access point provides access to.

Returns:

  • (String)

    The ID of the EFS file system that the access point provides access to.

#posix_userTypes::PosixUser

The operating system user and group applied to all file system requests made using the access point.

Returns:

  • (Types::PosixUser)

    The operating system user and group applied to all file system requests made using the access point.

#root_directoryTypes::RootDirectory

Specifies the directory on the Amazon EFS file system that the access point exposes as the root directory of your file system to NFS clients using the access point. The clients using the access point can only access the root directory and below. If the RootDirectory > Path specified does not exist, EFS creates it and applies the CreationInfo settings when a client connects to an access point. When specifying a RootDirectory, you need to provide the Path, and the CreationInfo is optional.

Returns:

  • (Types::RootDirectory)

    Specifies the directory on the Amazon EFS file system that the access point exposes as the root directory of your file system to NFS clients using the access point.

#tagsArray<Types::Tag>

Creates tags associated with the access point. Each tag is a key-value pair.

Returns:

  • (Array<Types::Tag>)

    Creates tags associated with the access point.