RestoreDBClusterToPointInTimeRequest.Builder (AWS SDK for Java

All Superinterfaces:

CopyableBuilder<RestoreDBClusterToPointInTimeRequest.Builder,RestoreDBClusterToPointInTimeRequest>, SdkBuilder<RestoreDBClusterToPointInTimeRequest.Builder,RestoreDBClusterToPointInTimeRequest>

Enclosing class:

RestoreDBClusterToPointInTimeRequest
```
public static interface RestoreDBClusterToPointInTimeRequest.Builder
extends CopyableBuilder<RestoreDBClusterToPointInTimeRequest.Builder,RestoreDBClusterToPointInTimeRequest>
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`RestoreDBClusterToPointInTimeRequest.Builder`	`dbClusterIdentifier(String dbClusterIdentifier)`	The name of the new DB cluster to be created.
`RestoreDBClusterToPointInTimeRequest.Builder`	`dbSubnetGroupName(String dbSubnetGroupName)`	The DB subnet group name to use for the new DB cluster.
`RestoreDBClusterToPointInTimeRequest.Builder`	`enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)`	A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
`RestoreDBClusterToPointInTimeRequest.Builder`	`kmsKeyId(String kmsKeyId)`	The 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`	`port(Integer port)`	The port number on which the new DB cluster accepts connections.
`RestoreDBClusterToPointInTimeRequest.Builder`	`restoreToTime(Date 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)`
`RestoreDBClusterToPointInTimeRequest.Builder`	`tags(Tag... tags)`	NOTE: This method appends the values to the existing list (if any).
`RestoreDBClusterToPointInTimeRequest.Builder`	`useLatestRestorableTime(Boolean useLatestRestorableTime)`	A value that is set to `true` to restore the DB cluster to the latest restorable backup time, and `false` otherwise.
`RestoreDBClusterToPointInTimeRequest.Builder`	`vpcSecurityGroupIds(String... vpcSecurityGroupIds)`	A list of VPC security groups that the new DB cluster belongs to.
`RestoreDBClusterToPointInTimeRequest.Builder`	`vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)`	A list of VPC security groups that the new DB cluster belongs to.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
apply, 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 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot 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 alphanumeric characters or hyphens
    
    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 cannot 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 cannot 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 be the identifier of an existing database instance
    - Must contain from 1 to 63 alphanumeric characters or hyphens
    - First character must be a letter
    - Cannot end with a hyphen or contain two consecutive hyphens
    Parameters:
    sourceDBClusterIdentifier - The identifier of the source DB cluster from which to restore.
    
    Constraints:
    
    Must be the identifier of an existing database instance
    
    Must contain from 1 to 63 alphanumeric characters or hyphens
    
    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.
  - restoreToTime
```
RestoreDBClusterToPointInTimeRequest.Builder restoreToTime(Date 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 is not provided
    - Cannot be specified if UseLatestRestorableTime parameter is true
    - Cannot be specified if 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 is not provided
    
    Cannot be specified if UseLatestRestorableTime parameter is true
    
    Cannot be specified if 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 DB cluster to the latest restorable backup time, and false otherwise.
    
    Default: false
    
    Constraints: Cannot be specified if RestoreToTime parameter is provided.
    
    Parameters:
    
    useLatestRestorableTime - A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.
    
    Default: false
    
    Constraints: Cannot 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: Value must be 1150-65535
    
    Default: The same port as the original DB cluster.
    
    Parameters:
    
    port - The port number on which the new DB cluster accepts connections.
    
    Constraints: Value must be 1150-65535
    
    Default: The same port as the original DB cluster.
    
    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: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
    
    Example: mySubnetgroup
    
    Parameters:
    
    dbSubnetGroupName - The DB subnet group name to use for the new DB cluster.
    
    Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
    
    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.
    
    NOTE: This method appends the values to the existing list (if any). Use #setVpcSecurityGroupIds(java.util.Collection) or #withVpcSecurityGroupIds(java.util.Collection) if you want to override the existing values.
    
    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)
```
    Parameters:
    
    tags -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tags
```
RestoreDBClusterToPointInTimeRequest.Builder tags(Tag... tags)
```
    NOTE: This method appends the values to the existing list (if any). Use #setTags(java.util.Collection) or #withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags -
    
    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 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 will be encrypted with the KMS key identified by the KmsKeyId parameter.
    
    If you do not specify a value for the KmsKeyId parameter, then the following will occur:
    - 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 is not encrypted, then the restored DB cluster is not encrypted.
    If DBClusterIdentifier refers to a DB cluster that is not encrypted, then the restore request is rejected.
    Parameters:
    kmsKeyId - The 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 will be encrypted with the KMS key identified by the KmsKeyId parameter.
    
    If you do not specify a value for the KmsKeyId parameter, then the following will occur:
    
    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 is not encrypted, then the restored DB cluster is not encrypted.
    
    If DBClusterIdentifier refers to a DB 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.
  - enableIAMDatabaseAuthentication
```
RestoreDBClusterToPointInTimeRequest.Builder enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
```
    A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
    
    Default: false
    
    Parameters:
    
    enableIAMDatabaseAuthentication - A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
    
    Default: false
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.

Interface RestoreDBClusterToPointInTimeRequest.Builder

Method Summary

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

kmsKeyId

enableIAMDatabaseAuthentication