• Public
  • Public/Protected
  • All

Interface Volume

Describes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.


  • Volume



Optional AdministrativeActions

AdministrativeActions: AdministrativeAction[]

A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the UpdateVolume action.

Optional CreationTime

CreationTime: Date

The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

Optional FileSystemId

FileSystemId: undefined | string

The globally unique ID of the file system, assigned by Amazon FSx.

Optional Lifecycle

Lifecycle: VolumeLifecycle | string

The lifecycle status of the volume.

  • AVAILABLE - The volume is fully available for use.

  • CREATED - The volume has been created.

  • CREATING - Amazon FSx is creating the new volume.

  • DELETING - Amazon FSx is deleting an existing volume.

  • FAILED - Amazon FSx was unable to create the volume.

  • MISCONFIGURED - The volume is in a failed but recoverable state.

  • PENDING - Amazon FSx hasn't started creating the volume.

Optional LifecycleTransitionReason

LifecycleTransitionReason: LifecycleTransitionReason

The reason why the volume lifecycle status changed.

Optional Name

Name: undefined | string

The name of the volume.

Optional OntapConfiguration

OntapConfiguration: OntapVolumeConfiguration

The configuration of an Amazon FSx for NetApp ONTAP volume.

Optional OpenZFSConfiguration

OpenZFSConfiguration: OpenZFSVolumeConfiguration

The configuration of an Amazon FSx for OpenZFS volume.

Optional ResourceARN

ResourceARN: undefined | string

The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Optional Tags

Tags: Tag[]

A list of Tag values, with a maximum of 50 elements.

Optional VolumeId

VolumeId: undefined | string

The system-generated, unique ID of the volume.

Optional VolumeType

VolumeType: VolumeType | string

The type of the volume.