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

#include <RestoreDBClusterFromS3Request.h>

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

Public Member Functions

 RestoreDBClusterFromS3Request ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::Vector< Aws::String > & GetAvailabilityZones () const
 
bool AvailabilityZonesHasBeenSet () const
 
void SetAvailabilityZones (const Aws::Vector< Aws::String > &value)
 
void SetAvailabilityZones (Aws::Vector< Aws::String > &&value)
 
RestoreDBClusterFromS3RequestWithAvailabilityZones (const Aws::Vector< Aws::String > &value)
 
RestoreDBClusterFromS3RequestWithAvailabilityZones (Aws::Vector< Aws::String > &&value)
 
RestoreDBClusterFromS3RequestAddAvailabilityZones (const Aws::String &value)
 
RestoreDBClusterFromS3RequestAddAvailabilityZones (Aws::String &&value)
 
RestoreDBClusterFromS3RequestAddAvailabilityZones (const char *value)
 
int GetBackupRetentionPeriod () const
 
bool BackupRetentionPeriodHasBeenSet () const
 
void SetBackupRetentionPeriod (int value)
 
RestoreDBClusterFromS3RequestWithBackupRetentionPeriod (int value)
 
const Aws::StringGetCharacterSetName () const
 
bool CharacterSetNameHasBeenSet () const
 
void SetCharacterSetName (const Aws::String &value)
 
void SetCharacterSetName (Aws::String &&value)
 
void SetCharacterSetName (const char *value)
 
RestoreDBClusterFromS3RequestWithCharacterSetName (const Aws::String &value)
 
RestoreDBClusterFromS3RequestWithCharacterSetName (Aws::String &&value)
 
RestoreDBClusterFromS3RequestWithCharacterSetName (const char *value)
 
const Aws::StringGetDatabaseName () const
 
bool DatabaseNameHasBeenSet () const
 
void SetDatabaseName (const Aws::String &value)
 
void SetDatabaseName (Aws::String &&value)
 
void SetDatabaseName (const char *value)
 
RestoreDBClusterFromS3RequestWithDatabaseName (const Aws::String &value)
 
RestoreDBClusterFromS3RequestWithDatabaseName (Aws::String &&value)
 
RestoreDBClusterFromS3RequestWithDatabaseName (const char *value)
 
const Aws::StringGetDBClusterIdentifier () const
 
bool DBClusterIdentifierHasBeenSet () const
 
void SetDBClusterIdentifier (const Aws::String &value)
 
void SetDBClusterIdentifier (Aws::String &&value)
 
void SetDBClusterIdentifier (const char *value)
 
RestoreDBClusterFromS3RequestWithDBClusterIdentifier (const Aws::String &value)
 
RestoreDBClusterFromS3RequestWithDBClusterIdentifier (Aws::String &&value)
 
RestoreDBClusterFromS3RequestWithDBClusterIdentifier (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)
 
RestoreDBClusterFromS3RequestWithDBClusterParameterGroupName (const Aws::String &value)
 
RestoreDBClusterFromS3RequestWithDBClusterParameterGroupName (Aws::String &&value)
 
RestoreDBClusterFromS3RequestWithDBClusterParameterGroupName (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)
 
RestoreDBClusterFromS3RequestWithVpcSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
RestoreDBClusterFromS3RequestWithVpcSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
RestoreDBClusterFromS3RequestAddVpcSecurityGroupIds (const Aws::String &value)
 
RestoreDBClusterFromS3RequestAddVpcSecurityGroupIds (Aws::String &&value)
 
RestoreDBClusterFromS3RequestAddVpcSecurityGroupIds (const char *value)
 
const Aws::StringGetDBSubnetGroupName () const
 
bool DBSubnetGroupNameHasBeenSet () const
 
void SetDBSubnetGroupName (const Aws::String &value)
 
void SetDBSubnetGroupName (Aws::String &&value)
 
void SetDBSubnetGroupName (const char *value)
 
RestoreDBClusterFromS3RequestWithDBSubnetGroupName (const Aws::String &value)
 
RestoreDBClusterFromS3RequestWithDBSubnetGroupName (Aws::String &&value)
 
RestoreDBClusterFromS3RequestWithDBSubnetGroupName (const char *value)
 
const Aws::StringGetEngine () const
 
bool EngineHasBeenSet () const
 
void SetEngine (const Aws::String &value)
 
void SetEngine (Aws::String &&value)
 
void SetEngine (const char *value)
 
RestoreDBClusterFromS3RequestWithEngine (const Aws::String &value)
 
RestoreDBClusterFromS3RequestWithEngine (Aws::String &&value)
 
RestoreDBClusterFromS3RequestWithEngine (const char *value)
 
const Aws::StringGetEngineVersion () const
 
bool EngineVersionHasBeenSet () const
 
void SetEngineVersion (const Aws::String &value)
 
void SetEngineVersion (Aws::String &&value)
 
void SetEngineVersion (const char *value)
 
RestoreDBClusterFromS3RequestWithEngineVersion (const Aws::String &value)
 
RestoreDBClusterFromS3RequestWithEngineVersion (Aws::String &&value)
 
RestoreDBClusterFromS3RequestWithEngineVersion (const char *value)
 
int GetPort () const
 
bool PortHasBeenSet () const
 
void SetPort (int value)
 
RestoreDBClusterFromS3RequestWithPort (int value)
 
const Aws::StringGetMasterUsername () const
 
bool MasterUsernameHasBeenSet () const
 
void SetMasterUsername (const Aws::String &value)
 
void SetMasterUsername (Aws::String &&value)
 
void SetMasterUsername (const char *value)
 
RestoreDBClusterFromS3RequestWithMasterUsername (const Aws::String &value)
 
RestoreDBClusterFromS3RequestWithMasterUsername (Aws::String &&value)
 
RestoreDBClusterFromS3RequestWithMasterUsername (const char *value)
 
const Aws::StringGetMasterUserPassword () const
 
bool MasterUserPasswordHasBeenSet () const
 
void SetMasterUserPassword (const Aws::String &value)
 
void SetMasterUserPassword (Aws::String &&value)
 
void SetMasterUserPassword (const char *value)
 
RestoreDBClusterFromS3RequestWithMasterUserPassword (const Aws::String &value)
 
RestoreDBClusterFromS3RequestWithMasterUserPassword (Aws::String &&value)
 
RestoreDBClusterFromS3RequestWithMasterUserPassword (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)
 
RestoreDBClusterFromS3RequestWithOptionGroupName (const Aws::String &value)
 
RestoreDBClusterFromS3RequestWithOptionGroupName (Aws::String &&value)
 
RestoreDBClusterFromS3RequestWithOptionGroupName (const char *value)
 
const Aws::StringGetPreferredBackupWindow () const
 
bool PreferredBackupWindowHasBeenSet () const
 
void SetPreferredBackupWindow (const Aws::String &value)
 
void SetPreferredBackupWindow (Aws::String &&value)
 
void SetPreferredBackupWindow (const char *value)
 
RestoreDBClusterFromS3RequestWithPreferredBackupWindow (const Aws::String &value)
 
RestoreDBClusterFromS3RequestWithPreferredBackupWindow (Aws::String &&value)
 
RestoreDBClusterFromS3RequestWithPreferredBackupWindow (const char *value)
 
const Aws::StringGetPreferredMaintenanceWindow () const
 
bool PreferredMaintenanceWindowHasBeenSet () const
 
void SetPreferredMaintenanceWindow (const Aws::String &value)
 
void SetPreferredMaintenanceWindow (Aws::String &&value)
 
void SetPreferredMaintenanceWindow (const char *value)
 
RestoreDBClusterFromS3RequestWithPreferredMaintenanceWindow (const Aws::String &value)
 
RestoreDBClusterFromS3RequestWithPreferredMaintenanceWindow (Aws::String &&value)
 
RestoreDBClusterFromS3RequestWithPreferredMaintenanceWindow (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)
 
RestoreDBClusterFromS3RequestWithTags (const Aws::Vector< Tag > &value)
 
RestoreDBClusterFromS3RequestWithTags (Aws::Vector< Tag > &&value)
 
RestoreDBClusterFromS3RequestAddTags (const Tag &value)
 
RestoreDBClusterFromS3RequestAddTags (Tag &&value)
 
bool GetStorageEncrypted () const
 
bool StorageEncryptedHasBeenSet () const
 
void SetStorageEncrypted (bool value)
 
RestoreDBClusterFromS3RequestWithStorageEncrypted (bool value)
 
const Aws::StringGetKmsKeyId () const
 
bool KmsKeyIdHasBeenSet () const
 
void SetKmsKeyId (const Aws::String &value)
 
void SetKmsKeyId (Aws::String &&value)
 
void SetKmsKeyId (const char *value)
 
RestoreDBClusterFromS3RequestWithKmsKeyId (const Aws::String &value)
 
RestoreDBClusterFromS3RequestWithKmsKeyId (Aws::String &&value)
 
RestoreDBClusterFromS3RequestWithKmsKeyId (const char *value)
 
bool GetEnableIAMDatabaseAuthentication () const
 
bool EnableIAMDatabaseAuthenticationHasBeenSet () const
 
void SetEnableIAMDatabaseAuthentication (bool value)
 
RestoreDBClusterFromS3RequestWithEnableIAMDatabaseAuthentication (bool value)
 
const Aws::StringGetSourceEngine () const
 
bool SourceEngineHasBeenSet () const
 
void SetSourceEngine (const Aws::String &value)
 
void SetSourceEngine (Aws::String &&value)
 
void SetSourceEngine (const char *value)
 
RestoreDBClusterFromS3RequestWithSourceEngine (const Aws::String &value)
 
RestoreDBClusterFromS3RequestWithSourceEngine (Aws::String &&value)
 
RestoreDBClusterFromS3RequestWithSourceEngine (const char *value)
 
const Aws::StringGetSourceEngineVersion () const
 
bool SourceEngineVersionHasBeenSet () const
 
void SetSourceEngineVersion (const Aws::String &value)
 
void SetSourceEngineVersion (Aws::String &&value)
 
void SetSourceEngineVersion (const char *value)
 
RestoreDBClusterFromS3RequestWithSourceEngineVersion (const Aws::String &value)
 
RestoreDBClusterFromS3RequestWithSourceEngineVersion (Aws::String &&value)
 
RestoreDBClusterFromS3RequestWithSourceEngineVersion (const char *value)
 
const Aws::StringGetS3BucketName () const
 
bool S3BucketNameHasBeenSet () const
 
void SetS3BucketName (const Aws::String &value)
 
void SetS3BucketName (Aws::String &&value)
 
void SetS3BucketName (const char *value)
 
RestoreDBClusterFromS3RequestWithS3BucketName (const Aws::String &value)
 
RestoreDBClusterFromS3RequestWithS3BucketName (Aws::String &&value)
 
RestoreDBClusterFromS3RequestWithS3BucketName (const char *value)
 
const Aws::StringGetS3Prefix () const
 
bool S3PrefixHasBeenSet () const
 
void SetS3Prefix (const Aws::String &value)
 
void SetS3Prefix (Aws::String &&value)
 
void SetS3Prefix (const char *value)
 
RestoreDBClusterFromS3RequestWithS3Prefix (const Aws::String &value)
 
RestoreDBClusterFromS3RequestWithS3Prefix (Aws::String &&value)
 
RestoreDBClusterFromS3RequestWithS3Prefix (const char *value)
 
const Aws::StringGetS3IngestionRoleArn () const
 
bool S3IngestionRoleArnHasBeenSet () const
 
void SetS3IngestionRoleArn (const Aws::String &value)
 
void SetS3IngestionRoleArn (Aws::String &&value)
 
void SetS3IngestionRoleArn (const char *value)
 
RestoreDBClusterFromS3RequestWithS3IngestionRoleArn (const Aws::String &value)
 
RestoreDBClusterFromS3RequestWithS3IngestionRoleArn (Aws::String &&value)
 
RestoreDBClusterFromS3RequestWithS3IngestionRoleArn (const char *value)
 
long long GetBacktrackWindow () const
 
bool BacktrackWindowHasBeenSet () const
 
void SetBacktrackWindow (long long value)
 
RestoreDBClusterFromS3RequestWithBacktrackWindow (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)
 
RestoreDBClusterFromS3RequestWithEnableCloudwatchLogsExports (const Aws::Vector< Aws::String > &value)
 
RestoreDBClusterFromS3RequestWithEnableCloudwatchLogsExports (Aws::Vector< Aws::String > &&value)
 
RestoreDBClusterFromS3RequestAddEnableCloudwatchLogsExports (const Aws::String &value)
 
RestoreDBClusterFromS3RequestAddEnableCloudwatchLogsExports (Aws::String &&value)
 
RestoreDBClusterFromS3RequestAddEnableCloudwatchLogsExports (const char *value)
 
bool GetDeletionProtection () const
 
bool DeletionProtectionHasBeenSet () const
 
void SetDeletionProtection (bool value)
 
RestoreDBClusterFromS3RequestWithDeletionProtection (bool value)
 
bool GetCopyTagsToSnapshot () const
 
bool CopyTagsToSnapshotHasBeenSet () const
 
void SetCopyTagsToSnapshot (bool value)
 
RestoreDBClusterFromS3RequestWithCopyTagsToSnapshot (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)
 
RestoreDBClusterFromS3RequestWithDomain (const Aws::String &value)
 
RestoreDBClusterFromS3RequestWithDomain (Aws::String &&value)
 
RestoreDBClusterFromS3RequestWithDomain (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)
 
RestoreDBClusterFromS3RequestWithDomainIAMRoleName (const Aws::String &value)
 
RestoreDBClusterFromS3RequestWithDomainIAMRoleName (Aws::String &&value)
 
RestoreDBClusterFromS3RequestWithDomainIAMRoleName (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

Definition at line 23 of file RestoreDBClusterFromS3Request.h.

Constructor & Destructor Documentation

◆ RestoreDBClusterFromS3Request()

Aws::RDS::Model::RestoreDBClusterFromS3Request::RestoreDBClusterFromS3Request ( )

Member Function Documentation

◆ AddAvailabilityZones() [1/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::AddAvailabilityZones ( Aws::String &&  value)
inline

A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

Definition at line 87 of file RestoreDBClusterFromS3Request.h.

◆ AddAvailabilityZones() [2/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::AddAvailabilityZones ( const Aws::String value)
inline

A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

Definition at line 81 of file RestoreDBClusterFromS3Request.h.

◆ AddAvailabilityZones() [3/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::AddAvailabilityZones ( const char *  value)
inline

A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

Definition at line 93 of file RestoreDBClusterFromS3Request.h.

◆ AddEnableCloudwatchLogsExports() [1/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1709 of file RestoreDBClusterFromS3Request.h.

◆ AddEnableCloudwatchLogsExports() [2/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1699 of file RestoreDBClusterFromS3Request.h.

◆ AddEnableCloudwatchLogsExports() [3/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1719 of file RestoreDBClusterFromS3Request.h.

◆ AddTags() [1/2]

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

Definition at line 1148 of file RestoreDBClusterFromS3Request.h.

◆ AddTags() [2/2]

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

Definition at line 1151 of file RestoreDBClusterFromS3Request.h.

◆ AddVpcSecurityGroupIds() [1/3]

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

A list of EC2 VPC security groups to associate with the restored DB cluster.

Definition at line 407 of file RestoreDBClusterFromS3Request.h.

◆ AddVpcSecurityGroupIds() [2/3]

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

A list of EC2 VPC security groups to associate with the restored DB cluster.

Definition at line 401 of file RestoreDBClusterFromS3Request.h.

◆ AddVpcSecurityGroupIds() [3/3]

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

A list of EC2 VPC security groups to associate with the restored DB cluster.

Definition at line 413 of file RestoreDBClusterFromS3Request.h.

◆ AvailabilityZonesHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterFromS3Request::AvailabilityZonesHasBeenSet ( ) const
inline

A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

Definition at line 51 of file RestoreDBClusterFromS3Request.h.

◆ BacktrackWindowHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1610 of file RestoreDBClusterFromS3Request.h.

◆ BackupRetentionPeriodHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterFromS3Request::BackupRetentionPeriodHasBeenSet ( ) const
inline

The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

  • Must be a value from 1 to 35

Definition at line 108 of file RestoreDBClusterFromS3Request.h.

◆ CharacterSetNameHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterFromS3Request::CharacterSetNameHasBeenSet ( ) const
inline

A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

Definition at line 135 of file RestoreDBClusterFromS3Request.h.

◆ CopyTagsToSnapshotHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1761 of file RestoreDBClusterFromS3Request.h.

◆ DatabaseNameHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterFromS3Request::DatabaseNameHasBeenSet ( ) const
inline

The database name for the restored DB cluster.

Definition at line 182 of file RestoreDBClusterFromS3Request.h.

◆ DBClusterIdentifierHasBeenSet()

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

The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.

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.

Example: my-cluster1

Definition at line 233 of file RestoreDBClusterFromS3Request.h.

◆ DBClusterParameterGroupNameHasBeenSet()

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

The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, default.aurora5.6 is used.

Constraints:

Definition at line 310 of file RestoreDBClusterFromS3Request.h.

◆ DBSubnetGroupNameHasBeenSet()

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

A DB subnet group to associate with the restored DB cluster.

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

Example: mySubnetgroup

Definition at line 428 of file RestoreDBClusterFromS3Request.h.

◆ DeletionProtectionHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1734 of file RestoreDBClusterFromS3Request.h.

◆ DomainHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1794 of file RestoreDBClusterFromS3Request.h.

◆ DomainIAMRoleNameHasBeenSet()

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

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

Definition at line 1867 of file RestoreDBClusterFromS3Request.h.

◆ DumpBodyToUrl()

void Aws::RDS::Model::RestoreDBClusterFromS3Request::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::RestoreDBClusterFromS3Request::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 1649 of file RestoreDBClusterFromS3Request.h.

◆ EnableIAMDatabaseAuthenticationHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1296 of file RestoreDBClusterFromS3Request.h.

◆ EngineHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterFromS3Request::EngineHasBeenSet ( ) const
inline

The name of the database engine to be used for this DB cluster.

Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

Definition at line 487 of file RestoreDBClusterFromS3Request.h.

◆ EngineVersionHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterFromS3Request::EngineVersionHasBeenSet ( ) const
inline

The version number of the database engine to use.

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora-mysql –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-postgresql, use the following command:

aws rds describe-db-engine-versions –engine aurora-postgresql –query "DBEngineVersions[].EngineVersion"

Aurora MySQL

Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5

Aurora PostgreSQL

Example: 9.6.3, 10.7

Definition at line 574 of file RestoreDBClusterFromS3Request.h.

◆ GetAvailabilityZones()

const Aws::Vector<Aws::String>& Aws::RDS::Model::RestoreDBClusterFromS3Request::GetAvailabilityZones ( ) const
inline

A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

Definition at line 45 of file RestoreDBClusterFromS3Request.h.

◆ GetBacktrackWindow()

long long Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1601 of file RestoreDBClusterFromS3Request.h.

◆ GetBackupRetentionPeriod()

int Aws::RDS::Model::RestoreDBClusterFromS3Request::GetBackupRetentionPeriod ( ) const
inline

The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

  • Must be a value from 1 to 35

Definition at line 101 of file RestoreDBClusterFromS3Request.h.

◆ GetCharacterSetName()

const Aws::String& Aws::RDS::Model::RestoreDBClusterFromS3Request::GetCharacterSetName ( ) const
inline

A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

Definition at line 129 of file RestoreDBClusterFromS3Request.h.

◆ GetCopyTagsToSnapshot()

bool Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1755 of file RestoreDBClusterFromS3Request.h.

◆ GetDatabaseName()

const Aws::String& Aws::RDS::Model::RestoreDBClusterFromS3Request::GetDatabaseName ( ) const
inline

The database name for the restored DB cluster.

Definition at line 177 of file RestoreDBClusterFromS3Request.h.

◆ GetDBClusterIdentifier()

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

The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.

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.

Example: my-cluster1

Definition at line 223 of file RestoreDBClusterFromS3Request.h.

◆ GetDBClusterParameterGroupName()

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

The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, default.aurora5.6 is used.

Constraints:

Definition at line 302 of file RestoreDBClusterFromS3Request.h.

◆ GetDBSubnetGroupName()

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

A DB subnet group to associate with the restored DB cluster.

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

Example: mySubnetgroup

Definition at line 421 of file RestoreDBClusterFromS3Request.h.

◆ GetDeletionProtection()

bool Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1727 of file RestoreDBClusterFromS3Request.h.

◆ GetDomain()

const Aws::String& Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1784 of file RestoreDBClusterFromS3Request.h.

◆ GetDomainIAMRoleName()

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

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

Definition at line 1861 of file RestoreDBClusterFromS3Request.h.

◆ GetEnableCloudwatchLogsExports()

const Aws::Vector<Aws::String>& Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1639 of file RestoreDBClusterFromS3Request.h.

◆ GetEnableIAMDatabaseAuthentication()

bool Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1287 of file RestoreDBClusterFromS3Request.h.

◆ GetEngine()

const Aws::String& Aws::RDS::Model::RestoreDBClusterFromS3Request::GetEngine ( ) const
inline

The name of the database engine to be used for this DB cluster.

Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

Definition at line 479 of file RestoreDBClusterFromS3Request.h.

◆ GetEngineVersion()

const Aws::String& Aws::RDS::Model::RestoreDBClusterFromS3Request::GetEngineVersion ( ) const
inline

The version number of the database engine to use.

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora-mysql –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-postgresql, use the following command:

aws rds describe-db-engine-versions –engine aurora-postgresql –query "DBEngineVersions[].EngineVersion"

Aurora MySQL

Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5

Aurora PostgreSQL

Example: 9.6.3, 10.7

Definition at line 555 of file RestoreDBClusterFromS3Request.h.

◆ GetKmsKeyId()

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

The Amazon Web Services KMS key identifier for 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.

If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default CMK. There is a default CMK for your Amazon Web Services account. Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region.

Definition at line 1186 of file RestoreDBClusterFromS3Request.h.

◆ GetMasterUsername()

const Aws::String& Aws::RDS::Model::RestoreDBClusterFromS3Request::GetMasterUsername ( ) const
inline

The name of the master user for the restored DB cluster.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

Definition at line 722 of file RestoreDBClusterFromS3Request.h.

◆ GetMasterUserPassword()

const Aws::String& Aws::RDS::Model::RestoreDBClusterFromS3Request::GetMasterUserPassword ( ) const
inline

The password for the master database user. This password can contain any printable ASCII character except "/", """, or "".

Constraints: Must contain from 8 to 41 characters.

Definition at line 786 of file RestoreDBClusterFromS3Request.h.

◆ GetOptionGroupName()

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

A value that indicates that the restored DB cluster should be associated with the specified option group.

Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.

Definition at line 844 of file RestoreDBClusterFromS3Request.h.

◆ GetPort()

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

The port number on which the instances in the restored DB cluster accept connections.

Default: 3306

Definition at line 695 of file RestoreDBClusterFromS3Request.h.

◆ GetPreferredBackupWindow()

const Aws::String& Aws::RDS::Model::RestoreDBClusterFromS3Request::GetPreferredBackupWindow ( ) const
inline

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 916 of file RestoreDBClusterFromS3Request.h.

◆ GetPreferredMaintenanceWindow()

const Aws::String& Aws::RDS::Model::RestoreDBClusterFromS3Request::GetPreferredMaintenanceWindow ( ) const
inline

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

Definition at line 1035 of file RestoreDBClusterFromS3Request.h.

◆ GetS3BucketName()

const Aws::String& Aws::RDS::Model::RestoreDBClusterFromS3Request::GetS3BucketName ( ) const
inline

The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

Definition at line 1427 of file RestoreDBClusterFromS3Request.h.

◆ GetS3IngestionRoleArn()

const Aws::String& Aws::RDS::Model::RestoreDBClusterFromS3Request::GetS3IngestionRoleArn ( ) const
inline

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.

Definition at line 1542 of file RestoreDBClusterFromS3Request.h.

◆ GetS3Prefix()

const Aws::String& Aws::RDS::Model::RestoreDBClusterFromS3Request::GetS3Prefix ( ) const
inline

The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.

Definition at line 1478 of file RestoreDBClusterFromS3Request.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file RestoreDBClusterFromS3Request.h.

◆ GetSourceEngine()

const Aws::String& Aws::RDS::Model::RestoreDBClusterFromS3Request::GetSourceEngine ( ) const
inline

The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.

Valid values: mysql

Definition at line 1321 of file RestoreDBClusterFromS3Request.h.

◆ GetSourceEngineVersion()

const Aws::String& Aws::RDS::Model::RestoreDBClusterFromS3Request::GetSourceEngineVersion ( ) const
inline

The version of the database that the backup files were created from.

MySQL versions 5.5, 5.6, and 5.7 are supported.

Example: 5.6.40, 5.7.28

Definition at line 1371 of file RestoreDBClusterFromS3Request.h.

◆ GetStorageEncrypted()

bool Aws::RDS::Model::RestoreDBClusterFromS3Request::GetStorageEncrypted ( ) const
inline

A value that indicates whether the restored DB cluster is encrypted.

Definition at line 1157 of file RestoreDBClusterFromS3Request.h.

◆ GetTags()

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

Definition at line 1130 of file RestoreDBClusterFromS3Request.h.

◆ GetVpcSecurityGroupIds()

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

A list of EC2 VPC security groups to associate with the restored DB cluster.

Definition at line 365 of file RestoreDBClusterFromS3Request.h.

◆ KmsKeyIdHasBeenSet()

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

The Amazon Web Services KMS key identifier for 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.

If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default CMK. There is a default CMK for your Amazon Web Services account. Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region.

Definition at line 1199 of file RestoreDBClusterFromS3Request.h.

◆ MasterUsernameHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterFromS3Request::MasterUsernameHasBeenSet ( ) const
inline

The name of the master user for the restored DB cluster.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

Definition at line 730 of file RestoreDBClusterFromS3Request.h.

◆ MasterUserPasswordHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterFromS3Request::MasterUserPasswordHasBeenSet ( ) const
inline

The password for the master database user. This password can contain any printable ASCII character except "/", """, or "".

Constraints: Must contain from 8 to 41 characters.

Definition at line 793 of file RestoreDBClusterFromS3Request.h.

◆ OptionGroupNameHasBeenSet()

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

A value that indicates that the restored DB cluster should be associated with the specified option group.

Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.

Definition at line 852 of file RestoreDBClusterFromS3Request.h.

◆ PortHasBeenSet()

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

The port number on which the instances in the restored DB cluster accept connections.

Default: 3306

Definition at line 701 of file RestoreDBClusterFromS3Request.h.

◆ PreferredBackupWindowHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterFromS3Request::PreferredBackupWindowHasBeenSet ( ) const
inline

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 931 of file RestoreDBClusterFromS3Request.h.

◆ PreferredMaintenanceWindowHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterFromS3Request::PreferredMaintenanceWindowHasBeenSet ( ) const
inline

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

Definition at line 1048 of file RestoreDBClusterFromS3Request.h.

◆ S3BucketNameHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterFromS3Request::S3BucketNameHasBeenSet ( ) const
inline

The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

Definition at line 1433 of file RestoreDBClusterFromS3Request.h.

◆ S3IngestionRoleArnHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterFromS3Request::S3IngestionRoleArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.

Definition at line 1549 of file RestoreDBClusterFromS3Request.h.

◆ S3PrefixHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterFromS3Request::S3PrefixHasBeenSet ( ) const
inline

The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.

Definition at line 1486 of file RestoreDBClusterFromS3Request.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAvailabilityZones() [1/2]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetAvailabilityZones ( Aws::Vector< Aws::String > &&  value)
inline

A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

Definition at line 63 of file RestoreDBClusterFromS3Request.h.

◆ SetAvailabilityZones() [2/2]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetAvailabilityZones ( const Aws::Vector< Aws::String > &  value)
inline

A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

Definition at line 57 of file RestoreDBClusterFromS3Request.h.

◆ SetBacktrackWindow()

void Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1619 of file RestoreDBClusterFromS3Request.h.

◆ SetBackupRetentionPeriod()

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetBackupRetentionPeriod ( int  value)
inline

The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

  • Must be a value from 1 to 35

Definition at line 115 of file RestoreDBClusterFromS3Request.h.

◆ SetCharacterSetName() [1/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetCharacterSetName ( Aws::String &&  value)
inline

A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

Definition at line 147 of file RestoreDBClusterFromS3Request.h.

◆ SetCharacterSetName() [2/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetCharacterSetName ( const Aws::String value)
inline

A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

Definition at line 141 of file RestoreDBClusterFromS3Request.h.

◆ SetCharacterSetName() [3/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetCharacterSetName ( const char *  value)
inline

A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

Definition at line 153 of file RestoreDBClusterFromS3Request.h.

◆ SetCopyTagsToSnapshot()

void Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1767 of file RestoreDBClusterFromS3Request.h.

◆ SetDatabaseName() [1/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetDatabaseName ( Aws::String &&  value)
inline

The database name for the restored DB cluster.

Definition at line 192 of file RestoreDBClusterFromS3Request.h.

◆ SetDatabaseName() [2/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetDatabaseName ( const Aws::String value)
inline

The database name for the restored DB cluster.

Definition at line 187 of file RestoreDBClusterFromS3Request.h.

◆ SetDatabaseName() [3/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetDatabaseName ( const char *  value)
inline

The database name for the restored DB cluster.

Definition at line 197 of file RestoreDBClusterFromS3Request.h.

◆ SetDBClusterIdentifier() [1/3]

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

The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.

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.

Example: my-cluster1

Definition at line 253 of file RestoreDBClusterFromS3Request.h.

◆ SetDBClusterIdentifier() [2/3]

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

The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.

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.

Example: my-cluster1

Definition at line 243 of file RestoreDBClusterFromS3Request.h.

◆ SetDBClusterIdentifier() [3/3]

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

The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.

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.

Example: my-cluster1

Definition at line 263 of file RestoreDBClusterFromS3Request.h.

◆ SetDBClusterParameterGroupName() [1/3]

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

The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, default.aurora5.6 is used.

Constraints:

Definition at line 326 of file RestoreDBClusterFromS3Request.h.

◆ SetDBClusterParameterGroupName() [2/3]

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

The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, default.aurora5.6 is used.

Constraints:

Definition at line 318 of file RestoreDBClusterFromS3Request.h.

◆ SetDBClusterParameterGroupName() [3/3]

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

The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, default.aurora5.6 is used.

Constraints:

Definition at line 334 of file RestoreDBClusterFromS3Request.h.

◆ SetDBSubnetGroupName() [1/3]

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

A DB subnet group to associate with the restored DB cluster.

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

Example: mySubnetgroup

Definition at line 442 of file RestoreDBClusterFromS3Request.h.

◆ SetDBSubnetGroupName() [2/3]

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

A DB subnet group to associate with the restored DB cluster.

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

Example: mySubnetgroup

Definition at line 435 of file RestoreDBClusterFromS3Request.h.

◆ SetDBSubnetGroupName() [3/3]

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

A DB subnet group to associate with the restored DB cluster.

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

Example: mySubnetgroup

Definition at line 449 of file RestoreDBClusterFromS3Request.h.

◆ SetDeletionProtection()

void Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1741 of file RestoreDBClusterFromS3Request.h.

◆ SetDomain() [1/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1814 of file RestoreDBClusterFromS3Request.h.

◆ SetDomain() [2/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1804 of file RestoreDBClusterFromS3Request.h.

◆ SetDomain() [3/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1824 of file RestoreDBClusterFromS3Request.h.

◆ SetDomainIAMRoleName() [1/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1879 of file RestoreDBClusterFromS3Request.h.

◆ SetDomainIAMRoleName() [2/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1873 of file RestoreDBClusterFromS3Request.h.

◆ SetDomainIAMRoleName() [3/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1885 of file RestoreDBClusterFromS3Request.h.

◆ SetEnableCloudwatchLogsExports() [1/2]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1669 of file RestoreDBClusterFromS3Request.h.

◆ SetEnableCloudwatchLogsExports() [2/2]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1659 of file RestoreDBClusterFromS3Request.h.

◆ SetEnableIAMDatabaseAuthentication()

void Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1305 of file RestoreDBClusterFromS3Request.h.

◆ SetEngine() [1/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetEngine ( Aws::String &&  value)
inline

The name of the database engine to be used for this DB cluster.

Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

Definition at line 503 of file RestoreDBClusterFromS3Request.h.

◆ SetEngine() [2/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetEngine ( const Aws::String value)
inline

The name of the database engine to be used for this DB cluster.

Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

Definition at line 495 of file RestoreDBClusterFromS3Request.h.

◆ SetEngine() [3/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetEngine ( const char *  value)
inline

The name of the database engine to be used for this DB cluster.

Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

Definition at line 511 of file RestoreDBClusterFromS3Request.h.

◆ SetEngineVersion() [1/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetEngineVersion ( Aws::String &&  value)
inline

The version number of the database engine to use.

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora-mysql –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-postgresql, use the following command:

aws rds describe-db-engine-versions –engine aurora-postgresql –query "DBEngineVersions[].EngineVersion"

Aurora MySQL

Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5

Aurora PostgreSQL

Example: 9.6.3, 10.7

Definition at line 612 of file RestoreDBClusterFromS3Request.h.

◆ SetEngineVersion() [2/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetEngineVersion ( const Aws::String value)
inline

The version number of the database engine to use.

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora-mysql –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-postgresql, use the following command:

aws rds describe-db-engine-versions –engine aurora-postgresql –query "DBEngineVersions[].EngineVersion"

Aurora MySQL

Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5

Aurora PostgreSQL

Example: 9.6.3, 10.7

Definition at line 593 of file RestoreDBClusterFromS3Request.h.

◆ SetEngineVersion() [3/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetEngineVersion ( const char *  value)
inline

The version number of the database engine to use.

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora-mysql –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-postgresql, use the following command:

aws rds describe-db-engine-versions –engine aurora-postgresql –query "DBEngineVersions[].EngineVersion"

Aurora MySQL

Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5

Aurora PostgreSQL

Example: 9.6.3, 10.7

Definition at line 631 of file RestoreDBClusterFromS3Request.h.

◆ SetKmsKeyId() [1/3]

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

The Amazon Web Services KMS key identifier for 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.

If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default CMK. There is a default CMK for your Amazon Web Services account. Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region.

Definition at line 1225 of file RestoreDBClusterFromS3Request.h.

◆ SetKmsKeyId() [2/3]

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

The Amazon Web Services KMS key identifier for 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.

If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default CMK. There is a default CMK for your Amazon Web Services account. Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region.

Definition at line 1212 of file RestoreDBClusterFromS3Request.h.

◆ SetKmsKeyId() [3/3]

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

The Amazon Web Services KMS key identifier for 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.

If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default CMK. There is a default CMK for your Amazon Web Services account. Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region.

Definition at line 1238 of file RestoreDBClusterFromS3Request.h.

◆ SetMasterUsername() [1/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetMasterUsername ( Aws::String &&  value)
inline

The name of the master user for the restored DB cluster.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

Definition at line 746 of file RestoreDBClusterFromS3Request.h.

◆ SetMasterUsername() [2/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetMasterUsername ( const Aws::String value)
inline

The name of the master user for the restored DB cluster.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

Definition at line 738 of file RestoreDBClusterFromS3Request.h.

◆ SetMasterUsername() [3/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetMasterUsername ( const char *  value)
inline

The name of the master user for the restored DB cluster.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

Definition at line 754 of file RestoreDBClusterFromS3Request.h.

◆ SetMasterUserPassword() [1/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetMasterUserPassword ( Aws::String &&  value)
inline

The password for the master database user. This password can contain any printable ASCII character except "/", """, or "".

Constraints: Must contain from 8 to 41 characters.

Definition at line 807 of file RestoreDBClusterFromS3Request.h.

◆ SetMasterUserPassword() [2/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetMasterUserPassword ( const Aws::String value)
inline

The password for the master database user. This password can contain any printable ASCII character except "/", """, or "".

Constraints: Must contain from 8 to 41 characters.

Definition at line 800 of file RestoreDBClusterFromS3Request.h.

◆ SetMasterUserPassword() [3/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetMasterUserPassword ( const char *  value)
inline

The password for the master database user. This password can contain any printable ASCII character except "/", """, or "".

Constraints: Must contain from 8 to 41 characters.

Definition at line 814 of file RestoreDBClusterFromS3Request.h.

◆ SetOptionGroupName() [1/3]

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

A value that indicates that the restored DB cluster should be associated with the specified option group.

Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.

Definition at line 868 of file RestoreDBClusterFromS3Request.h.

◆ SetOptionGroupName() [2/3]

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

A value that indicates that the restored DB cluster should be associated with the specified option group.

Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.

Definition at line 860 of file RestoreDBClusterFromS3Request.h.

◆ SetOptionGroupName() [3/3]

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

A value that indicates that the restored DB cluster should be associated with the specified option group.

Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.

Definition at line 876 of file RestoreDBClusterFromS3Request.h.

◆ SetPort()

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

The port number on which the instances in the restored DB cluster accept connections.

Default: 3306

Definition at line 707 of file RestoreDBClusterFromS3Request.h.

◆ SetPreferredBackupWindow() [1/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetPreferredBackupWindow ( Aws::String &&  value)
inline

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 961 of file RestoreDBClusterFromS3Request.h.

◆ SetPreferredBackupWindow() [2/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetPreferredBackupWindow ( const Aws::String value)
inline

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 946 of file RestoreDBClusterFromS3Request.h.

◆ SetPreferredBackupWindow() [3/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetPreferredBackupWindow ( const char *  value)
inline

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 976 of file RestoreDBClusterFromS3Request.h.

◆ SetPreferredMaintenanceWindow() [1/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetPreferredMaintenanceWindow ( Aws::String &&  value)
inline

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

Definition at line 1074 of file RestoreDBClusterFromS3Request.h.

◆ SetPreferredMaintenanceWindow() [2/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetPreferredMaintenanceWindow ( const Aws::String value)
inline

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

Definition at line 1061 of file RestoreDBClusterFromS3Request.h.

◆ SetPreferredMaintenanceWindow() [3/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetPreferredMaintenanceWindow ( const char *  value)
inline

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

Definition at line 1087 of file RestoreDBClusterFromS3Request.h.

◆ SetS3BucketName() [1/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetS3BucketName ( Aws::String &&  value)
inline

The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

Definition at line 1445 of file RestoreDBClusterFromS3Request.h.

◆ SetS3BucketName() [2/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetS3BucketName ( const Aws::String value)
inline

The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

Definition at line 1439 of file RestoreDBClusterFromS3Request.h.

◆ SetS3BucketName() [3/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetS3BucketName ( const char *  value)
inline

The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

Definition at line 1451 of file RestoreDBClusterFromS3Request.h.

◆ SetS3IngestionRoleArn() [1/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetS3IngestionRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.

Definition at line 1563 of file RestoreDBClusterFromS3Request.h.

◆ SetS3IngestionRoleArn() [2/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetS3IngestionRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.

Definition at line 1556 of file RestoreDBClusterFromS3Request.h.

◆ SetS3IngestionRoleArn() [3/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetS3IngestionRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.

Definition at line 1570 of file RestoreDBClusterFromS3Request.h.

◆ SetS3Prefix() [1/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetS3Prefix ( Aws::String &&  value)
inline

The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.

Definition at line 1502 of file RestoreDBClusterFromS3Request.h.

◆ SetS3Prefix() [2/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetS3Prefix ( const Aws::String value)
inline

The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.

Definition at line 1494 of file RestoreDBClusterFromS3Request.h.

◆ SetS3Prefix() [3/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetS3Prefix ( const char *  value)
inline

The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.

Definition at line 1510 of file RestoreDBClusterFromS3Request.h.

◆ SetSourceEngine() [1/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetSourceEngine ( Aws::String &&  value)
inline

The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.

Valid values: mysql

Definition at line 1339 of file RestoreDBClusterFromS3Request.h.

◆ SetSourceEngine() [2/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetSourceEngine ( const Aws::String value)
inline

The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.

Valid values: mysql

Definition at line 1333 of file RestoreDBClusterFromS3Request.h.

◆ SetSourceEngine() [3/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetSourceEngine ( const char *  value)
inline

The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.

Valid values: mysql

Definition at line 1345 of file RestoreDBClusterFromS3Request.h.

◆ SetSourceEngineVersion() [1/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetSourceEngineVersion ( Aws::String &&  value)
inline

The version of the database that the backup files were created from.

MySQL versions 5.5, 5.6, and 5.7 are supported.

Example: 5.6.40, 5.7.28

Definition at line 1392 of file RestoreDBClusterFromS3Request.h.

◆ SetSourceEngineVersion() [2/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetSourceEngineVersion ( const Aws::String value)
inline

The version of the database that the backup files were created from.

MySQL versions 5.5, 5.6, and 5.7 are supported.

Example: 5.6.40, 5.7.28

Definition at line 1385 of file RestoreDBClusterFromS3Request.h.

◆ SetSourceEngineVersion() [3/3]

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetSourceEngineVersion ( const char *  value)
inline

The version of the database that the backup files were created from.

MySQL versions 5.5, 5.6, and 5.7 are supported.

Example: 5.6.40, 5.7.28

Definition at line 1399 of file RestoreDBClusterFromS3Request.h.

◆ SetStorageEncrypted()

void Aws::RDS::Model::RestoreDBClusterFromS3Request::SetStorageEncrypted ( bool  value)
inline

A value that indicates whether the restored DB cluster is encrypted.

Definition at line 1167 of file RestoreDBClusterFromS3Request.h.

◆ SetTags() [1/2]

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

Definition at line 1139 of file RestoreDBClusterFromS3Request.h.

◆ SetTags() [2/2]

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

Definition at line 1136 of file RestoreDBClusterFromS3Request.h.

◆ SetVpcSecurityGroupIds() [1/2]

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

A list of EC2 VPC security groups to associate with the restored DB cluster.

Definition at line 383 of file RestoreDBClusterFromS3Request.h.

◆ SetVpcSecurityGroupIds() [2/2]

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

A list of EC2 VPC security groups to associate with the restored DB cluster.

Definition at line 377 of file RestoreDBClusterFromS3Request.h.

◆ SourceEngineHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterFromS3Request::SourceEngineHasBeenSet ( ) const
inline

The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.

Valid values: mysql

Definition at line 1327 of file RestoreDBClusterFromS3Request.h.

◆ SourceEngineVersionHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterFromS3Request::SourceEngineVersionHasBeenSet ( ) const
inline

The version of the database that the backup files were created from.

MySQL versions 5.5, 5.6, and 5.7 are supported.

Example: 5.6.40, 5.7.28

Definition at line 1378 of file RestoreDBClusterFromS3Request.h.

◆ StorageEncryptedHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterFromS3Request::StorageEncryptedHasBeenSet ( ) const
inline

A value that indicates whether the restored DB cluster is encrypted.

Definition at line 1162 of file RestoreDBClusterFromS3Request.h.

◆ TagsHasBeenSet()

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

Definition at line 1133 of file RestoreDBClusterFromS3Request.h.

◆ VpcSecurityGroupIdsHasBeenSet()

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

A list of EC2 VPC security groups to associate with the restored DB cluster.

Definition at line 371 of file RestoreDBClusterFromS3Request.h.

◆ WithAvailabilityZones() [1/2]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithAvailabilityZones ( Aws::Vector< Aws::String > &&  value)
inline

A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

Definition at line 75 of file RestoreDBClusterFromS3Request.h.

◆ WithAvailabilityZones() [2/2]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithAvailabilityZones ( const Aws::Vector< Aws::String > &  value)
inline

A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

Definition at line 69 of file RestoreDBClusterFromS3Request.h.

◆ WithBacktrackWindow()

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1628 of file RestoreDBClusterFromS3Request.h.

◆ WithBackupRetentionPeriod()

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithBackupRetentionPeriod ( int  value)
inline

The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

  • Must be a value from 1 to 35

Definition at line 122 of file RestoreDBClusterFromS3Request.h.

◆ WithCharacterSetName() [1/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithCharacterSetName ( Aws::String &&  value)
inline

A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

Definition at line 165 of file RestoreDBClusterFromS3Request.h.

◆ WithCharacterSetName() [2/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithCharacterSetName ( const Aws::String value)
inline

A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

Definition at line 159 of file RestoreDBClusterFromS3Request.h.

◆ WithCharacterSetName() [3/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithCharacterSetName ( const char *  value)
inline

A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

Definition at line 171 of file RestoreDBClusterFromS3Request.h.

◆ WithCopyTagsToSnapshot()

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1773 of file RestoreDBClusterFromS3Request.h.

◆ WithDatabaseName() [1/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithDatabaseName ( Aws::String &&  value)
inline

The database name for the restored DB cluster.

Definition at line 207 of file RestoreDBClusterFromS3Request.h.

◆ WithDatabaseName() [2/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithDatabaseName ( const Aws::String value)
inline

The database name for the restored DB cluster.

Definition at line 202 of file RestoreDBClusterFromS3Request.h.

◆ WithDatabaseName() [3/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithDatabaseName ( const char *  value)
inline

The database name for the restored DB cluster.

Definition at line 212 of file RestoreDBClusterFromS3Request.h.

◆ WithDBClusterIdentifier() [1/3]

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

The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.

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.

Example: my-cluster1

Definition at line 283 of file RestoreDBClusterFromS3Request.h.

◆ WithDBClusterIdentifier() [2/3]

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

The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.

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.

Example: my-cluster1

Definition at line 273 of file RestoreDBClusterFromS3Request.h.

◆ WithDBClusterIdentifier() [3/3]

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

The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.

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.

Example: my-cluster1

Definition at line 293 of file RestoreDBClusterFromS3Request.h.

◆ WithDBClusterParameterGroupName() [1/3]

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

The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, default.aurora5.6 is used.

Constraints:

Definition at line 350 of file RestoreDBClusterFromS3Request.h.

◆ WithDBClusterParameterGroupName() [2/3]

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

The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, default.aurora5.6 is used.

Constraints:

Definition at line 342 of file RestoreDBClusterFromS3Request.h.

◆ WithDBClusterParameterGroupName() [3/3]

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

The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, default.aurora5.6 is used.

Constraints:

Definition at line 358 of file RestoreDBClusterFromS3Request.h.

◆ WithDBSubnetGroupName() [1/3]

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

A DB subnet group to associate with the restored DB cluster.

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

Example: mySubnetgroup

Definition at line 463 of file RestoreDBClusterFromS3Request.h.

◆ WithDBSubnetGroupName() [2/3]

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

A DB subnet group to associate with the restored DB cluster.

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

Example: mySubnetgroup

Definition at line 456 of file RestoreDBClusterFromS3Request.h.

◆ WithDBSubnetGroupName() [3/3]

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

A DB subnet group to associate with the restored DB cluster.

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

Example: mySubnetgroup

Definition at line 470 of file RestoreDBClusterFromS3Request.h.

◆ WithDeletionProtection()

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1748 of file RestoreDBClusterFromS3Request.h.

◆ WithDomain() [1/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1844 of file RestoreDBClusterFromS3Request.h.

◆ WithDomain() [2/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1834 of file RestoreDBClusterFromS3Request.h.

◆ WithDomain() [3/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1854 of file RestoreDBClusterFromS3Request.h.

◆ WithDomainIAMRoleName() [1/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1897 of file RestoreDBClusterFromS3Request.h.

◆ WithDomainIAMRoleName() [2/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1891 of file RestoreDBClusterFromS3Request.h.

◆ WithDomainIAMRoleName() [3/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1903 of file RestoreDBClusterFromS3Request.h.

◆ WithEnableCloudwatchLogsExports() [1/2]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1689 of file RestoreDBClusterFromS3Request.h.

◆ WithEnableCloudwatchLogsExports() [2/2]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1679 of file RestoreDBClusterFromS3Request.h.

◆ WithEnableIAMDatabaseAuthentication()

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::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 1314 of file RestoreDBClusterFromS3Request.h.

◆ WithEngine() [1/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithEngine ( Aws::String &&  value)
inline

The name of the database engine to be used for this DB cluster.

Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

Definition at line 527 of file RestoreDBClusterFromS3Request.h.

◆ WithEngine() [2/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithEngine ( const Aws::String value)
inline

The name of the database engine to be used for this DB cluster.

Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

Definition at line 519 of file RestoreDBClusterFromS3Request.h.

◆ WithEngine() [3/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithEngine ( const char *  value)
inline

The name of the database engine to be used for this DB cluster.

Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

Definition at line 535 of file RestoreDBClusterFromS3Request.h.

◆ WithEngineVersion() [1/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithEngineVersion ( Aws::String &&  value)
inline

The version number of the database engine to use.

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora-mysql –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-postgresql, use the following command:

aws rds describe-db-engine-versions –engine aurora-postgresql –query "DBEngineVersions[].EngineVersion"

Aurora MySQL

Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5

Aurora PostgreSQL

Example: 9.6.3, 10.7

Definition at line 669 of file RestoreDBClusterFromS3Request.h.

◆ WithEngineVersion() [2/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithEngineVersion ( const Aws::String value)
inline

The version number of the database engine to use.

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora-mysql –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-postgresql, use the following command:

aws rds describe-db-engine-versions –engine aurora-postgresql –query "DBEngineVersions[].EngineVersion"

Aurora MySQL

Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5

Aurora PostgreSQL

Example: 9.6.3, 10.7

Definition at line 650 of file RestoreDBClusterFromS3Request.h.

◆ WithEngineVersion() [3/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithEngineVersion ( const char *  value)
inline

The version number of the database engine to use.

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora-mysql –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-postgresql, use the following command:

aws rds describe-db-engine-versions –engine aurora-postgresql –query "DBEngineVersions[].EngineVersion"

Aurora MySQL

Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5

Aurora PostgreSQL

Example: 9.6.3, 10.7

Definition at line 688 of file RestoreDBClusterFromS3Request.h.

◆ WithKmsKeyId() [1/3]

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

The Amazon Web Services KMS key identifier for 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.

If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default CMK. There is a default CMK for your Amazon Web Services account. Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region.

Definition at line 1264 of file RestoreDBClusterFromS3Request.h.

◆ WithKmsKeyId() [2/3]

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

The Amazon Web Services KMS key identifier for 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.

If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default CMK. There is a default CMK for your Amazon Web Services account. Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region.

Definition at line 1251 of file RestoreDBClusterFromS3Request.h.

◆ WithKmsKeyId() [3/3]

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

The Amazon Web Services KMS key identifier for 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.

If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default CMK. There is a default CMK for your Amazon Web Services account. Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region.

Definition at line 1277 of file RestoreDBClusterFromS3Request.h.

◆ WithMasterUsername() [1/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithMasterUsername ( Aws::String &&  value)
inline

The name of the master user for the restored DB cluster.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

Definition at line 770 of file RestoreDBClusterFromS3Request.h.

◆ WithMasterUsername() [2/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithMasterUsername ( const Aws::String value)
inline

The name of the master user for the restored DB cluster.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

Definition at line 762 of file RestoreDBClusterFromS3Request.h.

◆ WithMasterUsername() [3/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithMasterUsername ( const char *  value)
inline

The name of the master user for the restored DB cluster.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

Definition at line 778 of file RestoreDBClusterFromS3Request.h.

◆ WithMasterUserPassword() [1/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithMasterUserPassword ( Aws::String &&  value)
inline

The password for the master database user. This password can contain any printable ASCII character except "/", """, or "".

Constraints: Must contain from 8 to 41 characters.

Definition at line 828 of file RestoreDBClusterFromS3Request.h.

◆ WithMasterUserPassword() [2/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithMasterUserPassword ( const Aws::String value)
inline

The password for the master database user. This password can contain any printable ASCII character except "/", """, or "".

Constraints: Must contain from 8 to 41 characters.

Definition at line 821 of file RestoreDBClusterFromS3Request.h.

◆ WithMasterUserPassword() [3/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithMasterUserPassword ( const char *  value)
inline

The password for the master database user. This password can contain any printable ASCII character except "/", """, or "".

Constraints: Must contain from 8 to 41 characters.

Definition at line 835 of file RestoreDBClusterFromS3Request.h.

◆ WithOptionGroupName() [1/3]

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

A value that indicates that the restored DB cluster should be associated with the specified option group.

Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.

Definition at line 892 of file RestoreDBClusterFromS3Request.h.

◆ WithOptionGroupName() [2/3]

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

A value that indicates that the restored DB cluster should be associated with the specified option group.

Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.

Definition at line 884 of file RestoreDBClusterFromS3Request.h.

◆ WithOptionGroupName() [3/3]

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

A value that indicates that the restored DB cluster should be associated with the specified option group.

Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.

Definition at line 900 of file RestoreDBClusterFromS3Request.h.

◆ WithPort()

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

The port number on which the instances in the restored DB cluster accept connections.

Default: 3306

Definition at line 713 of file RestoreDBClusterFromS3Request.h.

◆ WithPreferredBackupWindow() [1/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithPreferredBackupWindow ( Aws::String &&  value)
inline

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 1006 of file RestoreDBClusterFromS3Request.h.

◆ WithPreferredBackupWindow() [2/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithPreferredBackupWindow ( const Aws::String value)
inline

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 991 of file RestoreDBClusterFromS3Request.h.

◆ WithPreferredBackupWindow() [3/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithPreferredBackupWindow ( const char *  value)
inline

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 1021 of file RestoreDBClusterFromS3Request.h.

◆ WithPreferredMaintenanceWindow() [1/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithPreferredMaintenanceWindow ( Aws::String &&  value)
inline

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

Definition at line 1113 of file RestoreDBClusterFromS3Request.h.

◆ WithPreferredMaintenanceWindow() [2/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithPreferredMaintenanceWindow ( const Aws::String value)
inline

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

Definition at line 1100 of file RestoreDBClusterFromS3Request.h.

◆ WithPreferredMaintenanceWindow() [3/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithPreferredMaintenanceWindow ( const char *  value)
inline

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

Definition at line 1126 of file RestoreDBClusterFromS3Request.h.

◆ WithS3BucketName() [1/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithS3BucketName ( Aws::String &&  value)
inline

The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

Definition at line 1463 of file RestoreDBClusterFromS3Request.h.

◆ WithS3BucketName() [2/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithS3BucketName ( const Aws::String value)
inline

The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

Definition at line 1457 of file RestoreDBClusterFromS3Request.h.

◆ WithS3BucketName() [3/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithS3BucketName ( const char *  value)
inline

The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

Definition at line 1469 of file RestoreDBClusterFromS3Request.h.

◆ WithS3IngestionRoleArn() [1/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithS3IngestionRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.

Definition at line 1584 of file RestoreDBClusterFromS3Request.h.

◆ WithS3IngestionRoleArn() [2/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithS3IngestionRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.

Definition at line 1577 of file RestoreDBClusterFromS3Request.h.

◆ WithS3IngestionRoleArn() [3/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithS3IngestionRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.

Definition at line 1591 of file RestoreDBClusterFromS3Request.h.

◆ WithS3Prefix() [1/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithS3Prefix ( Aws::String &&  value)
inline

The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.

Definition at line 1526 of file RestoreDBClusterFromS3Request.h.

◆ WithS3Prefix() [2/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithS3Prefix ( const Aws::String value)
inline

The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.

Definition at line 1518 of file RestoreDBClusterFromS3Request.h.

◆ WithS3Prefix() [3/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithS3Prefix ( const char *  value)
inline

The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.

Definition at line 1534 of file RestoreDBClusterFromS3Request.h.

◆ WithSourceEngine() [1/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithSourceEngine ( Aws::String &&  value)
inline

The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.

Valid values: mysql

Definition at line 1357 of file RestoreDBClusterFromS3Request.h.

◆ WithSourceEngine() [2/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithSourceEngine ( const Aws::String value)
inline

The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.

Valid values: mysql

Definition at line 1351 of file RestoreDBClusterFromS3Request.h.

◆ WithSourceEngine() [3/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithSourceEngine ( const char *  value)
inline

The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.

Valid values: mysql

Definition at line 1363 of file RestoreDBClusterFromS3Request.h.

◆ WithSourceEngineVersion() [1/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithSourceEngineVersion ( Aws::String &&  value)
inline

The version of the database that the backup files were created from.

MySQL versions 5.5, 5.6, and 5.7 are supported.

Example: 5.6.40, 5.7.28

Definition at line 1413 of file RestoreDBClusterFromS3Request.h.

◆ WithSourceEngineVersion() [2/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithSourceEngineVersion ( const Aws::String value)
inline

The version of the database that the backup files were created from.

MySQL versions 5.5, 5.6, and 5.7 are supported.

Example: 5.6.40, 5.7.28

Definition at line 1406 of file RestoreDBClusterFromS3Request.h.

◆ WithSourceEngineVersion() [3/3]

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithSourceEngineVersion ( const char *  value)
inline

The version of the database that the backup files were created from.

MySQL versions 5.5, 5.6, and 5.7 are supported.

Example: 5.6.40, 5.7.28

Definition at line 1420 of file RestoreDBClusterFromS3Request.h.

◆ WithStorageEncrypted()

RestoreDBClusterFromS3Request& Aws::RDS::Model::RestoreDBClusterFromS3Request::WithStorageEncrypted ( bool  value)
inline

A value that indicates whether the restored DB cluster is encrypted.

Definition at line 1172 of file RestoreDBClusterFromS3Request.h.

◆ WithTags() [1/2]

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

Definition at line 1145 of file RestoreDBClusterFromS3Request.h.

◆ WithTags() [2/2]

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

Definition at line 1142 of file RestoreDBClusterFromS3Request.h.

◆ WithVpcSecurityGroupIds() [1/2]

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

A list of EC2 VPC security groups to associate with the restored DB cluster.

Definition at line 395 of file RestoreDBClusterFromS3Request.h.

◆ WithVpcSecurityGroupIds() [2/2]

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

A list of EC2 VPC security groups to associate with the restored DB cluster.

Definition at line 389 of file RestoreDBClusterFromS3Request.h.


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