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

FieldTypeRequiredDescription
batchImportMetaDataOnCreateboolean—A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created.
dataRepositoryPathstringyesThe path to the Amazon S3 data repository that will be linked to the file system.
fileSystemIdstringyesThe globally unique ID of the file system, assigned by Amazon FSx.
fileSystemPathstringyesThis path specifies where in your file system files will be exported from or imported to.
importedFileChunkSizeinteger—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.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
s3object—The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association.
s3.autoExportPolicyobject—FSxDataRepositoryAssociationAutoExportPolicy is a nested property type of AWS::FSx::DataRepositoryAssociation.
s3.autoExportPolicy.eventsarray<string>yes
s3.autoImportPolicyobject—FSxDataRepositoryAssociationAutoImportPolicy is a nested property type of AWS::FSx::DataRepositoryAssociation.
s3.autoImportPolicy.eventsarray<string>yes
tagsarray<object>—A list of Tag values, with a maximum of 50 elements.
tags[].keystringyes
tags[].valuestringyes

Status

FieldTypeRequiredDescription
associationIdstring—The system-generated, unique ID of the data repository association.
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
resourceARNstring—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

FieldTypeRequiredDescription
namestringyesThe name of the S3 access point attachment; also used for the name of the S3 access point.
ontapConfigurationobject—The OntapConfiguration of the S3 access point attachment.
ontapConfiguration.fileSystemIdentityobjectyesThe file system identity used to authorize file access requests made using the S3 access point.
ontapConfiguration.fileSystemIdentity.typeenumyesSpecifies the FSx for ONTAP user identity type, accepts either UNIX or WINDOWS. Allowed: UNIX, WINDOWS
ontapConfiguration.fileSystemIdentity.unixUserobject—Specifies the properties of the file system UNIX user.
ontapConfiguration.fileSystemIdentity.unixUser.namestringyesThe name of the UNIX user.
ontapConfiguration.fileSystemIdentity.windowsUserobject—Specifies the properties of the file system Windows user.
ontapConfiguration.fileSystemIdentity.windowsUser.namestringyesThe name of the Windows user.
ontapConfiguration.volumeIdstringyesThe ID of the FSx for ONTAP volume that the S3 access point is attached to.
openZFSConfigurationobject—The OpenZFSConfiguration of the S3 access point attachment.
openZFSConfiguration.fileSystemIdentityobjectyesThe file system identity used to authorize file access requests made using the S3 access point.
openZFSConfiguration.fileSystemIdentity.posixUserobjectyesSpecifies the UID and GIDs of the file system POSIX user.
openZFSConfiguration.fileSystemIdentity.posixUser.gidnumberyesThe GID of the file system user.
openZFSConfiguration.fileSystemIdentity.posixUser.secondaryGidsarray<object>—The list of secondary GIDs for the file system user.
openZFSConfiguration.fileSystemIdentity.posixUser.secondaryGids[].gidnumberyesThe GID of the file system user.
openZFSConfiguration.fileSystemIdentity.posixUser.uidnumberyesThe UID of the file system user.
openZFSConfiguration.fileSystemIdentity.typeenumyesSpecifies the FSx for OpenZFS user identity type, accepts only POSIX. Allowed: POSIX
openZFSConfiguration.volumeIdstringyesThe ID of the FSx for OpenZFS volume that the S3 access point is attached to.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
s3AccessPointobject—The S3 access point configuration of the S3 access point attachment.
s3AccessPoint.aliasstring—The S3 access point's alias.
s3AccessPoint.policyobject—The S3 access point's policy.
s3AccessPoint.resourceARNstring—The S3 access point's ARN.
s3AccessPoint.vpcConfigurationobject—The S3 access point's virtual private cloud (VPC) configuration.
s3AccessPoint.vpcConfiguration.vpcIdstringyesSpecifies the virtual private cloud (VPC) for the S3 access point VPC configuration, if one exists.
typeenumyesThe type of Amazon FSx volume that the S3 access point is attached to. Allowed: OPENZFS, ONTAP

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
lifecycleenum—The lifecycle status of the S3 access point attachment. Allowed: AVAILABLE, CREATING, DELETING, FAILED, MISCONFIGURED, UPDATING
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—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

FieldTypeRequiredDescription
backupIdstring—Specifies the ID of the volume backup to use to create a new volume.
namestringyesThe name of the volume.
ontapConfigurationobject—The configuration of an Amazon FSx for NetApp ONTAP volume.
ontapConfiguration.aggregateConfigurationobject—Used to specify the configuration options for an FSx for ONTAP volume's storage aggregate or aggregates.
ontapConfiguration.aggregateConfiguration.aggregatesarray<string>—The list of aggregates that this volume resides on.
ontapConfiguration.aggregateConfiguration.constituentsPerAggregateinteger—Used to explicitly set the number of constituents within the FlexGroup per storage aggregate.
ontapConfiguration.copyTagsToBackupsstring—A boolean flag indicating whether tags for the volume should be copied to backups.
ontapConfiguration.junctionPathstring—Specifies the location in the SVM's namespace where the volume is mounted.
ontapConfiguration.ontapVolumeTypestring—Specifies the type of volume you are creating.
ontapConfiguration.securityStylestring—Specifies the security style for the volume.
ontapConfiguration.sizeInBytesstring—Specifies the configured size of the volume, in bytes.
ontapConfiguration.sizeInMegabytesstring—Use SizeInBytes instead.
ontapConfiguration.snaplockConfigurationobject—The SnapLock configuration object for an FSx for ONTAP SnapLock volume.
ontapConfiguration.snaplockConfiguration.auditLogVolumestring—Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume
ontapConfiguration.snaplockConfiguration.autocommitPeriodobject—The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.
ontapConfiguration.snaplockConfiguration.autocommitPeriod.typestringyesDefines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.
ontapConfiguration.snaplockConfiguration.autocommitPeriod.valueinteger—Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume.
ontapConfiguration.snaplockConfiguration.privilegedDeletestring—Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume.
ontapConfiguration.snaplockConfiguration.retentionPeriodobject—Specifies the retention period of an FSx for ONTAP SnapLock volume.
ontapConfiguration.snaplockConfiguration.retentionPeriod.defaultRetentionobjectyesThe 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.typestringyesDefines the type of time for the retention period of an FSx for ONTAP SnapLock volume.
ontapConfiguration.snaplockConfiguration.retentionPeriod.defaultRetention.valueinteger—Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume.
ontapConfiguration.snaplockConfiguration.retentionPeriod.maximumRetentionobjectyesThe longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
ontapConfiguration.snaplockConfiguration.retentionPeriod.maximumRetention.typestringyesDefines the type of time for the retention period of an FSx for ONTAP SnapLock volume.
ontapConfiguration.snaplockConfiguration.retentionPeriod.maximumRetention.valueinteger—Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume.
ontapConfiguration.snaplockConfiguration.retentionPeriod.minimumRetentionobjectyesThe shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
ontapConfiguration.snaplockConfiguration.retentionPeriod.minimumRetention.typestringyesDefines the type of time for the retention period of an FSx for ONTAP SnapLock volume.
ontapConfiguration.snaplockConfiguration.retentionPeriod.minimumRetention.valueinteger—Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume.
ontapConfiguration.snaplockConfiguration.snaplockTypestringyesSpecifies the retention mode of an FSx for ONTAP SnapLock volume.
ontapConfiguration.snaplockConfiguration.volumeAppendModeEnabledstring—Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume.
ontapConfiguration.snapshotPolicystring—Specifies the snapshot policy for the volume.
ontapConfiguration.storageEfficiencyEnabledstring—Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.
ontapConfiguration.storageVirtualMachineIdstringyesSpecifies the ONTAP SVM in which to create the volume.
ontapConfiguration.tieringPolicyobject—Describes the data tiering policy for an ONTAP volume.
ontapConfiguration.tieringPolicy.coolingPeriodinteger—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.namestring—Specifies the tiering policy used to transition data.
ontapConfiguration.volumeStylestring—Use to specify the style of an ONTAP volume.
openZFSConfigurationobject—The configuration of an Amazon FSx for OpenZFS volume.
openZFSConfiguration.copyTagsToSnapshotsboolean—A Boolean value indicating whether tags for the volume should be copied to snapshots.
openZFSConfiguration.dataCompressionTypestring—Specifies the method used to compress the data on the volume
openZFSConfiguration.nfsExportsarray<object>—The configuration object for mounting a Network File System (NFS) file system.
openZFSConfiguration.nfsExports[].clientConfigurationsarray<object>yesThe configuration object for mounting a Network File System (NFS) file system.
openZFSConfiguration.nfsExports[].clientConfigurations[].clientsstringyesA value that specifies who can mount the file system.
openZFSConfiguration.nfsExports[].clientConfigurations[].optionsarray<string>yesThe configuration object for mounting a Network File System (NFS) file system.
openZFSConfiguration.optionsarray<string>—The configuration object for mounting a Network File System (NFS) file system.
openZFSConfiguration.originSnapshotobject—The configuration of an Amazon FSx for OpenZFS volume.
openZFSConfiguration.originSnapshot.copyStrategystringyesThe configuration object for mounting a Network File System (NFS) file system.
openZFSConfiguration.originSnapshot.snapshotARNstringyesSpecifies the snapshot to use when creating an OpenZFS volume from a snapshot.
openZFSConfiguration.parentVolumeIdstringyesThe ID of the volume to use as the parent volume of the volume that you are creating.
openZFSConfiguration.readOnlyboolean—A Boolean value indicating whether the volume is read-only.
openZFSConfiguration.recordSizeKiBinteger—Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB).
openZFSConfiguration.storageCapacityQuotaGiBinteger—Sets the maximum storage size in gibibytes (GiB) for the volume.
openZFSConfiguration.storageCapacityReservationGiBinteger—Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume.
openZFSConfiguration.userAndGroupQuotasarray<object>—Configures how much storage users and groups can use on the volume.
openZFSConfiguration.userAndGroupQuotas[].idintegeryesThe ID of the user or group that the quota applies to.
openZFSConfiguration.userAndGroupQuotas[].storageCapacityQuotaGiBintegeryesThe user or group's storage quota, in gibibytes (GiB).
openZFSConfiguration.userAndGroupQuotas[].typestringyesSpecifies whether the quota applies to a user or group.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
tagsarray<object>—One or more tags.
tags[].keystringyes
tags[].valuestringyes
volumeTypestring—The type of the volume.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
resourceARNstring—Returns the volume's Amazon Resource Name (ARN).
uuidstring—Returns the volume's ID.
volumeIdstring—Returns the volume's universally unique identifier (UUID).