Redshift / Client / modify_cluster_snapshot

modify_cluster_snapshot#

Redshift.Client.modify_cluster_snapshot(**kwargs)#

Modifies the settings for a snapshot.

This exanmple modifies the manual retention period setting for a cluster snapshot.

Request Syntax

response = client.modify_cluster_snapshot(
    SnapshotIdentifier='string',
    ManualSnapshotRetentionPeriod=123,
    Force=True|False
)

Parameters:

SnapshotIdentifier (string) –
[REQUIRED]

The identifier of the snapshot whose setting you want to modify.
ManualSnapshotRetentionPeriod (integer) –
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

If the manual snapshot falls outside of the new retention period, you can specify the force option to immediately delete the snapshot.

The value must be either -1 or an integer between 1 and 3,653.
Force (boolean) – A Boolean option to override an exception if the retention period has already passed.

Return type:

dict

Returns:

Response Syntax

{
    'Snapshot': {
        'SnapshotIdentifier': 'string',
        'ClusterIdentifier': 'string',
        'SnapshotCreateTime': datetime(2015, 1, 1),
        'Status': 'string',
        'Port': 123,
        'AvailabilityZone': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1),
        'MasterUsername': 'string',
        'ClusterVersion': 'string',
        'EngineFullVersion': 'string',
        'SnapshotType': 'string',
        'NodeType': 'string',
        'NumberOfNodes': 123,
        'DBName': 'string',
        'VpcId': 'string',
        'Encrypted': True|False,
        'KmsKeyId': 'string',
        'EncryptedWithHSM': True|False,
        'AccountsWithRestoreAccess': [
            {
                'AccountId': 'string',
                'AccountAlias': 'string'
            },
        ],
        'OwnerAccount': 'string',
        'TotalBackupSizeInMegaBytes': 123.0,
        'ActualIncrementalBackupSizeInMegaBytes': 123.0,
        'BackupProgressInMegaBytes': 123.0,
        'CurrentBackupRateInMegaBytesPerSecond': 123.0,
        'EstimatedSecondsToCompletion': 123,
        'ElapsedTimeInSeconds': 123,
        'SourceRegion': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'RestorableNodeTypes': [
            'string',
        ],
        'EnhancedVpcRouting': True|False,
        'MaintenanceTrackName': 'string',
        'ManualSnapshotRetentionPeriod': 123,
        'ManualSnapshotRemainingDays': 123,
        'SnapshotRetentionStartTime': datetime(2015, 1, 1),
        'MasterPasswordSecretArn': 'string',
        'MasterPasswordSecretKmsKeyId': 'string',
        'SnapshotArn': 'string'
    }
}

Response Structure

(dict) –
- Snapshot (dict) –
  
  Describes a snapshot.
  - SnapshotIdentifier (string) –
    
    The snapshot identifier that is provided in the request.
  - ClusterIdentifier (string) –
    
    The identifier of the cluster for which the snapshot was taken.
  - SnapshotCreateTime (datetime) –
    
    The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.
  - Status (string) –
    
    The snapshot status. The value of the status depends on the API operation used:
    - CreateClusterSnapshot and CopyClusterSnapshot returns status as “creating”.
    - DescribeClusterSnapshots returns status as “creating”, “available”, “final snapshot”, or “failed”.
    - DeleteClusterSnapshot returns status as “deleted”.
  - Port (integer) –
    
    The port that the cluster is listening on.
  - AvailabilityZone (string) –
    
    The Availability Zone in which the cluster was created.
  - ClusterCreateTime (datetime) –
    
    The time (UTC) when the cluster was originally created.
  - MasterUsername (string) –
    
    The admin user name for the cluster.
  - ClusterVersion (string) –
    
    The version ID of the Amazon Redshift engine that is running on the cluster.
  - EngineFullVersion (string) –
    
    The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.
  - SnapshotType (string) –
    
    The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type “manual”.
  - NodeType (string) –
    
    The node type of the nodes in the cluster.
  - NumberOfNodes (integer) –
    
    The number of nodes in the cluster.
  - DBName (string) –
    
    The name of the database that was created when the cluster was created.
  - VpcId (string) –
    
    The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.
  - Encrypted (boolean) –
    
    If true, the data in the snapshot is encrypted at rest.
  - KmsKeyId (string) –
    
    The Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.
  - EncryptedWithHSM (boolean) –
    
    A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.
  - AccountsWithRestoreAccess (list) –
    
    A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.
    - (dict) –
      
      Describes an Amazon Web Services account authorized to restore a snapshot.
      - AccountId (string) –
        
        The identifier of an Amazon Web Services account authorized to restore a snapshot.
      - AccountAlias (string) –
        
        The identifier of an Amazon Web Services support account authorized to restore a snapshot. For Amazon Web Services Support, the identifier is amazon-redshift-support.
  - OwnerAccount (string) –
    
    For manual snapshots, the Amazon Web Services account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
  - TotalBackupSizeInMegaBytes (float) –
    
    The size of the complete set of backup data that would be used to restore the cluster.
  - ActualIncrementalBackupSizeInMegaBytes (float) –
    
    The size of the incremental backup.
  - BackupProgressInMegaBytes (float) –
    
    The number of megabytes that have been transferred to the snapshot backup.
  - CurrentBackupRateInMegaBytesPerSecond (float) –
    
    The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.
  - EstimatedSecondsToCompletion (integer) –
    
    The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.
  - ElapsedTimeInSeconds (integer) –
    
    The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.
  - SourceRegion (string) –
    
    The source region from which the snapshot was copied.
  - Tags (list) –
    
    The list of tags for the cluster snapshot.
    - (dict) –
      
      A tag consisting of a name/value pair for a resource.
      - Key (string) –
        
        The key, or name, for the resource tag.
      - Value (string) –
        
        The value for the resource tag.
  - RestorableNodeTypes (list) –
    
    The list of node types that this cluster snapshot is able to restore into.
    - (string) –
  - EnhancedVpcRouting (boolean) –
    
    An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
    
    If this option is true, enhanced VPC routing is enabled.
    
    Default: false
  - MaintenanceTrackName (string) –
    
    The name of the maintenance track for the snapshot.
  - ManualSnapshotRetentionPeriod (integer) –
    
    The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
    
    The value must be either -1 or an integer between 1 and 3,653.
  - ManualSnapshotRemainingDays (integer) –
    
    The number of days until a manual snapshot will pass its retention period.
  - SnapshotRetentionStartTime (datetime) –
    
    A timestamp representing the start of the retention period for the snapshot.
  - MasterPasswordSecretArn (string) –
    
    The Amazon Resource Name (ARN) for the cluster’s admin user credentials secret.
  - MasterPasswordSecretKmsKeyId (string) –
    
    The ID of the Key Management Service (KMS) key used to encrypt and store the cluster’s admin credentials secret.
  - SnapshotArn (string) –
    
    The Amazon Resource Name (ARN) of the snapshot.

modify_cluster_snapshot#

Request Syntax

Response Syntax

Response Structure

Exceptions