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

Inherits:

Struct

• Object
• Struct
• Aws::EFS::Types::CreateAccessPointRequest

Includes:

Structure

Defined in:

lib/aws-sdk-efs/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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 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.

Returns:

• (String)

# File 'lib/aws-sdk-efs/types.rb', line 357

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.

Returns:

• (String)

# File 'lib/aws-sdk-efs/types.rb', line 357

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.

Returns:

• (Types::PosixUser)

# File 'lib/aws-sdk-efs/types.rb', line 357

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 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` &gt; `Path` specified does not exist, Amazon 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.

Returns:

• (Types::RootDirectory)

# File 'lib/aws-sdk-efs/types.rb', line 357

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][1

in the *Amazon Web

Services General Reference Guide*.

[1]: docs.aws.amazon.com/general/latest/gr/aws_tagging.html

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-efs/types.rb', line 357

class CreateAccessPointRequest < Struct.new(
  :client_token,
  :tags,
  :file_system_id,
  :posix_user,
  :root_directory)
  SENSITIVE = []
  include Aws::Structure
end