AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::EFS::Types::AccessPointDescription

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb

Overview

Provides a description of an EFS file system access point.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_point_arnString

The unique Amazon Resource Name (ARN) associated with the access point.

Returns:

  • (String)


85
86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 85

class AccessPointDescription < Struct.new(
  :client_token,
  :name,
  :tags,
  :access_point_id,
  :access_point_arn,
  :file_system_id,
  :posix_user,
  :root_directory,
  :owner_id,
  :life_cycle_state)
  SENSITIVE = []
  include Aws::Structure
end

#access_point_idString

The ID of the access point, assigned by Amazon EFS.

Returns:

  • (String)


85
86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 85

class AccessPointDescription < Struct.new(
  :client_token,
  :name,
  :tags,
  :access_point_id,
  :access_point_arn,
  :file_system_id,
  :posix_user,
  :root_directory,
  :owner_id,
  :life_cycle_state)
  SENSITIVE = []
  include Aws::Structure
end

#client_tokenString

The opaque string specified in the request to ensure idempotent creation.

Returns:

  • (String)


85
86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 85

class AccessPointDescription < Struct.new(
  :client_token,
  :name,
  :tags,
  :access_point_id,
  :access_point_arn,
  :file_system_id,
  :posix_user,
  :root_directory,
  :owner_id,
  :life_cycle_state)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_idString

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

Returns:

  • (String)


85
86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 85

class AccessPointDescription < Struct.new(
  :client_token,
  :name,
  :tags,
  :access_point_id,
  :access_point_arn,
  :file_system_id,
  :posix_user,
  :root_directory,
  :owner_id,
  :life_cycle_state)
  SENSITIVE = []
  include Aws::Structure
end

#life_cycle_stateString

Identifies the lifecycle phase of the access point.

Returns:

  • (String)


85
86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 85

class AccessPointDescription < Struct.new(
  :client_token,
  :name,
  :tags,
  :access_point_id,
  :access_point_arn,
  :file_system_id,
  :posix_user,
  :root_directory,
  :owner_id,
  :life_cycle_state)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the access point. This is the value of the Name tag.

Returns:

  • (String)


85
86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 85

class AccessPointDescription < Struct.new(
  :client_token,
  :name,
  :tags,
  :access_point_id,
  :access_point_arn,
  :file_system_id,
  :posix_user,
  :root_directory,
  :owner_id,
  :life_cycle_state)
  SENSITIVE = []
  include Aws::Structure
end

#owner_idString

Identified the AWS account that owns the access point resource.

Returns:

  • (String)


85
86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 85

class AccessPointDescription < Struct.new(
  :client_token,
  :name,
  :tags,
  :access_point_id,
  :access_point_arn,
  :file_system_id,
  :posix_user,
  :root_directory,
  :owner_id,
  :life_cycle_state)
  SENSITIVE = []
  include Aws::Structure
end

#posix_userTypes::PosixUser

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.

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 85

class AccessPointDescription < Struct.new(
  :client_token,
  :name,
  :tags,
  :access_point_id,
  :access_point_arn,
  :file_system_id,
  :posix_user,
  :root_directory,
  :owner_id,
  :life_cycle_state)
  SENSITIVE = []
  include Aws::Structure
end

#root_directoryTypes::RootDirectory

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 85

class AccessPointDescription < Struct.new(
  :client_token,
  :name,
  :tags,
  :access_point_id,
  :access_point_arn,
  :file_system_id,
  :posix_user,
  :root_directory,
  :owner_id,
  :life_cycle_state)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

The tags associated with the access point, presented as an array of Tag objects.

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'gems/aws-sdk-efs/lib/aws-sdk-efs/types.rb', line 85

class AccessPointDescription < Struct.new(
  :client_token,
  :name,
  :tags,
  :access_point_id,
  :access_point_arn,
  :file_system_id,
  :posix_user,
  :root_directory,
  :owner_id,
  :life_cycle_state)
  SENSITIVE = []
  include Aws::Structure
end