AWS SDK for C++  1.9.66
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest Class Reference

#include <RestoreDBClusterToPointInTimeRequest.h>

+ Inheritance diagram for Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest:

Public Member Functions

 RestoreDBClusterToPointInTimeRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetDBClusterIdentifier () const
 
bool DBClusterIdentifierHasBeenSet () const
 
void SetDBClusterIdentifier (const Aws::String &value)
 
void SetDBClusterIdentifier (Aws::String &&value)
 
void SetDBClusterIdentifier (const char *value)
 
RestoreDBClusterToPointInTimeRequestWithDBClusterIdentifier (const Aws::String &value)
 
RestoreDBClusterToPointInTimeRequestWithDBClusterIdentifier (Aws::String &&value)
 
RestoreDBClusterToPointInTimeRequestWithDBClusterIdentifier (const char *value)
 
const Aws::StringGetRestoreType () const
 
bool RestoreTypeHasBeenSet () const
 
void SetRestoreType (const Aws::String &value)
 
void SetRestoreType (Aws::String &&value)
 
void SetRestoreType (const char *value)
 
RestoreDBClusterToPointInTimeRequestWithRestoreType (const Aws::String &value)
 
RestoreDBClusterToPointInTimeRequestWithRestoreType (Aws::String &&value)
 
RestoreDBClusterToPointInTimeRequestWithRestoreType (const char *value)
 
const Aws::StringGetSourceDBClusterIdentifier () const
 
bool SourceDBClusterIdentifierHasBeenSet () const
 
void SetSourceDBClusterIdentifier (const Aws::String &value)
 
void SetSourceDBClusterIdentifier (Aws::String &&value)
 
void SetSourceDBClusterIdentifier (const char *value)
 
RestoreDBClusterToPointInTimeRequestWithSourceDBClusterIdentifier (const Aws::String &value)
 
RestoreDBClusterToPointInTimeRequestWithSourceDBClusterIdentifier (Aws::String &&value)
 
RestoreDBClusterToPointInTimeRequestWithSourceDBClusterIdentifier (const char *value)
 
const Aws::Utils::DateTimeGetRestoreToTime () const
 
bool RestoreToTimeHasBeenSet () const
 
void SetRestoreToTime (const Aws::Utils::DateTime &value)
 
void SetRestoreToTime (Aws::Utils::DateTime &&value)
 
RestoreDBClusterToPointInTimeRequestWithRestoreToTime (const Aws::Utils::DateTime &value)
 
RestoreDBClusterToPointInTimeRequestWithRestoreToTime (Aws::Utils::DateTime &&value)
 
bool GetUseLatestRestorableTime () const
 
bool UseLatestRestorableTimeHasBeenSet () const
 
void SetUseLatestRestorableTime (bool value)
 
RestoreDBClusterToPointInTimeRequestWithUseLatestRestorableTime (bool value)
 
int GetPort () const
 
bool PortHasBeenSet () const
 
void SetPort (int value)
 
RestoreDBClusterToPointInTimeRequestWithPort (int value)
 
const Aws::StringGetDBSubnetGroupName () const
 
bool DBSubnetGroupNameHasBeenSet () const
 
void SetDBSubnetGroupName (const Aws::String &value)
 
void SetDBSubnetGroupName (Aws::String &&value)
 
void SetDBSubnetGroupName (const char *value)
 
RestoreDBClusterToPointInTimeRequestWithDBSubnetGroupName (const Aws::String &value)
 
RestoreDBClusterToPointInTimeRequestWithDBSubnetGroupName (Aws::String &&value)
 
RestoreDBClusterToPointInTimeRequestWithDBSubnetGroupName (const char *value)
 
const Aws::StringGetOptionGroupName () const
 
bool OptionGroupNameHasBeenSet () const
 
void SetOptionGroupName (const Aws::String &value)
 
void SetOptionGroupName (Aws::String &&value)
 
void SetOptionGroupName (const char *value)
 
RestoreDBClusterToPointInTimeRequestWithOptionGroupName (const Aws::String &value)
 
RestoreDBClusterToPointInTimeRequestWithOptionGroupName (Aws::String &&value)
 
RestoreDBClusterToPointInTimeRequestWithOptionGroupName (const char *value)
 
const Aws::Vector< Aws::String > & GetVpcSecurityGroupIds () const
 
bool VpcSecurityGroupIdsHasBeenSet () const
 
void SetVpcSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
void SetVpcSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
RestoreDBClusterToPointInTimeRequestWithVpcSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
RestoreDBClusterToPointInTimeRequestWithVpcSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
RestoreDBClusterToPointInTimeRequestAddVpcSecurityGroupIds (const Aws::String &value)
 
RestoreDBClusterToPointInTimeRequestAddVpcSecurityGroupIds (Aws::String &&value)
 
RestoreDBClusterToPointInTimeRequestAddVpcSecurityGroupIds (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
RestoreDBClusterToPointInTimeRequestWithTags (const Aws::Vector< Tag > &value)
 
RestoreDBClusterToPointInTimeRequestWithTags (Aws::Vector< Tag > &&value)
 
RestoreDBClusterToPointInTimeRequestAddTags (const Tag &value)
 
RestoreDBClusterToPointInTimeRequestAddTags (Tag &&value)
 
const Aws::StringGetKmsKeyId () const
 
bool KmsKeyIdHasBeenSet () const
 
void SetKmsKeyId (const Aws::String &value)
 
void SetKmsKeyId (Aws::String &&value)
 
void SetKmsKeyId (const char *value)
 
RestoreDBClusterToPointInTimeRequestWithKmsKeyId (const Aws::String &value)
 
RestoreDBClusterToPointInTimeRequestWithKmsKeyId (Aws::String &&value)
 
RestoreDBClusterToPointInTimeRequestWithKmsKeyId (const char *value)
 
bool GetEnableIAMDatabaseAuthentication () const
 
bool EnableIAMDatabaseAuthenticationHasBeenSet () const
 
void SetEnableIAMDatabaseAuthentication (bool value)
 
RestoreDBClusterToPointInTimeRequestWithEnableIAMDatabaseAuthentication (bool value)
 
long long GetBacktrackWindow () const
 
bool BacktrackWindowHasBeenSet () const
 
void SetBacktrackWindow (long long value)
 
RestoreDBClusterToPointInTimeRequestWithBacktrackWindow (long long value)
 
const Aws::Vector< Aws::String > & GetEnableCloudwatchLogsExports () const
 
bool EnableCloudwatchLogsExportsHasBeenSet () const
 
void SetEnableCloudwatchLogsExports (const Aws::Vector< Aws::String > &value)
 
void SetEnableCloudwatchLogsExports (Aws::Vector< Aws::String > &&value)
 
RestoreDBClusterToPointInTimeRequestWithEnableCloudwatchLogsExports (const Aws::Vector< Aws::String > &value)
 
RestoreDBClusterToPointInTimeRequestWithEnableCloudwatchLogsExports (Aws::Vector< Aws::String > &&value)
 
RestoreDBClusterToPointInTimeRequestAddEnableCloudwatchLogsExports (const Aws::String &value)
 
RestoreDBClusterToPointInTimeRequestAddEnableCloudwatchLogsExports (Aws::String &&value)
 
RestoreDBClusterToPointInTimeRequestAddEnableCloudwatchLogsExports (const char *value)
 
const Aws::StringGetDBClusterParameterGroupName () const
 
bool DBClusterParameterGroupNameHasBeenSet () const
 
void SetDBClusterParameterGroupName (const Aws::String &value)
 
void SetDBClusterParameterGroupName (Aws::String &&value)
 
void SetDBClusterParameterGroupName (const char *value)
 
RestoreDBClusterToPointInTimeRequestWithDBClusterParameterGroupName (const Aws::String &value)
 
RestoreDBClusterToPointInTimeRequestWithDBClusterParameterGroupName (Aws::String &&value)
 
RestoreDBClusterToPointInTimeRequestWithDBClusterParameterGroupName (const char *value)
 
bool GetDeletionProtection () const
 
bool DeletionProtectionHasBeenSet () const
 
void SetDeletionProtection (bool value)
 
RestoreDBClusterToPointInTimeRequestWithDeletionProtection (bool value)
 
bool GetCopyTagsToSnapshot () const
 
bool CopyTagsToSnapshotHasBeenSet () const
 
void SetCopyTagsToSnapshot (bool value)
 
RestoreDBClusterToPointInTimeRequestWithCopyTagsToSnapshot (bool value)
 
const Aws::StringGetDomain () const
 
bool DomainHasBeenSet () const
 
void SetDomain (const Aws::String &value)
 
void SetDomain (Aws::String &&value)
 
void SetDomain (const char *value)
 
RestoreDBClusterToPointInTimeRequestWithDomain (const Aws::String &value)
 
RestoreDBClusterToPointInTimeRequestWithDomain (Aws::String &&value)
 
RestoreDBClusterToPointInTimeRequestWithDomain (const char *value)
 
const Aws::StringGetDomainIAMRoleName () const
 
bool DomainIAMRoleNameHasBeenSet () const
 
void SetDomainIAMRoleName (const Aws::String &value)
 
void SetDomainIAMRoleName (Aws::String &&value)
 
void SetDomainIAMRoleName (const char *value)
 
RestoreDBClusterToPointInTimeRequestWithDomainIAMRoleName (const Aws::String &value)
 
RestoreDBClusterToPointInTimeRequestWithDomainIAMRoleName (Aws::String &&value)
 
RestoreDBClusterToPointInTimeRequestWithDomainIAMRoleName (const char *value)
 
const ScalingConfigurationGetScalingConfiguration () const
 
bool ScalingConfigurationHasBeenSet () const
 
void SetScalingConfiguration (const ScalingConfiguration &value)
 
void SetScalingConfiguration (ScalingConfiguration &&value)
 
RestoreDBClusterToPointInTimeRequestWithScalingConfiguration (const ScalingConfiguration &value)
 
RestoreDBClusterToPointInTimeRequestWithScalingConfiguration (ScalingConfiguration &&value)
 
const Aws::StringGetEngineMode () const
 
bool EngineModeHasBeenSet () const
 
void SetEngineMode (const Aws::String &value)
 
void SetEngineMode (Aws::String &&value)
 
void SetEngineMode (const char *value)
 
RestoreDBClusterToPointInTimeRequestWithEngineMode (const Aws::String &value)
 
RestoreDBClusterToPointInTimeRequestWithEngineMode (Aws::String &&value)
 
RestoreDBClusterToPointInTimeRequestWithEngineMode (const char *value)
 
- Public Member Functions inherited from Aws::RDS::RDSRequest
virtual ~RDSRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::RDS::RDSRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

See Also:

AWS API Reference

Definition at line 28 of file RestoreDBClusterToPointInTimeRequest.h.

Constructor & Destructor Documentation

◆ RestoreDBClusterToPointInTimeRequest()

Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::RestoreDBClusterToPointInTimeRequest ( )

Member Function Documentation

◆ AddEnableCloudwatchLogsExports() [1/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::AddEnableCloudwatchLogsExports ( Aws::String &&  value)
inline

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.

Definition at line 888 of file RestoreDBClusterToPointInTimeRequest.h.

◆ AddEnableCloudwatchLogsExports() [2/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::AddEnableCloudwatchLogsExports ( const Aws::String value)
inline

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.

Definition at line 878 of file RestoreDBClusterToPointInTimeRequest.h.

◆ AddEnableCloudwatchLogsExports() [3/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::AddEnableCloudwatchLogsExports ( const char *  value)
inline

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.

Definition at line 898 of file RestoreDBClusterToPointInTimeRequest.h.

◆ AddTags() [1/2]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::AddTags ( const Tag value)
inline

Definition at line 569 of file RestoreDBClusterToPointInTimeRequest.h.

◆ AddTags() [2/2]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::AddTags ( Tag &&  value)
inline

Definition at line 572 of file RestoreDBClusterToPointInTimeRequest.h.

◆ AddVpcSecurityGroupIds() [1/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::AddVpcSecurityGroupIds ( Aws::String &&  value)
inline

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

Definition at line 542 of file RestoreDBClusterToPointInTimeRequest.h.

◆ AddVpcSecurityGroupIds() [2/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::AddVpcSecurityGroupIds ( const Aws::String value)
inline

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

Definition at line 537 of file RestoreDBClusterToPointInTimeRequest.h.

◆ AddVpcSecurityGroupIds() [3/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::AddVpcSecurityGroupIds ( const char *  value)
inline

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

Definition at line 547 of file RestoreDBClusterToPointInTimeRequest.h.

◆ BacktrackWindowHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::BacktrackWindowHasBeenSet ( ) const
inline

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

Default: 0

Constraints:

  • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Definition at line 789 of file RestoreDBClusterToPointInTimeRequest.h.

◆ CopyTagsToSnapshotHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::CopyTagsToSnapshotHasBeenSet ( ) const
inline

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.

Definition at line 1029 of file RestoreDBClusterToPointInTimeRequest.h.

◆ DBClusterIdentifierHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::DBClusterIdentifierHasBeenSet ( ) const
inline

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

Definition at line 60 of file RestoreDBClusterToPointInTimeRequest.h.

◆ DBClusterParameterGroupNameHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::DBClusterParameterGroupNameHasBeenSet ( ) const
inline

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.

Definition at line 921 of file RestoreDBClusterToPointInTimeRequest.h.

◆ DBSubnetGroupNameHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::DBSubnetGroupNameHasBeenSet ( ) const
inline

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

Definition at line 418 of file RestoreDBClusterToPointInTimeRequest.h.

◆ DeletionProtectionHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::DeletionProtectionHasBeenSet ( ) const
inline

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.

Definition at line 1002 of file RestoreDBClusterToPointInTimeRequest.h.

◆ DomainHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::DomainHasBeenSet ( ) const
inline

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 Kerberos Authentication in the Amazon Aurora User Guide.

Definition at line 1062 of file RestoreDBClusterToPointInTimeRequest.h.

◆ DomainIAMRoleNameHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::DomainIAMRoleNameHasBeenSet ( ) const
inline

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Definition at line 1135 of file RestoreDBClusterToPointInTimeRequest.h.

◆ DumpBodyToUrl()

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ EnableCloudwatchLogsExportsHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::EnableCloudwatchLogsExportsHasBeenSet ( ) const
inline

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.

Definition at line 828 of file RestoreDBClusterToPointInTimeRequest.h.

◆ EnableIAMDatabaseAuthenticationHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::EnableIAMDatabaseAuthenticationHasBeenSet ( ) const
inline

A value that indicates whether to enable mapping of Amazon Web Services 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.

Definition at line 752 of file RestoreDBClusterToPointInTimeRequest.h.

◆ EngineModeHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::EngineModeHasBeenSet ( ) const
inline

The engine mode of the new cluster. Specify provisioned or serverless, depending on the type of the cluster you are creating. You can create an Aurora Serverless clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless cluster. To create a clone that is an Aurora Serverless cluster, the original cluster must be an Aurora Serverless cluster or an encrypted provisioned cluster.

Definition at line 1229 of file RestoreDBClusterToPointInTimeRequest.h.

◆ GetBacktrackWindow()

long long Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::GetBacktrackWindow ( ) const
inline

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

Default: 0

Constraints:

  • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Definition at line 780 of file RestoreDBClusterToPointInTimeRequest.h.

◆ GetCopyTagsToSnapshot()

bool Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::GetCopyTagsToSnapshot ( ) const
inline

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.

Definition at line 1023 of file RestoreDBClusterToPointInTimeRequest.h.

◆ GetDBClusterIdentifier()

const Aws::String& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::GetDBClusterIdentifier ( ) const
inline

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

Definition at line 52 of file RestoreDBClusterToPointInTimeRequest.h.

◆ GetDBClusterParameterGroupName()

const Aws::String& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::GetDBClusterParameterGroupName ( ) const
inline

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.

Definition at line 910 of file RestoreDBClusterToPointInTimeRequest.h.

◆ GetDBSubnetGroupName()

const Aws::String& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::GetDBSubnetGroupName ( ) const
inline

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

Definition at line 411 of file RestoreDBClusterToPointInTimeRequest.h.

◆ GetDeletionProtection()

bool Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::GetDeletionProtection ( ) const
inline

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.

Definition at line 995 of file RestoreDBClusterToPointInTimeRequest.h.

◆ GetDomain()

const Aws::String& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::GetDomain ( ) const
inline

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 Kerberos Authentication in the Amazon Aurora User Guide.

Definition at line 1052 of file RestoreDBClusterToPointInTimeRequest.h.

◆ GetDomainIAMRoleName()

const Aws::String& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::GetDomainIAMRoleName ( ) const
inline

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Definition at line 1129 of file RestoreDBClusterToPointInTimeRequest.h.

◆ GetEnableCloudwatchLogsExports()

const Aws::Vector<Aws::String>& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::GetEnableCloudwatchLogsExports ( ) const
inline

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.

Definition at line 818 of file RestoreDBClusterToPointInTimeRequest.h.

◆ GetEnableIAMDatabaseAuthentication()

bool Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::GetEnableIAMDatabaseAuthentication ( ) const
inline

A value that indicates whether to enable mapping of Amazon Web Services 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.

Definition at line 743 of file RestoreDBClusterToPointInTimeRequest.h.

◆ GetEngineMode()

const Aws::String& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::GetEngineMode ( ) const
inline

The engine mode of the new cluster. Specify provisioned or serverless, depending on the type of the cluster you are creating. You can create an Aurora Serverless clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless cluster. To create a clone that is an Aurora Serverless cluster, the original cluster must be an Aurora Serverless cluster or an encrypted provisioned cluster.

Definition at line 1219 of file RestoreDBClusterToPointInTimeRequest.h.

◆ GetKmsKeyId()

const Aws::String& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::GetKmsKeyId ( ) const
inline

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK). To use a CMK in a different Amazon Web Services account, specify the key ARN or alias ARN.

You can restore to a new DB cluster and encrypt the new DB cluster with a Amazon Web Services KMS CMK that is different than the Amazon Web Services KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the Amazon Web Services KMS CMK 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 Amazon Web Services KMS CMK 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.

Definition at line 593 of file RestoreDBClusterToPointInTimeRequest.h.

◆ GetOptionGroupName()

const Aws::String& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::GetOptionGroupName ( ) const
inline

The name of the option group for the new DB cluster.

Definition at line 466 of file RestoreDBClusterToPointInTimeRequest.h.

◆ GetPort()

int Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::GetPort ( ) const
inline

The port number on which the new DB cluster accepts connections.

Constraints: A value from 1150-65535.

Default: The default port for the engine.

Definition at line 382 of file RestoreDBClusterToPointInTimeRequest.h.

◆ GetRestoreToTime()

const Aws::Utils::DateTime& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::GetRestoreToTime ( ) const
inline

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

Definition at line 276 of file RestoreDBClusterToPointInTimeRequest.h.

◆ GetRestoreType()

const Aws::String& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::GetRestoreType ( ) const
inline

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.

Definition at line 121 of file RestoreDBClusterToPointInTimeRequest.h.

◆ GetScalingConfiguration()

const ScalingConfiguration& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::GetScalingConfiguration ( ) const
inline

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

Definition at line 1178 of file RestoreDBClusterToPointInTimeRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

◆ GetSourceDBClusterIdentifier()

const Aws::String& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::GetSourceDBClusterIdentifier ( ) const
inline

The identifier of the source DB cluster from which to restore.

Constraints:

  • Must match the identifier of an existing DBCluster.

Definition at line 213 of file RestoreDBClusterToPointInTimeRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::GetTags ( ) const
inline

Definition at line 551 of file RestoreDBClusterToPointInTimeRequest.h.

◆ GetUseLatestRestorableTime()

bool Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::GetUseLatestRestorableTime ( ) const
inline

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.

Definition at line 350 of file RestoreDBClusterToPointInTimeRequest.h.

◆ GetVpcSecurityGroupIds()

const Aws::Vector<Aws::String>& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::GetVpcSecurityGroupIds ( ) const
inline

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

Definition at line 507 of file RestoreDBClusterToPointInTimeRequest.h.

◆ KmsKeyIdHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::KmsKeyIdHasBeenSet ( ) const
inline

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK). To use a CMK in a different Amazon Web Services account, specify the key ARN or alias ARN.

You can restore to a new DB cluster and encrypt the new DB cluster with a Amazon Web Services KMS CMK that is different than the Amazon Web Services KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the Amazon Web Services KMS CMK 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 Amazon Web Services KMS CMK 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.

Definition at line 613 of file RestoreDBClusterToPointInTimeRequest.h.

◆ OptionGroupNameHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::OptionGroupNameHasBeenSet ( ) const
inline

The name of the option group for the new DB cluster.

Definition at line 471 of file RestoreDBClusterToPointInTimeRequest.h.

◆ PortHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::PortHasBeenSet ( ) const
inline

The port number on which the new DB cluster accepts connections.

Constraints: A value from 1150-65535.

Default: The default port for the engine.

Definition at line 389 of file RestoreDBClusterToPointInTimeRequest.h.

◆ RestoreToTimeHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::RestoreToTimeHasBeenSet ( ) const
inline

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

Definition at line 289 of file RestoreDBClusterToPointInTimeRequest.h.

◆ RestoreTypeHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::RestoreTypeHasBeenSet ( ) const
inline

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.

Definition at line 133 of file RestoreDBClusterToPointInTimeRequest.h.

◆ ScalingConfigurationHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::ScalingConfigurationHasBeenSet ( ) const
inline

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

Definition at line 1184 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SerializePayload()

Aws::String Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBacktrackWindow()

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetBacktrackWindow ( long long  value)
inline

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

Default: 0

Constraints:

  • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Definition at line 798 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetCopyTagsToSnapshot()

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetCopyTagsToSnapshot ( bool  value)
inline

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.

Definition at line 1035 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetDBClusterIdentifier() [1/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetDBClusterIdentifier ( Aws::String &&  value)
inline

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

Definition at line 76 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetDBClusterIdentifier() [2/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetDBClusterIdentifier ( const Aws::String value)
inline

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

Definition at line 68 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetDBClusterIdentifier() [3/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetDBClusterIdentifier ( const char *  value)
inline

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

Definition at line 84 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetDBClusterParameterGroupName() [1/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetDBClusterParameterGroupName ( Aws::String &&  value)
inline

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.

Definition at line 943 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetDBClusterParameterGroupName() [2/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetDBClusterParameterGroupName ( const Aws::String value)
inline

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.

Definition at line 932 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetDBClusterParameterGroupName() [3/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetDBClusterParameterGroupName ( const char *  value)
inline

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.

Definition at line 954 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetDBSubnetGroupName() [1/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetDBSubnetGroupName ( Aws::String &&  value)
inline

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

Definition at line 432 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetDBSubnetGroupName() [2/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetDBSubnetGroupName ( const Aws::String value)
inline

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

Definition at line 425 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetDBSubnetGroupName() [3/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetDBSubnetGroupName ( const char *  value)
inline

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

Definition at line 439 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetDeletionProtection()

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetDeletionProtection ( bool  value)
inline

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.

Definition at line 1009 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetDomain() [1/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetDomain ( Aws::String &&  value)
inline

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 Kerberos Authentication in the Amazon Aurora User Guide.

Definition at line 1082 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetDomain() [2/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetDomain ( const Aws::String value)
inline

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 Kerberos Authentication in the Amazon Aurora User Guide.

Definition at line 1072 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetDomain() [3/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetDomain ( const char *  value)
inline

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 Kerberos Authentication in the Amazon Aurora User Guide.

Definition at line 1092 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetDomainIAMRoleName() [1/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetDomainIAMRoleName ( Aws::String &&  value)
inline

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Definition at line 1147 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetDomainIAMRoleName() [2/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetDomainIAMRoleName ( const Aws::String value)
inline

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Definition at line 1141 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetDomainIAMRoleName() [3/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetDomainIAMRoleName ( const char *  value)
inline

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Definition at line 1153 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetEnableCloudwatchLogsExports() [1/2]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetEnableCloudwatchLogsExports ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 848 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetEnableCloudwatchLogsExports() [2/2]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetEnableCloudwatchLogsExports ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 838 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetEnableIAMDatabaseAuthentication()

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetEnableIAMDatabaseAuthentication ( bool  value)
inline

A value that indicates whether to enable mapping of Amazon Web Services 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.

Definition at line 761 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetEngineMode() [1/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetEngineMode ( Aws::String &&  value)
inline

The engine mode of the new cluster. Specify provisioned or serverless, depending on the type of the cluster you are creating. You can create an Aurora Serverless clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless cluster. To create a clone that is an Aurora Serverless cluster, the original cluster must be an Aurora Serverless cluster or an encrypted provisioned cluster.

Definition at line 1249 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetEngineMode() [2/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetEngineMode ( const Aws::String value)
inline

The engine mode of the new cluster. Specify provisioned or serverless, depending on the type of the cluster you are creating. You can create an Aurora Serverless clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless cluster. To create a clone that is an Aurora Serverless cluster, the original cluster must be an Aurora Serverless cluster or an encrypted provisioned cluster.

Definition at line 1239 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetEngineMode() [3/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetEngineMode ( const char *  value)
inline

The engine mode of the new cluster. Specify provisioned or serverless, depending on the type of the cluster you are creating. You can create an Aurora Serverless clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless cluster. To create a clone that is an Aurora Serverless cluster, the original cluster must be an Aurora Serverless cluster or an encrypted provisioned cluster.

Definition at line 1259 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetKmsKeyId() [1/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetKmsKeyId ( Aws::String &&  value)
inline

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK). To use a CMK in a different Amazon Web Services account, specify the key ARN or alias ARN.

You can restore to a new DB cluster and encrypt the new DB cluster with a Amazon Web Services KMS CMK that is different than the Amazon Web Services KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the Amazon Web Services KMS CMK 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 Amazon Web Services KMS CMK 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.

Definition at line 653 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetKmsKeyId() [2/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetKmsKeyId ( const Aws::String value)
inline

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK). To use a CMK in a different Amazon Web Services account, specify the key ARN or alias ARN.

You can restore to a new DB cluster and encrypt the new DB cluster with a Amazon Web Services KMS CMK that is different than the Amazon Web Services KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the Amazon Web Services KMS CMK 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 Amazon Web Services KMS CMK 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.

Definition at line 633 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetKmsKeyId() [3/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetKmsKeyId ( const char *  value)
inline

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK). To use a CMK in a different Amazon Web Services account, specify the key ARN or alias ARN.

You can restore to a new DB cluster and encrypt the new DB cluster with a Amazon Web Services KMS CMK that is different than the Amazon Web Services KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the Amazon Web Services KMS CMK 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 Amazon Web Services KMS CMK 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.

Definition at line 673 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetOptionGroupName() [1/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetOptionGroupName ( Aws::String &&  value)
inline

The name of the option group for the new DB cluster.

Definition at line 481 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetOptionGroupName() [2/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetOptionGroupName ( const Aws::String value)
inline

The name of the option group for the new DB cluster.

Definition at line 476 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetOptionGroupName() [3/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetOptionGroupName ( const char *  value)
inline

The name of the option group for the new DB cluster.

Definition at line 486 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetPort()

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetPort ( int  value)
inline

The port number on which the new DB cluster accepts connections.

Constraints: A value from 1150-65535.

Default: The default port for the engine.

Definition at line 396 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetRestoreToTime() [1/2]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetRestoreToTime ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 315 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetRestoreToTime() [2/2]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetRestoreToTime ( const Aws::Utils::DateTime value)
inline

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

Definition at line 302 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetRestoreType() [1/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetRestoreType ( Aws::String &&  value)
inline

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.

Definition at line 157 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetRestoreType() [2/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetRestoreType ( const Aws::String value)
inline

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.

Definition at line 145 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetRestoreType() [3/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetRestoreType ( const char *  value)
inline

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.

Definition at line 169 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetScalingConfiguration() [1/2]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetScalingConfiguration ( const ScalingConfiguration value)
inline

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

Definition at line 1190 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetScalingConfiguration() [2/2]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetScalingConfiguration ( ScalingConfiguration &&  value)
inline

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

Definition at line 1196 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetSourceDBClusterIdentifier() [1/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetSourceDBClusterIdentifier ( Aws::String &&  value)
inline

The identifier of the source DB cluster from which to restore.

Constraints:

  • Must match the identifier of an existing DBCluster.

Definition at line 234 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetSourceDBClusterIdentifier() [2/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetSourceDBClusterIdentifier ( const Aws::String value)
inline

The identifier of the source DB cluster from which to restore.

Constraints:

  • Must match the identifier of an existing DBCluster.

Definition at line 227 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetSourceDBClusterIdentifier() [3/3]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetSourceDBClusterIdentifier ( const char *  value)
inline

The identifier of the source DB cluster from which to restore.

Constraints:

  • Must match the identifier of an existing DBCluster.

Definition at line 241 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetTags() [1/2]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

Definition at line 560 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetTags() [2/2]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

Definition at line 557 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetUseLatestRestorableTime()

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetUseLatestRestorableTime ( bool  value)
inline

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.

Definition at line 366 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetVpcSecurityGroupIds() [1/2]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetVpcSecurityGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

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

Definition at line 522 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SetVpcSecurityGroupIds() [2/2]

void Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SetVpcSecurityGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

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

Definition at line 517 of file RestoreDBClusterToPointInTimeRequest.h.

◆ SourceDBClusterIdentifierHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::SourceDBClusterIdentifierHasBeenSet ( ) const
inline

The identifier of the source DB cluster from which to restore.

Constraints:

  • Must match the identifier of an existing DBCluster.

Definition at line 220 of file RestoreDBClusterToPointInTimeRequest.h.

◆ TagsHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::TagsHasBeenSet ( ) const
inline

Definition at line 554 of file RestoreDBClusterToPointInTimeRequest.h.

◆ UseLatestRestorableTimeHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::UseLatestRestorableTimeHasBeenSet ( ) const
inline

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.

Definition at line 358 of file RestoreDBClusterToPointInTimeRequest.h.

◆ VpcSecurityGroupIdsHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::VpcSecurityGroupIdsHasBeenSet ( ) const
inline

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

Definition at line 512 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithBacktrackWindow()

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithBacktrackWindow ( long long  value)
inline

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

Default: 0

Constraints:

  • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Definition at line 807 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithCopyTagsToSnapshot()

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithCopyTagsToSnapshot ( bool  value)
inline

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.

Definition at line 1041 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithDBClusterIdentifier() [1/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithDBClusterIdentifier ( Aws::String &&  value)
inline

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

Definition at line 100 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithDBClusterIdentifier() [2/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithDBClusterIdentifier ( const Aws::String value)
inline

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

Definition at line 92 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithDBClusterIdentifier() [3/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithDBClusterIdentifier ( const char *  value)
inline

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

Definition at line 108 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithDBClusterParameterGroupName() [1/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithDBClusterParameterGroupName ( Aws::String &&  value)
inline

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.

Definition at line 976 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithDBClusterParameterGroupName() [2/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithDBClusterParameterGroupName ( const Aws::String value)
inline

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.

Definition at line 965 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithDBClusterParameterGroupName() [3/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithDBClusterParameterGroupName ( const char *  value)
inline

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.

Definition at line 987 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithDBSubnetGroupName() [1/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithDBSubnetGroupName ( Aws::String &&  value)
inline

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

Definition at line 453 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithDBSubnetGroupName() [2/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithDBSubnetGroupName ( const Aws::String value)
inline

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

Definition at line 446 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithDBSubnetGroupName() [3/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithDBSubnetGroupName ( const char *  value)
inline

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

Definition at line 460 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithDeletionProtection()

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithDeletionProtection ( bool  value)
inline

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.

Definition at line 1016 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithDomain() [1/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithDomain ( Aws::String &&  value)
inline

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 Kerberos Authentication in the Amazon Aurora User Guide.

Definition at line 1112 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithDomain() [2/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithDomain ( const Aws::String value)
inline

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 Kerberos Authentication in the Amazon Aurora User Guide.

Definition at line 1102 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithDomain() [3/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithDomain ( const char *  value)
inline

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 Kerberos Authentication in the Amazon Aurora User Guide.

Definition at line 1122 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithDomainIAMRoleName() [1/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithDomainIAMRoleName ( Aws::String &&  value)
inline

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Definition at line 1165 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithDomainIAMRoleName() [2/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithDomainIAMRoleName ( const Aws::String value)
inline

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Definition at line 1159 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithDomainIAMRoleName() [3/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithDomainIAMRoleName ( const char *  value)
inline

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Definition at line 1171 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithEnableCloudwatchLogsExports() [1/2]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithEnableCloudwatchLogsExports ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 868 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithEnableCloudwatchLogsExports() [2/2]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithEnableCloudwatchLogsExports ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 858 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithEnableIAMDatabaseAuthentication()

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithEnableIAMDatabaseAuthentication ( bool  value)
inline

A value that indicates whether to enable mapping of Amazon Web Services 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.

Definition at line 770 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithEngineMode() [1/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithEngineMode ( Aws::String &&  value)
inline

The engine mode of the new cluster. Specify provisioned or serverless, depending on the type of the cluster you are creating. You can create an Aurora Serverless clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless cluster. To create a clone that is an Aurora Serverless cluster, the original cluster must be an Aurora Serverless cluster or an encrypted provisioned cluster.

Definition at line 1279 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithEngineMode() [2/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithEngineMode ( const Aws::String value)
inline

The engine mode of the new cluster. Specify provisioned or serverless, depending on the type of the cluster you are creating. You can create an Aurora Serverless clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless cluster. To create a clone that is an Aurora Serverless cluster, the original cluster must be an Aurora Serverless cluster or an encrypted provisioned cluster.

Definition at line 1269 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithEngineMode() [3/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithEngineMode ( const char *  value)
inline

The engine mode of the new cluster. Specify provisioned or serverless, depending on the type of the cluster you are creating. You can create an Aurora Serverless clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless cluster. To create a clone that is an Aurora Serverless cluster, the original cluster must be an Aurora Serverless cluster or an encrypted provisioned cluster.

Definition at line 1289 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithKmsKeyId() [1/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithKmsKeyId ( Aws::String &&  value)
inline

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK). To use a CMK in a different Amazon Web Services account, specify the key ARN or alias ARN.

You can restore to a new DB cluster and encrypt the new DB cluster with a Amazon Web Services KMS CMK that is different than the Amazon Web Services KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the Amazon Web Services KMS CMK 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 Amazon Web Services KMS CMK 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.

Definition at line 713 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithKmsKeyId() [2/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithKmsKeyId ( const Aws::String value)
inline

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK). To use a CMK in a different Amazon Web Services account, specify the key ARN or alias ARN.

You can restore to a new DB cluster and encrypt the new DB cluster with a Amazon Web Services KMS CMK that is different than the Amazon Web Services KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the Amazon Web Services KMS CMK 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 Amazon Web Services KMS CMK 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.

Definition at line 693 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithKmsKeyId() [3/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithKmsKeyId ( const char *  value)
inline

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK). To use a CMK in a different Amazon Web Services account, specify the key ARN or alias ARN.

You can restore to a new DB cluster and encrypt the new DB cluster with a Amazon Web Services KMS CMK that is different than the Amazon Web Services KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the Amazon Web Services KMS CMK 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 Amazon Web Services KMS CMK 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.

Definition at line 733 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithOptionGroupName() [1/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithOptionGroupName ( Aws::String &&  value)
inline

The name of the option group for the new DB cluster.

Definition at line 496 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithOptionGroupName() [2/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithOptionGroupName ( const Aws::String value)
inline

The name of the option group for the new DB cluster.

Definition at line 491 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithOptionGroupName() [3/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithOptionGroupName ( const char *  value)
inline

The name of the option group for the new DB cluster.

Definition at line 501 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithPort()

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithPort ( int  value)
inline

The port number on which the new DB cluster accepts connections.

Constraints: A value from 1150-65535.

Default: The default port for the engine.

Definition at line 403 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithRestoreToTime() [1/2]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithRestoreToTime ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 341 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithRestoreToTime() [2/2]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithRestoreToTime ( const Aws::Utils::DateTime value)
inline

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

Definition at line 328 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithRestoreType() [1/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithRestoreType ( Aws::String &&  value)
inline

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.

Definition at line 193 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithRestoreType() [2/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithRestoreType ( const Aws::String value)
inline

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.

Definition at line 181 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithRestoreType() [3/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithRestoreType ( const char *  value)
inline

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.

Definition at line 205 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithScalingConfiguration() [1/2]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithScalingConfiguration ( const ScalingConfiguration value)
inline

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

Definition at line 1202 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithScalingConfiguration() [2/2]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithScalingConfiguration ( ScalingConfiguration &&  value)
inline

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

Definition at line 1208 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithSourceDBClusterIdentifier() [1/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithSourceDBClusterIdentifier ( Aws::String &&  value)
inline

The identifier of the source DB cluster from which to restore.

Constraints:

  • Must match the identifier of an existing DBCluster.

Definition at line 255 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithSourceDBClusterIdentifier() [2/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithSourceDBClusterIdentifier ( const Aws::String value)
inline

The identifier of the source DB cluster from which to restore.

Constraints:

  • Must match the identifier of an existing DBCluster.

Definition at line 248 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithSourceDBClusterIdentifier() [3/3]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithSourceDBClusterIdentifier ( const char *  value)
inline

The identifier of the source DB cluster from which to restore.

Constraints:

  • Must match the identifier of an existing DBCluster.

Definition at line 262 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithTags() [1/2]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

Definition at line 566 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithTags() [2/2]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

Definition at line 563 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithUseLatestRestorableTime()

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithUseLatestRestorableTime ( bool  value)
inline

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.

Definition at line 374 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithVpcSecurityGroupIds() [1/2]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithVpcSecurityGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

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

Definition at line 532 of file RestoreDBClusterToPointInTimeRequest.h.

◆ WithVpcSecurityGroupIds() [2/2]

RestoreDBClusterToPointInTimeRequest& Aws::RDS::Model::RestoreDBClusterToPointInTimeRequest::WithVpcSecurityGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

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

Definition at line 527 of file RestoreDBClusterToPointInTimeRequest.h.


The documentation for this class was generated from the following file: