Package software.amazon.awssdk.services.docdb.model

Interface RestoreDbClusterToPointInTimeRequest.Builder

    • Method Detail

      • dbClusterIdentifier

        RestoreDbClusterToPointInTimeRequest.Builder dbClusterIdentifier​(String dbClusterIdentifier)

        The name of the new cluster to be created.

        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.

        Parameters:
        dbClusterIdentifier - The name of the new cluster to be created.

        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • restoreType

        RestoreDbClusterToPointInTimeRequest.Builder restoreType​(String restoreType)

        The type of restore to be performed. You can specify one of the following values:

        • full-copy - The new DB cluster is restored as a full copy of the source DB cluster.

        • copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

        Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

        If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

        Parameters:
        restoreType - The type of restore to be performed. You can specify one of the following values:

        • full-copy - The new DB cluster is restored as a full copy of the source DB cluster.

        • copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

        Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

        If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sourceDBClusterIdentifier

        RestoreDbClusterToPointInTimeRequest.Builder sourceDBClusterIdentifier​(String sourceDBClusterIdentifier)

        The identifier of the source cluster from which to restore.

        Constraints:

        • Must match the identifier of an existing DBCluster.

        Parameters:
        sourceDBClusterIdentifier - The identifier of the source cluster from which to restore.

        Constraints:

        • Must match the identifier of an existing DBCluster.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • restoreToTime

        RestoreDbClusterToPointInTimeRequest.Builder restoreToTime​(Instant restoreToTime)

        The date and time to restore the cluster to.

        Valid values: A time in Universal Coordinated Time (UTC) format.

        Constraints:

        • Must be before the latest restorable time for the instance.

        • Must be specified if the UseLatestRestorableTime parameter is not provided.

        • Cannot be specified if the UseLatestRestorableTime parameter is true.

        • Cannot be specified if the RestoreType parameter is copy-on-write.

        Example: 2015-03-07T23:45:00Z

        Parameters:
        restoreToTime - The date and time to restore the cluster to.

        Valid values: A time in Universal Coordinated Time (UTC) format.

        Constraints:

        • Must be before the latest restorable time for the instance.

        • Must be specified if the UseLatestRestorableTime parameter is not provided.

        • Cannot be specified if the UseLatestRestorableTime parameter is true.

        • Cannot be specified if the RestoreType parameter is copy-on-write.

        Example: 2015-03-07T23:45:00Z

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • useLatestRestorableTime

        RestoreDbClusterToPointInTimeRequest.Builder useLatestRestorableTime​(Boolean useLatestRestorableTime)

        A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.

        Default: false

        Constraints: Cannot be specified if the RestoreToTime parameter is provided.

        Parameters:
        useLatestRestorableTime - A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.

        Default: false

        Constraints: Cannot be specified if the RestoreToTime parameter is provided.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • port

        RestoreDbClusterToPointInTimeRequest.Builder port​(Integer port)

        The port number on which the new cluster accepts connections.

        Constraints: Must be a value from 1150 to 65535.

        Default: The default port for the engine.

        Parameters:
        port - The port number on which the new cluster accepts connections.

        Constraints: Must be a value from 1150 to 65535.

        Default: The default port for the engine.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbSubnetGroupName

        RestoreDbClusterToPointInTimeRequest.Builder dbSubnetGroupName​(String dbSubnetGroupName)

        The subnet group name to use for the new cluster.

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

        Example: mySubnetgroup

        Parameters:
        dbSubnetGroupName - The subnet group name to use for the new cluster.

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

        Example: mySubnetgroup

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcSecurityGroupIds

        RestoreDbClusterToPointInTimeRequest.Builder vpcSecurityGroupIds​(Collection<String> vpcSecurityGroupIds)

        A list of VPC security groups that the new cluster belongs to.

        Parameters:
        vpcSecurityGroupIds - A list of VPC security groups that the new cluster belongs to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcSecurityGroupIds

        RestoreDbClusterToPointInTimeRequest.Builder vpcSecurityGroupIds​(String... vpcSecurityGroupIds)

        A list of VPC security groups that the new cluster belongs to.

        Parameters:
        vpcSecurityGroupIds - A list of VPC security groups that the new cluster belongs to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        RestoreDbClusterToPointInTimeRequest.Builder tags​(Collection<Tag> tags)

        The tags to be assigned to the restored cluster.

        Parameters:
        tags - The tags to be assigned to the restored cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        RestoreDbClusterToPointInTimeRequest.Builder tags​(Tag... tags)

        The tags to be assigned to the restored cluster.

        Parameters:
        tags - The tags to be assigned to the restored cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kmsKeyId

        RestoreDbClusterToPointInTimeRequest.Builder kmsKeyId​(String kmsKeyId)

        The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.

        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.

        You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.

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

        • If the cluster is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the source cluster.

        • If the cluster is not encrypted, then the restored cluster is not encrypted.

        If DBClusterIdentifier refers to a cluster that is not encrypted, then the restore request is rejected.

        Parameters:
        kmsKeyId - The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.

        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.

        You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.

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

        • If the cluster is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the source cluster.

        • If the cluster is not encrypted, then the restored cluster is not encrypted.

        If DBClusterIdentifier refers to a cluster that is not encrypted, then the restore request is rejected.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enableCloudwatchLogsExports

        RestoreDbClusterToPointInTimeRequest.Builder enableCloudwatchLogsExports​(Collection<String> enableCloudwatchLogsExports)

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

        Parameters:
        enableCloudwatchLogsExports - A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enableCloudwatchLogsExports

        RestoreDbClusterToPointInTimeRequest.Builder enableCloudwatchLogsExports​(String... enableCloudwatchLogsExports)

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

        Parameters:
        enableCloudwatchLogsExports - A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • deletionProtection

        RestoreDbClusterToPointInTimeRequest.Builder deletionProtection​(Boolean deletionProtection)

        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.

        Parameters:
        deletionProtection - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • storageType

        RestoreDbClusterToPointInTimeRequest.Builder storageType​(String storageType)

        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

        Parameters:
        storageType - 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

        Returns:
        Returns a reference to this object so that method calls can be chained together.