EFS

3 resource kinds. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

EFSAccessPoint # GA

EFSAccessPoint is the Schema for managing EFS access points.

kubectl get efsaccesspoints · example on GitHub

Example

# EFSAccessPoint — EFS
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/efs.html#efsaccesspoint
apiVersion: aws.konfig.io/v1alpha1
kind: EFSAccessPoint
metadata:
  name: example-efsaccesspoint
  namespace: default
spec:
  fileSystemId: fs-0abc1234def567890
  posixUser:
    gid: 1
    secondaryGids:
    - 1
    uid: 1
  providerRef:
    name: example-efsaccesspoint
    region: us-east-1
  rootDirectory:
    creationInfo:
      ownerGid: 1
      ownerUid: 1
      permissions: example
    path: example
  tags:
    environment: dev
    team: platform

Spec

Field	Type	Required	Description
`fileSystemId`	string	yes	FileSystemID is the ID of the EFS file system.
`posixUser`	object	—	PosixUser specifies the POSIX user identity for the access point.
`posixUser.gid`	integer	yes	GID is the POSIX group ID.
`posixUser.secondaryGids`	array<integer>	—	SecondaryGIDs are additional POSIX group IDs.
`posixUser.uid`	integer	yes	UID is the POSIX user ID.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`rootDirectory`	object	—	RootDirectory specifies the root directory configuration.
`rootDirectory.creationInfo`	object	—	CreationInfo specifies the POSIX identity used to create the root directory.
`rootDirectory.creationInfo.ownerGid`	integer	yes	OwnerGID is the POSIX group ID of the directory owner.
`rootDirectory.creationInfo.ownerUid`	integer	yes	OwnerUID is the POSIX user ID of the directory owner.
`rootDirectory.creationInfo.permissions`	string	yes	Permissions are the POSIX permissions of the directory in octal notation.
`rootDirectory.path`	string	—	Path is the full path to the root directory.
`tags`	map<string>	—	Tags are AWS resource tags to apply.

Status

Field	Type	Required	Description
`accessPointArn`	string	—	AccessPointARN is the ARN of the access point.
`accessPointId`	string	—	AccessPointID is the ID of the access point.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`lifeCycleState`	string	—	LifeCycleState is the current state of the access point.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.

EFSFileSystem # GA

EFSFileSystem is the Schema for managing EFS file systems.

kubectl get efsfilesystems · example on GitHub

Example

# EFSFileSystem — EFS
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/efs.html#efsfilesystem
apiVersion: aws.konfig.io/v1alpha1
kind: EFSFileSystem
metadata:
  name: example-efsfilesystem
  namespace: default
spec:
  encrypted: true
  kmsKeyId: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
  performanceMode: generalPurpose
  providerRef:
    name: example-efsfilesystem
    region: us-east-1
  provisionedThroughputInMibps: 1
  tags:
    environment: dev
    team: platform
  throughputMode: bursting

Spec

Field	Type	Required	Description
`encrypted`	boolean	—	Encrypted specifies whether the file system is encrypted at rest.
`kmsKeyId`	string	—	KMSKeyID is the ARN or ID of the KMS key for encryption.
`performanceMode`	enum	—	PerformanceMode sets the performance mode of the file system. Allowed: `generalPurpose, maxIO`
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`provisionedThroughputInMibps`	number	—	ProvisionedThroughputInMibps sets provisioned throughput (only for provisioned mode).
`tags`	map<string>	—	Tags are AWS resource tags to apply.
`throughputMode`	enum	—	ThroughputMode sets the throughput mode of the file system. Allowed: `bursting, provisioned, elastic`

Status

Field	Type	Required	Description
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`fileSystemArn`	string	—	FileSystemARN is the ARN of the EFS file system.
`fileSystemId`	string	—	FileSystemID is the ID of the EFS file system.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`lifeCycleState`	string	—	LifeCycleState is the current state of the file system.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.

EFSMountTarget # GA

EFSMountTarget is the Schema for managing EFS mount targets.

kubectl get efsmounttargets · example on GitHub

Example

# EFSMountTarget — EFS
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/efs.html#efsmounttarget
apiVersion: aws.konfig.io/v1alpha1
kind: EFSMountTarget
metadata:
  name: example-efsmounttarget
  namespace: default
spec:
  fileSystemId: fs-0abc1234def567890
  ipAddress: example
  providerRef:
    name: example-efsmounttarget
    region: us-east-1
  securityGroups:
  - example
  subnetId: subnet-0abc12def3456789

Spec

Field	Type	Required	Description
`fileSystemId`	string	yes	FileSystemID is the ID of the EFS file system.
`ipAddress`	string	—	IPAddress is a valid IPv4 address within the address range of the subnet.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`securityGroups`	array<string>	—	SecurityGroups are the security group IDs to associate with the mount target.
`subnetId`	string	yes	SubnetID is the VPC subnet ID in which to create the mount target.

Status

Field	Type	Required	Description
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`ipAddress`	string	—	IPAddress is the IP address of the mount target.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`lifeCycleState`	string	—	LifeCycleState is the current lifecycle state of the mount target.
`mountTargetId`	string	—	MountTargetID is the ID of the mount target.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.