FileSystem

efs.services.k8s.aws/v1alpha1

Metadata#

Spec#

availabilityZoneName: string
backup: boolean
backupPolicy: 
  status: string
encrypted: boolean
fileSystemProtection: 
  replicationOverwriteProtection: string
kmsKeyID: string
kmsKeyRef: 
  from: 
    name: string
lifecyclePolicies:
- transitionToArchive: string
  transitionToIA: string
  transitionToPrimaryStorageClass: string
performanceMode: string
policy: string
provisionedThroughputInMiBps: number
tags:
- key: string
  value: string
throughputMode: string

When using the put-lifecycle-configuration CLI command or the PutLifecycleConfiguration API action, Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies must be structured as an array of LifecyclePolicy objects, one object for each transition. For more information, see the request examples in PutLifecycleConfiguration. || lifecyclePolicies.[].transitionToArchive
Optional | string
| | lifecyclePolicies.[].transitionToIA
Optional | string
| | lifecyclePolicies.[].transitionToPrimaryStorageClass
Optional | string
| | performanceMode
Optional | string
The Performance mode of the file system. We recommend generalPurpose performance
mode for all file systems. File systems using the maxIO performance mode
can scale to higher levels of aggregate throughput and operations per second
with a tradeoff of slightly higher latencies for most file operations. The
performance mode can’t be changed after the file system has been created.
The maxIO mode is not supported on One Zone file systems.


Due to the higher per-operation latencies with Max I/O, we recommend using
General Purpose performance mode for all file systems.


Default is generalPurpose. | | policy
Optional | string
The FileSystemPolicy that you’re creating. Accepts a JSON formatted policy
definition. EFS file system policies have a 20,000 character limit. To find
out more about the elements that make up a file system policy, see EFS Resource-based
Policies (https://docs.aws.amazon.com/efs/latest/ug/access-control-overview.html#access-control-manage-access-intro-resource-policies). | | provisionedThroughputInMiBps
Optional | number
The throughput, measured in mebibytes per second (MiBps), that you want to
provision for a file system that you’re creating. Required if ThroughputMode
is set to provisioned. Valid values are 1-3414 MiBps, with the upper limit
depending on Region. To increase this limit, contact Amazon Web Services
Support. For more information, see Amazon EFS quotas that you can increase
(https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the
Amazon EFS User Guide. | | tags
Optional | array
Use to create one or more tags associated with the file system. Each tag
is a user-defined key-value pair. Name your file system on creation by including
a “Key”:“Name”,“Value”:"{value}" 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
  | | throughputMode
  Optional | string
  Specifies the throughput mode for the file system. The mode can be bursting,
  provisioned, or elastic. If you set ThroughputMode to provisioned, you must
  also set a value for ProvisionedThroughputInMibps. After you create the file
  system, you can decrease your file system’s Provisioned throughput or change
  between the throughput modes, with certain time restrictions. For more information,
  see Specifying throughput with provisioned mode (https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput)
  in the Amazon EFS User Guide.
  
  
  Default is bursting. |

Status#

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
availabilityZoneID: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
creationTime: string
fileSystemID: string
lifeCycleState: string
name: string
numberOfMountTargets: integer
ownerID: string
sizeInBytes: 
  timestamp: string
  value: integer
  valueInArchive: integer
  valueInIA: integer
  valueInStandard: integer