Volume
Describes an Amazon FSx volume.
Contents
- AdministrativeActions
-
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
UpdateVolumeaction.Type: Array of AdministrativeAction objects
Array Members: Maximum number of 50 items.
Required: No
- CreationTime
-
The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
Type: Timestamp
Required: No
- FileSystemId
-
The globally unique ID of the file system, assigned by Amazon FSx.
Type: String
Length Constraints: Minimum length of 11. Maximum length of 21.
Pattern:
^(fs-[0-9a-f]{8,})$Required: No
- Lifecycle
-
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.
Type: String
Valid Values:
CREATING | CREATED | DELETING | FAILED | MISCONFIGURED | PENDING | AVAILABLERequired: No
-
- LifecycleTransitionReason
-
The reason why the volume lifecycle status changed.
Type: LifecycleTransitionReason object
Required: No
- Name
-
The name of the volume.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 203.
Pattern:
^[^\u0000\u0085\u2028\u2029\r\n]{1,203}$Required: No
- OntapConfiguration
-
The configuration of an Amazon FSx for NetApp ONTAP volume.
Type: OntapVolumeConfiguration object
Required: No
- OpenZFSConfiguration
-
The configuration of an Amazon FSx for OpenZFS volume.
Type: OpenZFSVolumeConfiguration object
Required: No
- ResourceARN
-
The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify AWS resources. We require an ARN when you need to specify a resource unambiguously across all of AWS. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
Type: String
Length Constraints: Minimum length of 8. Maximum length of 512.
Pattern:
^arn:(?=[^:]+:fsx:[^:]+:\d{12}:)((|(?=[a-z0-9-.]{1,63})(?!\d{1,3}(\.\d{1,3}){3})(?![^:]*-{2})(?![^:]*-\.)(?![^:]*\.-)[a-z0-9].*(?<!-)):){4}(?!/).{0,1024}$Required: No
- Tags
-
A list of
Tagvalues, with a maximum of 50 elements.Type: Array of Tag objects
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Required: No
- VolumeId
-
The system-generated, unique ID of the volume.
Type: String
Length Constraints: Fixed length of 23.
Pattern:
^(fsvol-[0-9a-f]{17,})$Required: No
- VolumeType
-
The type of the volume.
Type: String
Valid Values:
ONTAP | OPENZFSRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
