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

Interface RestoreDbClusterFromSnapshotRequest.Builder

    • Method Detail

      • availabilityZones

        RestoreDbClusterFromSnapshotRequest.Builder availabilityZones​(Collection<String> availabilityZones)

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

        Parameters:
        availabilityZones - Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • availabilityZones

        RestoreDbClusterFromSnapshotRequest.Builder availabilityZones​(String... availabilityZones)

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

        Parameters:
        availabilityZones - Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbClusterIdentifier

        RestoreDbClusterFromSnapshotRequest.Builder dbClusterIdentifier​(String dbClusterIdentifier)

        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

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

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

      • snapshotIdentifier

        RestoreDbClusterFromSnapshotRequest.Builder snapshotIdentifier​(String snapshotIdentifier)

        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.

        Parameters:
        snapshotIdentifier - 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.

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

      • engine

        RestoreDbClusterFromSnapshotRequest.Builder engine​(String engine)

        The database engine to use for the new cluster.

        Default: The same as source.

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

        Parameters:
        engine - The database engine to use for the new cluster.

        Default: The same as source.

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

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

      • engineVersion

        RestoreDbClusterFromSnapshotRequest.Builder engineVersion​(String engineVersion)

        The version of the database engine to use for the new cluster.

        Parameters:
        engineVersion - The version of the database engine to use for the new cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • port

        RestoreDbClusterFromSnapshotRequest.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 same port as the original cluster.

        Parameters:
        port - 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.

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

      • dbSubnetGroupName

        RestoreDbClusterFromSnapshotRequest.Builder dbSubnetGroupName​(String dbSubnetGroupName)

        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

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

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

      • vpcSecurityGroupIds

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

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

        Parameters:
        vpcSecurityGroupIds - A list of virtual private cloud (VPC) security groups that the new cluster will belong to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcSecurityGroupIds

        RestoreDbClusterFromSnapshotRequest.Builder vpcSecurityGroupIds​(String... vpcSecurityGroupIds)

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

        Parameters:
        vpcSecurityGroupIds - A list of virtual private cloud (VPC) security groups that the new cluster will belong to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        RestoreDbClusterFromSnapshotRequest.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

        RestoreDbClusterFromSnapshotRequest.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

        RestoreDbClusterFromSnapshotRequest.Builder kmsKeyId​(String kmsKeyId)

        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.

        Parameters:
        kmsKeyId - 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.

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

      • enableCloudwatchLogsExports

        RestoreDbClusterFromSnapshotRequest.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

        RestoreDbClusterFromSnapshotRequest.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

        RestoreDbClusterFromSnapshotRequest.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.

      • dbClusterParameterGroupName

        RestoreDbClusterFromSnapshotRequest.Builder dbClusterParameterGroupName​(String dbClusterParameterGroupName)

        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.

        Parameters:
        dbClusterParameterGroupName - 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.

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

      • storageType

        RestoreDbClusterFromSnapshotRequest.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.