# openstack.shared_file_system.v2.share_snapshot

## The ShareSnapshot Class

The `ShareSnapshot` class inherits from `Resource`.

class openstack.shared_file_system.v2.share_snapshot.ShareSnapshot(_synchronized=False, connection=None, **attrs)

  The base resource

  Parameters:

    - _synchronized (bool) – This is not intended to be used directly. See `new()` and `existing()`.

    - connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of `self._connection` in Resource code should protect itself with a check for None.

  resource_key = 'snapshot'

    Singular form of key for resource.

  resources_key = 'snapshots'

    Plural form of key for resource.

  base_path = '/snapshots'

    The base part of the URI for this resource.

  allow_create = True

    Allow create operation for this resource.

  allow_fetch = True

    Allow get operation for this resource.

  allow_commit = True

    Allow update operation for this resource.

  allow_delete = True

    Allow delete operation for this resource.

  allow_list = True

    Allow list operation for this resource.

  allow_head = False

    Allow head operation for this resource.

  created_at

    Properties The date and time stamp when the resource was created within the service’s database.

  description

    The user defined description of the resource.

  display_name

    The user defined name of the resource.

  display_description

    The user defined description of the resource

  project_id

    ID of the project that the snapshot belongs to.

  share_id

    The UUID of the source share that was used to create the snapshot.

  share_proto

    The file system protocol of a share snapshot

  share_size

    The snapshot’s source share’s size, in GiBs.

  size

    The snapshot size, in GiBs.

  status

    The snapshot status

  user_id

    ID of the user that the snapshot was created by.

this page last updated: 2026-01-16 23:06:19

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.