Skip to content

Volume

Source code in docs_src/capo_fsx/types/volume.py
class Volume(TypedDict, closed=True):
    creation_time: NotRequired["capo_fsx.types.creation_time.CreationTime"]
    file_system_id: NotRequired["capo_fsx.types.file_system_id.FileSystemId"]
    lifecycle: NotRequired["capo_fsx.types.volume_lifecycle.VolumeLifecycle"]
    """<p>The lifecycle status of the volume.</p> <ul> <li> <p> <code>AVAILABLE</code> - The volume is fully available for use.</p> </li> <li> <p> <code>CREATED</code> - The volume has been created.</p> </li> <li> <p> <code>CREATING</code> - Amazon FSx is creating the new volume.</p> </li> <li> <p> <code>DELETING</code> - Amazon FSx is deleting an existing volume.</p> </li> <li> <p> <code>FAILED</code> - Amazon FSx was unable to create the volume.</p> </li> <li> <p> <code>MISCONFIGURED</code> - The volume is in a failed but recoverable state.</p> </li> <li> <p> <code>PENDING</code> - Amazon FSx hasn't started creating the volume.</p> </li> </ul>"""
    name: NotRequired["capo_fsx.types.volume_name.VolumeName"]
    """<p>The name of the volume.</p>"""
    ontap_configuration: NotRequired[
        "capo_fsx.types.ontap_volume_configuration.OntapVolumeConfiguration"
    ]
    resource_arn: NotRequired["capo_fsx.types.resource_arn.ResourceARN"]
    tags: NotRequired["capo_fsx.types.tags.Tags"]
    volume_id: NotRequired["capo_fsx.types.volume_id.VolumeId"]
    """<p>The system-generated, unique ID of the volume.</p>"""
    volume_type: NotRequired["capo_fsx.types.volume_type.VolumeType"]
    """<p>The type of the volume.</p>"""
    lifecycle_transition_reason: NotRequired[
        "capo_fsx.types.lifecycle_transition_reason.LifecycleTransitionReason"
    ]
    """<p>The reason why the volume lifecycle status changed.</p>"""
    administrative_actions: NotRequired[
        "capo_fsx.types.administrative_actions.AdministrativeActions"
    ]
    """<p>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 <code>UpdateVolume</code> action.</p>"""
    open_zfs_configuration: NotRequired[
        "capo_fsx.types.open_zfs_volume_configuration.OpenZFSVolumeConfiguration"
    ]
    """<p>The configuration of an Amazon FSx for OpenZFS volume.</p>"""

administrative_actions instance-attribute

administrative_actions: NotRequired[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 UpdateVolume action.

creation_time instance-attribute

creation_time: NotRequired[CreationTime]

file_system_id instance-attribute

file_system_id: NotRequired[FileSystemId]

lifecycle instance-attribute

lifecycle: NotRequired[VolumeLifecycle]

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.

lifecycle_transition_reason instance-attribute

lifecycle_transition_reason: NotRequired[LifecycleTransitionReason]

The reason why the volume lifecycle status changed.

name instance-attribute

name: NotRequired[VolumeName]

The name of the volume.

ontap_configuration instance-attribute

ontap_configuration: NotRequired[OntapVolumeConfiguration]

open_zfs_configuration instance-attribute

open_zfs_configuration: NotRequired[OpenZFSVolumeConfiguration]

The configuration of an Amazon FSx for OpenZFS volume.

resource_arn instance-attribute

resource_arn: NotRequired[ResourceARN]

tags instance-attribute

tags: NotRequired[Tags]

volume_id instance-attribute

volume_id: NotRequired[VolumeId]

The system-generated, unique ID of the volume.

volume_type instance-attribute

volume_type: NotRequired[VolumeType]

The type of the volume.