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

#include <RestoreDBClusterFromSnapshotRequest.h>

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

Public Member Functions

 RestoreDBClusterFromSnapshotRequest ()
 
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)
 
RestoreDBClusterFromSnapshotRequestWithAvailabilityZones (const Aws::Vector< Aws::String > &value)
 
RestoreDBClusterFromSnapshotRequestWithAvailabilityZones (Aws::Vector< Aws::String > &&value)
 
RestoreDBClusterFromSnapshotRequestAddAvailabilityZones (const Aws::String &value)
 
RestoreDBClusterFromSnapshotRequestAddAvailabilityZones (Aws::String &&value)
 
RestoreDBClusterFromSnapshotRequestAddAvailabilityZones (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)
 
RestoreDBClusterFromSnapshotRequestWithDBClusterIdentifier (const Aws::String &value)
 
RestoreDBClusterFromSnapshotRequestWithDBClusterIdentifier (Aws::String &&value)
 
RestoreDBClusterFromSnapshotRequestWithDBClusterIdentifier (const char *value)
 
const Aws::StringGetSnapshotIdentifier () const
 
bool SnapshotIdentifierHasBeenSet () const
 
void SetSnapshotIdentifier (const Aws::String &value)
 
void SetSnapshotIdentifier (Aws::String &&value)
 
void SetSnapshotIdentifier (const char *value)
 
RestoreDBClusterFromSnapshotRequestWithSnapshotIdentifier (const Aws::String &value)
 
RestoreDBClusterFromSnapshotRequestWithSnapshotIdentifier (Aws::String &&value)
 
RestoreDBClusterFromSnapshotRequestWithSnapshotIdentifier (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)
 
RestoreDBClusterFromSnapshotRequestWithEngine (const Aws::String &value)
 
RestoreDBClusterFromSnapshotRequestWithEngine (Aws::String &&value)
 
RestoreDBClusterFromSnapshotRequestWithEngine (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)
 
RestoreDBClusterFromSnapshotRequestWithEngineVersion (const Aws::String &value)
 
RestoreDBClusterFromSnapshotRequestWithEngineVersion (Aws::String &&value)
 
RestoreDBClusterFromSnapshotRequestWithEngineVersion (const char *value)
 
int GetPort () const
 
bool PortHasBeenSet () const
 
void SetPort (int value)
 
RestoreDBClusterFromSnapshotRequestWithPort (int value)
 
const Aws::StringGetDBSubnetGroupName () const
 
bool DBSubnetGroupNameHasBeenSet () const
 
void SetDBSubnetGroupName (const Aws::String &value)
 
void SetDBSubnetGroupName (Aws::String &&value)
 
void SetDBSubnetGroupName (const char *value)
 
RestoreDBClusterFromSnapshotRequestWithDBSubnetGroupName (const Aws::String &value)
 
RestoreDBClusterFromSnapshotRequestWithDBSubnetGroupName (Aws::String &&value)
 
RestoreDBClusterFromSnapshotRequestWithDBSubnetGroupName (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)
 
RestoreDBClusterFromSnapshotRequestWithDatabaseName (const Aws::String &value)
 
RestoreDBClusterFromSnapshotRequestWithDatabaseName (Aws::String &&value)
 
RestoreDBClusterFromSnapshotRequestWithDatabaseName (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)
 
RestoreDBClusterFromSnapshotRequestWithOptionGroupName (const Aws::String &value)
 
RestoreDBClusterFromSnapshotRequestWithOptionGroupName (Aws::String &&value)
 
RestoreDBClusterFromSnapshotRequestWithOptionGroupName (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)
 
RestoreDBClusterFromSnapshotRequestWithVpcSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
RestoreDBClusterFromSnapshotRequestWithVpcSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
RestoreDBClusterFromSnapshotRequestAddVpcSecurityGroupIds (const Aws::String &value)
 
RestoreDBClusterFromSnapshotRequestAddVpcSecurityGroupIds (Aws::String &&value)
 
RestoreDBClusterFromSnapshotRequestAddVpcSecurityGroupIds (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)
 
RestoreDBClusterFromSnapshotRequestWithTags (const Aws::Vector< Tag > &value)
 
RestoreDBClusterFromSnapshotRequestWithTags (Aws::Vector< Tag > &&value)
 
RestoreDBClusterFromSnapshotRequestAddTags (const Tag &value)
 
RestoreDBClusterFromSnapshotRequestAddTags (Tag &&value)
 
const Aws::StringGetKmsKeyId () const
 
bool KmsKeyIdHasBeenSet () const
 
void SetKmsKeyId (const Aws::String &value)
 
void SetKmsKeyId (Aws::String &&value)
 
void SetKmsKeyId (const char *value)
 
RestoreDBClusterFromSnapshotRequestWithKmsKeyId (const Aws::String &value)
 
RestoreDBClusterFromSnapshotRequestWithKmsKeyId (Aws::String &&value)
 
RestoreDBClusterFromSnapshotRequestWithKmsKeyId (const char *value)
 
bool GetEnableIAMDatabaseAuthentication () const
 
bool EnableIAMDatabaseAuthenticationHasBeenSet () const
 
void SetEnableIAMDatabaseAuthentication (bool value)
 
RestoreDBClusterFromSnapshotRequestWithEnableIAMDatabaseAuthentication (bool value)
 
long long GetBacktrackWindow () const
 
bool BacktrackWindowHasBeenSet () const
 
void SetBacktrackWindow (long long value)
 
RestoreDBClusterFromSnapshotRequestWithBacktrackWindow (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)
 
RestoreDBClusterFromSnapshotRequestWithEnableCloudwatchLogsExports (const Aws::Vector< Aws::String > &value)
 
RestoreDBClusterFromSnapshotRequestWithEnableCloudwatchLogsExports (Aws::Vector< Aws::String > &&value)
 
RestoreDBClusterFromSnapshotRequestAddEnableCloudwatchLogsExports (const Aws::String &value)
 
RestoreDBClusterFromSnapshotRequestAddEnableCloudwatchLogsExports (Aws::String &&value)
 
RestoreDBClusterFromSnapshotRequestAddEnableCloudwatchLogsExports (const char *value)
 
const Aws::StringGetEngineMode () const
 
bool EngineModeHasBeenSet () const
 
void SetEngineMode (const Aws::String &value)
 
void SetEngineMode (Aws::String &&value)
 
void SetEngineMode (const char *value)
 
RestoreDBClusterFromSnapshotRequestWithEngineMode (const Aws::String &value)
 
RestoreDBClusterFromSnapshotRequestWithEngineMode (Aws::String &&value)
 
RestoreDBClusterFromSnapshotRequestWithEngineMode (const char *value)
 
const ScalingConfigurationGetScalingConfiguration () const
 
bool ScalingConfigurationHasBeenSet () const
 
void SetScalingConfiguration (const ScalingConfiguration &value)
 
void SetScalingConfiguration (ScalingConfiguration &&value)
 
RestoreDBClusterFromSnapshotRequestWithScalingConfiguration (const ScalingConfiguration &value)
 
RestoreDBClusterFromSnapshotRequestWithScalingConfiguration (ScalingConfiguration &&value)
 
const Aws::StringGetDBClusterParameterGroupName () const
 
bool DBClusterParameterGroupNameHasBeenSet () const
 
void SetDBClusterParameterGroupName (const Aws::String &value)
 
void SetDBClusterParameterGroupName (Aws::String &&value)
 
void SetDBClusterParameterGroupName (const char *value)
 
RestoreDBClusterFromSnapshotRequestWithDBClusterParameterGroupName (const Aws::String &value)
 
RestoreDBClusterFromSnapshotRequestWithDBClusterParameterGroupName (Aws::String &&value)
 
RestoreDBClusterFromSnapshotRequestWithDBClusterParameterGroupName (const char *value)
 
bool GetDeletionProtection () const
 
bool DeletionProtectionHasBeenSet () const
 
void SetDeletionProtection (bool value)
 
RestoreDBClusterFromSnapshotRequestWithDeletionProtection (bool value)
 
bool GetCopyTagsToSnapshot () const
 
bool CopyTagsToSnapshotHasBeenSet () const
 
void SetCopyTagsToSnapshot (bool value)
 
RestoreDBClusterFromSnapshotRequestWithCopyTagsToSnapshot (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)
 
RestoreDBClusterFromSnapshotRequestWithDomain (const Aws::String &value)
 
RestoreDBClusterFromSnapshotRequestWithDomain (Aws::String &&value)
 
RestoreDBClusterFromSnapshotRequestWithDomain (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)
 
RestoreDBClusterFromSnapshotRequestWithDomainIAMRoleName (const Aws::String &value)
 
RestoreDBClusterFromSnapshotRequestWithDomainIAMRoleName (Aws::String &&value)
 
RestoreDBClusterFromSnapshotRequestWithDomainIAMRoleName (const char *value)
 
- Public Member Functions inherited from Aws::RDS::RDSRequest
virtual ~RDSRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

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

Detailed Description

See Also:

AWS API Reference

Definition at line 27 of file RestoreDBClusterFromSnapshotRequest.h.

Constructor & Destructor Documentation

◆ RestoreDBClusterFromSnapshotRequest()

Aws::RDS::Model::RestoreDBClusterFromSnapshotRequest::RestoreDBClusterFromSnapshotRequest ( )

Member Function Documentation

◆ AddAvailabilityZones() [1/3]

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

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

Definition at line 91 of file RestoreDBClusterFromSnapshotRequest.h.

◆ AddAvailabilityZones() [2/3]

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

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

Definition at line 85 of file RestoreDBClusterFromSnapshotRequest.h.

◆ AddAvailabilityZones() [3/3]

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

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

Definition at line 97 of file RestoreDBClusterFromSnapshotRequest.h.

◆ AddEnableCloudwatchLogsExports() [1/3]

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

The list of logs that the restored DB cluster is to export to Amazon 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 1008 of file RestoreDBClusterFromSnapshotRequest.h.

◆ AddEnableCloudwatchLogsExports() [2/3]

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

The list of logs that the restored DB cluster is to export to Amazon 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 998 of file RestoreDBClusterFromSnapshotRequest.h.

◆ AddEnableCloudwatchLogsExports() [3/3]

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

The list of logs that the restored DB cluster is to export to Amazon 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 1018 of file RestoreDBClusterFromSnapshotRequest.h.

◆ AddTags() [1/2]

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

The tags to be assigned to the restored DB cluster.

Definition at line 727 of file RestoreDBClusterFromSnapshotRequest.h.

◆ AddTags() [2/2]

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

The tags to be assigned to the restored DB cluster.

Definition at line 732 of file RestoreDBClusterFromSnapshotRequest.h.

◆ AddVpcSecurityGroupIds() [1/3]

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

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

Definition at line 686 of file RestoreDBClusterFromSnapshotRequest.h.

◆ AddVpcSecurityGroupIds() [2/3]

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

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

Definition at line 681 of file RestoreDBClusterFromSnapshotRequest.h.

◆ AddVpcSecurityGroupIds() [3/3]

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

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

Definition at line 691 of file RestoreDBClusterFromSnapshotRequest.h.

◆ AvailabilityZonesHasBeenSet()

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

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

Definition at line 55 of file RestoreDBClusterFromSnapshotRequest.h.

◆ BacktrackWindowHasBeenSet()

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

◆ CopyTagsToSnapshotHasBeenSet()

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

◆ DatabaseNameHasBeenSet()

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

The database name for the restored DB cluster.

Definition at line 574 of file RestoreDBClusterFromSnapshotRequest.h.

◆ DBClusterIdentifierHasBeenSet()

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

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. 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-snapshot-id

Definition at line 118 of file RestoreDBClusterFromSnapshotRequest.h.

◆ DBClusterParameterGroupNameHasBeenSet()

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

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

Constraints:

  • If supplied, must match the name of an existing default DB cluster parameter group.

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Definition at line 1151 of file RestoreDBClusterFromSnapshotRequest.h.

◆ DBSubnetGroupNameHasBeenSet()

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

The name of the DB subnet group to use for the new DB cluster.

Constraints: If supplied, must match the name of an existing DB subnet group.

Example: mySubnetgroup

Definition at line 521 of file RestoreDBClusterFromSnapshotRequest.h.

◆ DeletionProtectionHasBeenSet()

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

◆ DomainHasBeenSet()

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

Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

Definition at line 1292 of file RestoreDBClusterFromSnapshotRequest.h.

◆ DomainIAMRoleNameHasBeenSet()

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

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

Definition at line 1365 of file RestoreDBClusterFromSnapshotRequest.h.

◆ DumpBodyToUrl()

void Aws::RDS::Model::RestoreDBClusterFromSnapshotRequest::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::RestoreDBClusterFromSnapshotRequest::EnableCloudwatchLogsExportsHasBeenSet ( ) const
inline

The list of logs that the restored DB cluster is to export to Amazon 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 948 of file RestoreDBClusterFromSnapshotRequest.h.

◆ EnableIAMDatabaseAuthenticationHasBeenSet()

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

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

Definition at line 872 of file RestoreDBClusterFromSnapshotRequest.h.

◆ EngineHasBeenSet()

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

The database engine to use for the new DB cluster.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Definition at line 266 of file RestoreDBClusterFromSnapshotRequest.h.

◆ EngineModeHasBeenSet()

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

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

For more information, see CreateDBCluster.

Definition at line 1037 of file RestoreDBClusterFromSnapshotRequest.h.

◆ EngineVersionHasBeenSet()

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

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

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"

If you aren't using the default engine version, then you must specify the engine version.

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 351 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetAvailabilityZones()

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

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

Definition at line 49 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetBacktrackWindow()

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

◆ GetCopyTagsToSnapshot()

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

◆ GetDatabaseName()

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

The database name for the restored DB cluster.

Definition at line 569 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetDBClusterIdentifier()

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

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. 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-snapshot-id

Definition at line 108 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetDBClusterParameterGroupName()

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

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

Constraints:

  • If supplied, must match the name of an existing default DB cluster parameter group.

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Definition at line 1140 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetDBSubnetGroupName()

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

The name of the DB subnet group to use for the new DB cluster.

Constraints: If supplied, must match the name of an existing DB subnet group.

Example: mySubnetgroup

Definition at line 514 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetDeletionProtection()

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

◆ GetDomain()

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

Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

Definition at line 1282 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetDomainIAMRoleName()

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

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

Definition at line 1359 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetEnableCloudwatchLogsExports()

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

The list of logs that the restored DB cluster is to export to Amazon 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 938 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetEnableIAMDatabaseAuthentication()

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

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

Definition at line 863 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetEngine()

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

The database engine to use for the new DB cluster.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Definition at line 259 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetEngineMode()

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

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

For more information, see CreateDBCluster.

Definition at line 1028 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetEngineVersion()

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

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

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"

If you aren't using the default engine version, then you must specify the engine version.

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 330 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetKmsKeyId()

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

The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

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

When you don't specify a value for the KmsKeyId parameter, then the following occurs:

  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the AWS KMS CMK that was used to encrypt the DB snapshot or DB cluster snapshot.

  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn't encrypted, then the restored DB cluster isn't encrypted.

Definition at line 748 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetOptionGroupName()

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

The name of the option group to use for the restored DB cluster.

Definition at line 610 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetPort()

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

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

Constraints: This value must be 1150-65535

Default: The same port as the original DB cluster.

Definition at line 485 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetScalingConfiguration()

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

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

Definition at line 1098 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetServiceRequestName()

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

◆ GetSnapshotIdentifier()

const Aws::String& Aws::RDS::Model::RestoreDBClusterFromSnapshotRequest::GetSnapshotIdentifier ( ) const
inline

The identifier for the DB snapshot or DB cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

Constraints:

  • Must match the identifier of an existing Snapshot.

Definition at line 188 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetTags()

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

The tags to be assigned to the restored DB cluster.

Definition at line 697 of file RestoreDBClusterFromSnapshotRequest.h.

◆ GetVpcSecurityGroupIds()

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

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

Definition at line 651 of file RestoreDBClusterFromSnapshotRequest.h.

◆ KmsKeyIdHasBeenSet()

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

The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

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

When you don't specify a value for the KmsKeyId parameter, then the following occurs:

  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the AWS KMS CMK that was used to encrypt the DB snapshot or DB cluster snapshot.

  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn't encrypted, then the restored DB cluster isn't encrypted.

Definition at line 763 of file RestoreDBClusterFromSnapshotRequest.h.

◆ OptionGroupNameHasBeenSet()

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

The name of the option group to use for the restored DB cluster.

Definition at line 615 of file RestoreDBClusterFromSnapshotRequest.h.

◆ PortHasBeenSet()

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

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

Constraints: This value must be 1150-65535

Default: The same port as the original DB cluster.

Definition at line 492 of file RestoreDBClusterFromSnapshotRequest.h.

◆ ScalingConfigurationHasBeenSet()

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

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

Definition at line 1104 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAvailabilityZones() [1/2]

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

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

Definition at line 67 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetAvailabilityZones() [2/2]

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

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

Definition at line 61 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetBacktrackWindow()

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

◆ SetCopyTagsToSnapshot()

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

◆ SetDatabaseName() [1/3]

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

The database name for the restored DB cluster.

Definition at line 584 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetDatabaseName() [2/3]

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

The database name for the restored DB cluster.

Definition at line 579 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetDatabaseName() [3/3]

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

The database name for the restored DB cluster.

Definition at line 589 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetDBClusterIdentifier() [1/3]

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

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. 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-snapshot-id

Definition at line 138 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetDBClusterIdentifier() [2/3]

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

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. 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-snapshot-id

Definition at line 128 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetDBClusterIdentifier() [3/3]

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

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. 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-snapshot-id

Definition at line 148 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetDBClusterParameterGroupName() [1/3]

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

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

Constraints:

  • If supplied, must match the name of an existing default DB cluster parameter group.

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Definition at line 1173 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetDBClusterParameterGroupName() [2/3]

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

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

Constraints:

  • If supplied, must match the name of an existing default DB cluster parameter group.

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Definition at line 1162 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetDBClusterParameterGroupName() [3/3]

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

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

Constraints:

  • If supplied, must match the name of an existing default DB cluster parameter group.

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Definition at line 1184 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetDBSubnetGroupName() [1/3]

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

The name of the DB subnet group to use for the new DB cluster.

Constraints: If supplied, must match the name of an existing DB subnet group.

Example: mySubnetgroup

Definition at line 535 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetDBSubnetGroupName() [2/3]

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

The name of the DB subnet group to use for the new DB cluster.

Constraints: If supplied, must match the name of an existing DB subnet group.

Example: mySubnetgroup

Definition at line 528 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetDBSubnetGroupName() [3/3]

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

The name of the DB subnet group to use for the new DB cluster.

Constraints: If supplied, must match the name of an existing DB subnet group.

Example: mySubnetgroup

Definition at line 542 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetDeletionProtection()

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

◆ SetDomain() [1/3]

void Aws::RDS::Model::RestoreDBClusterFromSnapshotRequest::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. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

Definition at line 1312 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetDomain() [2/3]

void Aws::RDS::Model::RestoreDBClusterFromSnapshotRequest::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. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

Definition at line 1302 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetDomain() [3/3]

void Aws::RDS::Model::RestoreDBClusterFromSnapshotRequest::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. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

Definition at line 1322 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetDomainIAMRoleName() [1/3]

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

◆ SetDomainIAMRoleName() [2/3]

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

◆ SetDomainIAMRoleName() [3/3]

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

◆ SetEnableCloudwatchLogsExports() [1/2]

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

The list of logs that the restored DB cluster is to export to Amazon 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 968 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetEnableCloudwatchLogsExports() [2/2]

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

The list of logs that the restored DB cluster is to export to Amazon 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 958 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetEnableIAMDatabaseAuthentication()

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

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

Definition at line 881 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetEngine() [1/3]

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

The database engine to use for the new DB cluster.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Definition at line 280 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetEngine() [2/3]

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

The database engine to use for the new DB cluster.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Definition at line 273 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetEngine() [3/3]

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

The database engine to use for the new DB cluster.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Definition at line 287 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetEngineMode() [1/3]

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

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

For more information, see CreateDBCluster.

Definition at line 1055 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetEngineMode() [2/3]

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

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

For more information, see CreateDBCluster.

Definition at line 1046 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetEngineMode() [3/3]

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

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

For more information, see CreateDBCluster.

Definition at line 1064 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetEngineVersion() [1/3]

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

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

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"

If you aren't using the default engine version, then you must specify the engine version.

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 393 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetEngineVersion() [2/3]

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

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

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"

If you aren't using the default engine version, then you must specify the engine version.

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 372 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetEngineVersion() [3/3]

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

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

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"

If you aren't using the default engine version, then you must specify the engine version.

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 414 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetKmsKeyId() [1/3]

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

The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

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

When you don't specify a value for the KmsKeyId parameter, then the following occurs:

  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the AWS KMS CMK that was used to encrypt the DB snapshot or DB cluster snapshot.

  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn't encrypted, then the restored DB cluster isn't encrypted.

Definition at line 793 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetKmsKeyId() [2/3]

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

The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

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

When you don't specify a value for the KmsKeyId parameter, then the following occurs:

  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the AWS KMS CMK that was used to encrypt the DB snapshot or DB cluster snapshot.

  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn't encrypted, then the restored DB cluster isn't encrypted.

Definition at line 778 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetKmsKeyId() [3/3]

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

The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

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

When you don't specify a value for the KmsKeyId parameter, then the following occurs:

  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the AWS KMS CMK that was used to encrypt the DB snapshot or DB cluster snapshot.

  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn't encrypted, then the restored DB cluster isn't encrypted.

Definition at line 808 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetOptionGroupName() [1/3]

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

The name of the option group to use for the restored DB cluster.

Definition at line 625 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetOptionGroupName() [2/3]

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

The name of the option group to use for the restored DB cluster.

Definition at line 620 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetOptionGroupName() [3/3]

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

The name of the option group to use for the restored DB cluster.

Definition at line 630 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetPort()

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

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

Constraints: This value must be 1150-65535

Default: The same port as the original DB cluster.

Definition at line 499 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetScalingConfiguration() [1/2]

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

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

Definition at line 1110 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetScalingConfiguration() [2/2]

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

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

Definition at line 1116 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetSnapshotIdentifier() [1/3]

void Aws::RDS::Model::RestoreDBClusterFromSnapshotRequest::SetSnapshotIdentifier ( Aws::String &&  value)
inline

The identifier for the DB snapshot or DB cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

Constraints:

  • Must match the identifier of an existing Snapshot.

Definition at line 215 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetSnapshotIdentifier() [2/3]

void Aws::RDS::Model::RestoreDBClusterFromSnapshotRequest::SetSnapshotIdentifier ( const Aws::String value)
inline

The identifier for the DB snapshot or DB cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

Constraints:

  • Must match the identifier of an existing Snapshot.

Definition at line 206 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetSnapshotIdentifier() [3/3]

void Aws::RDS::Model::RestoreDBClusterFromSnapshotRequest::SetSnapshotIdentifier ( const char *  value)
inline

The identifier for the DB snapshot or DB cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

Constraints:

  • Must match the identifier of an existing Snapshot.

Definition at line 224 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetTags() [1/2]

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

The tags to be assigned to the restored DB cluster.

Definition at line 712 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetTags() [2/2]

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

The tags to be assigned to the restored DB cluster.

Definition at line 707 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetVpcSecurityGroupIds() [1/2]

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

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

Definition at line 666 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SetVpcSecurityGroupIds() [2/2]

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

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

Definition at line 661 of file RestoreDBClusterFromSnapshotRequest.h.

◆ SnapshotIdentifierHasBeenSet()

bool Aws::RDS::Model::RestoreDBClusterFromSnapshotRequest::SnapshotIdentifierHasBeenSet ( ) const
inline

The identifier for the DB snapshot or DB cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

Constraints:

  • Must match the identifier of an existing Snapshot.

Definition at line 197 of file RestoreDBClusterFromSnapshotRequest.h.

◆ TagsHasBeenSet()

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

The tags to be assigned to the restored DB cluster.

Definition at line 702 of file RestoreDBClusterFromSnapshotRequest.h.

◆ VpcSecurityGroupIdsHasBeenSet()

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

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

Definition at line 656 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithAvailabilityZones() [1/2]

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

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

Definition at line 79 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithAvailabilityZones() [2/2]

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

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

Definition at line 73 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithBacktrackWindow()

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

◆ WithCopyTagsToSnapshot()

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

◆ WithDatabaseName() [1/3]

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

The database name for the restored DB cluster.

Definition at line 599 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithDatabaseName() [2/3]

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

The database name for the restored DB cluster.

Definition at line 594 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithDatabaseName() [3/3]

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

The database name for the restored DB cluster.

Definition at line 604 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithDBClusterIdentifier() [1/3]

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

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. 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-snapshot-id

Definition at line 168 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithDBClusterIdentifier() [2/3]

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

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. 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-snapshot-id

Definition at line 158 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithDBClusterIdentifier() [3/3]

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

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. 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-snapshot-id

Definition at line 178 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithDBClusterParameterGroupName() [1/3]

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

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

Constraints:

  • If supplied, must match the name of an existing default DB cluster parameter group.

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Definition at line 1206 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithDBClusterParameterGroupName() [2/3]

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

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

Constraints:

  • If supplied, must match the name of an existing default DB cluster parameter group.

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Definition at line 1195 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithDBClusterParameterGroupName() [3/3]

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

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

Constraints:

  • If supplied, must match the name of an existing default DB cluster parameter group.

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Definition at line 1217 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithDBSubnetGroupName() [1/3]

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

The name of the DB subnet group to use for the new DB cluster.

Constraints: If supplied, must match the name of an existing DB subnet group.

Example: mySubnetgroup

Definition at line 556 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithDBSubnetGroupName() [2/3]

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

The name of the DB subnet group to use for the new DB cluster.

Constraints: If supplied, must match the name of an existing DB subnet group.

Example: mySubnetgroup

Definition at line 549 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithDBSubnetGroupName() [3/3]

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

The name of the DB subnet group to use for the new DB cluster.

Constraints: If supplied, must match the name of an existing DB subnet group.

Example: mySubnetgroup

Definition at line 563 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithDeletionProtection()

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

◆ WithDomain() [1/3]

RestoreDBClusterFromSnapshotRequest& Aws::RDS::Model::RestoreDBClusterFromSnapshotRequest::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. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

Definition at line 1342 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithDomain() [2/3]

RestoreDBClusterFromSnapshotRequest& Aws::RDS::Model::RestoreDBClusterFromSnapshotRequest::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. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

Definition at line 1332 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithDomain() [3/3]

RestoreDBClusterFromSnapshotRequest& Aws::RDS::Model::RestoreDBClusterFromSnapshotRequest::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. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

Definition at line 1352 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithDomainIAMRoleName() [1/3]

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

◆ WithDomainIAMRoleName() [2/3]

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

◆ WithDomainIAMRoleName() [3/3]

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

◆ WithEnableCloudwatchLogsExports() [1/2]

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

The list of logs that the restored DB cluster is to export to Amazon 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 988 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithEnableCloudwatchLogsExports() [2/2]

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

The list of logs that the restored DB cluster is to export to Amazon 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 978 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithEnableIAMDatabaseAuthentication()

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

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

Definition at line 890 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithEngine() [1/3]

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

The database engine to use for the new DB cluster.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Definition at line 301 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithEngine() [2/3]

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

The database engine to use for the new DB cluster.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Definition at line 294 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithEngine() [3/3]

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

The database engine to use for the new DB cluster.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Definition at line 308 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithEngineMode() [1/3]

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

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

For more information, see CreateDBCluster.

Definition at line 1082 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithEngineMode() [2/3]

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

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

For more information, see CreateDBCluster.

Definition at line 1073 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithEngineMode() [3/3]

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

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

For more information, see CreateDBCluster.

Definition at line 1091 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithEngineVersion() [1/3]

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

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

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"

If you aren't using the default engine version, then you must specify the engine version.

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 456 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithEngineVersion() [2/3]

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

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

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"

If you aren't using the default engine version, then you must specify the engine version.

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 435 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithEngineVersion() [3/3]

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

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

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"

If you aren't using the default engine version, then you must specify the engine version.

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 477 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithKmsKeyId() [1/3]

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

The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

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

When you don't specify a value for the KmsKeyId parameter, then the following occurs:

  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the AWS KMS CMK that was used to encrypt the DB snapshot or DB cluster snapshot.

  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn't encrypted, then the restored DB cluster isn't encrypted.

Definition at line 838 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithKmsKeyId() [2/3]

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

The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

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

When you don't specify a value for the KmsKeyId parameter, then the following occurs:

  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the AWS KMS CMK that was used to encrypt the DB snapshot or DB cluster snapshot.

  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn't encrypted, then the restored DB cluster isn't encrypted.

Definition at line 823 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithKmsKeyId() [3/3]

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

The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

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

When you don't specify a value for the KmsKeyId parameter, then the following occurs:

  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the AWS KMS CMK that was used to encrypt the DB snapshot or DB cluster snapshot.

  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn't encrypted, then the restored DB cluster isn't encrypted.

Definition at line 853 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithOptionGroupName() [1/3]

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

The name of the option group to use for the restored DB cluster.

Definition at line 640 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithOptionGroupName() [2/3]

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

The name of the option group to use for the restored DB cluster.

Definition at line 635 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithOptionGroupName() [3/3]

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

The name of the option group to use for the restored DB cluster.

Definition at line 645 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithPort()

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

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

Constraints: This value must be 1150-65535

Default: The same port as the original DB cluster.

Definition at line 506 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithScalingConfiguration() [1/2]

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

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

Definition at line 1122 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithScalingConfiguration() [2/2]

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

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

Definition at line 1128 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithSnapshotIdentifier() [1/3]

RestoreDBClusterFromSnapshotRequest& Aws::RDS::Model::RestoreDBClusterFromSnapshotRequest::WithSnapshotIdentifier ( Aws::String &&  value)
inline

The identifier for the DB snapshot or DB cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

Constraints:

  • Must match the identifier of an existing Snapshot.

Definition at line 242 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithSnapshotIdentifier() [2/3]

RestoreDBClusterFromSnapshotRequest& Aws::RDS::Model::RestoreDBClusterFromSnapshotRequest::WithSnapshotIdentifier ( const Aws::String value)
inline

The identifier for the DB snapshot or DB cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

Constraints:

  • Must match the identifier of an existing Snapshot.

Definition at line 233 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithSnapshotIdentifier() [3/3]

RestoreDBClusterFromSnapshotRequest& Aws::RDS::Model::RestoreDBClusterFromSnapshotRequest::WithSnapshotIdentifier ( const char *  value)
inline

The identifier for the DB snapshot or DB cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

Constraints:

  • Must match the identifier of an existing Snapshot.

Definition at line 251 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithTags() [1/2]

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

The tags to be assigned to the restored DB cluster.

Definition at line 722 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithTags() [2/2]

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

The tags to be assigned to the restored DB cluster.

Definition at line 717 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithVpcSecurityGroupIds() [1/2]

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

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

Definition at line 676 of file RestoreDBClusterFromSnapshotRequest.h.

◆ WithVpcSecurityGroupIds() [2/2]

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

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

Definition at line 671 of file RestoreDBClusterFromSnapshotRequest.h.


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