CloudHSMV2 / Client / modify_backup_attributes

modify_backup_attributes#

CloudHSMV2.Client.modify_backup_attributes(**kwargs)#

Modifies attributes for CloudHSM backup.

Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.modify_backup_attributes(
    BackupId='string',
    NeverExpires=True|False
)
Parameters:

  • BackupId (string) –

    [REQUIRED]

    The identifier (ID) of the backup to modify. To find the ID of a backup, use the DescribeBackups operation.

  • NeverExpires (boolean) –

    [REQUIRED]

    Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.

Return type:

dict

Returns:

Response Syntax

{
    'Backup': {
        'BackupId': 'string',
        'BackupArn': 'string',
        'BackupState': 'CREATE_IN_PROGRESS'|'READY'|'DELETED'|'PENDING_DELETION',
        'ClusterId': 'string',
        'CreateTimestamp': datetime(2015, 1, 1),
        'CopyTimestamp': datetime(2015, 1, 1),
        'NeverExpires': True|False,
        'SourceRegion': 'string',
        'SourceBackup': 'string',
        'SourceCluster': 'string',
        'DeleteTimestamp': datetime(2015, 1, 1),
        'TagList': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'HsmType': 'string',
        'Mode': 'FIPS'|'NON_FIPS'
    }
}

Response Structure

  • (dict) –

    • Backup (dict) –

      Contains information about a backup of an CloudHSM cluster. All backup objects contain the BackupId, BackupState, ClusterId, and CreateTimestamp parameters. Backups that were copied into a destination region additionally contain the CopyTimestamp, SourceBackup, SourceCluster, and SourceRegion parameters. A backup that is pending deletion will include the DeleteTimestamp parameter.

      • BackupId (string) –

        The identifier (ID) of the backup.

      • BackupArn (string) –

        The Amazon Resource Name (ARN) of the backup.

      • BackupState (string) –

        The state of the backup.

      • ClusterId (string) –

        The identifier (ID) of the cluster that was backed up.

      • CreateTimestamp (datetime) –

        The date and time when the backup was created.

      • CopyTimestamp (datetime) –

        The date and time when the backup was copied from a source backup.

      • NeverExpires (boolean) –

        Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.

      • SourceRegion (string) –

        The AWS Region that contains the source backup from which the new backup was copied.

      • SourceBackup (string) –

        The identifier (ID) of the source backup from which the new backup was copied.

      • SourceCluster (string) –

        The identifier (ID) of the cluster containing the source backup from which the new backup was copied.

      • DeleteTimestamp (datetime) –

        The date and time when the backup will be permanently deleted.

      • TagList (list) –

        The list of tags for the backup.

        • (dict) –

          Contains a tag. A tag is a key-value pair.

          • Key (string) –

            The key of the tag.

          • Value (string) –

            The value of the tag.

      • HsmType (string) –

        The HSM type used to create the backup.

      • Mode (string) –

        The mode of the cluster that was backed up.

Exceptions