DocDB / Client / restore_db_cluster_from_snapshot

restore_db_cluster_from_snapshot#

DocDB.Client.restore_db_cluster_from_snapshot(**kwargs)#

Creates a new cluster from a snapshot or cluster snapshot.

If a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group.

If a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group.

See also: AWS API Documentation

Request Syntax

response = client.restore_db_cluster_from_snapshot(
    AvailabilityZones=[
        'string',
    ],
    DBClusterIdentifier='string',
    SnapshotIdentifier='string',
    Engine='string',
    EngineVersion='string',
    Port=123,
    DBSubnetGroupName='string',
    VpcSecurityGroupIds=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    KmsKeyId='string',
    EnableCloudwatchLogsExports=[
        'string',
    ],
    DeletionProtection=True|False,
    DBClusterParameterGroupName='string',
    StorageType='string'
)
Parameters:

  • AvailabilityZones (list) –

    Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

    • (string) –

  • DBClusterIdentifier (string) –

    [REQUIRED]

    The name of the cluster to create from the snapshot or cluster snapshot. This parameter isn’t case sensitive.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.

    • The first character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    Example: my-snapshot-id

  • SnapshotIdentifier (string) –

    [REQUIRED]

    The identifier for the snapshot or cluster snapshot to restore from.

    You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.

    Constraints:

    • Must match the identifier of an existing snapshot.

  • Engine (string) –

    [REQUIRED]

    The database engine to use for the new cluster.

    Default: The same as source.

    Constraint: Must be compatible with the engine of the source.

  • EngineVersion (string) – The version of the database engine to use for the new cluster.

  • Port (integer) –

    The port number on which the new cluster accepts connections.

    Constraints: Must be a value from 1150 to 65535.

    Default: The same port as the original cluster.

  • DBSubnetGroupName (string) –

    The name of the subnet group to use for the new cluster.

    Constraints: If provided, must match the name of an existing DBSubnetGroup.

    Example: mySubnetgroup

  • VpcSecurityGroupIds (list) –

    A list of virtual private cloud (VPC) security groups that the new cluster will belong to.

    • (string) –

  • Tags (list) –

    The tags to be assigned to the restored cluster.

    • (dict) –

      Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.

      • Key (string) –

        The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with “ aws:” or “ rds:”. The string can contain only the set of Unicode letters, digits, white space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$”).

      • Value (string) –

        The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with “ aws:” or “ rds:”. The string can contain only the set of Unicode letters, digits, white space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$”).

  • KmsKeyId (string) –

    The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

    If you do not specify a value for the KmsKeyId parameter, then the following occurs:

    • If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the snapshot or the cluster snapshot.

    • If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

  • EnableCloudwatchLogsExports (list) –

    A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

    • (string) –

  • DeletionProtection (boolean) – Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

  • DBClusterParameterGroupName (string) –

    The name of the DB cluster parameter group to associate with this DB cluster.

    Type: String.       Required: No.

    If this argument is omitted, the default DB cluster parameter group is used. If supplied, must match the name of an existing default DB cluster parameter group. The string must consist of from 1 to 255 letters, numbers or hyphens. Its first character must be a letter, and it cannot end with a hyphen or contain two consecutive hyphens.

  • StorageType (string) –

    The storage type to associate with the DB cluster.

    For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

    Valid values for storage type - standard | iopt1

    Default value is standard

Return type:

dict

Returns:

Response Syntax

{
    'DBCluster': {
        'AvailabilityZones': [
            'string',
        ],
        'BackupRetentionPeriod': 123,
        'DBClusterIdentifier': 'string',
        'DBClusterParameterGroup': 'string',
        'DBSubnetGroup': 'string',
        'Status': 'string',
        'PercentProgress': 'string',
        'EarliestRestorableTime': datetime(2015, 1, 1),
        'Endpoint': 'string',
        'ReaderEndpoint': 'string',
        'MultiAZ': True|False,
        'Engine': 'string',
        'EngineVersion': 'string',
        'LatestRestorableTime': datetime(2015, 1, 1),
        'Port': 123,
        'MasterUsername': 'string',
        'PreferredBackupWindow': 'string',
        'PreferredMaintenanceWindow': 'string',
        'ReplicationSourceIdentifier': 'string',
        'ReadReplicaIdentifiers': [
            'string',
        ],
        'DBClusterMembers': [
            {
                'DBInstanceIdentifier': 'string',
                'IsClusterWriter': True|False,
                'DBClusterParameterGroupStatus': 'string',
                'PromotionTier': 123
            },
        ],
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'HostedZoneId': 'string',
        'StorageEncrypted': True|False,
        'KmsKeyId': 'string',
        'DbClusterResourceId': 'string',
        'DBClusterArn': 'string',
        'AssociatedRoles': [
            {
                'RoleArn': 'string',
                'Status': 'string'
            },
        ],
        'CloneGroupId': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1),
        'EnabledCloudwatchLogsExports': [
            'string',
        ],
        'DeletionProtection': True|False,
        'StorageType': 'string',
        'MasterUserSecret': {
            'SecretArn': 'string',
            'SecretStatus': 'string',
            'KmsKeyId': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • DBCluster (dict) –

      Detailed information about a cluster.

      • AvailabilityZones (list) –

        Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

        • (string) –

      • BackupRetentionPeriod (integer) –

        Specifies the number of days for which automatic snapshots are retained.

      • DBClusterIdentifier (string) –

        Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

      • DBClusterParameterGroup (string) –

        Specifies the name of the cluster parameter group for the cluster.

      • DBSubnetGroup (string) –

        Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.

      • Status (string) –

        Specifies the current state of this cluster.

      • PercentProgress (string) –

        Specifies the progress of the operation as a percentage.

      • EarliestRestorableTime (datetime) –

        The earliest time to which a database can be restored with point-in-time restore.

      • Endpoint (string) –

        Specifies the connection endpoint for the primary instance of the cluster.

      • ReaderEndpoint (string) –

        The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

        If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

      • MultiAZ (boolean) –

        Specifies whether the cluster has instances in multiple Availability Zones.

      • Engine (string) –

        Provides the name of the database engine to be used for this cluster.

      • EngineVersion (string) –

        Indicates the database engine version.

      • LatestRestorableTime (datetime) –

        Specifies the latest time to which a database can be restored with point-in-time restore.

      • Port (integer) –

        Specifies the port that the database engine is listening on.

      • MasterUsername (string) –

        Contains the master user name for the cluster.

      • PreferredBackupWindow (string) –

        Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

      • PreferredMaintenanceWindow (string) –

        Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

      • ReplicationSourceIdentifier (string) –

        Contains the identifier of the source cluster if this cluster is a secondary cluster.

      • ReadReplicaIdentifiers (list) –

        Contains one or more identifiers of the secondary clusters that are associated with this cluster.

        • (string) –

      • DBClusterMembers (list) –

        Provides the list of instances that make up the cluster.

        • (dict) –

          Contains information about an instance that is part of a cluster.

          • DBInstanceIdentifier (string) –

            Specifies the instance identifier for this member of the cluster.

          • IsClusterWriter (boolean) –

            A value that is true if the cluster member is the primary instance for the cluster and false otherwise.

          • DBClusterParameterGroupStatus (string) –

            Specifies the status of the cluster parameter group for this member of the DB cluster.

          • PromotionTier (integer) –

            A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

      • VpcSecurityGroups (list) –

        Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

        • (dict) –

          Used as a response element for queries on virtual private cloud (VPC) security group membership.

          • VpcSecurityGroupId (string) –

            The name of the VPC security group.

          • Status (string) –

            The status of the VPC security group.

      • HostedZoneId (string) –

        Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

      • StorageEncrypted (boolean) –

        Specifies whether the cluster is encrypted.

      • KmsKeyId (string) –

        If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.

      • DbClusterResourceId (string) –

        The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.

      • DBClusterArn (string) –

        The Amazon Resource Name (ARN) for the cluster.

      • AssociatedRoles (list) –

        Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

        • (dict) –

          Describes an Identity and Access Management (IAM) role that is associated with a cluster.

          • RoleArn (string) –

            The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.

          • Status (string) –

            Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:

            • ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.

            • PENDING - The IAMrole ARN is being associated with the cluster.

            • INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.

      • CloneGroupId (string) –

        Identifies the clone group to which the DB cluster is associated.

      • ClusterCreateTime (datetime) –

        Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

      • EnabledCloudwatchLogsExports (list) –

        A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

        • (string) –

      • DeletionProtection (boolean) –

        Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

      • StorageType (string) –

        Storage type associated with your cluster

        Storage type associated with your cluster

        For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

        Valid values for storage type - standard | iopt1

        Default value is standard

      • MasterUserSecret (dict) –

        The secret managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the master user password.

        • SecretArn (string) –

          The Amazon Resource Name (ARN) of the secret.

        • SecretStatus (string) –

          The status of the secret.

          The possible status values include the following:

          • creating - The secret is being created.

          • active - The secret is available for normal use and rotation.

          • rotating - The secret is being rotated.

          • impaired - The secret can be used to access database credentials, but it can’t be rotated. A secret might have this status if, for example, permissions are changed so that Amazon DocumentDB can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the instance to turn off automatic management of database credentials, and then modify the instance again to turn on automatic management of database credentials.

        • KmsKeyId (string) –

          The Amazon Web Services KMS key identifier that is used to encrypt the secret.

Exceptions