Skip to content

StorageVirtualMachine

Source code in docs_src/capo_fsx/types/storage_virtual_machine.py
class StorageVirtualMachine(TypedDict, closed=True):
    active_directory_configuration: NotRequired[
        "capo_fsx.types.svm_active_directory_configuration.SvmActiveDirectoryConfiguration"
    ]
    """<p>Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.</p>"""
    creation_time: NotRequired["capo_fsx.types.creation_time.CreationTime"]
    endpoints: NotRequired["capo_fsx.types.svm_endpoints.SvmEndpoints"]
    """<p>The endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager. They are the <code>Iscsi</code>, <code>Management</code>, <code>Nfs</code>, and <code>Smb</code> endpoints.</p>"""
    file_system_id: NotRequired["capo_fsx.types.file_system_id.FileSystemId"]
    lifecycle: NotRequired[
        "capo_fsx.types.storage_virtual_machine_lifecycle.StorageVirtualMachineLifecycle"
    ]
    """<p>Describes the SVM's lifecycle status.</p> <ul> <li> <p> <code>CREATED</code> - The SVM is fully available for use.</p> </li> <li> <p> <code>CREATING</code> - Amazon FSx is creating the new SVM.</p> </li> <li> <p> <code>DELETING</code> - Amazon FSx is deleting an existing SVM.</p> </li> <li> <p> <code>FAILED</code> - Amazon FSx was unable to create the SVM.</p> </li> <li> <p> <code>MISCONFIGURED</code> - The SVM is in a failed but recoverable state.</p> </li> <li> <p> <code>PENDING</code> - Amazon FSx has not started creating the SVM.</p> </li> </ul>"""
    name: NotRequired[
        "capo_fsx.types.storage_virtual_machine_name.StorageVirtualMachineName"
    ]
    """<p>The name of the SVM, if provisioned.</p>"""
    resource_arn: NotRequired["capo_fsx.types.resource_arn.ResourceARN"]
    storage_virtual_machine_id: NotRequired[
        "capo_fsx.types.storage_virtual_machine_id.StorageVirtualMachineId"
    ]
    """<p>The SVM's system generated unique ID.</p>"""
    subtype: NotRequired[
        "capo_fsx.types.storage_virtual_machine_subtype.StorageVirtualMachineSubtype"
    ]
    """<p>Describes the SVM's subtype.</p>"""
    uuid: NotRequired["capo_fsx.types.uuid.UUID"]
    """<p>The SVM's UUID (universally unique identifier).</p>"""
    tags: NotRequired["capo_fsx.types.tags.Tags"]
    lifecycle_transition_reason: NotRequired[
        "capo_fsx.types.lifecycle_transition_reason.LifecycleTransitionReason"
    ]
    """<p>Describes why the SVM lifecycle state changed.</p>"""
    root_volume_security_style: NotRequired[
        "capo_fsx.types.storage_virtual_machine_root_volume_security_style.StorageVirtualMachineRootVolumeSecurityStyle"
    ]
    """<p>The security style of the root volume of the SVM.</p>"""

active_directory_configuration instance-attribute

active_directory_configuration: NotRequired[SvmActiveDirectoryConfiguration]

Describes the Microsoft Active Directory configuration to which the SVM is joined, if applicable.

creation_time instance-attribute

creation_time: NotRequired[CreationTime]

endpoints instance-attribute

endpoints: NotRequired[SvmEndpoints]

The endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager. They are the Iscsi, Management, Nfs, and Smb endpoints.

file_system_id instance-attribute

file_system_id: NotRequired[FileSystemId]

lifecycle instance-attribute

lifecycle: NotRequired[StorageVirtualMachineLifecycle]

Describes the SVM's lifecycle status.

  • CREATED - The SVM is fully available for use.

  • CREATING - Amazon FSx is creating the new SVM.

  • DELETING - Amazon FSx is deleting an existing SVM.

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

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

  • PENDING - Amazon FSx has not started creating the SVM.

lifecycle_transition_reason instance-attribute

lifecycle_transition_reason: NotRequired[LifecycleTransitionReason]

Describes why the SVM lifecycle state changed.

name instance-attribute

name: NotRequired[StorageVirtualMachineName]

The name of the SVM, if provisioned.

resource_arn instance-attribute

resource_arn: NotRequired[ResourceARN]

root_volume_security_style instance-attribute

root_volume_security_style: NotRequired[StorageVirtualMachineRootVolumeSecurityStyle]

The security style of the root volume of the SVM.

storage_virtual_machine_id instance-attribute

storage_virtual_machine_id: NotRequired[StorageVirtualMachineId]

The SVM's system generated unique ID.

subtype instance-attribute

subtype: NotRequired[StorageVirtualMachineSubtype]

Describes the SVM's subtype.

tags instance-attribute

tags: NotRequired[Tags]

uuid instance-attribute

uuid: NotRequired[UUID]

The SVM's UUID (universally unique identifier).