FSx
3 resource kinds. Generated from the operator's CRD schemas.
API Group:
aws.konfig.io/v1alpha1
FSxDataRepositoryAssociation # CLOUD CONTROL · AWS::FSx::DataRepositoryAssociation
FSxDataRepositoryAssociation manages AWS::FSx::DataRepositoryAssociation through the AWS Cloud Control API.
kubectl get fsxdatarepositoryassociations · example on GitHub
Example
# FSxDataRepositoryAssociation — FSx
# 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/fsx.html#fsxdatarepositoryassociation
apiVersion: aws.konfig.io/v1alpha1
kind: FSxDataRepositoryAssociation
metadata:
name: example-fsxdatarepositoryassociation
namespace: default
spec:
batchImportMetaDataOnCreate: false
dataRepositoryPath: example
fileSystemId: fs-0abc1234def567890
fileSystemPath: example
importedFileChunkSize: 443
providerRef:
name: example-fsxdatarepositoryassociation
region: us-east-1
s3:
autoExportPolicy:
events:
- example
autoImportPolicy:
events:
- example
tags:
- key: example
value: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
batchImportMetaDataOnCreate | boolean | — | A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created. |
dataRepositoryPath | string | yes | The path to the Amazon S3 data repository that will be linked to the file system. |
fileSystemId | string | yes | The globally unique ID of the file system, assigned by Amazon FSx. |
fileSystemPath | string | yes | This path specifies where in your file system files will be exported from or imported to. |
importedFileChunkSize | integer | — | For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. |
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. |
s3 | object | — | The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. |
s3.autoExportPolicy | object | — | FSxDataRepositoryAssociationAutoExportPolicy is a nested property type of AWS::FSx::DataRepositoryAssociation. |
s3.autoExportPolicy.events | array<string> | yes | |
s3.autoImportPolicy | object | — | FSxDataRepositoryAssociationAutoImportPolicy is a nested property type of AWS::FSx::DataRepositoryAssociation. |
s3.autoImportPolicy.events | array<string> | yes | |
tags | array<object> | — | A list of Tag values, with a maximum of 50 elements. |
tags[].key | string | yes | |
tags[].value | string | yes |
Status
| Field | Type | Required | Description |
|---|---|---|---|
associationId | string | — | The system-generated, unique ID of the data repository association. |
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
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. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
resourceARN | string | — | The Amazon Resource Name (ARN) for a given resource. |
FSxS3AccessPointAttachment # CLOUD CONTROL · AWS::FSx::S3AccessPointAttachment
FSxS3AccessPointAttachment manages AWS::FSx::S3AccessPointAttachment through the AWS Cloud Control API.
kubectl get fsxs3accesspointattachments · example on GitHub
Example
# FSxS3AccessPointAttachment — FSx
# 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/fsx.html#fsxs3accesspointattachment
apiVersion: aws.konfig.io/v1alpha1
kind: FSxS3AccessPointAttachment
metadata:
name: example-fsxs3accesspointattachment
namespace: default
spec:
name: example-fsxs3accesspointattachment
ontapConfiguration:
fileSystemIdentity:
type: UNIX
unixUser:
name: example-unixuser
windowsUser:
name: example-windowsuser
volumeId: example-id-xxxxxxxxxxxx
openZFSConfiguration:
fileSystemIdentity:
posixUser:
gid: 1
secondaryGids:
- gid: 1
uid: 1
type: POSIX
volumeId: example-id-xxxxxxxxxxxx
providerRef:
name: example-fsxs3accesspointattachment
region: us-east-1
s3AccessPoint:
alias: example
resourceARN: arn:aws:iam::123456789012:role/example-role
vpcConfiguration:
vpcId: vpc-0abc12def3456789
type: OPENZFS
Spec
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | The name of the S3 access point attachment; also used for the name of the S3 access point. |
ontapConfiguration | object | — | The OntapConfiguration of the S3 access point attachment. |
ontapConfiguration.fileSystemIdentity | object | yes | The file system identity used to authorize file access requests made using the S3 access point. |
ontapConfiguration.fileSystemIdentity.type | enum | yes | Specifies the FSx for ONTAP user identity type, accepts either UNIX or WINDOWS. Allowed: UNIX, WINDOWS |
ontapConfiguration.fileSystemIdentity.unixUser | object | — | Specifies the properties of the file system UNIX user. |
ontapConfiguration.fileSystemIdentity.unixUser.name | string | yes | The name of the UNIX user. |
ontapConfiguration.fileSystemIdentity.windowsUser | object | — | Specifies the properties of the file system Windows user. |
ontapConfiguration.fileSystemIdentity.windowsUser.name | string | yes | The name of the Windows user. |
ontapConfiguration.volumeId | string | yes | The ID of the FSx for ONTAP volume that the S3 access point is attached to. |
openZFSConfiguration | object | — | The OpenZFSConfiguration of the S3 access point attachment. |
openZFSConfiguration.fileSystemIdentity | object | yes | The file system identity used to authorize file access requests made using the S3 access point. |
openZFSConfiguration.fileSystemIdentity.posixUser | object | yes | Specifies the UID and GIDs of the file system POSIX user. |
openZFSConfiguration.fileSystemIdentity.posixUser.gid | number | yes | The GID of the file system user. |
openZFSConfiguration.fileSystemIdentity.posixUser.secondaryGids | array<object> | — | The list of secondary GIDs for the file system user. |
openZFSConfiguration.fileSystemIdentity.posixUser.secondaryGids[].gid | number | yes | The GID of the file system user. |
openZFSConfiguration.fileSystemIdentity.posixUser.uid | number | yes | The UID of the file system user. |
openZFSConfiguration.fileSystemIdentity.type | enum | yes | Specifies the FSx for OpenZFS user identity type, accepts only POSIX. Allowed: POSIX |
openZFSConfiguration.volumeId | string | yes | The ID of the FSx for OpenZFS volume that the S3 access point is attached to. |
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. |
s3AccessPoint | object | — | The S3 access point configuration of the S3 access point attachment. |
s3AccessPoint.alias | string | — | The S3 access point's alias. |
s3AccessPoint.policy | object | — | The S3 access point's policy. |
s3AccessPoint.resourceARN | string | — | The S3 access point's ARN. |
s3AccessPoint.vpcConfiguration | object | — | The S3 access point's virtual private cloud (VPC) configuration. |
s3AccessPoint.vpcConfiguration.vpcId | string | yes | Specifies the virtual private cloud (VPC) for the S3 access point VPC configuration, if one exists. |
type | enum | yes | The type of Amazon FSx volume that the S3 access point is attached to. Allowed: OPENZFS, ONTAP |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
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. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
lifecycle | enum | — | The lifecycle status of the S3 access point attachment. Allowed: AVAILABLE, CREATING, DELETING, FAILED, MISCONFIGURED, UPDATING |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
FSxVolume # CLOUD CONTROL · AWS::FSx::Volume
FSxVolume manages AWS::FSx::Volume through the AWS Cloud Control API.
kubectl get fsxvolumes · example on GitHub
Example
# FSxVolume — FSx
# 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/fsx.html#fsxvolume
apiVersion: aws.konfig.io/v1alpha1
kind: FSxVolume
metadata:
name: example-fsxvolume
namespace: default
spec:
name: example-fsxvolume
ontapConfiguration:
aggregateConfiguration:
aggregates:
- example
constituentsPerAggregate: 1
copyTagsToBackups: example
junctionPath: example
ontapVolumeType: example
securityStyle: example
sizeInBytes: example
sizeInMegabytes: example
snaplockConfiguration:
auditLogVolume: example
autocommitPeriod:
type: example
value: 1
privilegedDelete: example
retentionPeriod:
defaultRetention:
type: example
value: 1
maximumRetention:
type: example
value: 1
minimumRetention:
type: example
value: 1
snaplockType: example
volumeAppendModeEnabled: example
snapshotPolicy: example
storageEfficiencyEnabled: example
storageVirtualMachineId: example-id
tieringPolicy:
coolingPeriod: 1
name: example-fsxvolume
volumeStyle: example
openZFSConfiguration:
copyTagsToSnapshots: false
dataCompressionType: example
nfsExports:
- clientConfigurations:
- clients: example
options:
- example
options:
- example
originSnapshot:
copyStrategy: example
snapshotARN: arn:aws:iam::123456789012:role/example-role
parentVolumeId: example-id
readOnly: false
recordSizeKiB: 2
storageCapacityQuotaGiB: 2
storageCapacityReservationGiB: 2
userAndGroupQuotas:
- id: 1
storageCapacityQuotaGiB: 2
type: example
providerRef:
name: example-fsxvolume
region: us-east-1
tags:
- key: example
value: example
volumeType: example
Spec
| Field | Type | Required | Description |
|---|---|---|---|
backupId | string | — | Specifies the ID of the volume backup to use to create a new volume. |
name | string | yes | The name of the volume. |
ontapConfiguration | object | — | The configuration of an Amazon FSx for NetApp ONTAP volume. |
ontapConfiguration.aggregateConfiguration | object | — | Used to specify the configuration options for an FSx for ONTAP volume's storage aggregate or aggregates. |
ontapConfiguration.aggregateConfiguration.aggregates | array<string> | — | The list of aggregates that this volume resides on. |
ontapConfiguration.aggregateConfiguration.constituentsPerAggregate | integer | — | Used to explicitly set the number of constituents within the FlexGroup per storage aggregate. |
ontapConfiguration.copyTagsToBackups | string | — | A boolean flag indicating whether tags for the volume should be copied to backups. |
ontapConfiguration.junctionPath | string | — | Specifies the location in the SVM's namespace where the volume is mounted. |
ontapConfiguration.ontapVolumeType | string | — | Specifies the type of volume you are creating. |
ontapConfiguration.securityStyle | string | — | Specifies the security style for the volume. |
ontapConfiguration.sizeInBytes | string | — | Specifies the configured size of the volume, in bytes. |
ontapConfiguration.sizeInMegabytes | string | — | Use SizeInBytes instead. |
ontapConfiguration.snaplockConfiguration | object | — | The SnapLock configuration object for an FSx for ONTAP SnapLock volume. |
ontapConfiguration.snaplockConfiguration.auditLogVolume | string | — | Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume |
ontapConfiguration.snaplockConfiguration.autocommitPeriod | object | — | The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume. |
ontapConfiguration.snaplockConfiguration.autocommitPeriod.type | string | yes | Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. |
ontapConfiguration.snaplockConfiguration.autocommitPeriod.value | integer | — | Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. |
ontapConfiguration.snaplockConfiguration.privilegedDelete | string | — | Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. |
ontapConfiguration.snaplockConfiguration.retentionPeriod | object | — | Specifies the retention period of an FSx for ONTAP SnapLock volume. |
ontapConfiguration.snaplockConfiguration.retentionPeriod.defaultRetention | object | yes | The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. |
ontapConfiguration.snaplockConfiguration.retentionPeriod.defaultRetention.type | string | yes | Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. |
ontapConfiguration.snaplockConfiguration.retentionPeriod.defaultRetention.value | integer | — | Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. |
ontapConfiguration.snaplockConfiguration.retentionPeriod.maximumRetention | object | yes | The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. |
ontapConfiguration.snaplockConfiguration.retentionPeriod.maximumRetention.type | string | yes | Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. |
ontapConfiguration.snaplockConfiguration.retentionPeriod.maximumRetention.value | integer | — | Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. |
ontapConfiguration.snaplockConfiguration.retentionPeriod.minimumRetention | object | yes | The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume. |
ontapConfiguration.snaplockConfiguration.retentionPeriod.minimumRetention.type | string | yes | Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. |
ontapConfiguration.snaplockConfiguration.retentionPeriod.minimumRetention.value | integer | — | Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. |
ontapConfiguration.snaplockConfiguration.snaplockType | string | yes | Specifies the retention mode of an FSx for ONTAP SnapLock volume. |
ontapConfiguration.snaplockConfiguration.volumeAppendModeEnabled | string | — | Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. |
ontapConfiguration.snapshotPolicy | string | — | Specifies the snapshot policy for the volume. |
ontapConfiguration.storageEfficiencyEnabled | string | — | Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them. |
ontapConfiguration.storageVirtualMachineId | string | yes | Specifies the ONTAP SVM in which to create the volume. |
ontapConfiguration.tieringPolicy | object | — | Describes the data tiering policy for an ONTAP volume. |
ontapConfiguration.tieringPolicy.coolingPeriod | integer | — | Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. |
ontapConfiguration.tieringPolicy.name | string | — | Specifies the tiering policy used to transition data. |
ontapConfiguration.volumeStyle | string | — | Use to specify the style of an ONTAP volume. |
openZFSConfiguration | object | — | The configuration of an Amazon FSx for OpenZFS volume. |
openZFSConfiguration.copyTagsToSnapshots | boolean | — | A Boolean value indicating whether tags for the volume should be copied to snapshots. |
openZFSConfiguration.dataCompressionType | string | — | Specifies the method used to compress the data on the volume |
openZFSConfiguration.nfsExports | array<object> | — | The configuration object for mounting a Network File System (NFS) file system. |
openZFSConfiguration.nfsExports[].clientConfigurations | array<object> | yes | The configuration object for mounting a Network File System (NFS) file system. |
openZFSConfiguration.nfsExports[].clientConfigurations[].clients | string | yes | A value that specifies who can mount the file system. |
openZFSConfiguration.nfsExports[].clientConfigurations[].options | array<string> | yes | The configuration object for mounting a Network File System (NFS) file system. |
openZFSConfiguration.options | array<string> | — | The configuration object for mounting a Network File System (NFS) file system. |
openZFSConfiguration.originSnapshot | object | — | The configuration of an Amazon FSx for OpenZFS volume. |
openZFSConfiguration.originSnapshot.copyStrategy | string | yes | The configuration object for mounting a Network File System (NFS) file system. |
openZFSConfiguration.originSnapshot.snapshotARN | string | yes | Specifies the snapshot to use when creating an OpenZFS volume from a snapshot. |
openZFSConfiguration.parentVolumeId | string | yes | The ID of the volume to use as the parent volume of the volume that you are creating. |
openZFSConfiguration.readOnly | boolean | — | A Boolean value indicating whether the volume is read-only. |
openZFSConfiguration.recordSizeKiB | integer | — | Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). |
openZFSConfiguration.storageCapacityQuotaGiB | integer | — | Sets the maximum storage size in gibibytes (GiB) for the volume. |
openZFSConfiguration.storageCapacityReservationGiB | integer | — | Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. |
openZFSConfiguration.userAndGroupQuotas | array<object> | — | Configures how much storage users and groups can use on the volume. |
openZFSConfiguration.userAndGroupQuotas[].id | integer | yes | The ID of the user or group that the quota applies to. |
openZFSConfiguration.userAndGroupQuotas[].storageCapacityQuotaGiB | integer | yes | The user or group's storage quota, in gibibytes (GiB). |
openZFSConfiguration.userAndGroupQuotas[].type | string | yes | Specifies whether the quota applies to a user or group. |
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. |
tags | array<object> | — | One or more tags. |
tags[].key | string | yes | |
tags[].value | string | yes | |
volumeType | string | — | The type of the volume. |
Status
| Field | Type | Required | Description |
|---|---|---|---|
attempt | integer | — | Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure. |
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. |
identifier | string | — | Identifier is the Cloud Control primary identifier of the resource. |
lastSyncTime | string | — | |
observedGeneration | integer | — | |
operation | string | — | Operation is the in-flight operation (CREATE, UPDATE, DELETE). |
operationStatus | string | — | OperationStatus is the last reported operation status. |
requestToken | string | — | RequestToken tracks an in-flight asynchronous operation. |
resourceARN | string | — | Returns the volume's Amazon Resource Name (ARN). |
uuid | string | — | Returns the volume's ID. |
volumeId | string | — | Returns the volume's universally unique identifier (UUID). |