Class: Aws::EFS::Types::CreateAccessPointRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::EFS::Types::CreateAccessPointRequest
- Defined in:
- gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb
Overview
When making an API call, you may pass CreateAccessPointRequest data as a 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
},
},
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#client_token ⇒ String
A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.
-
#file_system_id ⇒ String
The ID of the EFS file system that the access point provides access to.
-
#posix_user ⇒ Types::PosixUser
The operating system user and group applied to all file system requests made using the access point.
-
#root_directory ⇒ 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.
-
#tags ⇒ Array<Types::Tag>
Creates tags associated with the access point.
Instance Attribute Details
#client_token ⇒ String
A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.
A suitable default value is auto-generated. You should normally not need to pass this option.
363 364 365 366 367 368 369 370 371 |
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 363 class CreateAccessPointRequest < Struct.new( :client_token, :tags, :file_system_id, :posix_user, :root_directory) SENSITIVE = [] include Aws::Structure end |
#file_system_id ⇒ String
The ID of the EFS file system that the access point provides access to.
363 364 365 366 367 368 369 370 371 |
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 363 class CreateAccessPointRequest < Struct.new( :client_token, :tags, :file_system_id, :posix_user, :root_directory) SENSITIVE = [] include Aws::Structure end |
#posix_user ⇒ Types::PosixUser
The operating system user and group applied to all file system requests made using the access point.
363 364 365 366 367 368 369 370 371 |
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 363 class CreateAccessPointRequest < Struct.new( :client_token, :tags, :file_system_id, :posix_user, :root_directory) SENSITIVE = [] include Aws::Structure end |
#root_directory ⇒ 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. 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 must provide
the Path
, and the CreationInfo
.
Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount using the access point will fail.
363 364 365 366 367 368 369 370 371 |
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 363 class CreateAccessPointRequest < Struct.new( :client_token, :tags, :file_system_id, :posix_user, :root_directory) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
Creates tags associated with the access point. Each tag is a key-value pair, each key must be unique. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
363 364 365 366 367 368 369 370 371 |
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 363 class CreateAccessPointRequest < Struct.new( :client_token, :tags, :file_system_id, :posix_user, :root_directory) SENSITIVE = [] include Aws::Structure end |