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

#include <CreateDBInstanceReadReplicaRequest.h>

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

Public Member Functions

 CreateDBInstanceReadReplicaRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetDBInstanceIdentifier () const
 
bool DBInstanceIdentifierHasBeenSet () const
 
void SetDBInstanceIdentifier (const Aws::String &value)
 
void SetDBInstanceIdentifier (Aws::String &&value)
 
void SetDBInstanceIdentifier (const char *value)
 
CreateDBInstanceReadReplicaRequestWithDBInstanceIdentifier (const Aws::String &value)
 
CreateDBInstanceReadReplicaRequestWithDBInstanceIdentifier (Aws::String &&value)
 
CreateDBInstanceReadReplicaRequestWithDBInstanceIdentifier (const char *value)
 
const Aws::StringGetSourceDBInstanceIdentifier () const
 
bool SourceDBInstanceIdentifierHasBeenSet () const
 
void SetSourceDBInstanceIdentifier (const Aws::String &value)
 
void SetSourceDBInstanceIdentifier (Aws::String &&value)
 
void SetSourceDBInstanceIdentifier (const char *value)
 
CreateDBInstanceReadReplicaRequestWithSourceDBInstanceIdentifier (const Aws::String &value)
 
CreateDBInstanceReadReplicaRequestWithSourceDBInstanceIdentifier (Aws::String &&value)
 
CreateDBInstanceReadReplicaRequestWithSourceDBInstanceIdentifier (const char *value)
 
const Aws::StringGetDBInstanceClass () const
 
bool DBInstanceClassHasBeenSet () const
 
void SetDBInstanceClass (const Aws::String &value)
 
void SetDBInstanceClass (Aws::String &&value)
 
void SetDBInstanceClass (const char *value)
 
CreateDBInstanceReadReplicaRequestWithDBInstanceClass (const Aws::String &value)
 
CreateDBInstanceReadReplicaRequestWithDBInstanceClass (Aws::String &&value)
 
CreateDBInstanceReadReplicaRequestWithDBInstanceClass (const char *value)
 
const Aws::StringGetAvailabilityZone () const
 
bool AvailabilityZoneHasBeenSet () const
 
void SetAvailabilityZone (const Aws::String &value)
 
void SetAvailabilityZone (Aws::String &&value)
 
void SetAvailabilityZone (const char *value)
 
CreateDBInstanceReadReplicaRequestWithAvailabilityZone (const Aws::String &value)
 
CreateDBInstanceReadReplicaRequestWithAvailabilityZone (Aws::String &&value)
 
CreateDBInstanceReadReplicaRequestWithAvailabilityZone (const char *value)
 
int GetPort () const
 
bool PortHasBeenSet () const
 
void SetPort (int value)
 
CreateDBInstanceReadReplicaRequestWithPort (int value)
 
bool GetMultiAZ () const
 
bool MultiAZHasBeenSet () const
 
void SetMultiAZ (bool value)
 
CreateDBInstanceReadReplicaRequestWithMultiAZ (bool value)
 
bool GetAutoMinorVersionUpgrade () const
 
bool AutoMinorVersionUpgradeHasBeenSet () const
 
void SetAutoMinorVersionUpgrade (bool value)
 
CreateDBInstanceReadReplicaRequestWithAutoMinorVersionUpgrade (bool value)
 
int GetIops () const
 
bool IopsHasBeenSet () const
 
void SetIops (int value)
 
CreateDBInstanceReadReplicaRequestWithIops (int value)
 
const Aws::StringGetOptionGroupName () const
 
bool OptionGroupNameHasBeenSet () const
 
void SetOptionGroupName (const Aws::String &value)
 
void SetOptionGroupName (Aws::String &&value)
 
void SetOptionGroupName (const char *value)
 
CreateDBInstanceReadReplicaRequestWithOptionGroupName (const Aws::String &value)
 
CreateDBInstanceReadReplicaRequestWithOptionGroupName (Aws::String &&value)
 
CreateDBInstanceReadReplicaRequestWithOptionGroupName (const char *value)
 
const Aws::StringGetDBParameterGroupName () const
 
bool DBParameterGroupNameHasBeenSet () const
 
void SetDBParameterGroupName (const Aws::String &value)
 
void SetDBParameterGroupName (Aws::String &&value)
 
void SetDBParameterGroupName (const char *value)
 
CreateDBInstanceReadReplicaRequestWithDBParameterGroupName (const Aws::String &value)
 
CreateDBInstanceReadReplicaRequestWithDBParameterGroupName (Aws::String &&value)
 
CreateDBInstanceReadReplicaRequestWithDBParameterGroupName (const char *value)
 
bool GetPubliclyAccessible () const
 
bool PubliclyAccessibleHasBeenSet () const
 
void SetPubliclyAccessible (bool value)
 
CreateDBInstanceReadReplicaRequestWithPubliclyAccessible (bool value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateDBInstanceReadReplicaRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateDBInstanceReadReplicaRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateDBInstanceReadReplicaRequestAddTags (const Tag &value)
 
CreateDBInstanceReadReplicaRequestAddTags (Tag &&value)
 
const Aws::StringGetDBSubnetGroupName () const
 
bool DBSubnetGroupNameHasBeenSet () const
 
void SetDBSubnetGroupName (const Aws::String &value)
 
void SetDBSubnetGroupName (Aws::String &&value)
 
void SetDBSubnetGroupName (const char *value)
 
CreateDBInstanceReadReplicaRequestWithDBSubnetGroupName (const Aws::String &value)
 
CreateDBInstanceReadReplicaRequestWithDBSubnetGroupName (Aws::String &&value)
 
CreateDBInstanceReadReplicaRequestWithDBSubnetGroupName (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)
 
CreateDBInstanceReadReplicaRequestWithVpcSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
CreateDBInstanceReadReplicaRequestWithVpcSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
CreateDBInstanceReadReplicaRequestAddVpcSecurityGroupIds (const Aws::String &value)
 
CreateDBInstanceReadReplicaRequestAddVpcSecurityGroupIds (Aws::String &&value)
 
CreateDBInstanceReadReplicaRequestAddVpcSecurityGroupIds (const char *value)
 
const Aws::StringGetStorageType () const
 
bool StorageTypeHasBeenSet () const
 
void SetStorageType (const Aws::String &value)
 
void SetStorageType (Aws::String &&value)
 
void SetStorageType (const char *value)
 
CreateDBInstanceReadReplicaRequestWithStorageType (const Aws::String &value)
 
CreateDBInstanceReadReplicaRequestWithStorageType (Aws::String &&value)
 
CreateDBInstanceReadReplicaRequestWithStorageType (const char *value)
 
bool GetCopyTagsToSnapshot () const
 
bool CopyTagsToSnapshotHasBeenSet () const
 
void SetCopyTagsToSnapshot (bool value)
 
CreateDBInstanceReadReplicaRequestWithCopyTagsToSnapshot (bool value)
 
int GetMonitoringInterval () const
 
bool MonitoringIntervalHasBeenSet () const
 
void SetMonitoringInterval (int value)
 
CreateDBInstanceReadReplicaRequestWithMonitoringInterval (int value)
 
const Aws::StringGetMonitoringRoleArn () const
 
bool MonitoringRoleArnHasBeenSet () const
 
void SetMonitoringRoleArn (const Aws::String &value)
 
void SetMonitoringRoleArn (Aws::String &&value)
 
void SetMonitoringRoleArn (const char *value)
 
CreateDBInstanceReadReplicaRequestWithMonitoringRoleArn (const Aws::String &value)
 
CreateDBInstanceReadReplicaRequestWithMonitoringRoleArn (Aws::String &&value)
 
CreateDBInstanceReadReplicaRequestWithMonitoringRoleArn (const char *value)
 
const Aws::StringGetKmsKeyId () const
 
bool KmsKeyIdHasBeenSet () const
 
void SetKmsKeyId (const Aws::String &value)
 
void SetKmsKeyId (Aws::String &&value)
 
void SetKmsKeyId (const char *value)
 
CreateDBInstanceReadReplicaRequestWithKmsKeyId (const Aws::String &value)
 
CreateDBInstanceReadReplicaRequestWithKmsKeyId (Aws::String &&value)
 
CreateDBInstanceReadReplicaRequestWithKmsKeyId (const char *value)
 
const Aws::StringGetPreSignedUrl () const
 
bool PreSignedUrlHasBeenSet () const
 
void SetPreSignedUrl (const Aws::String &value)
 
void SetPreSignedUrl (Aws::String &&value)
 
void SetPreSignedUrl (const char *value)
 
CreateDBInstanceReadReplicaRequestWithPreSignedUrl (const Aws::String &value)
 
CreateDBInstanceReadReplicaRequestWithPreSignedUrl (Aws::String &&value)
 
CreateDBInstanceReadReplicaRequestWithPreSignedUrl (const char *value)
 
bool GetEnableIAMDatabaseAuthentication () const
 
bool EnableIAMDatabaseAuthenticationHasBeenSet () const
 
void SetEnableIAMDatabaseAuthentication (bool value)
 
CreateDBInstanceReadReplicaRequestWithEnableIAMDatabaseAuthentication (bool value)
 
bool GetEnablePerformanceInsights () const
 
bool EnablePerformanceInsightsHasBeenSet () const
 
void SetEnablePerformanceInsights (bool value)
 
CreateDBInstanceReadReplicaRequestWithEnablePerformanceInsights (bool value)
 
const Aws::StringGetPerformanceInsightsKMSKeyId () const
 
bool PerformanceInsightsKMSKeyIdHasBeenSet () const
 
void SetPerformanceInsightsKMSKeyId (const Aws::String &value)
 
void SetPerformanceInsightsKMSKeyId (Aws::String &&value)
 
void SetPerformanceInsightsKMSKeyId (const char *value)
 
CreateDBInstanceReadReplicaRequestWithPerformanceInsightsKMSKeyId (const Aws::String &value)
 
CreateDBInstanceReadReplicaRequestWithPerformanceInsightsKMSKeyId (Aws::String &&value)
 
CreateDBInstanceReadReplicaRequestWithPerformanceInsightsKMSKeyId (const char *value)
 
int GetPerformanceInsightsRetentionPeriod () const
 
bool PerformanceInsightsRetentionPeriodHasBeenSet () const
 
void SetPerformanceInsightsRetentionPeriod (int value)
 
CreateDBInstanceReadReplicaRequestWithPerformanceInsightsRetentionPeriod (int 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)
 
CreateDBInstanceReadReplicaRequestWithEnableCloudwatchLogsExports (const Aws::Vector< Aws::String > &value)
 
CreateDBInstanceReadReplicaRequestWithEnableCloudwatchLogsExports (Aws::Vector< Aws::String > &&value)
 
CreateDBInstanceReadReplicaRequestAddEnableCloudwatchLogsExports (const Aws::String &value)
 
CreateDBInstanceReadReplicaRequestAddEnableCloudwatchLogsExports (Aws::String &&value)
 
CreateDBInstanceReadReplicaRequestAddEnableCloudwatchLogsExports (const char *value)
 
const Aws::Vector< ProcessorFeature > & GetProcessorFeatures () const
 
bool ProcessorFeaturesHasBeenSet () const
 
void SetProcessorFeatures (const Aws::Vector< ProcessorFeature > &value)
 
void SetProcessorFeatures (Aws::Vector< ProcessorFeature > &&value)
 
CreateDBInstanceReadReplicaRequestWithProcessorFeatures (const Aws::Vector< ProcessorFeature > &value)
 
CreateDBInstanceReadReplicaRequestWithProcessorFeatures (Aws::Vector< ProcessorFeature > &&value)
 
CreateDBInstanceReadReplicaRequestAddProcessorFeatures (const ProcessorFeature &value)
 
CreateDBInstanceReadReplicaRequestAddProcessorFeatures (ProcessorFeature &&value)
 
bool GetUseDefaultProcessorFeatures () const
 
bool UseDefaultProcessorFeaturesHasBeenSet () const
 
void SetUseDefaultProcessorFeatures (bool value)
 
CreateDBInstanceReadReplicaRequestWithUseDefaultProcessorFeatures (bool value)
 
bool GetDeletionProtection () const
 
bool DeletionProtectionHasBeenSet () const
 
void SetDeletionProtection (bool value)
 
CreateDBInstanceReadReplicaRequestWithDeletionProtection (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)
 
CreateDBInstanceReadReplicaRequestWithDomain (const Aws::String &value)
 
CreateDBInstanceReadReplicaRequestWithDomain (Aws::String &&value)
 
CreateDBInstanceReadReplicaRequestWithDomain (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)
 
CreateDBInstanceReadReplicaRequestWithDomainIAMRoleName (const Aws::String &value)
 
CreateDBInstanceReadReplicaRequestWithDomainIAMRoleName (Aws::String &&value)
 
CreateDBInstanceReadReplicaRequestWithDomainIAMRoleName (const char *value)
 
const ReplicaModeGetReplicaMode () const
 
bool ReplicaModeHasBeenSet () const
 
void SetReplicaMode (const ReplicaMode &value)
 
void SetReplicaMode (ReplicaMode &&value)
 
CreateDBInstanceReadReplicaRequestWithReplicaMode (const ReplicaMode &value)
 
CreateDBInstanceReadReplicaRequestWithReplicaMode (ReplicaMode &&value)
 
int GetMaxAllocatedStorage () const
 
bool MaxAllocatedStorageHasBeenSet () const
 
void SetMaxAllocatedStorage (int value)
 
CreateDBInstanceReadReplicaRequestWithMaxAllocatedStorage (int value)
 
const Aws::StringGetSourceRegion () const
 
bool SourceRegionHasBeenSet () const
 
void SetSourceRegion (const Aws::String &value)
 
void SetSourceRegion (Aws::String &&value)
 
void SetSourceRegion (const char *value)
 
CreateDBInstanceReadReplicaRequestWithSourceRegion (const Aws::String &value)
 
CreateDBInstanceReadReplicaRequestWithSourceRegion (Aws::String &&value)
 
CreateDBInstanceReadReplicaRequestWithSourceRegion (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 25 of file CreateDBInstanceReadReplicaRequest.h.

Constructor & Destructor Documentation

◆ CreateDBInstanceReadReplicaRequest()

Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::CreateDBInstanceReadReplicaRequest ( )

Member Function Documentation

◆ AddEnableCloudwatchLogsExports() [1/3]

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

The list of logs that the new DB instance 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 RDS User Guide.

Definition at line 2112 of file CreateDBInstanceReadReplicaRequest.h.

◆ AddEnableCloudwatchLogsExports() [2/3]

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

The list of logs that the new DB instance 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 RDS User Guide.

Definition at line 2102 of file CreateDBInstanceReadReplicaRequest.h.

◆ AddEnableCloudwatchLogsExports() [3/3]

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

The list of logs that the new DB instance 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 RDS User Guide.

Definition at line 2122 of file CreateDBInstanceReadReplicaRequest.h.

◆ AddProcessorFeatures() [1/2]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::AddProcessorFeatures ( const ProcessorFeature value)
inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Definition at line 2165 of file CreateDBInstanceReadReplicaRequest.h.

◆ AddProcessorFeatures() [2/2]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::AddProcessorFeatures ( ProcessorFeature &&  value)
inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Definition at line 2171 of file CreateDBInstanceReadReplicaRequest.h.

◆ AddTags() [1/2]

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

Definition at line 841 of file CreateDBInstanceReadReplicaRequest.h.

◆ AddTags() [2/2]

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

Definition at line 844 of file CreateDBInstanceReadReplicaRequest.h.

◆ AddVpcSecurityGroupIds() [1/3]

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

A list of EC2 VPC security groups to associate with the read replica.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

Definition at line 1038 of file CreateDBInstanceReadReplicaRequest.h.

◆ AddVpcSecurityGroupIds() [2/3]

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

A list of EC2 VPC security groups to associate with the read replica.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

Definition at line 1031 of file CreateDBInstanceReadReplicaRequest.h.

◆ AddVpcSecurityGroupIds() [3/3]

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

A list of EC2 VPC security groups to associate with the read replica.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

Definition at line 1045 of file CreateDBInstanceReadReplicaRequest.h.

◆ AutoMinorVersionUpgradeHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::AutoMinorVersionUpgradeHasBeenSet ( ) const
inline

A value that indicates whether minor engine upgrades are applied automatically to the read replica during the maintenance window.

Default: Inherits from the source DB instance

Definition at line 557 of file CreateDBInstanceReadReplicaRequest.h.

◆ AvailabilityZoneHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::AvailabilityZoneHasBeenSet ( ) const
inline

The Availability Zone (AZ) where the read replica will be created.

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

Example: us-east-1d

Definition at line 434 of file CreateDBInstanceReadReplicaRequest.h.

◆ CopyTagsToSnapshotHasBeenSet()

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

A value that indicates whether to copy all tags from the read replica to snapshots of the read replica. By default, tags are not copied.

Definition at line 1131 of file CreateDBInstanceReadReplicaRequest.h.

◆ DBInstanceClassHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::DBInstanceClassHasBeenSet ( ) const
inline

The compute and memory capacity of the read replica, for example, db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Default: Inherits from the source DB instance.

Definition at line 353 of file CreateDBInstanceReadReplicaRequest.h.

◆ DBInstanceIdentifierHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::DBInstanceIdentifierHasBeenSet ( ) const
inline

The DB instance identifier of the read replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.

Definition at line 55 of file CreateDBInstanceReadReplicaRequest.h.

◆ DBParameterGroupNameHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::DBParameterGroupNameHasBeenSet ( ) const
inline

The name of the DB parameter group to associate with this DB instance.

If you do not specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of source DB instance for a same region read replica, or the default DBParameterGroup for the specified DB engine for a cross region read replica.

Currently, specifying a parameter group for this operation is only supported for Oracle DB instances.

Constraints:

  • 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 682 of file CreateDBInstanceReadReplicaRequest.h.

◆ DBSubnetGroupNameHasBeenSet()

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

Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.

Constraints:

  • Can only be specified if the source DB instance identifier specifies a DB instance in another Amazon Web Services Region.

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

  • The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.

  • All read replicas in one Amazon Web Services Region that are created from the same source DB instance must either:>

    • Specify DB subnet groups from the same VPC. All these read replicas are created in the same VPC.

    • Not specify a DB subnet group. All these read replicas are created outside of any VPC.

Example: mySubnetgroup

Definition at line 879 of file CreateDBInstanceReadReplicaRequest.h.

◆ DeletionProtectionHasBeenSet()

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

A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.

Definition at line 2215 of file CreateDBInstanceReadReplicaRequest.h.

◆ DomainHasBeenSet()

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

The Active Directory directory ID to create the DB instance in. 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 2252 of file CreateDBInstanceReadReplicaRequest.h.

◆ DomainIAMRoleNameHasBeenSet()

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

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

Definition at line 2319 of file CreateDBInstanceReadReplicaRequest.h.

◆ DumpBodyToUrl()

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

The list of logs that the new DB instance 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 RDS User Guide.

Definition at line 2052 of file CreateDBInstanceReadReplicaRequest.h.

◆ EnableIAMDatabaseAuthenticationHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::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 about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

Definition at line 1854 of file CreateDBInstanceReadReplicaRequest.h.

◆ EnablePerformanceInsightsHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::EnablePerformanceInsightsHasBeenSet ( ) const
inline

A value that indicates whether to enable Performance Insights for the read replica.

For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.

Definition at line 1893 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetAutoMinorVersionUpgrade()

bool Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::GetAutoMinorVersionUpgrade ( ) const
inline

A value that indicates whether minor engine upgrades are applied automatically to the read replica during the maintenance window.

Default: Inherits from the source DB instance

Definition at line 550 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetAvailabilityZone()

const Aws::String& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::GetAvailabilityZone ( ) const
inline

The Availability Zone (AZ) where the read replica will be created.

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

Example: us-east-1d

Definition at line 427 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetCopyTagsToSnapshot()

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

A value that indicates whether to copy all tags from the read replica to snapshots of the read replica. By default, tags are not copied.

Definition at line 1125 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetDBInstanceClass()

const Aws::String& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::GetDBInstanceClass ( ) const
inline

The compute and memory capacity of the read replica, for example, db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Default: Inherits from the source DB instance.

Definition at line 342 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetDBInstanceIdentifier()

const Aws::String& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::GetDBInstanceIdentifier ( ) const
inline

The DB instance identifier of the read replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.

Definition at line 48 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetDBParameterGroupName()

const Aws::String& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::GetDBParameterGroupName ( ) const
inline

The name of the DB parameter group to associate with this DB instance.

If you do not specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of source DB instance for a same region read replica, or the default DBParameterGroup for the specified DB engine for a cross region read replica.

Currently, specifying a parameter group for this operation is only supported for Oracle DB instances.

Constraints:

  • 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 668 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetDBSubnetGroupName()

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

Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.

Constraints:

  • Can only be specified if the source DB instance identifier specifies a DB instance in another Amazon Web Services Region.

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

  • The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.

  • All read replicas in one Amazon Web Services Region that are created from the same source DB instance must either:>

    • Specify DB subnet groups from the same VPC. All these read replicas are created in the same VPC.

    • Not specify a DB subnet group. All these read replicas are created outside of any VPC.

Example: mySubnetgroup

Definition at line 862 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetDeletionProtection()

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

A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.

Definition at line 2206 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetDomain()

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

The Active Directory directory ID to create the DB instance in. 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 2243 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetDomainIAMRoleName()

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

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

Definition at line 2313 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetEnableCloudwatchLogsExports()

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

The list of logs that the new DB instance 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 RDS User Guide.

Definition at line 2042 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetEnableIAMDatabaseAuthentication()

bool Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::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 about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

Definition at line 1843 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetEnablePerformanceInsights()

bool Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::GetEnablePerformanceInsights ( ) const
inline

A value that indicates whether to enable Performance Insights for the read replica.

For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.

Definition at line 1885 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetIops()

int Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::GetIops ( ) const
inline

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

Definition at line 578 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetKmsKeyId()

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

The Amazon Web Services KMS key identifier for an encrypted read replica.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS CMK.

If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance, then do not specify a value for this parameter. A read replica in the same Region is always encrypted with the same Amazon Web Services KMS CMK as the source DB instance.

If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. Amazon Web Services KMS CMKs are specific to the Amazon Web Services Region that they are created in, and you can't use CMKs from one Amazon Web Services Region in another Amazon Web Services Region.

You can't create an encrypted read replica from an unencrypted DB instance.

Definition at line 1295 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetMaxAllocatedStorage()

int Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::GetMaxAllocatedStorage ( ) const
inline

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.

Definition at line 2463 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetMonitoringInterval()

int Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::GetMonitoringInterval ( ) const
inline

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

Definition at line 1153 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetMonitoringRoleArn()

const Aws::String& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::GetMonitoringRoleArn ( ) const
inline

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

Definition at line 1193 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetMultiAZ()

bool Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::GetMultiAZ ( ) const
inline

A value that indicates whether the read replica is in a Multi-AZ deployment.

You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your read replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.

Definition at line 515 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetOptionGroupName()

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

The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.

For SQL Server, you must use the option group associated with the source instance.

Definition at line 604 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetPerformanceInsightsKMSKeyId()

const Aws::String& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::GetPerformanceInsightsKMSKeyId ( ) const
inline

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

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).

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses 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 1922 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetPerformanceInsightsRetentionPeriod()

int Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::GetPerformanceInsightsRetentionPeriod ( ) const
inline

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

Definition at line 2013 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetPort()

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

The port number that the DB instance uses for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

Definition at line 484 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetPreSignedUrl()

const Aws::String& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::GetPreSignedUrl ( ) const
inline

The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source Amazon Web Services Region that contains the source DB instance.

You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted read replica in the same Amazon Web Services Region.

The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:

  • DestinationRegion - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL.

    For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.

  • KmsKeyId - The Amazon Web Services KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination Amazon Web Services Region, and the action contained in the presigned URL.

  • SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or –source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.

SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS doesn't support cross-region read replicas.

Definition at line 1467 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetProcessorFeatures()

const Aws::Vector<ProcessorFeature>& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::GetProcessorFeatures ( ) const
inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Definition at line 2129 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetPubliclyAccessible()

bool Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::GetPubliclyAccessible ( ) const
inline

A value that indicates whether the DB instance is publicly accessible.

When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

Definition at line 780 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetReplicaMode()

const ReplicaMode& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::GetReplicaMode ( ) const
inline

The open mode of the replica database: mounted or read-only.

This parameter is only supported for Oracle DB instances.

Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload.

You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

Definition at line 2372 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetSourceDBInstanceIdentifier()

const Aws::String& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::GetSourceDBInstanceIdentifier ( ) const
inline

The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to five read replicas.

Constraints:

  • Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB instance.

  • Can specify a DB instance that is a MySQL read replica only if the source is running MySQL 5.6 or later.

  • For the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the Amazon RDS User Guide.

  • For the limitations of SQL Server read replicas, see Read Replica Limitations with Microsoft SQL Server in the Amazon RDS User Guide.

  • Can specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication).

  • The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0.

  • If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier.

  • If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn't apply to SQL Server, which doesn't support cross-region replicas.

Definition at line 127 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetSourceRegion()

const Aws::String& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::GetSourceRegion ( ) const
inline

If SourceRegion is specified, SDKs will generate pre-signed URLs and populate the pre-signed URL field.

Definition at line 2499 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetStorageType()

const Aws::String& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::GetStorageType ( ) const
inline

Specifies the storage type to be associated with the read replica.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise gp2

Definition at line 1055 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetTags()

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

Definition at line 823 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetUseDefaultProcessorFeatures()

bool Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::GetUseDefaultProcessorFeatures ( ) const
inline

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

Definition at line 2178 of file CreateDBInstanceReadReplicaRequest.h.

◆ GetVpcSecurityGroupIds()

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

A list of EC2 VPC security groups to associate with the read replica.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

Definition at line 989 of file CreateDBInstanceReadReplicaRequest.h.

◆ IopsHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::IopsHasBeenSet ( ) const
inline

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

Definition at line 584 of file CreateDBInstanceReadReplicaRequest.h.

◆ KmsKeyIdHasBeenSet()

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

The Amazon Web Services KMS key identifier for an encrypted read replica.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS CMK.

If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance, then do not specify a value for this parameter. A read replica in the same Region is always encrypted with the same Amazon Web Services KMS CMK as the source DB instance.

If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. Amazon Web Services KMS CMKs are specific to the Amazon Web Services Region that they are created in, and you can't use CMKs from one Amazon Web Services Region in another Amazon Web Services Region.

You can't create an encrypted read replica from an unencrypted DB instance.

Definition at line 1312 of file CreateDBInstanceReadReplicaRequest.h.

◆ MaxAllocatedStorageHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::MaxAllocatedStorageHasBeenSet ( ) const
inline

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.

Definition at line 2473 of file CreateDBInstanceReadReplicaRequest.h.

◆ MonitoringIntervalHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::MonitoringIntervalHasBeenSet ( ) const
inline

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

Definition at line 1162 of file CreateDBInstanceReadReplicaRequest.h.

◆ MonitoringRoleArnHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::MonitoringRoleArnHasBeenSet ( ) const
inline

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

Definition at line 1205 of file CreateDBInstanceReadReplicaRequest.h.

◆ MultiAZHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::MultiAZHasBeenSet ( ) const
inline

A value that indicates whether the read replica is in a Multi-AZ deployment.

You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your read replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.

Definition at line 524 of file CreateDBInstanceReadReplicaRequest.h.

◆ OptionGroupNameHasBeenSet()

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

The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.

For SQL Server, you must use the option group associated with the source instance.

Definition at line 611 of file CreateDBInstanceReadReplicaRequest.h.

◆ PerformanceInsightsKMSKeyIdHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::PerformanceInsightsKMSKeyIdHasBeenSet ( ) const
inline

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

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).

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses 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 1934 of file CreateDBInstanceReadReplicaRequest.h.

◆ PerformanceInsightsRetentionPeriodHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::PerformanceInsightsRetentionPeriodHasBeenSet ( ) const
inline

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

Definition at line 2019 of file CreateDBInstanceReadReplicaRequest.h.

◆ PortHasBeenSet()

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

The port number that the DB instance uses for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

Definition at line 491 of file CreateDBInstanceReadReplicaRequest.h.

◆ PreSignedUrlHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::PreSignedUrlHasBeenSet ( ) const
inline

The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source Amazon Web Services Region that contains the source DB instance.

You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted read replica in the same Amazon Web Services Region.

The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:

  • DestinationRegion - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL.

    For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.

  • KmsKeyId - The Amazon Web Services KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination Amazon Web Services Region, and the action contained in the presigned URL.

  • SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or –source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.

SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS doesn't support cross-region read replicas.

Definition at line 1519 of file CreateDBInstanceReadReplicaRequest.h.

◆ ProcessorFeaturesHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::ProcessorFeaturesHasBeenSet ( ) const
inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Definition at line 2135 of file CreateDBInstanceReadReplicaRequest.h.

◆ PubliclyAccessibleHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::PubliclyAccessibleHasBeenSet ( ) const
inline

A value that indicates whether the DB instance is publicly accessible.

When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

Definition at line 793 of file CreateDBInstanceReadReplicaRequest.h.

◆ ReplicaModeHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::ReplicaModeHasBeenSet ( ) const
inline

The open mode of the replica database: mounted or read-only.

This parameter is only supported for Oracle DB instances.

Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload.

You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

Definition at line 2388 of file CreateDBInstanceReadReplicaRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAutoMinorVersionUpgrade()

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetAutoMinorVersionUpgrade ( bool  value)
inline

A value that indicates whether minor engine upgrades are applied automatically to the read replica during the maintenance window.

Default: Inherits from the source DB instance

Definition at line 564 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetAvailabilityZone() [1/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetAvailabilityZone ( Aws::String &&  value)
inline

The Availability Zone (AZ) where the read replica will be created.

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

Example: us-east-1d

Definition at line 448 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetAvailabilityZone() [2/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetAvailabilityZone ( const Aws::String value)
inline

The Availability Zone (AZ) where the read replica will be created.

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

Example: us-east-1d

Definition at line 441 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetAvailabilityZone() [3/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetAvailabilityZone ( const char *  value)
inline

The Availability Zone (AZ) where the read replica will be created.

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

Example: us-east-1d

Definition at line 455 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetCopyTagsToSnapshot()

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

A value that indicates whether to copy all tags from the read replica to snapshots of the read replica. By default, tags are not copied.

Definition at line 1137 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetDBInstanceClass() [1/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetDBInstanceClass ( Aws::String &&  value)
inline

The compute and memory capacity of the read replica, for example, db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Default: Inherits from the source DB instance.

Definition at line 375 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetDBInstanceClass() [2/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetDBInstanceClass ( const Aws::String value)
inline

The compute and memory capacity of the read replica, for example, db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Default: Inherits from the source DB instance.

Definition at line 364 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetDBInstanceClass() [3/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetDBInstanceClass ( const char *  value)
inline

The compute and memory capacity of the read replica, for example, db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Default: Inherits from the source DB instance.

Definition at line 386 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetDBInstanceIdentifier() [1/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetDBInstanceIdentifier ( Aws::String &&  value)
inline

The DB instance identifier of the read replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.

Definition at line 69 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetDBInstanceIdentifier() [2/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetDBInstanceIdentifier ( const Aws::String value)
inline

The DB instance identifier of the read replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.

Definition at line 62 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetDBInstanceIdentifier() [3/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetDBInstanceIdentifier ( const char *  value)
inline

The DB instance identifier of the read replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.

Definition at line 76 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetDBParameterGroupName() [1/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetDBParameterGroupName ( Aws::String &&  value)
inline

The name of the DB parameter group to associate with this DB instance.

If you do not specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of source DB instance for a same region read replica, or the default DBParameterGroup for the specified DB engine for a cross region read replica.

Currently, specifying a parameter group for this operation is only supported for Oracle DB instances.

Constraints:

  • 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 710 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetDBParameterGroupName() [2/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetDBParameterGroupName ( const Aws::String value)
inline

The name of the DB parameter group to associate with this DB instance.

If you do not specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of source DB instance for a same region read replica, or the default DBParameterGroup for the specified DB engine for a cross region read replica.

Currently, specifying a parameter group for this operation is only supported for Oracle DB instances.

Constraints:

  • 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 696 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetDBParameterGroupName() [3/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetDBParameterGroupName ( const char *  value)
inline

The name of the DB parameter group to associate with this DB instance.

If you do not specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of source DB instance for a same region read replica, or the default DBParameterGroup for the specified DB engine for a cross region read replica.

Currently, specifying a parameter group for this operation is only supported for Oracle DB instances.

Constraints:

  • 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 724 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetDBSubnetGroupName() [1/3]

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

Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.

Constraints:

  • Can only be specified if the source DB instance identifier specifies a DB instance in another Amazon Web Services Region.

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

  • The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.

  • All read replicas in one Amazon Web Services Region that are created from the same source DB instance must either:>

    • Specify DB subnet groups from the same VPC. All these read replicas are created in the same VPC.

    • Not specify a DB subnet group. All these read replicas are created outside of any VPC.

Example: mySubnetgroup

Definition at line 913 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetDBSubnetGroupName() [2/3]

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

Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.

Constraints:

  • Can only be specified if the source DB instance identifier specifies a DB instance in another Amazon Web Services Region.

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

  • The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.

  • All read replicas in one Amazon Web Services Region that are created from the same source DB instance must either:>

    • Specify DB subnet groups from the same VPC. All these read replicas are created in the same VPC.

    • Not specify a DB subnet group. All these read replicas are created outside of any VPC.

Example: mySubnetgroup

Definition at line 896 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetDBSubnetGroupName() [3/3]

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

Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.

Constraints:

  • Can only be specified if the source DB instance identifier specifies a DB instance in another Amazon Web Services Region.

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

  • The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.

  • All read replicas in one Amazon Web Services Region that are created from the same source DB instance must either:>

    • Specify DB subnet groups from the same VPC. All these read replicas are created in the same VPC.

    • Not specify a DB subnet group. All these read replicas are created outside of any VPC.

Example: mySubnetgroup

Definition at line 930 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetDeletionProtection()

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

A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.

Definition at line 2224 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetDomain() [1/3]

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

The Active Directory directory ID to create the DB instance in. 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 2270 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetDomain() [2/3]

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

The Active Directory directory ID to create the DB instance in. 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 2261 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetDomain() [3/3]

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

The Active Directory directory ID to create the DB instance in. 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 2279 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetDomainIAMRoleName() [1/3]

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

◆ SetDomainIAMRoleName() [2/3]

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

◆ SetDomainIAMRoleName() [3/3]

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

◆ SetEnableCloudwatchLogsExports() [1/2]

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

The list of logs that the new DB instance 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 RDS User Guide.

Definition at line 2072 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetEnableCloudwatchLogsExports() [2/2]

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

The list of logs that the new DB instance 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 RDS User Guide.

Definition at line 2062 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetEnableIAMDatabaseAuthentication()

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::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 about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

Definition at line 1865 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetEnablePerformanceInsights()

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetEnablePerformanceInsights ( bool  value)
inline

A value that indicates whether to enable Performance Insights for the read replica.

For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.

Definition at line 1901 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetIops()

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetIops ( int  value)
inline

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

Definition at line 590 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetKmsKeyId() [1/3]

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

The Amazon Web Services KMS key identifier for an encrypted read replica.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS CMK.

If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance, then do not specify a value for this parameter. A read replica in the same Region is always encrypted with the same Amazon Web Services KMS CMK as the source DB instance.

If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. Amazon Web Services KMS CMKs are specific to the Amazon Web Services Region that they are created in, and you can't use CMKs from one Amazon Web Services Region in another Amazon Web Services Region.

You can't create an encrypted read replica from an unencrypted DB instance.

Definition at line 1346 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetKmsKeyId() [2/3]

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

The Amazon Web Services KMS key identifier for an encrypted read replica.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS CMK.

If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance, then do not specify a value for this parameter. A read replica in the same Region is always encrypted with the same Amazon Web Services KMS CMK as the source DB instance.

If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. Amazon Web Services KMS CMKs are specific to the Amazon Web Services Region that they are created in, and you can't use CMKs from one Amazon Web Services Region in another Amazon Web Services Region.

You can't create an encrypted read replica from an unencrypted DB instance.

Definition at line 1329 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetKmsKeyId() [3/3]

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

The Amazon Web Services KMS key identifier for an encrypted read replica.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS CMK.

If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance, then do not specify a value for this parameter. A read replica in the same Region is always encrypted with the same Amazon Web Services KMS CMK as the source DB instance.

If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. Amazon Web Services KMS CMKs are specific to the Amazon Web Services Region that they are created in, and you can't use CMKs from one Amazon Web Services Region in another Amazon Web Services Region.

You can't create an encrypted read replica from an unencrypted DB instance.

Definition at line 1363 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetMaxAllocatedStorage()

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetMaxAllocatedStorage ( int  value)
inline

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.

Definition at line 2483 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetMonitoringInterval()

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetMonitoringInterval ( int  value)
inline

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

Definition at line 1171 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetMonitoringRoleArn() [1/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetMonitoringRoleArn ( Aws::String &&  value)
inline

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

Definition at line 1229 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetMonitoringRoleArn() [2/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetMonitoringRoleArn ( const Aws::String value)
inline

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

Definition at line 1217 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetMonitoringRoleArn() [3/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetMonitoringRoleArn ( const char *  value)
inline

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

Definition at line 1241 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetMultiAZ()

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetMultiAZ ( bool  value)
inline

A value that indicates whether the read replica is in a Multi-AZ deployment.

You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your read replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.

Definition at line 533 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetOptionGroupName() [1/3]

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

The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.

For SQL Server, you must use the option group associated with the source instance.

Definition at line 625 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetOptionGroupName() [2/3]

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

The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.

For SQL Server, you must use the option group associated with the source instance.

Definition at line 618 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetOptionGroupName() [3/3]

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

The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.

For SQL Server, you must use the option group associated with the source instance.

Definition at line 632 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetPerformanceInsightsKMSKeyId() [1/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetPerformanceInsightsKMSKeyId ( Aws::String &&  value)
inline

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

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).

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses 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 1958 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetPerformanceInsightsKMSKeyId() [2/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetPerformanceInsightsKMSKeyId ( const Aws::String value)
inline

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

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).

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses 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 1946 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetPerformanceInsightsKMSKeyId() [3/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetPerformanceInsightsKMSKeyId ( const char *  value)
inline

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

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).

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses 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 1970 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetPerformanceInsightsRetentionPeriod()

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetPerformanceInsightsRetentionPeriod ( int  value)
inline

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

Definition at line 2025 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetPort()

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

The port number that the DB instance uses for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

Definition at line 498 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetPreSignedUrl() [1/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetPreSignedUrl ( Aws::String &&  value)
inline

The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source Amazon Web Services Region that contains the source DB instance.

You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted read replica in the same Amazon Web Services Region.

The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:

  • DestinationRegion - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL.

    For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.

  • KmsKeyId - The Amazon Web Services KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination Amazon Web Services Region, and the action contained in the presigned URL.

  • SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or –source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.

SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS doesn't support cross-region read replicas.

Definition at line 1623 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetPreSignedUrl() [2/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetPreSignedUrl ( const Aws::String value)
inline

The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source Amazon Web Services Region that contains the source DB instance.

You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted read replica in the same Amazon Web Services Region.

The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:

  • DestinationRegion - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL.

    For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.

  • KmsKeyId - The Amazon Web Services KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination Amazon Web Services Region, and the action contained in the presigned URL.

  • SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or –source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.

SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS doesn't support cross-region read replicas.

Definition at line 1571 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetPreSignedUrl() [3/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetPreSignedUrl ( const char *  value)
inline

The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source Amazon Web Services Region that contains the source DB instance.

You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted read replica in the same Amazon Web Services Region.

The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:

  • DestinationRegion - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL.

    For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.

  • KmsKeyId - The Amazon Web Services KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination Amazon Web Services Region, and the action contained in the presigned URL.

  • SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or –source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.

SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS doesn't support cross-region read replicas.

Definition at line 1675 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetProcessorFeatures() [1/2]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetProcessorFeatures ( Aws::Vector< ProcessorFeature > &&  value)
inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Definition at line 2147 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetProcessorFeatures() [2/2]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetProcessorFeatures ( const Aws::Vector< ProcessorFeature > &  value)
inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Definition at line 2141 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetPubliclyAccessible()

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetPubliclyAccessible ( bool  value)
inline

A value that indicates whether the DB instance is publicly accessible.

When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

Definition at line 806 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetReplicaMode() [1/2]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetReplicaMode ( const ReplicaMode value)
inline

The open mode of the replica database: mounted or read-only.

This parameter is only supported for Oracle DB instances.

Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload.

You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

Definition at line 2404 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetReplicaMode() [2/2]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetReplicaMode ( ReplicaMode &&  value)
inline

The open mode of the replica database: mounted or read-only.

This parameter is only supported for Oracle DB instances.

Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload.

You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

Definition at line 2420 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetSourceDBInstanceIdentifier() [1/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetSourceDBInstanceIdentifier ( Aws::String &&  value)
inline

The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to five read replicas.

Constraints:

  • Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB instance.

  • Can specify a DB instance that is a MySQL read replica only if the source is running MySQL 5.6 or later.

  • For the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the Amazon RDS User Guide.

  • For the limitations of SQL Server read replicas, see Read Replica Limitations with Microsoft SQL Server in the Amazon RDS User Guide.

  • Can specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication).

  • The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0.

  • If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier.

  • If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn't apply to SQL Server, which doesn't support cross-region replicas.

Definition at line 214 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetSourceDBInstanceIdentifier() [2/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetSourceDBInstanceIdentifier ( const Aws::String value)
inline

The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to five read replicas.

Constraints:

  • Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB instance.

  • Can specify a DB instance that is a MySQL read replica only if the source is running MySQL 5.6 or later.

  • For the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the Amazon RDS User Guide.

  • For the limitations of SQL Server read replicas, see Read Replica Limitations with Microsoft SQL Server in the Amazon RDS User Guide.

  • Can specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication).

  • The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0.

  • If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier.

  • If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn't apply to SQL Server, which doesn't support cross-region replicas.

Definition at line 185 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetSourceDBInstanceIdentifier() [3/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetSourceDBInstanceIdentifier ( const char *  value)
inline

The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to five read replicas.

Constraints:

  • Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB instance.

  • Can specify a DB instance that is a MySQL read replica only if the source is running MySQL 5.6 or later.

  • For the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the Amazon RDS User Guide.

  • For the limitations of SQL Server read replicas, see Read Replica Limitations with Microsoft SQL Server in the Amazon RDS User Guide.

  • Can specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication).

  • The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0.

  • If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier.

  • If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn't apply to SQL Server, which doesn't support cross-region replicas.

Definition at line 243 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetSourceRegion() [1/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetSourceRegion ( Aws::String &&  value)
inline

If SourceRegion is specified, SDKs will generate pre-signed URLs and populate the pre-signed URL field.

Definition at line 2514 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetSourceRegion() [2/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetSourceRegion ( const Aws::String value)
inline

If SourceRegion is specified, SDKs will generate pre-signed URLs and populate the pre-signed URL field.

Definition at line 2509 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetSourceRegion() [3/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetSourceRegion ( const char *  value)
inline

If SourceRegion is specified, SDKs will generate pre-signed URLs and populate the pre-signed URL field.

Definition at line 2519 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetStorageType() [1/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetStorageType ( Aws::String &&  value)
inline

Specifies the storage type to be associated with the read replica.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise gp2

Definition at line 1082 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetStorageType() [2/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetStorageType ( const Aws::String value)
inline

Specifies the storage type to be associated with the read replica.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise gp2

Definition at line 1073 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetStorageType() [3/3]

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetStorageType ( const char *  value)
inline

Specifies the storage type to be associated with the read replica.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise gp2

Definition at line 1091 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetTags() [1/2]

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

Definition at line 832 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetTags() [2/2]

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

Definition at line 829 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetUseDefaultProcessorFeatures()

void Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SetUseDefaultProcessorFeatures ( bool  value)
inline

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

Definition at line 2190 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetVpcSecurityGroupIds() [1/2]

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

A list of EC2 VPC security groups to associate with the read replica.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

Definition at line 1010 of file CreateDBInstanceReadReplicaRequest.h.

◆ SetVpcSecurityGroupIds() [2/2]

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

A list of EC2 VPC security groups to associate with the read replica.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

Definition at line 1003 of file CreateDBInstanceReadReplicaRequest.h.

◆ SourceDBInstanceIdentifierHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SourceDBInstanceIdentifierHasBeenSet ( ) const
inline

The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to five read replicas.

Constraints:

  • Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB instance.

  • Can specify a DB instance that is a MySQL read replica only if the source is running MySQL 5.6 or later.

  • For the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the Amazon RDS User Guide.

  • For the limitations of SQL Server read replicas, see Read Replica Limitations with Microsoft SQL Server in the Amazon RDS User Guide.

  • Can specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication).

  • The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0.

  • If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier.

  • If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn't apply to SQL Server, which doesn't support cross-region replicas.

Definition at line 156 of file CreateDBInstanceReadReplicaRequest.h.

◆ SourceRegionHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::SourceRegionHasBeenSet ( ) const
inline

If SourceRegion is specified, SDKs will generate pre-signed URLs and populate the pre-signed URL field.

Definition at line 2504 of file CreateDBInstanceReadReplicaRequest.h.

◆ StorageTypeHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::StorageTypeHasBeenSet ( ) const
inline

Specifies the storage type to be associated with the read replica.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise gp2

Definition at line 1064 of file CreateDBInstanceReadReplicaRequest.h.

◆ TagsHasBeenSet()

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

Definition at line 826 of file CreateDBInstanceReadReplicaRequest.h.

◆ UseDefaultProcessorFeaturesHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::UseDefaultProcessorFeaturesHasBeenSet ( ) const
inline

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

Definition at line 2184 of file CreateDBInstanceReadReplicaRequest.h.

◆ VpcSecurityGroupIdsHasBeenSet()

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

A list of EC2 VPC security groups to associate with the read replica.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

Definition at line 996 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithAutoMinorVersionUpgrade()

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithAutoMinorVersionUpgrade ( bool  value)
inline

A value that indicates whether minor engine upgrades are applied automatically to the read replica during the maintenance window.

Default: Inherits from the source DB instance

Definition at line 571 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithAvailabilityZone() [1/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithAvailabilityZone ( Aws::String &&  value)
inline

The Availability Zone (AZ) where the read replica will be created.

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

Example: us-east-1d

Definition at line 469 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithAvailabilityZone() [2/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithAvailabilityZone ( const Aws::String value)
inline

The Availability Zone (AZ) where the read replica will be created.

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

Example: us-east-1d

Definition at line 462 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithAvailabilityZone() [3/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithAvailabilityZone ( const char *  value)
inline

The Availability Zone (AZ) where the read replica will be created.

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

Example: us-east-1d

Definition at line 476 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithCopyTagsToSnapshot()

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

A value that indicates whether to copy all tags from the read replica to snapshots of the read replica. By default, tags are not copied.

Definition at line 1143 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithDBInstanceClass() [1/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithDBInstanceClass ( Aws::String &&  value)
inline

The compute and memory capacity of the read replica, for example, db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Default: Inherits from the source DB instance.

Definition at line 408 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithDBInstanceClass() [2/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithDBInstanceClass ( const Aws::String value)
inline

The compute and memory capacity of the read replica, for example, db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Default: Inherits from the source DB instance.

Definition at line 397 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithDBInstanceClass() [3/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithDBInstanceClass ( const char *  value)
inline

The compute and memory capacity of the read replica, for example, db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Default: Inherits from the source DB instance.

Definition at line 419 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithDBInstanceIdentifier() [1/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithDBInstanceIdentifier ( Aws::String &&  value)
inline

The DB instance identifier of the read replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.

Definition at line 90 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithDBInstanceIdentifier() [2/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithDBInstanceIdentifier ( const Aws::String value)
inline

The DB instance identifier of the read replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.

Definition at line 83 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithDBInstanceIdentifier() [3/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithDBInstanceIdentifier ( const char *  value)
inline

The DB instance identifier of the read replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.

Definition at line 97 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithDBParameterGroupName() [1/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithDBParameterGroupName ( Aws::String &&  value)
inline

The name of the DB parameter group to associate with this DB instance.

If you do not specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of source DB instance for a same region read replica, or the default DBParameterGroup for the specified DB engine for a cross region read replica.

Currently, specifying a parameter group for this operation is only supported for Oracle DB instances.

Constraints:

  • 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 752 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithDBParameterGroupName() [2/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithDBParameterGroupName ( const Aws::String value)
inline

The name of the DB parameter group to associate with this DB instance.

If you do not specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of source DB instance for a same region read replica, or the default DBParameterGroup for the specified DB engine for a cross region read replica.

Currently, specifying a parameter group for this operation is only supported for Oracle DB instances.

Constraints:

  • 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 738 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithDBParameterGroupName() [3/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithDBParameterGroupName ( const char *  value)
inline

The name of the DB parameter group to associate with this DB instance.

If you do not specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of source DB instance for a same region read replica, or the default DBParameterGroup for the specified DB engine for a cross region read replica.

Currently, specifying a parameter group for this operation is only supported for Oracle DB instances.

Constraints:

  • 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 766 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithDBSubnetGroupName() [1/3]

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

Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.

Constraints:

  • Can only be specified if the source DB instance identifier specifies a DB instance in another Amazon Web Services Region.

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

  • The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.

  • All read replicas in one Amazon Web Services Region that are created from the same source DB instance must either:>

    • Specify DB subnet groups from the same VPC. All these read replicas are created in the same VPC.

    • Not specify a DB subnet group. All these read replicas are created outside of any VPC.

Example: mySubnetgroup

Definition at line 964 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithDBSubnetGroupName() [2/3]

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

Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.

Constraints:

  • Can only be specified if the source DB instance identifier specifies a DB instance in another Amazon Web Services Region.

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

  • The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.

  • All read replicas in one Amazon Web Services Region that are created from the same source DB instance must either:>

    • Specify DB subnet groups from the same VPC. All these read replicas are created in the same VPC.

    • Not specify a DB subnet group. All these read replicas are created outside of any VPC.

Example: mySubnetgroup

Definition at line 947 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithDBSubnetGroupName() [3/3]

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

Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.

Constraints:

  • Can only be specified if the source DB instance identifier specifies a DB instance in another Amazon Web Services Region.

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

  • The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running.

  • All read replicas in one Amazon Web Services Region that are created from the same source DB instance must either:>

    • Specify DB subnet groups from the same VPC. All these read replicas are created in the same VPC.

    • Not specify a DB subnet group. All these read replicas are created outside of any VPC.

Example: mySubnetgroup

Definition at line 981 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithDeletionProtection()

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

A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.

Definition at line 2233 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithDomain() [1/3]

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

The Active Directory directory ID to create the DB instance in. 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 2297 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithDomain() [2/3]

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

The Active Directory directory ID to create the DB instance in. 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 2288 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithDomain() [3/3]

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

The Active Directory directory ID to create the DB instance in. 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 2306 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithDomainIAMRoleName() [1/3]

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

◆ WithDomainIAMRoleName() [2/3]

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

◆ WithDomainIAMRoleName() [3/3]

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

◆ WithEnableCloudwatchLogsExports() [1/2]

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

The list of logs that the new DB instance 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 RDS User Guide.

Definition at line 2092 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithEnableCloudwatchLogsExports() [2/2]

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

The list of logs that the new DB instance 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 RDS User Guide.

Definition at line 2082 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithEnableIAMDatabaseAuthentication()

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::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 about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

Definition at line 1876 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithEnablePerformanceInsights()

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithEnablePerformanceInsights ( bool  value)
inline

A value that indicates whether to enable Performance Insights for the read replica.

For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.

Definition at line 1909 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithIops()

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithIops ( int  value)
inline

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

Definition at line 596 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithKmsKeyId() [1/3]

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

The Amazon Web Services KMS key identifier for an encrypted read replica.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS CMK.

If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance, then do not specify a value for this parameter. A read replica in the same Region is always encrypted with the same Amazon Web Services KMS CMK as the source DB instance.

If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. Amazon Web Services KMS CMKs are specific to the Amazon Web Services Region that they are created in, and you can't use CMKs from one Amazon Web Services Region in another Amazon Web Services Region.

You can't create an encrypted read replica from an unencrypted DB instance.

Definition at line 1397 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithKmsKeyId() [2/3]

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

The Amazon Web Services KMS key identifier for an encrypted read replica.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS CMK.

If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance, then do not specify a value for this parameter. A read replica in the same Region is always encrypted with the same Amazon Web Services KMS CMK as the source DB instance.

If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. Amazon Web Services KMS CMKs are specific to the Amazon Web Services Region that they are created in, and you can't use CMKs from one Amazon Web Services Region in another Amazon Web Services Region.

You can't create an encrypted read replica from an unencrypted DB instance.

Definition at line 1380 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithKmsKeyId() [3/3]

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

The Amazon Web Services KMS key identifier for an encrypted read replica.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS CMK.

If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance, then do not specify a value for this parameter. A read replica in the same Region is always encrypted with the same Amazon Web Services KMS CMK as the source DB instance.

If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. Amazon Web Services KMS CMKs are specific to the Amazon Web Services Region that they are created in, and you can't use CMKs from one Amazon Web Services Region in another Amazon Web Services Region.

You can't create an encrypted read replica from an unencrypted DB instance.

Definition at line 1414 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithMaxAllocatedStorage()

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithMaxAllocatedStorage ( int  value)
inline

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.

Definition at line 2493 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithMonitoringInterval()

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithMonitoringInterval ( int  value)
inline

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

Definition at line 1180 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithMonitoringRoleArn() [1/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithMonitoringRoleArn ( Aws::String &&  value)
inline

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

Definition at line 1265 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithMonitoringRoleArn() [2/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithMonitoringRoleArn ( const Aws::String value)
inline

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

Definition at line 1253 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithMonitoringRoleArn() [3/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithMonitoringRoleArn ( const char *  value)
inline

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

Definition at line 1277 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithMultiAZ()

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithMultiAZ ( bool  value)
inline

A value that indicates whether the read replica is in a Multi-AZ deployment.

You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your read replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.

Definition at line 542 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithOptionGroupName() [1/3]

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

The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.

For SQL Server, you must use the option group associated with the source instance.

Definition at line 646 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithOptionGroupName() [2/3]

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

The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.

For SQL Server, you must use the option group associated with the source instance.

Definition at line 639 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithOptionGroupName() [3/3]

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

The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.

For SQL Server, you must use the option group associated with the source instance.

Definition at line 653 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithPerformanceInsightsKMSKeyId() [1/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithPerformanceInsightsKMSKeyId ( Aws::String &&  value)
inline

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

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).

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses 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 1994 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithPerformanceInsightsKMSKeyId() [2/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithPerformanceInsightsKMSKeyId ( const Aws::String value)
inline

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

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).

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses 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 1982 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithPerformanceInsightsKMSKeyId() [3/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithPerformanceInsightsKMSKeyId ( const char *  value)
inline

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

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).

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses 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 2006 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithPerformanceInsightsRetentionPeriod()

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithPerformanceInsightsRetentionPeriod ( int  value)
inline

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

Definition at line 2031 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithPort()

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

The port number that the DB instance uses for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

Definition at line 505 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithPreSignedUrl() [1/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithPreSignedUrl ( Aws::String &&  value)
inline

The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source Amazon Web Services Region that contains the source DB instance.

You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted read replica in the same Amazon Web Services Region.

The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:

  • DestinationRegion - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL.

    For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.

  • KmsKeyId - The Amazon Web Services KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination Amazon Web Services Region, and the action contained in the presigned URL.

  • SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or –source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.

SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS doesn't support cross-region read replicas.

Definition at line 1779 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithPreSignedUrl() [2/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithPreSignedUrl ( const Aws::String value)
inline

The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source Amazon Web Services Region that contains the source DB instance.

You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted read replica in the same Amazon Web Services Region.

The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:

  • DestinationRegion - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL.

    For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.

  • KmsKeyId - The Amazon Web Services KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination Amazon Web Services Region, and the action contained in the presigned URL.

  • SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or –source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.

SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS doesn't support cross-region read replicas.

Definition at line 1727 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithPreSignedUrl() [3/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithPreSignedUrl ( const char *  value)
inline

The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source Amazon Web Services Region that contains the source DB instance.

You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted read replica in the same Amazon Web Services Region.

The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:

  • DestinationRegion - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL.

    For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.

  • KmsKeyId - The Amazon Web Services KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination Amazon Web Services Region, and the action contained in the presigned URL.

  • SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or –source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.

SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS doesn't support cross-region read replicas.

Definition at line 1831 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithProcessorFeatures() [1/2]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithProcessorFeatures ( Aws::Vector< ProcessorFeature > &&  value)
inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Definition at line 2159 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithProcessorFeatures() [2/2]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithProcessorFeatures ( const Aws::Vector< ProcessorFeature > &  value)
inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Definition at line 2153 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithPubliclyAccessible()

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithPubliclyAccessible ( bool  value)
inline

A value that indicates whether the DB instance is publicly accessible.

When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

Definition at line 819 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithReplicaMode() [1/2]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithReplicaMode ( const ReplicaMode value)
inline

The open mode of the replica database: mounted or read-only.

This parameter is only supported for Oracle DB instances.

Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload.

You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

Definition at line 2436 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithReplicaMode() [2/2]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithReplicaMode ( ReplicaMode &&  value)
inline

The open mode of the replica database: mounted or read-only.

This parameter is only supported for Oracle DB instances.

Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload.

You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

Definition at line 2452 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithSourceDBInstanceIdentifier() [1/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithSourceDBInstanceIdentifier ( Aws::String &&  value)
inline

The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to five read replicas.

Constraints:

  • Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB instance.

  • Can specify a DB instance that is a MySQL read replica only if the source is running MySQL 5.6 or later.

  • For the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the Amazon RDS User Guide.

  • For the limitations of SQL Server read replicas, see Read Replica Limitations with Microsoft SQL Server in the Amazon RDS User Guide.

  • Can specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication).

  • The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0.

  • If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier.

  • If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn't apply to SQL Server, which doesn't support cross-region replicas.

Definition at line 301 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithSourceDBInstanceIdentifier() [2/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithSourceDBInstanceIdentifier ( const Aws::String value)
inline

The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to five read replicas.

Constraints:

  • Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB instance.

  • Can specify a DB instance that is a MySQL read replica only if the source is running MySQL 5.6 or later.

  • For the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the Amazon RDS User Guide.

  • For the limitations of SQL Server read replicas, see Read Replica Limitations with Microsoft SQL Server in the Amazon RDS User Guide.

  • Can specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication).

  • The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0.

  • If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier.

  • If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn't apply to SQL Server, which doesn't support cross-region replicas.

Definition at line 272 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithSourceDBInstanceIdentifier() [3/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithSourceDBInstanceIdentifier ( const char *  value)
inline

The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to five read replicas.

Constraints:

  • Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB instance.

  • Can specify a DB instance that is a MySQL read replica only if the source is running MySQL 5.6 or later.

  • For the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the Amazon RDS User Guide.

  • For the limitations of SQL Server read replicas, see Read Replica Limitations with Microsoft SQL Server in the Amazon RDS User Guide.

  • Can specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication).

  • The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0.

  • If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier.

  • If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn't apply to SQL Server, which doesn't support cross-region replicas.

Definition at line 330 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithSourceRegion() [1/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithSourceRegion ( Aws::String &&  value)
inline

If SourceRegion is specified, SDKs will generate pre-signed URLs and populate the pre-signed URL field.

Definition at line 2529 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithSourceRegion() [2/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithSourceRegion ( const Aws::String value)
inline

If SourceRegion is specified, SDKs will generate pre-signed URLs and populate the pre-signed URL field.

Definition at line 2524 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithSourceRegion() [3/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithSourceRegion ( const char *  value)
inline

If SourceRegion is specified, SDKs will generate pre-signed URLs and populate the pre-signed URL field.

Definition at line 2534 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithStorageType() [1/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithStorageType ( Aws::String &&  value)
inline

Specifies the storage type to be associated with the read replica.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise gp2

Definition at line 1109 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithStorageType() [2/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithStorageType ( const Aws::String value)
inline

Specifies the storage type to be associated with the read replica.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise gp2

Definition at line 1100 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithStorageType() [3/3]

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithStorageType ( const char *  value)
inline

Specifies the storage type to be associated with the read replica.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise gp2

Definition at line 1118 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithTags() [1/2]

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

Definition at line 838 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithTags() [2/2]

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

Definition at line 835 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithUseDefaultProcessorFeatures()

CreateDBInstanceReadReplicaRequest& Aws::RDS::Model::CreateDBInstanceReadReplicaRequest::WithUseDefaultProcessorFeatures ( bool  value)
inline

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

Definition at line 2196 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithVpcSecurityGroupIds() [1/2]

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

A list of EC2 VPC security groups to associate with the read replica.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

Definition at line 1024 of file CreateDBInstanceReadReplicaRequest.h.

◆ WithVpcSecurityGroupIds() [2/2]

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

A list of EC2 VPC security groups to associate with the read replica.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

Definition at line 1017 of file CreateDBInstanceReadReplicaRequest.h.


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