Skip to content

CreateBackupRequest

Source code in docs_src/capo_fsx/types/create_backup_request.py 
14
15
16
17
18
19
20
21
22
23
24
class CreateBackupRequest(TypedDict, closed=True):
    file_system_id: NotRequired["capo_fsx.types.file_system_id.FileSystemId"]
    """<p>The ID of the file system to back up.</p>"""
    client_request_token: NotRequired[
        "capo_fsx.types.client_request_token.ClientRequestToken"
    ]
    """<p>(Optional) A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.</p>"""
    tags: NotRequired["capo_fsx.types.tags.Tags"]
    """<p>(Optional) The tags to apply to the backup at backup creation. The key value of the <code>Name</code> tag appears in the console as the backup name. If you have set <code>CopyTagsToBackups</code> to <code>true</code>, and you specify one or more tags using the <code>CreateBackup</code> operation, no existing file system tags are copied from the file system to the backup.</p>"""
    volume_id: NotRequired["capo_fsx.types.volume_id.VolumeId"]
    """<p>(Optional) The ID of the FSx for ONTAP volume to back up.</p>"""

client_request_token instance-attribute 

client_request_token: NotRequired[ClientRequestToken]

(Optional) A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

file_system_id instance-attribute 

file_system_id: NotRequired[FileSystemId]

The ID of the file system to back up.

tags instance-attribute 

tags: NotRequired[Tags]

(Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears in the console as the backup name. If you have set CopyTagsToBackups to true, and you specify one or more tags using the CreateBackup operation, no existing file system tags are copied from the file system to the backup.

volume_id instance-attribute 

volume_id: NotRequired[VolumeId]

(Optional) The ID of the FSx for ONTAP volume to back up.