RestoreDbClusterToPointInTimeRequest.Builder (AWS Java SDK :: Services

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<RestoreDbClusterToPointInTimeRequest.Builder,RestoreDbClusterToPointInTimeRequest>, RdsRequest.Builder, SdkBuilder<RestoreDbClusterToPointInTimeRequest.Builder,RestoreDbClusterToPointInTimeRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

RestoreDbClusterToPointInTimeRequest
```
public static interface RestoreDbClusterToPointInTimeRequest.Builder
extends RdsRequest.Builder, SdkPojo, CopyableBuilder<RestoreDbClusterToPointInTimeRequest.Builder,RestoreDbClusterToPointInTimeRequest>
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`RestoreDbClusterToPointInTimeRequest.Builder`	`backtrackWindow(Long backtrackWindow)` The target backtrack window, in seconds.
`RestoreDbClusterToPointInTimeRequest.Builder`	`copyTagsToSnapshot(Boolean copyTagsToSnapshot)` A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster.
`RestoreDbClusterToPointInTimeRequest.Builder`	`dbClusterIdentifier(String dbClusterIdentifier)` The name of the new DB cluster to be created.
`RestoreDbClusterToPointInTimeRequest.Builder`	`dbClusterParameterGroupName(String dbClusterParameterGroupName)` The name of the DB cluster parameter group to associate with this DB cluster.
`RestoreDbClusterToPointInTimeRequest.Builder`	`dbSubnetGroupName(String dbSubnetGroupName)` The DB subnet group name to use for the new DB cluster.
`RestoreDbClusterToPointInTimeRequest.Builder`	`deletionProtection(Boolean deletionProtection)` A value that indicates whether the DB cluster has deletion protection enabled.
`RestoreDbClusterToPointInTimeRequest.Builder`	`domain(String domain)` Specify the Active Directory directory ID to restore the DB cluster in.
`RestoreDbClusterToPointInTimeRequest.Builder`	`domainIAMRoleName(String domainIAMRoleName)` Specify the name of the IAM role to be used when making API calls to the Directory Service.
`RestoreDbClusterToPointInTimeRequest.Builder`	`enableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)` The list of logs that the restored DB cluster is to export to CloudWatch Logs.
`RestoreDbClusterToPointInTimeRequest.Builder`	`enableCloudwatchLogsExports(String... enableCloudwatchLogsExports)` The list of logs that the restored DB cluster is to export to CloudWatch Logs.
`RestoreDbClusterToPointInTimeRequest.Builder`	`enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)` A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
`RestoreDbClusterToPointInTimeRequest.Builder`	`kmsKeyId(String kmsKeyId)` The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
`RestoreDbClusterToPointInTimeRequest.Builder`	`optionGroupName(String optionGroupName)` The name of the option group for the new DB cluster.
`RestoreDbClusterToPointInTimeRequest.Builder`	`overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)`
`RestoreDbClusterToPointInTimeRequest.Builder`	`overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)`
`RestoreDbClusterToPointInTimeRequest.Builder`	`port(Integer port)` The port number on which the new DB cluster accepts connections.
`RestoreDbClusterToPointInTimeRequest.Builder`	`restoreToTime(Instant restoreToTime)` The date and time to restore the DB cluster to.
`RestoreDbClusterToPointInTimeRequest.Builder`	`restoreType(String restoreType)` The type of restore to be performed.
`RestoreDbClusterToPointInTimeRequest.Builder`	`sourceDBClusterIdentifier(String sourceDBClusterIdentifier)` The identifier of the source DB cluster from which to restore.
`RestoreDbClusterToPointInTimeRequest.Builder`	`tags(Collection<Tag> tags)` Sets the value of the Tags property for this object.
`RestoreDbClusterToPointInTimeRequest.Builder`	`tags(Consumer<Tag.Builder>... tags)` Sets the value of the Tags property for this object.
`RestoreDbClusterToPointInTimeRequest.Builder`	`tags(Tag... tags)` Sets the value of the Tags property for this object.
`RestoreDbClusterToPointInTimeRequest.Builder`	`useLatestRestorableTime(Boolean useLatestRestorableTime)` A value that indicates whether to restore the DB cluster to the latest restorable backup time.
`RestoreDbClusterToPointInTimeRequest.Builder`	`vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)` A list of VPC security groups that the new DB cluster belongs to.
`RestoreDbClusterToPointInTimeRequest.Builder`	`vpcSecurityGroupIds(String... vpcSecurityGroupIds)` A list of VPC security groups that the new DB cluster belongs to.

Methods inherited from interface software.amazon.awssdk.services.rds.model.RdsRequest.Builder
build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - dbClusterIdentifier
```
RestoreDbClusterToPointInTimeRequest.Builder dbClusterIdentifier(String dbClusterIdentifier)
```
    The name of the new DB cluster to be created.
    
    Constraints:
    - Must contain from 1 to 63 letters, numbers, or hyphens
    - First character must be a letter
    - Can't end with a hyphen or contain two consecutive hyphens
    Parameters:
    dbClusterIdentifier - The name of the new DB cluster to be created.
    
    Constraints:
    
    Must contain from 1 to 63 letters, numbers, or hyphens
    
    First character must be a letter
    
    Can't 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 DB cluster from which to restore.
    
    Constraints:
    - Must match the identifier of an existing DBCluster.
    Parameters:
    sourceDBClusterIdentifier - The identifier of the source DB 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 DB cluster to.
    
    Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
    
    Constraints:
    - Must be before the latest restorable time for the DB instance
    - Must be specified if UseLatestRestorableTime parameter isn't provided
    - Can't be specified if the UseLatestRestorableTime parameter is enabled
    - Can't 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 DB cluster to.
    
    Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
    
    Constraints:
    
    Must be before the latest restorable time for the DB instance
    
    Must be specified if UseLatestRestorableTime parameter isn't provided
    
    Can't be specified if the UseLatestRestorableTime parameter is enabled
    
    Can't 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 indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time.
    
    Constraints: Can't be specified if RestoreToTime parameter is provided.
    
    Parameters:
    
    useLatestRestorableTime - A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time.
    
    Constraints: Can't be specified if 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 DB cluster accepts connections.
    
    Constraints: A value from 1150-65535.
    
    Default: The default port for the engine.
    
    Parameters:
    
    port - The port number on which the new DB cluster accepts connections.
    
    Constraints: A value from 1150-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 DB subnet group name to use for the new DB cluster.
    
    Constraints: If supplied, must match the name of an existing DBSubnetGroup.
    
    Example: mySubnetgroup
    
    Parameters:
    
    dbSubnetGroupName - The DB subnet group name to use for the new DB cluster.
    
    Constraints: If supplied, 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.
  - optionGroupName
```
RestoreDbClusterToPointInTimeRequest.Builder optionGroupName(String optionGroupName)
```
    The name of the option group for the new DB cluster.
    
    Parameters:
    
    optionGroupName - The name of the option group for the new DB cluster.
    
    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 DB cluster belongs to.
    
    Parameters:
    
    vpcSecurityGroupIds - A list of VPC security groups that the new DB 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 DB cluster belongs to.
    
    Parameters:
    
    vpcSecurityGroupIds - A list of VPC security groups that the new DB 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)
```
    Sets the value of the Tags property for this object.
    
    Parameters:
    
    tags - The new value for the Tags property for this object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tags
```
RestoreDbClusterToPointInTimeRequest.Builder tags(Tag... tags)
```
    Sets the value of the Tags property for this object.
    
    Parameters:
    
    tags - The new value for the Tags property for this object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tags
```
RestoreDbClusterToPointInTimeRequest.Builder tags(Consumer<Tag.Builder>... tags)
```
    Sets the value of the Tags property for this object. This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).
    
    Parameters:
    
    tags - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #tags(List)
  - kmsKeyId
```
RestoreDbClusterToPointInTimeRequest.Builder kmsKeyId(String kmsKeyId)
```
    The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
    
    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
    
    You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.
    
    If you don't specify a value for the KmsKeyId parameter, then the following occurs:
    - If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
    - If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.
    If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request is rejected.
    Parameters:
    kmsKeyId - The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
    
    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
    
    You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.
    
    If you don't specify a value for the KmsKeyId parameter, then the following occurs:
    
    If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
    
    If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.
    
    If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request is rejected.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - enableIAMDatabaseAuthentication
```
RestoreDbClusterToPointInTimeRequest.Builder enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
```
    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
    
    For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
    
    Parameters:
    
    enableIAMDatabaseAuthentication - A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
    
    For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - backtrackWindow
```
RestoreDbClusterToPointInTimeRequest.Builder backtrackWindow(Long backtrackWindow)
```
    The target backtrack window, in seconds. To disable backtracking, set this value to 0.
    
    Default: 0
    
    Constraints:
    - If specified, this value must be set to a number from 0 to 259,200 (72 hours).
    Parameters:
    backtrackWindow - The target backtrack window, in seconds. To disable backtracking, set this value to 0.
    
    Default: 0
    
    Constraints:
    
    If specified, this value must be set to a number from 0 to 259,200 (72 hours).
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - enableCloudwatchLogsExports
```
RestoreDbClusterToPointInTimeRequest.Builder enableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
```
    The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
    
    Parameters:
    
    enableCloudwatchLogsExports - The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - enableCloudwatchLogsExports
```
RestoreDbClusterToPointInTimeRequest.Builder enableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
```
    The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
    
    Parameters:
    
    enableCloudwatchLogsExports - The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dbClusterParameterGroupName
```
RestoreDbClusterToPointInTimeRequest.Builder dbClusterParameterGroupName(String dbClusterParameterGroupName)
```
    The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
    
    Constraints:
    - If supplied, must match the name of an existing DB cluster parameter group.
    - Must be 1 to 255 letters, numbers, or hyphens.
    - First character must be a letter.
    - Can't 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. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
    
    Constraints:
    
    If supplied, must match the name of an existing DB cluster parameter group.
    
    Must be 1 to 255 letters, numbers, or hyphens.
    
    First character must be a letter.
    
    Can't end with a hyphen or contain two consecutive hyphens.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - deletionProtection
```
RestoreDbClusterToPointInTimeRequest.Builder deletionProtection(Boolean deletionProtection)
```
    A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
    
    Parameters:
    
    deletionProtection - A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - copyTagsToSnapshot
```
RestoreDbClusterToPointInTimeRequest.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)
```
    A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
    
    Parameters:
    
    copyTagsToSnapshot - A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - domain
```
RestoreDbClusterToPointInTimeRequest.Builder domain(String domain)
```
    Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
    
    For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Using Kerberos Authentication for Aurora MySQL in the Amazon Aurora User Guide.
    
    Parameters:
    
    domain - Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
    
    For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Using Kerberos Authentication for Aurora MySQL in the Amazon Aurora User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - domainIAMRoleName
```
RestoreDbClusterToPointInTimeRequest.Builder domainIAMRoleName(String domainIAMRoleName)
```
    Specify the name of the IAM role to be used when making API calls to the Directory Service.
    
    Parameters:
    
    domainIAMRoleName - Specify the name of the IAM role to be used when making API calls to the Directory Service.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - overrideConfiguration
```
RestoreDbClusterToPointInTimeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
  - overrideConfiguration
```
RestoreDbClusterToPointInTimeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder

Interface RestoreDbClusterToPointInTimeRequest.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.services.rds.model.RdsRequest.Builder

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

dbClusterIdentifier

restoreType

sourceDBClusterIdentifier

restoreToTime

useLatestRestorableTime

port

dbSubnetGroupName

optionGroupName

vpcSecurityGroupIds

vpcSecurityGroupIds

tags

tags

tags

kmsKeyId

enableIAMDatabaseAuthentication

backtrackWindow

enableCloudwatchLogsExports

enableCloudwatchLogsExports

dbClusterParameterGroupName

deletionProtection

copyTagsToSnapshot

domain

domainIAMRoleName

overrideConfiguration

overrideConfiguration