AccessPoint

efs.services.k8s.aws/v1alpha1

Type	Link
GoDoc	efs-controller/apis/v1alpha1#AccessPoint

Metadata

Property	Value
Scope	Namespaced
Kind	`AccessPoint`
ListKind	`AccessPointList`
Plural	`accesspoints`
Singular	`accesspoint`

Spec

fileSystemID: string
fileSystemRef: 
  from: 
    name: string
    namespace: string
posixUser: 
  gid: integer
  secondaryGIDs:
  - integer
  uid: integer
rootDirectory: 
  creationInfo: 
    ownerGID: integer
    ownerUID: integer
    permissions: string
  path: string
tags:
- key: string
  value: string

Field	Description
fileSystemID Optional	string The ID of the EFS file system that the access point provides access to.
fileSystemRef Optional	object AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef: from: name: my-api
fileSystemRef.from Optional	object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)
fileSystemRef.from.name Optional	string
fileSystemRef.from.namespace Optional	string
posixUser Optional	object The operating system user and group applied to all file system requests made using the access point.
posixUser.gid Optional	integer
posixUser.secondaryGIDs Optional	array
posixUser.secondaryGIDs.[] Required	integer
rootDirectory Optional	object 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 > 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.
rootDirectory.creationInfo Optional	object Required if the RootDirectory > Path specified does not exist. Specifies the POSIX IDs and permissions to apply to the access point’s RootDirectory > Path. If the access point root directory does not exist, EFS creates it with these settings when a client connects to the access point. When specifying CreationInfo, you must include values for all properties. 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. If you do not provide CreationInfo and the specified RootDirectory does not exist, attempts to mount the file system using the access point will fail.
rootDirectory.creationInfo.ownerGID Optional	integer
rootDirectory.creationInfo.ownerUID Optional	integer
rootDirectory.creationInfo.permissions Optional	string
rootDirectory.path Optional	string
tags Optional	array 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 (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the Amazon Web Services General Reference Guide.
tags.[] Required	object A tag is a key-value pair. Allowed characters are letters, white space, and
numbers that can be represented in UTF-8, and the following characters:+

= . _ : /. || tags.[].key
Optional | string
| | tags.[].value
Optional | string
|

Status

accessPointID: string
ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
lifeCycleState: string
name: string
ownerID: string

Field	Description
accessPointID Optional	string The ID of the access point, assigned by Amazon EFS.
ackResourceMetadata Optional	object All CRs managed by ACK have a common `Status.ACKResourceMetadata` member that is used to contain resource sync state, account ownership, constructed ARN for the resource
ackResourceMetadata.arn Optional	string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. https://github.com/aws/aws-controllers-k8s/issues/270
ackResourceMetadata.ownerAccountID Required	string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.
ackResourceMetadata.region Required	string Region is the AWS region in which the resource exists or will exist.
conditions Optional	array All CRS managed by ACK have a common `Status.Conditions` member that contains a collection of `ackv1alpha1.Condition` objects that describe the various terminal states of the CR and its backend AWS service API resource
conditions.[] Required	object Condition is the common struct used by all CRDs managed by ACK service
controllers to indicate terminal states of the CR and its backend AWS
service API resource
conditions.[].message Optional	string A human readable message indicating details about the transition.
conditions.[].reason Optional	string The reason for the condition’s last transition.
conditions.[].status Optional	string Status of the condition, one of True, False, Unknown.
conditions.[].type Optional	string Type is the type of the Condition
lifeCycleState Optional	string Identifies the lifecycle phase of the access point.
name Optional	string The name of the access point. This is the value of the Name tag.
ownerID Optional	string Identifies the Amazon Web Services account that owns the access point resource.

AccessPoint

Metadata#

Spec#

Status#

Metadata

Spec

Status