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

#include <CreateDBInstanceRequest.h>

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

Public Member Functions

 CreateDBInstanceRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetDBName () const
 
bool DBNameHasBeenSet () const
 
void SetDBName (const Aws::String &value)
 
void SetDBName (Aws::String &&value)
 
void SetDBName (const char *value)
 
CreateDBInstanceRequestWithDBName (const Aws::String &value)
 
CreateDBInstanceRequestWithDBName (Aws::String &&value)
 
CreateDBInstanceRequestWithDBName (const char *value)
 
const Aws::StringGetDBInstanceIdentifier () const
 
bool DBInstanceIdentifierHasBeenSet () const
 
void SetDBInstanceIdentifier (const Aws::String &value)
 
void SetDBInstanceIdentifier (Aws::String &&value)
 
void SetDBInstanceIdentifier (const char *value)
 
CreateDBInstanceRequestWithDBInstanceIdentifier (const Aws::String &value)
 
CreateDBInstanceRequestWithDBInstanceIdentifier (Aws::String &&value)
 
CreateDBInstanceRequestWithDBInstanceIdentifier (const char *value)
 
int GetAllocatedStorage () const
 
bool AllocatedStorageHasBeenSet () const
 
void SetAllocatedStorage (int value)
 
CreateDBInstanceRequestWithAllocatedStorage (int value)
 
const Aws::StringGetDBInstanceClass () const
 
bool DBInstanceClassHasBeenSet () const
 
void SetDBInstanceClass (const Aws::String &value)
 
void SetDBInstanceClass (Aws::String &&value)
 
void SetDBInstanceClass (const char *value)
 
CreateDBInstanceRequestWithDBInstanceClass (const Aws::String &value)
 
CreateDBInstanceRequestWithDBInstanceClass (Aws::String &&value)
 
CreateDBInstanceRequestWithDBInstanceClass (const char *value)
 
const Aws::StringGetEngine () const
 
bool EngineHasBeenSet () const
 
void SetEngine (const Aws::String &value)
 
void SetEngine (Aws::String &&value)
 
void SetEngine (const char *value)
 
CreateDBInstanceRequestWithEngine (const Aws::String &value)
 
CreateDBInstanceRequestWithEngine (Aws::String &&value)
 
CreateDBInstanceRequestWithEngine (const char *value)
 
const Aws::StringGetMasterUsername () const
 
bool MasterUsernameHasBeenSet () const
 
void SetMasterUsername (const Aws::String &value)
 
void SetMasterUsername (Aws::String &&value)
 
void SetMasterUsername (const char *value)
 
CreateDBInstanceRequestWithMasterUsername (const Aws::String &value)
 
CreateDBInstanceRequestWithMasterUsername (Aws::String &&value)
 
CreateDBInstanceRequestWithMasterUsername (const char *value)
 
const Aws::StringGetMasterUserPassword () const
 
bool MasterUserPasswordHasBeenSet () const
 
void SetMasterUserPassword (const Aws::String &value)
 
void SetMasterUserPassword (Aws::String &&value)
 
void SetMasterUserPassword (const char *value)
 
CreateDBInstanceRequestWithMasterUserPassword (const Aws::String &value)
 
CreateDBInstanceRequestWithMasterUserPassword (Aws::String &&value)
 
CreateDBInstanceRequestWithMasterUserPassword (const char *value)
 
const Aws::Vector< Aws::String > & GetDBSecurityGroups () const
 
bool DBSecurityGroupsHasBeenSet () const
 
void SetDBSecurityGroups (const Aws::Vector< Aws::String > &value)
 
void SetDBSecurityGroups (Aws::Vector< Aws::String > &&value)
 
CreateDBInstanceRequestWithDBSecurityGroups (const Aws::Vector< Aws::String > &value)
 
CreateDBInstanceRequestWithDBSecurityGroups (Aws::Vector< Aws::String > &&value)
 
CreateDBInstanceRequestAddDBSecurityGroups (const Aws::String &value)
 
CreateDBInstanceRequestAddDBSecurityGroups (Aws::String &&value)
 
CreateDBInstanceRequestAddDBSecurityGroups (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)
 
CreateDBInstanceRequestWithVpcSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
CreateDBInstanceRequestWithVpcSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
CreateDBInstanceRequestAddVpcSecurityGroupIds (const Aws::String &value)
 
CreateDBInstanceRequestAddVpcSecurityGroupIds (Aws::String &&value)
 
CreateDBInstanceRequestAddVpcSecurityGroupIds (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)
 
CreateDBInstanceRequestWithAvailabilityZone (const Aws::String &value)
 
CreateDBInstanceRequestWithAvailabilityZone (Aws::String &&value)
 
CreateDBInstanceRequestWithAvailabilityZone (const char *value)
 
const Aws::StringGetDBSubnetGroupName () const
 
bool DBSubnetGroupNameHasBeenSet () const
 
void SetDBSubnetGroupName (const Aws::String &value)
 
void SetDBSubnetGroupName (Aws::String &&value)
 
void SetDBSubnetGroupName (const char *value)
 
CreateDBInstanceRequestWithDBSubnetGroupName (const Aws::String &value)
 
CreateDBInstanceRequestWithDBSubnetGroupName (Aws::String &&value)
 
CreateDBInstanceRequestWithDBSubnetGroupName (const char *value)
 
const Aws::StringGetPreferredMaintenanceWindow () const
 
bool PreferredMaintenanceWindowHasBeenSet () const
 
void SetPreferredMaintenanceWindow (const Aws::String &value)
 
void SetPreferredMaintenanceWindow (Aws::String &&value)
 
void SetPreferredMaintenanceWindow (const char *value)
 
CreateDBInstanceRequestWithPreferredMaintenanceWindow (const Aws::String &value)
 
CreateDBInstanceRequestWithPreferredMaintenanceWindow (Aws::String &&value)
 
CreateDBInstanceRequestWithPreferredMaintenanceWindow (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)
 
CreateDBInstanceRequestWithDBParameterGroupName (const Aws::String &value)
 
CreateDBInstanceRequestWithDBParameterGroupName (Aws::String &&value)
 
CreateDBInstanceRequestWithDBParameterGroupName (const char *value)
 
int GetBackupRetentionPeriod () const
 
bool BackupRetentionPeriodHasBeenSet () const
 
void SetBackupRetentionPeriod (int value)
 
CreateDBInstanceRequestWithBackupRetentionPeriod (int value)
 
const Aws::StringGetPreferredBackupWindow () const
 
bool PreferredBackupWindowHasBeenSet () const
 
void SetPreferredBackupWindow (const Aws::String &value)
 
void SetPreferredBackupWindow (Aws::String &&value)
 
void SetPreferredBackupWindow (const char *value)
 
CreateDBInstanceRequestWithPreferredBackupWindow (const Aws::String &value)
 
CreateDBInstanceRequestWithPreferredBackupWindow (Aws::String &&value)
 
CreateDBInstanceRequestWithPreferredBackupWindow (const char *value)
 
int GetPort () const
 
bool PortHasBeenSet () const
 
void SetPort (int value)
 
CreateDBInstanceRequestWithPort (int value)
 
bool GetMultiAZ () const
 
bool MultiAZHasBeenSet () const
 
void SetMultiAZ (bool value)
 
CreateDBInstanceRequestWithMultiAZ (bool value)
 
const Aws::StringGetEngineVersion () const
 
bool EngineVersionHasBeenSet () const
 
void SetEngineVersion (const Aws::String &value)
 
void SetEngineVersion (Aws::String &&value)
 
void SetEngineVersion (const char *value)
 
CreateDBInstanceRequestWithEngineVersion (const Aws::String &value)
 
CreateDBInstanceRequestWithEngineVersion (Aws::String &&value)
 
CreateDBInstanceRequestWithEngineVersion (const char *value)
 
bool GetAutoMinorVersionUpgrade () const
 
bool AutoMinorVersionUpgradeHasBeenSet () const
 
void SetAutoMinorVersionUpgrade (bool value)
 
CreateDBInstanceRequestWithAutoMinorVersionUpgrade (bool value)
 
const Aws::StringGetLicenseModel () const
 
bool LicenseModelHasBeenSet () const
 
void SetLicenseModel (const Aws::String &value)
 
void SetLicenseModel (Aws::String &&value)
 
void SetLicenseModel (const char *value)
 
CreateDBInstanceRequestWithLicenseModel (const Aws::String &value)
 
CreateDBInstanceRequestWithLicenseModel (Aws::String &&value)
 
CreateDBInstanceRequestWithLicenseModel (const char *value)
 
int GetIops () const
 
bool IopsHasBeenSet () const
 
void SetIops (int value)
 
CreateDBInstanceRequestWithIops (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)
 
CreateDBInstanceRequestWithOptionGroupName (const Aws::String &value)
 
CreateDBInstanceRequestWithOptionGroupName (Aws::String &&value)
 
CreateDBInstanceRequestWithOptionGroupName (const char *value)
 
const Aws::StringGetCharacterSetName () const
 
bool CharacterSetNameHasBeenSet () const
 
void SetCharacterSetName (const Aws::String &value)
 
void SetCharacterSetName (Aws::String &&value)
 
void SetCharacterSetName (const char *value)
 
CreateDBInstanceRequestWithCharacterSetName (const Aws::String &value)
 
CreateDBInstanceRequestWithCharacterSetName (Aws::String &&value)
 
CreateDBInstanceRequestWithCharacterSetName (const char *value)
 
bool GetPubliclyAccessible () const
 
bool PubliclyAccessibleHasBeenSet () const
 
void SetPubliclyAccessible (bool value)
 
CreateDBInstanceRequestWithPubliclyAccessible (bool value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateDBInstanceRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateDBInstanceRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateDBInstanceRequestAddTags (const Tag &value)
 
CreateDBInstanceRequestAddTags (Tag &&value)
 
const Aws::StringGetDBClusterIdentifier () const
 
bool DBClusterIdentifierHasBeenSet () const
 
void SetDBClusterIdentifier (const Aws::String &value)
 
void SetDBClusterIdentifier (Aws::String &&value)
 
void SetDBClusterIdentifier (const char *value)
 
CreateDBInstanceRequestWithDBClusterIdentifier (const Aws::String &value)
 
CreateDBInstanceRequestWithDBClusterIdentifier (Aws::String &&value)
 
CreateDBInstanceRequestWithDBClusterIdentifier (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)
 
CreateDBInstanceRequestWithStorageType (const Aws::String &value)
 
CreateDBInstanceRequestWithStorageType (Aws::String &&value)
 
CreateDBInstanceRequestWithStorageType (const char *value)
 
const Aws::StringGetTdeCredentialArn () const
 
bool TdeCredentialArnHasBeenSet () const
 
void SetTdeCredentialArn (const Aws::String &value)
 
void SetTdeCredentialArn (Aws::String &&value)
 
void SetTdeCredentialArn (const char *value)
 
CreateDBInstanceRequestWithTdeCredentialArn (const Aws::String &value)
 
CreateDBInstanceRequestWithTdeCredentialArn (Aws::String &&value)
 
CreateDBInstanceRequestWithTdeCredentialArn (const char *value)
 
const Aws::StringGetTdeCredentialPassword () const
 
bool TdeCredentialPasswordHasBeenSet () const
 
void SetTdeCredentialPassword (const Aws::String &value)
 
void SetTdeCredentialPassword (Aws::String &&value)
 
void SetTdeCredentialPassword (const char *value)
 
CreateDBInstanceRequestWithTdeCredentialPassword (const Aws::String &value)
 
CreateDBInstanceRequestWithTdeCredentialPassword (Aws::String &&value)
 
CreateDBInstanceRequestWithTdeCredentialPassword (const char *value)
 
bool GetStorageEncrypted () const
 
bool StorageEncryptedHasBeenSet () const
 
void SetStorageEncrypted (bool value)
 
CreateDBInstanceRequestWithStorageEncrypted (bool value)
 
const Aws::StringGetKmsKeyId () const
 
bool KmsKeyIdHasBeenSet () const
 
void SetKmsKeyId (const Aws::String &value)
 
void SetKmsKeyId (Aws::String &&value)
 
void SetKmsKeyId (const char *value)
 
CreateDBInstanceRequestWithKmsKeyId (const Aws::String &value)
 
CreateDBInstanceRequestWithKmsKeyId (Aws::String &&value)
 
CreateDBInstanceRequestWithKmsKeyId (const char *value)
 
const Aws::StringGetDomain () const
 
bool DomainHasBeenSet () const
 
void SetDomain (const Aws::String &value)
 
void SetDomain (Aws::String &&value)
 
void SetDomain (const char *value)
 
CreateDBInstanceRequestWithDomain (const Aws::String &value)
 
CreateDBInstanceRequestWithDomain (Aws::String &&value)
 
CreateDBInstanceRequestWithDomain (const char *value)
 
bool GetCopyTagsToSnapshot () const
 
bool CopyTagsToSnapshotHasBeenSet () const
 
void SetCopyTagsToSnapshot (bool value)
 
CreateDBInstanceRequestWithCopyTagsToSnapshot (bool value)
 
int GetMonitoringInterval () const
 
bool MonitoringIntervalHasBeenSet () const
 
void SetMonitoringInterval (int value)
 
CreateDBInstanceRequestWithMonitoringInterval (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)
 
CreateDBInstanceRequestWithMonitoringRoleArn (const Aws::String &value)
 
CreateDBInstanceRequestWithMonitoringRoleArn (Aws::String &&value)
 
CreateDBInstanceRequestWithMonitoringRoleArn (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)
 
CreateDBInstanceRequestWithDomainIAMRoleName (const Aws::String &value)
 
CreateDBInstanceRequestWithDomainIAMRoleName (Aws::String &&value)
 
CreateDBInstanceRequestWithDomainIAMRoleName (const char *value)
 
int GetPromotionTier () const
 
bool PromotionTierHasBeenSet () const
 
void SetPromotionTier (int value)
 
CreateDBInstanceRequestWithPromotionTier (int value)
 
const Aws::StringGetTimezone () const
 
bool TimezoneHasBeenSet () const
 
void SetTimezone (const Aws::String &value)
 
void SetTimezone (Aws::String &&value)
 
void SetTimezone (const char *value)
 
CreateDBInstanceRequestWithTimezone (const Aws::String &value)
 
CreateDBInstanceRequestWithTimezone (Aws::String &&value)
 
CreateDBInstanceRequestWithTimezone (const char *value)
 
bool GetEnableIAMDatabaseAuthentication () const
 
bool EnableIAMDatabaseAuthenticationHasBeenSet () const
 
void SetEnableIAMDatabaseAuthentication (bool value)
 
CreateDBInstanceRequestWithEnableIAMDatabaseAuthentication (bool value)
 
bool GetEnablePerformanceInsights () const
 
bool EnablePerformanceInsightsHasBeenSet () const
 
void SetEnablePerformanceInsights (bool value)
 
CreateDBInstanceRequestWithEnablePerformanceInsights (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)
 
CreateDBInstanceRequestWithPerformanceInsightsKMSKeyId (const Aws::String &value)
 
CreateDBInstanceRequestWithPerformanceInsightsKMSKeyId (Aws::String &&value)
 
CreateDBInstanceRequestWithPerformanceInsightsKMSKeyId (const char *value)
 
int GetPerformanceInsightsRetentionPeriod () const
 
bool PerformanceInsightsRetentionPeriodHasBeenSet () const
 
void SetPerformanceInsightsRetentionPeriod (int value)
 
CreateDBInstanceRequestWithPerformanceInsightsRetentionPeriod (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)
 
CreateDBInstanceRequestWithEnableCloudwatchLogsExports (const Aws::Vector< Aws::String > &value)
 
CreateDBInstanceRequestWithEnableCloudwatchLogsExports (Aws::Vector< Aws::String > &&value)
 
CreateDBInstanceRequestAddEnableCloudwatchLogsExports (const Aws::String &value)
 
CreateDBInstanceRequestAddEnableCloudwatchLogsExports (Aws::String &&value)
 
CreateDBInstanceRequestAddEnableCloudwatchLogsExports (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)
 
CreateDBInstanceRequestWithProcessorFeatures (const Aws::Vector< ProcessorFeature > &value)
 
CreateDBInstanceRequestWithProcessorFeatures (Aws::Vector< ProcessorFeature > &&value)
 
CreateDBInstanceRequestAddProcessorFeatures (const ProcessorFeature &value)
 
CreateDBInstanceRequestAddProcessorFeatures (ProcessorFeature &&value)
 
bool GetDeletionProtection () const
 
bool DeletionProtectionHasBeenSet () const
 
void SetDeletionProtection (bool value)
 
CreateDBInstanceRequestWithDeletionProtection (bool value)
 
int GetMaxAllocatedStorage () const
 
bool MaxAllocatedStorageHasBeenSet () const
 
void SetMaxAllocatedStorage (int value)
 
CreateDBInstanceRequestWithMaxAllocatedStorage (int value)
 
- Public Member Functions inherited from Aws::RDS::RDSRequest
virtual ~RDSRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

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

Detailed Description

See Also:

AWS API Reference

Definition at line 27 of file CreateDBInstanceRequest.h.

Constructor & Destructor Documentation

◆ CreateDBInstanceRequest()

Aws::RDS::Model::CreateDBInstanceRequest::CreateDBInstanceRequest ( )

Member Function Documentation

◆ AddDBSecurityGroups() [1/3]

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::AddDBSecurityGroups ( const Aws::String value)
inline

A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.

Definition at line 1096 of file CreateDBInstanceRequest.h.

◆ AddDBSecurityGroups() [2/3]

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::AddDBSecurityGroups ( Aws::String &&  value)
inline

A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.

Definition at line 1102 of file CreateDBInstanceRequest.h.

◆ AddDBSecurityGroups() [3/3]

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::AddDBSecurityGroups ( const char *  value)
inline

A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.

Definition at line 1108 of file CreateDBInstanceRequest.h.

◆ AddEnableCloudwatchLogsExports() [1/3]

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

The list of log types that need to be enabled for exporting 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 Relational Database Service User Guide.

MariaDB

Possible values are audit, error, general, and slowquery.

Microsoft SQL Server

Possible values are agent and error.

MySQL

Possible values are audit, error, general, and slowquery.

Oracle

Possible values are alert, audit, listener, and trace.

PostgreSQL

Possible values are postgresql and upgrade.

Definition at line 3557 of file CreateDBInstanceRequest.h.

◆ AddEnableCloudwatchLogsExports() [2/3]

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

The list of log types that need to be enabled for exporting 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 Relational Database Service User Guide.

MariaDB

Possible values are audit, error, general, and slowquery.

Microsoft SQL Server

Possible values are agent and error.

MySQL

Possible values are audit, error, general, and slowquery.

Oracle

Possible values are alert, audit, listener, and trace.

PostgreSQL

Possible values are postgresql and upgrade.

Definition at line 3575 of file CreateDBInstanceRequest.h.

◆ AddEnableCloudwatchLogsExports() [3/3]

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

The list of log types that need to be enabled for exporting 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 Relational Database Service User Guide.

MariaDB

Possible values are audit, error, general, and slowquery.

Microsoft SQL Server

Possible values are agent and error.

MySQL

Possible values are audit, error, general, and slowquery.

Oracle

Possible values are alert, audit, listener, and trace.

PostgreSQL

Possible values are postgresql and upgrade.

Definition at line 3593 of file CreateDBInstanceRequest.h.

◆ AddProcessorFeatures() [1/2]

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

◆ AddProcessorFeatures() [2/2]

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

◆ AddTags() [1/2]

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

Tags to assign to the DB instance.

Definition at line 2444 of file CreateDBInstanceRequest.h.

◆ AddTags() [2/2]

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

Tags to assign to the DB instance.

Definition at line 2449 of file CreateDBInstanceRequest.h.

◆ AddVpcSecurityGroupIds() [1/3]

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

A list of Amazon EC2 VPC security groups to associate with this DB instance.

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster.

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

Definition at line 1165 of file CreateDBInstanceRequest.h.

◆ AddVpcSecurityGroupIds() [2/3]

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

A list of Amazon EC2 VPC security groups to associate with this DB instance.

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster.

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

Definition at line 1173 of file CreateDBInstanceRequest.h.

◆ AddVpcSecurityGroupIds() [3/3]

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

A list of Amazon EC2 VPC security groups to associate with this DB instance.

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster.

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

Definition at line 1181 of file CreateDBInstanceRequest.h.

◆ AllocatedStorageHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceRequest::AllocatedStorageHasBeenSet ( ) const
inline

The amount of storage (in gibibytes) to allocate for the DB instance.

Type: Integer

Amazon Aurora

Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.

MySQL

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

  • Magnetic storage (standard): Must be an integer from 5 to 3072.

MariaDB

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

  • Magnetic storage (standard): Must be an integer from 5 to 3072.

PostgreSQL

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

  • Magnetic storage (standard): Must be an integer from 5 to 3072.

Oracle

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

  • Magnetic storage (standard): Must be an integer from 10 to 3072.

SQL Server

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2):

    • Enterprise and Standard editions: Must be an integer from 200 to 16384.

    • Web and Express editions: Must be an integer from 20 to 16384.

  • Provisioned IOPS storage (io1):

    • Enterprise and Standard editions: Must be an integer from 200 to 16384.

    • Web and Express editions: Must be an integer from 100 to 16384.

  • Magnetic storage (standard):

    • Enterprise and Standard editions: Must be an integer from 200 to 1024.

    • Web and Express editions: Must be an integer from 20 to 1024.

Definition at line 467 of file CreateDBInstanceRequest.h.

◆ AutoMinorVersionUpgradeHasBeenSet()

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

A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.

Definition at line 2057 of file CreateDBInstanceRequest.h.

◆ AvailabilityZoneHasBeenSet()

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

The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.

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

Example: us-east-1d

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint.

If you're creating a DB instance in an RDS on VMware environment, specify the identifier of the custom Availability Zone to create the DB instance in.

For more information about RDS on VMware, see the RDS on VMware User Guide.

Definition at line 1216 of file CreateDBInstanceRequest.h.

◆ BackupRetentionPeriodHasBeenSet()

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

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Amazon Aurora

Not applicable. The retention period for automated backups is managed by the DB cluster.

Default: 1

Constraints:

  • Must be a value from 0 to 35

  • Can't be set to 0 if the DB instance is a source to read replicas

Definition at line 1568 of file CreateDBInstanceRequest.h.

◆ CharacterSetNameHasBeenSet()

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

For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.

Amazon Aurora

Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.

Definition at line 2263 of file CreateDBInstanceRequest.h.

◆ CopyTagsToSnapshotHasBeenSet()

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

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.

Definition at line 2903 of file CreateDBInstanceRequest.h.

◆ DBClusterIdentifierHasBeenSet()

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

The identifier of the DB cluster that the instance will belong to.

Definition at line 2460 of file CreateDBInstanceRequest.h.

◆ DBInstanceClassHasBeenSet()

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

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS 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.

Definition at line 566 of file CreateDBInstanceRequest.h.

◆ DBInstanceIdentifierHasBeenSet()

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

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

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

Example: mydbinstance

Definition at line 334 of file CreateDBInstanceRequest.h.

◆ DBNameHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceRequest::DBNameHasBeenSet ( ) const
inline

The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

  • Can't be a word reserved by the specified database engine

MariaDB

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

  • Can't be a word reserved by the specified database engine

PostgreSQL

The name of the database to create when the DB instance is created. If this parameter isn't specified, the default "postgres" database is created in the DB instance.

Constraints:

  • Must contain 1 to 63 letters, numbers, or underscores.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

  • Can't be a word reserved by the specified database engine

Oracle

The Oracle System ID (SID) of the created DB instance. If you specify null, the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName.

Default: ORCL

Constraints:

  • Can't be longer than 8 characters

SQL Server

Not applicable. Must be null.

Amazon Aurora

The name of the database to create when the primary instance of the DB cluster is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Can't be a word reserved by the specified database engine

Definition at line 111 of file CreateDBInstanceRequest.h.

◆ DBParameterGroupNameHasBeenSet()

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

The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then the default DB parameter group for the specified DB engine and version is used.

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 1485 of file CreateDBInstanceRequest.h.

◆ DBSecurityGroupsHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceRequest::DBSecurityGroupsHasBeenSet ( ) const
inline

A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.

Definition at line 1066 of file CreateDBInstanceRequest.h.

◆ DBSubnetGroupNameHasBeenSet()

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

A DB subnet group to associate with this DB instance.

If there is no DB subnet group, then it is a non-VPC DB instance.

Definition at line 1331 of file CreateDBInstanceRequest.h.

◆ DeletionProtectionHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceRequest::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.

Amazon Aurora

Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see CreateDBCluster. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.

Definition at line 3669 of file CreateDBInstanceRequest.h.

◆ DomainHasBeenSet()

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

◆ DomainIAMRoleNameHasBeenSet()

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

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

Definition at line 3068 of file CreateDBInstanceRequest.h.

◆ DumpBodyToUrl()

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

The list of log types that need to be enabled for exporting 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 Relational Database Service User Guide.

MariaDB

Possible values are audit, error, general, and slowquery.

Microsoft SQL Server

Possible values are agent and error.

MySQL

Possible values are audit, error, general, and slowquery.

Oracle

Possible values are alert, audit, listener, and trace.

PostgreSQL

Possible values are postgresql and upgrade.

Definition at line 3467 of file CreateDBInstanceRequest.h.

◆ EnableIAMDatabaseAuthenticationHasBeenSet()

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

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

You can enable IAM database authentication for the following database engines:

Amazon Aurora

Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.

MySQL

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

  • For MySQL 8.0, minor version 8.0.16 or higher

PostgreSQL

  • For PostgreSQL 9.5, minor version 9.5.15 or higher

  • For PostgreSQL 9.6, minor version 9.6.11 or higher

  • PostgreSQL 10.6, 10.7, and 10.9

For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

Definition at line 3249 of file CreateDBInstanceRequest.h.

◆ EnablePerformanceInsightsHasBeenSet()

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

A value that indicates whether to enable Performance Insights for the DB instance.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

Definition at line 3306 of file CreateDBInstanceRequest.h.

◆ EngineHasBeenSet()

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

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

Not every database engine is available for every AWS Region.

Valid Values:

  • aurora (for MySQL 5.6-compatible Aurora)

  • aurora-mysql (for MySQL 5.7-compatible Aurora)

  • aurora-postgresql

  • mariadb

  • mysql

  • oracle-ee

  • oracle-se2

  • oracle-se1

  • oracle-se

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

Definition at line 659 of file CreateDBInstanceRequest.h.

◆ EngineVersionHasBeenSet()

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

The version number of the database engine to use.

For a list of valid engine versions, use the DescribeDBEngineVersions action.

The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.

Amazon Aurora

Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.

MariaDB

See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.

Microsoft SQL Server

See Version and Feature Support on Amazon RDS in the Amazon RDS User Guide.

MySQL

See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.

Oracle

See Oracle Database Engine Release Notes in the Amazon RDS User Guide.

PostgreSQL

See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.

Definition at line 1892 of file CreateDBInstanceRequest.h.

◆ GetAllocatedStorage()

int Aws::RDS::Model::CreateDBInstanceRequest::GetAllocatedStorage ( ) const
inline

The amount of storage (in gibibytes) to allocate for the DB instance.

Type: Integer

Amazon Aurora

Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.

MySQL

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

  • Magnetic storage (standard): Must be an integer from 5 to 3072.

MariaDB

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

  • Magnetic storage (standard): Must be an integer from 5 to 3072.

PostgreSQL

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

  • Magnetic storage (standard): Must be an integer from 5 to 3072.

Oracle

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

  • Magnetic storage (standard): Must be an integer from 10 to 3072.

SQL Server

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2):

    • Enterprise and Standard editions: Must be an integer from 200 to 16384.

    • Web and Express editions: Must be an integer from 20 to 16384.

  • Provisioned IOPS storage (io1):

    • Enterprise and Standard editions: Must be an integer from 200 to 16384.

    • Web and Express editions: Must be an integer from 100 to 16384.

  • Magnetic storage (standard):

    • Enterprise and Standard editions: Must be an integer from 200 to 1024.

    • Web and Express editions: Must be an integer from 20 to 1024.

Definition at line 428 of file CreateDBInstanceRequest.h.

◆ GetAutoMinorVersionUpgrade()

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

A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.

Definition at line 2050 of file CreateDBInstanceRequest.h.

◆ GetAvailabilityZone()

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

The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.

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

Example: us-east-1d

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint.

If you're creating a DB instance in an RDS on VMware environment, specify the identifier of the custom Availability Zone to create the DB instance in.

For more information about RDS on VMware, see the RDS on VMware User Guide.

Definition at line 1199 of file CreateDBInstanceRequest.h.

◆ GetBackupRetentionPeriod()

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

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Amazon Aurora

Not applicable. The retention period for automated backups is managed by the DB cluster.

Default: 1

Constraints:

  • Must be a value from 0 to 35

  • Can't be set to 0 if the DB instance is a source to read replicas

Definition at line 1557 of file CreateDBInstanceRequest.h.

◆ GetCharacterSetName()

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

For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.

Amazon Aurora

Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.

Definition at line 2255 of file CreateDBInstanceRequest.h.

◆ GetCopyTagsToSnapshot()

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

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.

Definition at line 2894 of file CreateDBInstanceRequest.h.

◆ GetDBClusterIdentifier()

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

The identifier of the DB cluster that the instance will belong to.

Definition at line 2455 of file CreateDBInstanceRequest.h.

◆ GetDBInstanceClass()

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

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS 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.

Definition at line 556 of file CreateDBInstanceRequest.h.

◆ GetDBInstanceIdentifier()

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

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

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

Example: mydbinstance

Definition at line 325 of file CreateDBInstanceRequest.h.

◆ GetDBName()

const Aws::String& Aws::RDS::Model::CreateDBInstanceRequest::GetDBName ( ) const
inline

The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

  • Can't be a word reserved by the specified database engine

MariaDB

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

  • Can't be a word reserved by the specified database engine

PostgreSQL

The name of the database to create when the DB instance is created. If this parameter isn't specified, the default "postgres" database is created in the DB instance.

Constraints:

  • Must contain 1 to 63 letters, numbers, or underscores.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

  • Can't be a word reserved by the specified database engine

Oracle

The Oracle System ID (SID) of the created DB instance. If you specify null, the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName.

Default: ORCL

Constraints:

  • Can't be longer than 8 characters

SQL Server

Not applicable. Must be null.

Amazon Aurora

The name of the database to create when the primary instance of the DB cluster is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Can't be a word reserved by the specified database engine

Definition at line 77 of file CreateDBInstanceRequest.h.

◆ GetDBParameterGroupName()

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

The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then the default DB parameter group for the specified DB engine and version is used.

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 1475 of file CreateDBInstanceRequest.h.

◆ GetDBSecurityGroups()

const Aws::Vector<Aws::String>& Aws::RDS::Model::CreateDBInstanceRequest::GetDBSecurityGroups ( ) const
inline

A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.

Definition at line 1060 of file CreateDBInstanceRequest.h.

◆ GetDBSubnetGroupName()

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

A DB subnet group to associate with this DB instance.

If there is no DB subnet group, then it is a non-VPC DB instance.

Definition at line 1325 of file CreateDBInstanceRequest.h.

◆ GetDeletionProtection()

bool Aws::RDS::Model::CreateDBInstanceRequest::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.

Amazon Aurora

Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see CreateDBCluster. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.

Definition at line 3656 of file CreateDBInstanceRequest.h.

◆ GetDomain()

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

◆ GetDomainIAMRoleName()

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

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

Definition at line 3062 of file CreateDBInstanceRequest.h.

◆ GetEnableCloudwatchLogsExports()

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

The list of log types that need to be enabled for exporting 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 Relational Database Service User Guide.

MariaDB

Possible values are audit, error, general, and slowquery.

Microsoft SQL Server

Possible values are agent and error.

MySQL

Possible values are audit, error, general, and slowquery.

Oracle

Possible values are alert, audit, listener, and trace.

PostgreSQL

Possible values are postgresql and upgrade.

Definition at line 3449 of file CreateDBInstanceRequest.h.

◆ GetEnableIAMDatabaseAuthentication()

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

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

You can enable IAM database authentication for the following database engines:

Amazon Aurora

Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.

MySQL

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

  • For MySQL 8.0, minor version 8.0.16 or higher

PostgreSQL

  • For PostgreSQL 9.5, minor version 9.5.15 or higher

  • For PostgreSQL 9.6, minor version 9.6.11 or higher

  • PostgreSQL 10.6, 10.7, and 10.9

For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

Definition at line 3230 of file CreateDBInstanceRequest.h.

◆ GetEnablePerformanceInsights()

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

A value that indicates whether to enable Performance Insights for the DB instance.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

Definition at line 3297 of file CreateDBInstanceRequest.h.

◆ GetEngine()

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

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

Not every database engine is available for every AWS Region.

Valid Values:

  • aurora (for MySQL 5.6-compatible Aurora)

  • aurora-mysql (for MySQL 5.7-compatible Aurora)

  • aurora-postgresql

  • mariadb

  • mysql

  • oracle-ee

  • oracle-se2

  • oracle-se1

  • oracle-se

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

Definition at line 643 of file CreateDBInstanceRequest.h.

◆ GetEngineVersion()

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

The version number of the database engine to use.

For a list of valid engine versions, use the DescribeDBEngineVersions action.

The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.

Amazon Aurora

Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.

MariaDB

See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.

Microsoft SQL Server

See Version and Feature Support on Amazon RDS in the Amazon RDS User Guide.

MySQL

See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.

Oracle

See Oracle Database Engine Release Notes in the Amazon RDS User Guide.

PostgreSQL

See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.

Definition at line 1867 of file CreateDBInstanceRequest.h.

◆ GetIops()

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

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.

Definition at line 2142 of file CreateDBInstanceRequest.h.

◆ GetKmsKeyId()

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

The AWS KMS key identifier for an encrypted DB instance.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

Amazon Aurora

Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.

If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

Definition at line 2706 of file CreateDBInstanceRequest.h.

◆ GetLicenseModel()

const Aws::String& Aws::RDS::Model::CreateDBInstanceRequest::GetLicenseModel ( ) const
inline

License model information for this DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

Definition at line 2079 of file CreateDBInstanceRequest.h.

◆ GetMasterUsername()

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

The name for the master user.

Amazon Aurora

Not applicable. The name for the master user is managed by the DB cluster.

MariaDB

Constraints:

  • Required for MariaDB.

  • Must be 1 to 16 letters or numbers.

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

Microsoft SQL Server

Constraints:

  • Required for SQL Server.

  • Must be 1 to 128 letters or numbers.

  • The first character must be a letter.

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

MySQL

Constraints:

  • Required for MySQL.

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

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

Oracle

Constraints:

  • Required for Oracle.

  • Must be 1 to 30 letters or numbers.

  • First character must be a letter.

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

PostgreSQL

Constraints:

  • Required for PostgreSQL.

  • Must be 1 to 63 letters or numbers.

  • First character must be a letter.

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

Definition at line 780 of file CreateDBInstanceRequest.h.

◆ GetMasterUserPassword()

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

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

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster.

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Definition at line 962 of file CreateDBInstanceRequest.h.

◆ GetMaxAllocatedStorage()

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

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

Definition at line 3702 of file CreateDBInstanceRequest.h.

◆ GetMonitoringInterval()

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

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. 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 2931 of file CreateDBInstanceRequest.h.

◆ GetMonitoringRoleArn()

const Aws::String& Aws::RDS::Model::CreateDBInstanceRequest::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 Setting Up and Enabling 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 2971 of file CreateDBInstanceRequest.h.

◆ GetMultiAZ()

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

A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

Definition at line 1820 of file CreateDBInstanceRequest.h.

◆ GetOptionGroupName()

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

Indicates that the DB instance should be associated with the specified option group.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance

Definition at line 2190 of file CreateDBInstanceRequest.h.

◆ GetPerformanceInsightsKMSKeyId()

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

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

Definition at line 3335 of file CreateDBInstanceRequest.h.

◆ GetPerformanceInsightsRetentionPeriod()

int Aws::RDS::Model::CreateDBInstanceRequest::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 3412 of file CreateDBInstanceRequest.h.

◆ GetPort()

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

The port number on which the database accepts connections.

MySQL

Default: 3306

Valid values: 1150-65535

Type: Integer

MariaDB

Default: 3306

Valid values: 1150-65535

Type: Integer

PostgreSQL

Default: 5432

Valid values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid values: 1150-65535

SQL Server

Default: 1433

Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156.

Amazon Aurora

Default: 3306

Valid values: 1150-65535

Type: Integer

Definition at line 1761 of file CreateDBInstanceRequest.h.

◆ GetPreferredBackupWindow()

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

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see The Backup Window in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide.

Constraints:

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

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 1610 of file CreateDBInstanceRequest.h.

◆ GetPreferredMaintenanceWindow()

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

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window.

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

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

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

Constraints: Minimum 30-minute window.

Definition at line 1380 of file CreateDBInstanceRequest.h.

◆ GetProcessorFeatures()

const Aws::Vector<ProcessorFeature>& Aws::RDS::Model::CreateDBInstanceRequest::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 3600 of file CreateDBInstanceRequest.h.

◆ GetPromotionTier()

int Aws::RDS::Model::CreateDBInstanceRequest::GetPromotionTier ( ) const
inline

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

Default: 1

Valid Values: 0 - 15

Definition at line 3115 of file CreateDBInstanceRequest.h.

◆ GetPubliclyAccessible()

bool Aws::RDS::Model::CreateDBInstanceRequest::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.

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

  • If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private.

  • If the default VPC in the target region has an Internet gateway attached to it, the DB instance is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

  • If the subnets are part of a VPC that doesn’t have an Internet gateway attached to it, the DB instance is private.

  • If the subnets are part of a VPC that has an Internet gateway attached to it, the DB instance is public.

Definition at line 2336 of file CreateDBInstanceRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file CreateDBInstanceRequest.h.

◆ GetStorageEncrypted()

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

A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.

Amazon Aurora

Not applicable. The encryption for DB instances is managed by the DB cluster.

Definition at line 2669 of file CreateDBInstanceRequest.h.

◆ GetStorageType()

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

Specifies the storage type to be associated with the DB instance.

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 2500 of file CreateDBInstanceRequest.h.

◆ GetTags()

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

Tags to assign to the DB instance.

Definition at line 2414 of file CreateDBInstanceRequest.h.

◆ GetTdeCredentialArn()

const Aws::String& Aws::RDS::Model::CreateDBInstanceRequest::GetTdeCredentialArn ( ) const
inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 2570 of file CreateDBInstanceRequest.h.

◆ GetTdeCredentialPassword()

const Aws::String& Aws::RDS::Model::CreateDBInstanceRequest::GetTdeCredentialPassword ( ) const
inline

The password for the given ARN from the key store in order to access the device.

Definition at line 2619 of file CreateDBInstanceRequest.h.

◆ GetTimezone()

const Aws::String& Aws::RDS::Model::CreateDBInstanceRequest::GetTimezone ( ) const
inline

The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.

Definition at line 3154 of file CreateDBInstanceRequest.h.

◆ GetVpcSecurityGroupIds()

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

A list of Amazon EC2 VPC security groups to associate with this DB instance.

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster.

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

Definition at line 1117 of file CreateDBInstanceRequest.h.

◆ IopsHasBeenSet()

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

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.

Definition at line 2155 of file CreateDBInstanceRequest.h.

◆ KmsKeyIdHasBeenSet()

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

The AWS KMS key identifier for an encrypted DB instance.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

Amazon Aurora

Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.

If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

Definition at line 2721 of file CreateDBInstanceRequest.h.

◆ LicenseModelHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceRequest::LicenseModelHasBeenSet ( ) const
inline

License model information for this DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

Definition at line 2086 of file CreateDBInstanceRequest.h.

◆ MasterUsernameHasBeenSet()

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

The name for the master user.

Amazon Aurora

Not applicable. The name for the master user is managed by the DB cluster.

MariaDB

Constraints:

  • Required for MariaDB.

  • Must be 1 to 16 letters or numbers.

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

Microsoft SQL Server

Constraints:

  • Required for SQL Server.

  • Must be 1 to 128 letters or numbers.

  • The first character must be a letter.

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

MySQL

Constraints:

  • Required for MySQL.

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

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

Oracle

Constraints:

  • Required for Oracle.

  • Must be 1 to 30 letters or numbers.

  • First character must be a letter.

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

PostgreSQL

Constraints:

  • Required for PostgreSQL.

  • Must be 1 to 63 letters or numbers.

  • First character must be a letter.

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

Definition at line 804 of file CreateDBInstanceRequest.h.

◆ MasterUserPasswordHasBeenSet()

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

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

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster.

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Definition at line 975 of file CreateDBInstanceRequest.h.

◆ MaxAllocatedStorageHasBeenSet()

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

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

Definition at line 3708 of file CreateDBInstanceRequest.h.

◆ MonitoringIntervalHasBeenSet()

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

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. 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 2940 of file CreateDBInstanceRequest.h.

◆ MonitoringRoleArnHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceRequest::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 Setting Up and Enabling 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 2983 of file CreateDBInstanceRequest.h.

◆ MultiAZHasBeenSet()

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

A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

Definition at line 1827 of file CreateDBInstanceRequest.h.

◆ OptionGroupNameHasBeenSet()

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

Indicates that the DB instance should be associated with the specified option group.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance

Definition at line 2198 of file CreateDBInstanceRequest.h.

◆ PerformanceInsightsKMSKeyIdHasBeenSet()

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

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

Definition at line 3345 of file CreateDBInstanceRequest.h.

◆ PerformanceInsightsRetentionPeriodHasBeenSet()

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

◆ PortHasBeenSet()

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

The port number on which the database accepts connections.

MySQL

Default: 3306

Valid values: 1150-65535

Type: Integer

MariaDB

Default: 3306

Valid values: 1150-65535

Type: Integer

PostgreSQL

Default: 5432

Valid values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid values: 1150-65535

SQL Server

Default: 1433

Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156.

Amazon Aurora

Default: 3306

Valid values: 1150-65535

Type: Integer

Definition at line 1778 of file CreateDBInstanceRequest.h.

◆ PreferredBackupWindowHasBeenSet()

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

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see The Backup Window in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide.

Constraints:

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

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 1629 of file CreateDBInstanceRequest.h.

◆ PreferredMaintenanceWindowHasBeenSet()

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

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window.

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

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

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

Constraints: Minimum 30-minute window.

Definition at line 1392 of file CreateDBInstanceRequest.h.

◆ ProcessorFeaturesHasBeenSet()

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

◆ PromotionTierHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceRequest::PromotionTierHasBeenSet ( ) const
inline

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

Default: 1

Valid Values: 0 - 15

Definition at line 3125 of file CreateDBInstanceRequest.h.

◆ PubliclyAccessibleHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceRequest::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.

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

  • If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private.

  • If the default VPC in the target region has an Internet gateway attached to it, the DB instance is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

  • If the subnets are part of a VPC that doesn’t have an Internet gateway attached to it, the DB instance is private.

  • If the subnets are part of a VPC that has an Internet gateway attached to it, the DB instance is public.

Definition at line 2360 of file CreateDBInstanceRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAllocatedStorage()

void Aws::RDS::Model::CreateDBInstanceRequest::SetAllocatedStorage ( int  value)
inline

The amount of storage (in gibibytes) to allocate for the DB instance.

Type: Integer

Amazon Aurora

Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.

MySQL

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

  • Magnetic storage (standard): Must be an integer from 5 to 3072.

MariaDB

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

  • Magnetic storage (standard): Must be an integer from 5 to 3072.

PostgreSQL

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

  • Magnetic storage (standard): Must be an integer from 5 to 3072.

Oracle

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

  • Magnetic storage (standard): Must be an integer from 10 to 3072.

SQL Server

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2):

    • Enterprise and Standard editions: Must be an integer from 200 to 16384.

    • Web and Express editions: Must be an integer from 20 to 16384.

  • Provisioned IOPS storage (io1):

    • Enterprise and Standard editions: Must be an integer from 200 to 16384.

    • Web and Express editions: Must be an integer from 100 to 16384.

  • Magnetic storage (standard):

    • Enterprise and Standard editions: Must be an integer from 200 to 1024.

    • Web and Express editions: Must be an integer from 20 to 1024.

Definition at line 506 of file CreateDBInstanceRequest.h.

◆ SetAutoMinorVersionUpgrade()

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

A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.

Definition at line 2064 of file CreateDBInstanceRequest.h.

◆ SetAvailabilityZone() [1/3]

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

The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.

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

Example: us-east-1d

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint.

If you're creating a DB instance in an RDS on VMware environment, specify the identifier of the custom Availability Zone to create the DB instance in.

For more information about RDS on VMware, see the RDS on VMware User Guide.

Definition at line 1233 of file CreateDBInstanceRequest.h.

◆ SetAvailabilityZone() [2/3]

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

The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.

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

Example: us-east-1d

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint.

If you're creating a DB instance in an RDS on VMware environment, specify the identifier of the custom Availability Zone to create the DB instance in.

For more information about RDS on VMware, see the RDS on VMware User Guide.

Definition at line 1250 of file CreateDBInstanceRequest.h.

◆ SetAvailabilityZone() [3/3]

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

The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.

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

Example: us-east-1d

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint.

If you're creating a DB instance in an RDS on VMware environment, specify the identifier of the custom Availability Zone to create the DB instance in.

For more information about RDS on VMware, see the RDS on VMware User Guide.

Definition at line 1267 of file CreateDBInstanceRequest.h.

◆ SetBackupRetentionPeriod()

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

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Amazon Aurora

Not applicable. The retention period for automated backups is managed by the DB cluster.

Default: 1

Constraints:

  • Must be a value from 0 to 35

  • Can't be set to 0 if the DB instance is a source to read replicas

Definition at line 1579 of file CreateDBInstanceRequest.h.

◆ SetCharacterSetName() [1/3]

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

For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.

Amazon Aurora

Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.

Definition at line 2271 of file CreateDBInstanceRequest.h.

◆ SetCharacterSetName() [2/3]

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

For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.

Amazon Aurora

Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.

Definition at line 2279 of file CreateDBInstanceRequest.h.

◆ SetCharacterSetName() [3/3]

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

For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.

Amazon Aurora

Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.

Definition at line 2287 of file CreateDBInstanceRequest.h.

◆ SetCopyTagsToSnapshot()

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

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.

Definition at line 2912 of file CreateDBInstanceRequest.h.

◆ SetDBClusterIdentifier() [1/3]

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

The identifier of the DB cluster that the instance will belong to.

Definition at line 2465 of file CreateDBInstanceRequest.h.

◆ SetDBClusterIdentifier() [2/3]

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

The identifier of the DB cluster that the instance will belong to.

Definition at line 2470 of file CreateDBInstanceRequest.h.

◆ SetDBClusterIdentifier() [3/3]

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

The identifier of the DB cluster that the instance will belong to.

Definition at line 2475 of file CreateDBInstanceRequest.h.

◆ SetDBInstanceClass() [1/3]

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

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS 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.

Definition at line 576 of file CreateDBInstanceRequest.h.

◆ SetDBInstanceClass() [2/3]

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

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS 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.

Definition at line 586 of file CreateDBInstanceRequest.h.

◆ SetDBInstanceClass() [3/3]

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

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS 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.

Definition at line 596 of file CreateDBInstanceRequest.h.

◆ SetDBInstanceIdentifier() [1/3]

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

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

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

Example: mydbinstance

Definition at line 343 of file CreateDBInstanceRequest.h.

◆ SetDBInstanceIdentifier() [2/3]

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

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

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

Example: mydbinstance

Definition at line 352 of file CreateDBInstanceRequest.h.

◆ SetDBInstanceIdentifier() [3/3]

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

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

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

Example: mydbinstance

Definition at line 361 of file CreateDBInstanceRequest.h.

◆ SetDBName() [1/3]

void Aws::RDS::Model::CreateDBInstanceRequest::SetDBName ( const Aws::String value)
inline

The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

  • Can't be a word reserved by the specified database engine

MariaDB

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

  • Can't be a word reserved by the specified database engine

PostgreSQL

The name of the database to create when the DB instance is created. If this parameter isn't specified, the default "postgres" database is created in the DB instance.

Constraints:

  • Must contain 1 to 63 letters, numbers, or underscores.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

  • Can't be a word reserved by the specified database engine

Oracle

The Oracle System ID (SID) of the created DB instance. If you specify null, the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName.

Default: ORCL

Constraints:

  • Can't be longer than 8 characters

SQL Server

Not applicable. Must be null.

Amazon Aurora

The name of the database to create when the primary instance of the DB cluster is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Can't be a word reserved by the specified database engine

Definition at line 145 of file CreateDBInstanceRequest.h.

◆ SetDBName() [2/3]

void Aws::RDS::Model::CreateDBInstanceRequest::SetDBName ( Aws::String &&  value)
inline

The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

  • Can't be a word reserved by the specified database engine

MariaDB

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

  • Can't be a word reserved by the specified database engine

PostgreSQL

The name of the database to create when the DB instance is created. If this parameter isn't specified, the default "postgres" database is created in the DB instance.

Constraints:

  • Must contain 1 to 63 letters, numbers, or underscores.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

  • Can't be a word reserved by the specified database engine

Oracle

The Oracle System ID (SID) of the created DB instance. If you specify null, the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName.

Default: ORCL

Constraints:

  • Can't be longer than 8 characters

SQL Server

Not applicable. Must be null.

Amazon Aurora

The name of the database to create when the primary instance of the DB cluster is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Can't be a word reserved by the specified database engine

Definition at line 179 of file CreateDBInstanceRequest.h.

◆ SetDBName() [3/3]

void Aws::RDS::Model::CreateDBInstanceRequest::SetDBName ( const char *  value)
inline

The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

  • Can't be a word reserved by the specified database engine

MariaDB

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

  • Can't be a word reserved by the specified database engine

PostgreSQL

The name of the database to create when the DB instance is created. If this parameter isn't specified, the default "postgres" database is created in the DB instance.

Constraints:

  • Must contain 1 to 63 letters, numbers, or underscores.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

  • Can't be a word reserved by the specified database engine

Oracle

The Oracle System ID (SID) of the created DB instance. If you specify null, the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName.

Default: ORCL

Constraints:

  • Can't be longer than 8 characters

SQL Server

Not applicable. Must be null.

Amazon Aurora

The name of the database to create when the primary instance of the DB cluster is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Can't be a word reserved by the specified database engine

Definition at line 213 of file CreateDBInstanceRequest.h.

◆ SetDBParameterGroupName() [1/3]

void Aws::RDS::Model::CreateDBInstanceRequest::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, then the default DB parameter group for the specified DB engine and version is used.

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 1495 of file CreateDBInstanceRequest.h.

◆ SetDBParameterGroupName() [2/3]

void Aws::RDS::Model::CreateDBInstanceRequest::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, then the default DB parameter group for the specified DB engine and version is used.

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 1505 of file CreateDBInstanceRequest.h.

◆ SetDBParameterGroupName() [3/3]

void Aws::RDS::Model::CreateDBInstanceRequest::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, then the default DB parameter group for the specified DB engine and version is used.

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 1515 of file CreateDBInstanceRequest.h.

◆ SetDBSecurityGroups() [1/2]

void Aws::RDS::Model::CreateDBInstanceRequest::SetDBSecurityGroups ( const Aws::Vector< Aws::String > &  value)
inline

A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.

Definition at line 1072 of file CreateDBInstanceRequest.h.

◆ SetDBSecurityGroups() [2/2]

void Aws::RDS::Model::CreateDBInstanceRequest::SetDBSecurityGroups ( Aws::Vector< Aws::String > &&  value)
inline

A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.

Definition at line 1078 of file CreateDBInstanceRequest.h.

◆ SetDBSubnetGroupName() [1/3]

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

A DB subnet group to associate with this DB instance.

If there is no DB subnet group, then it is a non-VPC DB instance.

Definition at line 1337 of file CreateDBInstanceRequest.h.

◆ SetDBSubnetGroupName() [2/3]

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

A DB subnet group to associate with this DB instance.

If there is no DB subnet group, then it is a non-VPC DB instance.

Definition at line 1343 of file CreateDBInstanceRequest.h.

◆ SetDBSubnetGroupName() [3/3]

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

A DB subnet group to associate with this DB instance.

If there is no DB subnet group, then it is a non-VPC DB instance.

Definition at line 1349 of file CreateDBInstanceRequest.h.

◆ SetDeletionProtection()

void Aws::RDS::Model::CreateDBInstanceRequest::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.

Amazon Aurora

Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see CreateDBCluster. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.

Definition at line 3682 of file CreateDBInstanceRequest.h.

◆ SetDomain() [1/3]

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

◆ SetDomain() [2/3]

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

◆ SetDomain() [3/3]

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

◆ SetDomainIAMRoleName() [1/3]

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

◆ SetDomainIAMRoleName() [2/3]

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

◆ SetDomainIAMRoleName() [3/3]

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

◆ SetEnableCloudwatchLogsExports() [1/2]

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

The list of log types that need to be enabled for exporting 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 Relational Database Service User Guide.

MariaDB

Possible values are audit, error, general, and slowquery.

Microsoft SQL Server

Possible values are agent and error.

MySQL

Possible values are audit, error, general, and slowquery.

Oracle

Possible values are alert, audit, listener, and trace.

PostgreSQL

Possible values are postgresql and upgrade.

Definition at line 3485 of file CreateDBInstanceRequest.h.

◆ SetEnableCloudwatchLogsExports() [2/2]

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

The list of log types that need to be enabled for exporting 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 Relational Database Service User Guide.

MariaDB

Possible values are audit, error, general, and slowquery.

Microsoft SQL Server

Possible values are agent and error.

MySQL

Possible values are audit, error, general, and slowquery.

Oracle

Possible values are alert, audit, listener, and trace.

PostgreSQL

Possible values are postgresql and upgrade.

Definition at line 3503 of file CreateDBInstanceRequest.h.

◆ SetEnableIAMDatabaseAuthentication()

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

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

You can enable IAM database authentication for the following database engines:

Amazon Aurora

Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.

MySQL

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

  • For MySQL 8.0, minor version 8.0.16 or higher

PostgreSQL

  • For PostgreSQL 9.5, minor version 9.5.15 or higher

  • For PostgreSQL 9.6, minor version 9.6.11 or higher

  • PostgreSQL 10.6, 10.7, and 10.9

For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

Definition at line 3268 of file CreateDBInstanceRequest.h.

◆ SetEnablePerformanceInsights()

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

A value that indicates whether to enable Performance Insights for the DB instance.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

Definition at line 3315 of file CreateDBInstanceRequest.h.

◆ SetEngine() [1/3]

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

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

Not every database engine is available for every AWS Region.

Valid Values:

  • aurora (for MySQL 5.6-compatible Aurora)

  • aurora-mysql (for MySQL 5.7-compatible Aurora)

  • aurora-postgresql

  • mariadb

  • mysql

  • oracle-ee

  • oracle-se2

  • oracle-se1

  • oracle-se

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

Definition at line 675 of file CreateDBInstanceRequest.h.

◆ SetEngine() [2/3]

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

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

Not every database engine is available for every AWS Region.

Valid Values:

  • aurora (for MySQL 5.6-compatible Aurora)

  • aurora-mysql (for MySQL 5.7-compatible Aurora)

  • aurora-postgresql

  • mariadb

  • mysql

  • oracle-ee

  • oracle-se2

  • oracle-se1

  • oracle-se

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

Definition at line 691 of file CreateDBInstanceRequest.h.

◆ SetEngine() [3/3]

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

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

Not every database engine is available for every AWS Region.

Valid Values:

  • aurora (for MySQL 5.6-compatible Aurora)

  • aurora-mysql (for MySQL 5.7-compatible Aurora)

  • aurora-postgresql

  • mariadb

  • mysql

  • oracle-ee

  • oracle-se2

  • oracle-se1

  • oracle-se

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

Definition at line 707 of file CreateDBInstanceRequest.h.

◆ SetEngineVersion() [1/3]

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

The version number of the database engine to use.

For a list of valid engine versions, use the DescribeDBEngineVersions action.

The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.

Amazon Aurora

Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.

MariaDB

See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.

Microsoft SQL Server

See Version and Feature Support on Amazon RDS in the Amazon RDS User Guide.

MySQL

See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.

Oracle

See Oracle Database Engine Release Notes in the Amazon RDS User Guide.

PostgreSQL

See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.

Definition at line 1917 of file CreateDBInstanceRequest.h.

◆ SetEngineVersion() [2/3]

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

The version number of the database engine to use.

For a list of valid engine versions, use the DescribeDBEngineVersions action.

The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.

Amazon Aurora

Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.

MariaDB

See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.

Microsoft SQL Server

See Version and Feature Support on Amazon RDS in the Amazon RDS User Guide.

MySQL

See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.

Oracle

See Oracle Database Engine Release Notes in the Amazon RDS User Guide.

PostgreSQL

See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.

Definition at line 1942 of file CreateDBInstanceRequest.h.

◆ SetEngineVersion() [3/3]

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

The version number of the database engine to use.

For a list of valid engine versions, use the DescribeDBEngineVersions action.

The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.

Amazon Aurora

Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.

MariaDB

See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.

Microsoft SQL Server

See Version and Feature Support on Amazon RDS in the Amazon RDS User Guide.

MySQL

See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.

Oracle

See Oracle Database Engine Release Notes in the Amazon RDS User Guide.

PostgreSQL

See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.

Definition at line 1967 of file CreateDBInstanceRequest.h.

◆ SetIops()

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

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.

Definition at line 2168 of file CreateDBInstanceRequest.h.

◆ SetKmsKeyId() [1/3]

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

The AWS KMS key identifier for an encrypted DB instance.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

Amazon Aurora

Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.

If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

Definition at line 2736 of file CreateDBInstanceRequest.h.

◆ SetKmsKeyId() [2/3]

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

The AWS KMS key identifier for an encrypted DB instance.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

Amazon Aurora

Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.

If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

Definition at line 2751 of file CreateDBInstanceRequest.h.

◆ SetKmsKeyId() [3/3]

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

The AWS KMS key identifier for an encrypted DB instance.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

Amazon Aurora

Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.

If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

Definition at line 2766 of file CreateDBInstanceRequest.h.

◆ SetLicenseModel() [1/3]

void Aws::RDS::Model::CreateDBInstanceRequest::SetLicenseModel ( const Aws::String value)
inline

License model information for this DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

Definition at line 2093 of file CreateDBInstanceRequest.h.

◆ SetLicenseModel() [2/3]

void Aws::RDS::Model::CreateDBInstanceRequest::SetLicenseModel ( Aws::String &&  value)
inline

License model information for this DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

Definition at line 2100 of file CreateDBInstanceRequest.h.

◆ SetLicenseModel() [3/3]

void Aws::RDS::Model::CreateDBInstanceRequest::SetLicenseModel ( const char *  value)
inline

License model information for this DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

Definition at line 2107 of file CreateDBInstanceRequest.h.

◆ SetMasterUsername() [1/3]

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

The name for the master user.

Amazon Aurora

Not applicable. The name for the master user is managed by the DB cluster.

MariaDB

Constraints:

  • Required for MariaDB.

  • Must be 1 to 16 letters or numbers.

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

Microsoft SQL Server

Constraints:

  • Required for SQL Server.

  • Must be 1 to 128 letters or numbers.

  • The first character must be a letter.

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

MySQL

Constraints:

  • Required for MySQL.

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

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

Oracle

Constraints:

  • Required for Oracle.

  • Must be 1 to 30 letters or numbers.

  • First character must be a letter.

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

PostgreSQL

Constraints:

  • Required for PostgreSQL.

  • Must be 1 to 63 letters or numbers.

  • First character must be a letter.

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

Definition at line 828 of file CreateDBInstanceRequest.h.

◆ SetMasterUsername() [2/3]

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

The name for the master user.

Amazon Aurora

Not applicable. The name for the master user is managed by the DB cluster.

MariaDB

Constraints:

  • Required for MariaDB.

  • Must be 1 to 16 letters or numbers.

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

Microsoft SQL Server

Constraints:

  • Required for SQL Server.

  • Must be 1 to 128 letters or numbers.

  • The first character must be a letter.

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

MySQL

Constraints:

  • Required for MySQL.

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

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

Oracle

Constraints:

  • Required for Oracle.

  • Must be 1 to 30 letters or numbers.

  • First character must be a letter.

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

PostgreSQL

Constraints:

  • Required for PostgreSQL.

  • Must be 1 to 63 letters or numbers.

  • First character must be a letter.

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

Definition at line 852 of file CreateDBInstanceRequest.h.

◆ SetMasterUsername() [3/3]

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

The name for the master user.

Amazon Aurora

Not applicable. The name for the master user is managed by the DB cluster.

MariaDB

Constraints:

  • Required for MariaDB.

  • Must be 1 to 16 letters or numbers.

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

Microsoft SQL Server

Constraints:

  • Required for SQL Server.

  • Must be 1 to 128 letters or numbers.

  • The first character must be a letter.

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

MySQL

Constraints:

  • Required for MySQL.

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

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

Oracle

Constraints:

  • Required for Oracle.

  • Must be 1 to 30 letters or numbers.

  • First character must be a letter.

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

PostgreSQL

Constraints:

  • Required for PostgreSQL.

  • Must be 1 to 63 letters or numbers.

  • First character must be a letter.

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

Definition at line 876 of file CreateDBInstanceRequest.h.

◆ SetMasterUserPassword() [1/3]

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

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

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster.

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Definition at line 988 of file CreateDBInstanceRequest.h.

◆ SetMasterUserPassword() [2/3]

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

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

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster.

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Definition at line 1001 of file CreateDBInstanceRequest.h.

◆ SetMasterUserPassword() [3/3]

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

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

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster.

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Definition at line 1014 of file CreateDBInstanceRequest.h.

◆ SetMaxAllocatedStorage()

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

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

Definition at line 3714 of file CreateDBInstanceRequest.h.

◆ SetMonitoringInterval()

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

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. 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 2949 of file CreateDBInstanceRequest.h.

◆ SetMonitoringRoleArn() [1/3]

void Aws::RDS::Model::CreateDBInstanceRequest::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 Setting Up and Enabling 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 2995 of file CreateDBInstanceRequest.h.

◆ SetMonitoringRoleArn() [2/3]

void Aws::RDS::Model::CreateDBInstanceRequest::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 Setting Up and Enabling 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 3007 of file CreateDBInstanceRequest.h.

◆ SetMonitoringRoleArn() [3/3]

void Aws::RDS::Model::CreateDBInstanceRequest::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 Setting Up and Enabling 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 3019 of file CreateDBInstanceRequest.h.

◆ SetMultiAZ()

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

A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

Definition at line 1834 of file CreateDBInstanceRequest.h.

◆ SetOptionGroupName() [1/3]

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

Indicates that the DB instance should be associated with the specified option group.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance

Definition at line 2206 of file CreateDBInstanceRequest.h.

◆ SetOptionGroupName() [2/3]

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

Indicates that the DB instance should be associated with the specified option group.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance

Definition at line 2214 of file CreateDBInstanceRequest.h.

◆ SetOptionGroupName() [3/3]

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

Indicates that the DB instance should be associated with the specified option group.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance

Definition at line 2222 of file CreateDBInstanceRequest.h.

◆ SetPerformanceInsightsKMSKeyId() [1/3]

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

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

Definition at line 3355 of file CreateDBInstanceRequest.h.

◆ SetPerformanceInsightsKMSKeyId() [2/3]

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

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

Definition at line 3365 of file CreateDBInstanceRequest.h.

◆ SetPerformanceInsightsKMSKeyId() [3/3]

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

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

Definition at line 3375 of file CreateDBInstanceRequest.h.

◆ SetPerformanceInsightsRetentionPeriod()

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

◆ SetPort()

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

The port number on which the database accepts connections.

MySQL

Default: 3306

Valid values: 1150-65535

Type: Integer

MariaDB

Default: 3306

Valid values: 1150-65535

Type: Integer

PostgreSQL

Default: 5432

Valid values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid values: 1150-65535

SQL Server

Default: 1433

Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156.

Amazon Aurora

Default: 3306

Valid values: 1150-65535

Type: Integer

Definition at line 1795 of file CreateDBInstanceRequest.h.

◆ SetPreferredBackupWindow() [1/3]

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

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see The Backup Window in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide.

Constraints:

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

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 1648 of file CreateDBInstanceRequest.h.

◆ SetPreferredBackupWindow() [2/3]

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

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see The Backup Window in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide.

Constraints:

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

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 1667 of file CreateDBInstanceRequest.h.

◆ SetPreferredBackupWindow() [3/3]

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

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see The Backup Window in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide.

Constraints:

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

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 1686 of file CreateDBInstanceRequest.h.

◆ SetPreferredMaintenanceWindow() [1/3]

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

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window.

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

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

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

Constraints: Minimum 30-minute window.

Definition at line 1404 of file CreateDBInstanceRequest.h.

◆ SetPreferredMaintenanceWindow() [2/3]

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

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window.

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

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

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

Constraints: Minimum 30-minute window.

Definition at line 1416 of file CreateDBInstanceRequest.h.

◆ SetPreferredMaintenanceWindow() [3/3]

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

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window.

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

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

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

Constraints: Minimum 30-minute window.

Definition at line 1428 of file CreateDBInstanceRequest.h.

◆ SetProcessorFeatures() [1/2]

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

◆ SetProcessorFeatures() [2/2]

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

◆ SetPromotionTier()

void Aws::RDS::Model::CreateDBInstanceRequest::SetPromotionTier ( int  value)
inline

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

Default: 1

Valid Values: 0 - 15

Definition at line 3135 of file CreateDBInstanceRequest.h.

◆ SetPubliclyAccessible()

void Aws::RDS::Model::CreateDBInstanceRequest::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.

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

  • If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private.

  • If the default VPC in the target region has an Internet gateway attached to it, the DB instance is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

  • If the subnets are part of a VPC that doesn’t have an Internet gateway attached to it, the DB instance is private.

  • If the subnets are part of a VPC that has an Internet gateway attached to it, the DB instance is public.

Definition at line 2384 of file CreateDBInstanceRequest.h.

◆ SetStorageEncrypted()

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

A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.

Amazon Aurora

Not applicable. The encryption for DB instances is managed by the DB cluster.

Definition at line 2683 of file CreateDBInstanceRequest.h.

◆ SetStorageType() [1/3]

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

Specifies the storage type to be associated with the DB instance.

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 2518 of file CreateDBInstanceRequest.h.

◆ SetStorageType() [2/3]

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

Specifies the storage type to be associated with the DB instance.

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 2527 of file CreateDBInstanceRequest.h.

◆ SetStorageType() [3/3]

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

Specifies the storage type to be associated with the DB instance.

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 2536 of file CreateDBInstanceRequest.h.

◆ SetTags() [1/2]

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

Tags to assign to the DB instance.

Definition at line 2424 of file CreateDBInstanceRequest.h.

◆ SetTags() [2/2]

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

Tags to assign to the DB instance.

Definition at line 2429 of file CreateDBInstanceRequest.h.

◆ SetTdeCredentialArn() [1/3]

void Aws::RDS::Model::CreateDBInstanceRequest::SetTdeCredentialArn ( const Aws::String value)
inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 2582 of file CreateDBInstanceRequest.h.

◆ SetTdeCredentialArn() [2/3]

void Aws::RDS::Model::CreateDBInstanceRequest::SetTdeCredentialArn ( Aws::String &&  value)
inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 2588 of file CreateDBInstanceRequest.h.

◆ SetTdeCredentialArn() [3/3]

void Aws::RDS::Model::CreateDBInstanceRequest::SetTdeCredentialArn ( const char *  value)
inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 2594 of file CreateDBInstanceRequest.h.

◆ SetTdeCredentialPassword() [1/3]

void Aws::RDS::Model::CreateDBInstanceRequest::SetTdeCredentialPassword ( const Aws::String value)
inline

The password for the given ARN from the key store in order to access the device.

Definition at line 2631 of file CreateDBInstanceRequest.h.

◆ SetTdeCredentialPassword() [2/3]

void Aws::RDS::Model::CreateDBInstanceRequest::SetTdeCredentialPassword ( Aws::String &&  value)
inline

The password for the given ARN from the key store in order to access the device.

Definition at line 2637 of file CreateDBInstanceRequest.h.

◆ SetTdeCredentialPassword() [3/3]

void Aws::RDS::Model::CreateDBInstanceRequest::SetTdeCredentialPassword ( const char *  value)
inline

The password for the given ARN from the key store in order to access the device.

Definition at line 2643 of file CreateDBInstanceRequest.h.

◆ SetTimezone() [1/3]

void Aws::RDS::Model::CreateDBInstanceRequest::SetTimezone ( const Aws::String value)
inline

The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.

Definition at line 3170 of file CreateDBInstanceRequest.h.

◆ SetTimezone() [2/3]

void Aws::RDS::Model::CreateDBInstanceRequest::SetTimezone ( Aws::String &&  value)
inline

The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.

Definition at line 3178 of file CreateDBInstanceRequest.h.

◆ SetTimezone() [3/3]

void Aws::RDS::Model::CreateDBInstanceRequest::SetTimezone ( const char *  value)
inline

The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.

Definition at line 3186 of file CreateDBInstanceRequest.h.

◆ SetVpcSecurityGroupIds() [1/2]

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

A list of Amazon EC2 VPC security groups to associate with this DB instance.

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster.

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

Definition at line 1133 of file CreateDBInstanceRequest.h.

◆ SetVpcSecurityGroupIds() [2/2]

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

A list of Amazon EC2 VPC security groups to associate with this DB instance.

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster.

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

Definition at line 1141 of file CreateDBInstanceRequest.h.

◆ StorageEncryptedHasBeenSet()

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

A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.

Amazon Aurora

Not applicable. The encryption for DB instances is managed by the DB cluster.

Definition at line 2676 of file CreateDBInstanceRequest.h.

◆ StorageTypeHasBeenSet()

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

Specifies the storage type to be associated with the DB instance.

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 2509 of file CreateDBInstanceRequest.h.

◆ TagsHasBeenSet()

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

Tags to assign to the DB instance.

Definition at line 2419 of file CreateDBInstanceRequest.h.

◆ TdeCredentialArnHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceRequest::TdeCredentialArnHasBeenSet ( ) const
inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 2576 of file CreateDBInstanceRequest.h.

◆ TdeCredentialPasswordHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceRequest::TdeCredentialPasswordHasBeenSet ( ) const
inline

The password for the given ARN from the key store in order to access the device.

Definition at line 2625 of file CreateDBInstanceRequest.h.

◆ TimezoneHasBeenSet()

bool Aws::RDS::Model::CreateDBInstanceRequest::TimezoneHasBeenSet ( ) const
inline

The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.

Definition at line 3162 of file CreateDBInstanceRequest.h.

◆ VpcSecurityGroupIdsHasBeenSet()

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

A list of Amazon EC2 VPC security groups to associate with this DB instance.

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster.

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

Definition at line 1125 of file CreateDBInstanceRequest.h.

◆ WithAllocatedStorage()

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::WithAllocatedStorage ( int  value)
inline

The amount of storage (in gibibytes) to allocate for the DB instance.

Type: Integer

Amazon Aurora

Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.

MySQL

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

  • Magnetic storage (standard): Must be an integer from 5 to 3072.

MariaDB

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

  • Magnetic storage (standard): Must be an integer from 5 to 3072.

PostgreSQL

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

  • Magnetic storage (standard): Must be an integer from 5 to 3072.

Oracle

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

  • Magnetic storage (standard): Must be an integer from 10 to 3072.

SQL Server

Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp2):

    • Enterprise and Standard editions: Must be an integer from 200 to 16384.

    • Web and Express editions: Must be an integer from 20 to 16384.

  • Provisioned IOPS storage (io1):

    • Enterprise and Standard editions: Must be an integer from 200 to 16384.

    • Web and Express editions: Must be an integer from 100 to 16384.

  • Magnetic storage (standard):

    • Enterprise and Standard editions: Must be an integer from 200 to 1024.

    • Web and Express editions: Must be an integer from 20 to 1024.

Definition at line 545 of file CreateDBInstanceRequest.h.

◆ WithAutoMinorVersionUpgrade()

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

A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.

Definition at line 2071 of file CreateDBInstanceRequest.h.

◆ WithAvailabilityZone() [1/3]

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

The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.

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

Example: us-east-1d

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint.

If you're creating a DB instance in an RDS on VMware environment, specify the identifier of the custom Availability Zone to create the DB instance in.

For more information about RDS on VMware, see the RDS on VMware User Guide.

Definition at line 1284 of file CreateDBInstanceRequest.h.

◆ WithAvailabilityZone() [2/3]

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

The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.

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

Example: us-east-1d

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint.

If you're creating a DB instance in an RDS on VMware environment, specify the identifier of the custom Availability Zone to create the DB instance in.

For more information about RDS on VMware, see the RDS on VMware User Guide.

Definition at line 1301 of file CreateDBInstanceRequest.h.

◆ WithAvailabilityZone() [3/3]

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

The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.

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

Example: us-east-1d

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint.

If you're creating a DB instance in an RDS on VMware environment, specify the identifier of the custom Availability Zone to create the DB instance in.

For more information about RDS on VMware, see the RDS on VMware User Guide.

Definition at line 1318 of file CreateDBInstanceRequest.h.

◆ WithBackupRetentionPeriod()

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

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Amazon Aurora

Not applicable. The retention period for automated backups is managed by the DB cluster.

Default: 1

Constraints:

  • Must be a value from 0 to 35

  • Can't be set to 0 if the DB instance is a source to read replicas

Definition at line 1590 of file CreateDBInstanceRequest.h.

◆ WithCharacterSetName() [1/3]

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

For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.

Amazon Aurora

Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.

Definition at line 2295 of file CreateDBInstanceRequest.h.

◆ WithCharacterSetName() [2/3]

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

For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.

Amazon Aurora

Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.

Definition at line 2303 of file CreateDBInstanceRequest.h.

◆ WithCharacterSetName() [3/3]

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

For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.

Amazon Aurora

Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.

Definition at line 2311 of file CreateDBInstanceRequest.h.

◆ WithCopyTagsToSnapshot()

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

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.

Definition at line 2921 of file CreateDBInstanceRequest.h.

◆ WithDBClusterIdentifier() [1/3]

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

The identifier of the DB cluster that the instance will belong to.

Definition at line 2480 of file CreateDBInstanceRequest.h.

◆ WithDBClusterIdentifier() [2/3]

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

The identifier of the DB cluster that the instance will belong to.

Definition at line 2485 of file CreateDBInstanceRequest.h.

◆ WithDBClusterIdentifier() [3/3]

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

The identifier of the DB cluster that the instance will belong to.

Definition at line 2490 of file CreateDBInstanceRequest.h.

◆ WithDBInstanceClass() [1/3]

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

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS 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.

Definition at line 606 of file CreateDBInstanceRequest.h.

◆ WithDBInstanceClass() [2/3]

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

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS 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.

Definition at line 616 of file CreateDBInstanceRequest.h.

◆ WithDBInstanceClass() [3/3]

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

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS 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.

Definition at line 626 of file CreateDBInstanceRequest.h.

◆ WithDBInstanceIdentifier() [1/3]

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

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

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

Example: mydbinstance

Definition at line 370 of file CreateDBInstanceRequest.h.

◆ WithDBInstanceIdentifier() [2/3]

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

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

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

Example: mydbinstance

Definition at line 379 of file CreateDBInstanceRequest.h.

◆ WithDBInstanceIdentifier() [3/3]

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

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

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

Example: mydbinstance

Definition at line 388 of file CreateDBInstanceRequest.h.

◆ WithDBName() [1/3]

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::WithDBName ( const Aws::String value)
inline

The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

  • Can't be a word reserved by the specified database engine

MariaDB

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

  • Can't be a word reserved by the specified database engine

PostgreSQL

The name of the database to create when the DB instance is created. If this parameter isn't specified, the default "postgres" database is created in the DB instance.

Constraints:

  • Must contain 1 to 63 letters, numbers, or underscores.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

  • Can't be a word reserved by the specified database engine

Oracle

The Oracle System ID (SID) of the created DB instance. If you specify null, the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName.

Default: ORCL

Constraints:

  • Can't be longer than 8 characters

SQL Server

Not applicable. Must be null.

Amazon Aurora

The name of the database to create when the primary instance of the DB cluster is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Can't be a word reserved by the specified database engine

Definition at line 247 of file CreateDBInstanceRequest.h.

◆ WithDBName() [2/3]

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::WithDBName ( Aws::String &&  value)
inline

The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

  • Can't be a word reserved by the specified database engine

MariaDB

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

  • Can't be a word reserved by the specified database engine

PostgreSQL

The name of the database to create when the DB instance is created. If this parameter isn't specified, the default "postgres" database is created in the DB instance.

Constraints:

  • Must contain 1 to 63 letters, numbers, or underscores.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

  • Can't be a word reserved by the specified database engine

Oracle

The Oracle System ID (SID) of the created DB instance. If you specify null, the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName.

Default: ORCL

Constraints:

  • Can't be longer than 8 characters

SQL Server

Not applicable. Must be null.

Amazon Aurora

The name of the database to create when the primary instance of the DB cluster is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Can't be a word reserved by the specified database engine

Definition at line 281 of file CreateDBInstanceRequest.h.

◆ WithDBName() [3/3]

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::WithDBName ( const char *  value)
inline

The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

  • Can't be a word reserved by the specified database engine

MariaDB

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

  • Can't be a word reserved by the specified database engine

PostgreSQL

The name of the database to create when the DB instance is created. If this parameter isn't specified, the default "postgres" database is created in the DB instance.

Constraints:

  • Must contain 1 to 63 letters, numbers, or underscores.

  • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).

  • Can't be a word reserved by the specified database engine

Oracle

The Oracle System ID (SID) of the created DB instance. If you specify null, the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName.

Default: ORCL

Constraints:

  • Can't be longer than 8 characters

SQL Server

Not applicable. Must be null.

Amazon Aurora

The name of the database to create when the primary instance of the DB cluster is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 letters or numbers.

  • Can't be a word reserved by the specified database engine

Definition at line 315 of file CreateDBInstanceRequest.h.

◆ WithDBParameterGroupName() [1/3]

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::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, then the default DB parameter group for the specified DB engine and version is used.

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 1525 of file CreateDBInstanceRequest.h.

◆ WithDBParameterGroupName() [2/3]

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::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, then the default DB parameter group for the specified DB engine and version is used.

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 1535 of file CreateDBInstanceRequest.h.

◆ WithDBParameterGroupName() [3/3]

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::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, then the default DB parameter group for the specified DB engine and version is used.

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 1545 of file CreateDBInstanceRequest.h.

◆ WithDBSecurityGroups() [1/2]

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::WithDBSecurityGroups ( const Aws::Vector< Aws::String > &  value)
inline

A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.

Definition at line 1084 of file CreateDBInstanceRequest.h.

◆ WithDBSecurityGroups() [2/2]

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::WithDBSecurityGroups ( Aws::Vector< Aws::String > &&  value)
inline

A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.

Definition at line 1090 of file CreateDBInstanceRequest.h.

◆ WithDBSubnetGroupName() [1/3]

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

A DB subnet group to associate with this DB instance.

If there is no DB subnet group, then it is a non-VPC DB instance.

Definition at line 1355 of file CreateDBInstanceRequest.h.

◆ WithDBSubnetGroupName() [2/3]

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

A DB subnet group to associate with this DB instance.

If there is no DB subnet group, then it is a non-VPC DB instance.

Definition at line 1361 of file CreateDBInstanceRequest.h.

◆ WithDBSubnetGroupName() [3/3]

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

A DB subnet group to associate with this DB instance.

If there is no DB subnet group, then it is a non-VPC DB instance.

Definition at line 1367 of file CreateDBInstanceRequest.h.

◆ WithDeletionProtection()

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::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.

Amazon Aurora

Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see CreateDBCluster. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.

Definition at line 3695 of file CreateDBInstanceRequest.h.

◆ WithDomain() [1/3]

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

◆ WithDomain() [2/3]

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

◆ WithDomain() [3/3]

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

◆ WithDomainIAMRoleName() [1/3]

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

◆ WithDomainIAMRoleName() [2/3]

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

◆ WithDomainIAMRoleName() [3/3]

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

◆ WithEnableCloudwatchLogsExports() [1/2]

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

The list of log types that need to be enabled for exporting 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 Relational Database Service User Guide.

MariaDB

Possible values are audit, error, general, and slowquery.

Microsoft SQL Server

Possible values are agent and error.

MySQL

Possible values are audit, error, general, and slowquery.

Oracle

Possible values are alert, audit, listener, and trace.

PostgreSQL

Possible values are postgresql and upgrade.

Definition at line 3521 of file CreateDBInstanceRequest.h.

◆ WithEnableCloudwatchLogsExports() [2/2]

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

The list of log types that need to be enabled for exporting 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 Relational Database Service User Guide.

MariaDB

Possible values are audit, error, general, and slowquery.

Microsoft SQL Server

Possible values are agent and error.

MySQL

Possible values are audit, error, general, and slowquery.

Oracle

Possible values are alert, audit, listener, and trace.

PostgreSQL

Possible values are postgresql and upgrade.

Definition at line 3539 of file CreateDBInstanceRequest.h.

◆ WithEnableIAMDatabaseAuthentication()

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

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

You can enable IAM database authentication for the following database engines:

Amazon Aurora

Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.

MySQL

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

  • For MySQL 8.0, minor version 8.0.16 or higher

PostgreSQL

  • For PostgreSQL 9.5, minor version 9.5.15 or higher

  • For PostgreSQL 9.6, minor version 9.6.11 or higher

  • PostgreSQL 10.6, 10.7, and 10.9

For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

Definition at line 3287 of file CreateDBInstanceRequest.h.

◆ WithEnablePerformanceInsights()

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

A value that indicates whether to enable Performance Insights for the DB instance.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

Definition at line 3324 of file CreateDBInstanceRequest.h.

◆ WithEngine() [1/3]

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

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

Not every database engine is available for every AWS Region.

Valid Values:

  • aurora (for MySQL 5.6-compatible Aurora)

  • aurora-mysql (for MySQL 5.7-compatible Aurora)

  • aurora-postgresql

  • mariadb

  • mysql

  • oracle-ee

  • oracle-se2

  • oracle-se1

  • oracle-se

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

Definition at line 723 of file CreateDBInstanceRequest.h.

◆ WithEngine() [2/3]

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

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

Not every database engine is available for every AWS Region.

Valid Values:

  • aurora (for MySQL 5.6-compatible Aurora)

  • aurora-mysql (for MySQL 5.7-compatible Aurora)

  • aurora-postgresql

  • mariadb

  • mysql

  • oracle-ee

  • oracle-se2

  • oracle-se1

  • oracle-se

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

Definition at line 739 of file CreateDBInstanceRequest.h.

◆ WithEngine() [3/3]

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

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

Not every database engine is available for every AWS Region.

Valid Values:

  • aurora (for MySQL 5.6-compatible Aurora)

  • aurora-mysql (for MySQL 5.7-compatible Aurora)

  • aurora-postgresql

  • mariadb

  • mysql

  • oracle-ee

  • oracle-se2

  • oracle-se1

  • oracle-se

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

Definition at line 755 of file CreateDBInstanceRequest.h.

◆ WithEngineVersion() [1/3]

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

The version number of the database engine to use.

For a list of valid engine versions, use the DescribeDBEngineVersions action.

The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.

Amazon Aurora

Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.

MariaDB

See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.

Microsoft SQL Server

See Version and Feature Support on Amazon RDS in the Amazon RDS User Guide.

MySQL

See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.

Oracle

See Oracle Database Engine Release Notes in the Amazon RDS User Guide.

PostgreSQL

See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.

Definition at line 1992 of file CreateDBInstanceRequest.h.

◆ WithEngineVersion() [2/3]

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

The version number of the database engine to use.

For a list of valid engine versions, use the DescribeDBEngineVersions action.

The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.

Amazon Aurora

Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.

MariaDB

See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.

Microsoft SQL Server

See Version and Feature Support on Amazon RDS in the Amazon RDS User Guide.

MySQL

See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.

Oracle

See Oracle Database Engine Release Notes in the Amazon RDS User Guide.

PostgreSQL

See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.

Definition at line 2017 of file CreateDBInstanceRequest.h.

◆ WithEngineVersion() [3/3]

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

The version number of the database engine to use.

For a list of valid engine versions, use the DescribeDBEngineVersions action.

The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.

Amazon Aurora

Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.

MariaDB

See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.

Microsoft SQL Server

See Version and Feature Support on Amazon RDS in the Amazon RDS User Guide.

MySQL

See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.

Oracle

See Oracle Database Engine Release Notes in the Amazon RDS User Guide.

PostgreSQL

See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.

Definition at line 2042 of file CreateDBInstanceRequest.h.

◆ WithIops()

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

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.

Definition at line 2181 of file CreateDBInstanceRequest.h.

◆ WithKmsKeyId() [1/3]

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

The AWS KMS key identifier for an encrypted DB instance.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

Amazon Aurora

Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.

If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

Definition at line 2781 of file CreateDBInstanceRequest.h.

◆ WithKmsKeyId() [2/3]

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

The AWS KMS key identifier for an encrypted DB instance.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

Amazon Aurora

Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.

If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

Definition at line 2796 of file CreateDBInstanceRequest.h.

◆ WithKmsKeyId() [3/3]

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

The AWS KMS key identifier for an encrypted DB instance.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

Amazon Aurora

Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.

If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

Definition at line 2811 of file CreateDBInstanceRequest.h.

◆ WithLicenseModel() [1/3]

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::WithLicenseModel ( const Aws::String value)
inline

License model information for this DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

Definition at line 2114 of file CreateDBInstanceRequest.h.

◆ WithLicenseModel() [2/3]

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::WithLicenseModel ( Aws::String &&  value)
inline

License model information for this DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

Definition at line 2121 of file CreateDBInstanceRequest.h.

◆ WithLicenseModel() [3/3]

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::WithLicenseModel ( const char *  value)
inline

License model information for this DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

Definition at line 2128 of file CreateDBInstanceRequest.h.

◆ WithMasterUsername() [1/3]

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

The name for the master user.

Amazon Aurora

Not applicable. The name for the master user is managed by the DB cluster.

MariaDB

Constraints:

  • Required for MariaDB.

  • Must be 1 to 16 letters or numbers.

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

Microsoft SQL Server

Constraints:

  • Required for SQL Server.

  • Must be 1 to 128 letters or numbers.

  • The first character must be a letter.

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

MySQL

Constraints:

  • Required for MySQL.

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

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

Oracle

Constraints:

  • Required for Oracle.

  • Must be 1 to 30 letters or numbers.

  • First character must be a letter.

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

PostgreSQL

Constraints:

  • Required for PostgreSQL.

  • Must be 1 to 63 letters or numbers.

  • First character must be a letter.

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

Definition at line 900 of file CreateDBInstanceRequest.h.

◆ WithMasterUsername() [2/3]

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

The name for the master user.

Amazon Aurora

Not applicable. The name for the master user is managed by the DB cluster.

MariaDB

Constraints:

  • Required for MariaDB.

  • Must be 1 to 16 letters or numbers.

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

Microsoft SQL Server

Constraints:

  • Required for SQL Server.

  • Must be 1 to 128 letters or numbers.

  • The first character must be a letter.

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

MySQL

Constraints:

  • Required for MySQL.

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

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

Oracle

Constraints:

  • Required for Oracle.

  • Must be 1 to 30 letters or numbers.

  • First character must be a letter.

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

PostgreSQL

Constraints:

  • Required for PostgreSQL.

  • Must be 1 to 63 letters or numbers.

  • First character must be a letter.

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

Definition at line 924 of file CreateDBInstanceRequest.h.

◆ WithMasterUsername() [3/3]

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

The name for the master user.

Amazon Aurora

Not applicable. The name for the master user is managed by the DB cluster.

MariaDB

Constraints:

  • Required for MariaDB.

  • Must be 1 to 16 letters or numbers.

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

Microsoft SQL Server

Constraints:

  • Required for SQL Server.

  • Must be 1 to 128 letters or numbers.

  • The first character must be a letter.

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

MySQL

Constraints:

  • Required for MySQL.

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

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

Oracle

Constraints:

  • Required for Oracle.

  • Must be 1 to 30 letters or numbers.

  • First character must be a letter.

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

PostgreSQL

Constraints:

  • Required for PostgreSQL.

  • Must be 1 to 63 letters or numbers.

  • First character must be a letter.

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

Definition at line 948 of file CreateDBInstanceRequest.h.

◆ WithMasterUserPassword() [1/3]

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

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

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster.

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Definition at line 1027 of file CreateDBInstanceRequest.h.

◆ WithMasterUserPassword() [2/3]

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

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

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster.

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Definition at line 1040 of file CreateDBInstanceRequest.h.

◆ WithMasterUserPassword() [3/3]

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

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

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster.

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Definition at line 1053 of file CreateDBInstanceRequest.h.

◆ WithMaxAllocatedStorage()

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

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

Definition at line 3720 of file CreateDBInstanceRequest.h.

◆ WithMonitoringInterval()

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

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. 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 2958 of file CreateDBInstanceRequest.h.

◆ WithMonitoringRoleArn() [1/3]

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::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 Setting Up and Enabling 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 3031 of file CreateDBInstanceRequest.h.

◆ WithMonitoringRoleArn() [2/3]

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::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 Setting Up and Enabling 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 3043 of file CreateDBInstanceRequest.h.

◆ WithMonitoringRoleArn() [3/3]

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::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 Setting Up and Enabling 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 3055 of file CreateDBInstanceRequest.h.

◆ WithMultiAZ()

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

A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

Definition at line 1841 of file CreateDBInstanceRequest.h.

◆ WithOptionGroupName() [1/3]

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

Indicates that the DB instance should be associated with the specified option group.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance

Definition at line 2230 of file CreateDBInstanceRequest.h.

◆ WithOptionGroupName() [2/3]

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

Indicates that the DB instance should be associated with the specified option group.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance

Definition at line 2238 of file CreateDBInstanceRequest.h.

◆ WithOptionGroupName() [3/3]

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

Indicates that the DB instance should be associated with the specified option group.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance

Definition at line 2246 of file CreateDBInstanceRequest.h.

◆ WithPerformanceInsightsKMSKeyId() [1/3]

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

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

Definition at line 3385 of file CreateDBInstanceRequest.h.

◆ WithPerformanceInsightsKMSKeyId() [2/3]

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

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

Definition at line 3395 of file CreateDBInstanceRequest.h.

◆ WithPerformanceInsightsKMSKeyId() [3/3]

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

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

Definition at line 3405 of file CreateDBInstanceRequest.h.

◆ WithPerformanceInsightsRetentionPeriod()

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

◆ WithPort()

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

The port number on which the database accepts connections.

MySQL

Default: 3306

Valid values: 1150-65535

Type: Integer

MariaDB

Default: 3306

Valid values: 1150-65535

Type: Integer

PostgreSQL

Default: 5432

Valid values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid values: 1150-65535

SQL Server

Default: 1433

Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156.

Amazon Aurora

Default: 3306

Valid values: 1150-65535

Type: Integer

Definition at line 1812 of file CreateDBInstanceRequest.h.

◆ WithPreferredBackupWindow() [1/3]

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

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see The Backup Window in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide.

Constraints:

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

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 1705 of file CreateDBInstanceRequest.h.

◆ WithPreferredBackupWindow() [2/3]

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

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see The Backup Window in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide.

Constraints:

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

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 1724 of file CreateDBInstanceRequest.h.

◆ WithPreferredBackupWindow() [3/3]

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

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see The Backup Window in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide.

Constraints:

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

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 1743 of file CreateDBInstanceRequest.h.

◆ WithPreferredMaintenanceWindow() [1/3]

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

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window.

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

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

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

Constraints: Minimum 30-minute window.

Definition at line 1440 of file CreateDBInstanceRequest.h.

◆ WithPreferredMaintenanceWindow() [2/3]

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

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window.

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

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

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

Constraints: Minimum 30-minute window.

Definition at line 1452 of file CreateDBInstanceRequest.h.

◆ WithPreferredMaintenanceWindow() [3/3]

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

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window.

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

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

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

Constraints: Minimum 30-minute window.

Definition at line 1464 of file CreateDBInstanceRequest.h.

◆ WithProcessorFeatures() [1/2]

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

◆ WithProcessorFeatures() [2/2]

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

◆ WithPromotionTier()

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::WithPromotionTier ( int  value)
inline

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

Default: 1

Valid Values: 0 - 15

Definition at line 3145 of file CreateDBInstanceRequest.h.

◆ WithPubliclyAccessible()

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::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.

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

  • If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private.

  • If the default VPC in the target region has an Internet gateway attached to it, the DB instance is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

  • If the subnets are part of a VPC that doesn’t have an Internet gateway attached to it, the DB instance is private.

  • If the subnets are part of a VPC that has an Internet gateway attached to it, the DB instance is public.

Definition at line 2408 of file CreateDBInstanceRequest.h.

◆ WithStorageEncrypted()

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

A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.

Amazon Aurora

Not applicable. The encryption for DB instances is managed by the DB cluster.

Definition at line 2690 of file CreateDBInstanceRequest.h.

◆ WithStorageType() [1/3]

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

Specifies the storage type to be associated with the DB instance.

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 2545 of file CreateDBInstanceRequest.h.

◆ WithStorageType() [2/3]

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

Specifies the storage type to be associated with the DB instance.

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 2554 of file CreateDBInstanceRequest.h.

◆ WithStorageType() [3/3]

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

Specifies the storage type to be associated with the DB instance.

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 2563 of file CreateDBInstanceRequest.h.

◆ WithTags() [1/2]

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

Tags to assign to the DB instance.

Definition at line 2434 of file CreateDBInstanceRequest.h.

◆ WithTags() [2/2]

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

Tags to assign to the DB instance.

Definition at line 2439 of file CreateDBInstanceRequest.h.

◆ WithTdeCredentialArn() [1/3]

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::WithTdeCredentialArn ( const Aws::String value)
inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 2600 of file CreateDBInstanceRequest.h.

◆ WithTdeCredentialArn() [2/3]

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::WithTdeCredentialArn ( Aws::String &&  value)
inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 2606 of file CreateDBInstanceRequest.h.

◆ WithTdeCredentialArn() [3/3]

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::WithTdeCredentialArn ( const char *  value)
inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 2612 of file CreateDBInstanceRequest.h.

◆ WithTdeCredentialPassword() [1/3]

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::WithTdeCredentialPassword ( const Aws::String value)
inline

The password for the given ARN from the key store in order to access the device.

Definition at line 2649 of file CreateDBInstanceRequest.h.

◆ WithTdeCredentialPassword() [2/3]

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::WithTdeCredentialPassword ( Aws::String &&  value)
inline

The password for the given ARN from the key store in order to access the device.

Definition at line 2655 of file CreateDBInstanceRequest.h.

◆ WithTdeCredentialPassword() [3/3]

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::WithTdeCredentialPassword ( const char *  value)
inline

The password for the given ARN from the key store in order to access the device.

Definition at line 2661 of file CreateDBInstanceRequest.h.

◆ WithTimezone() [1/3]

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::WithTimezone ( const Aws::String value)
inline

The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.

Definition at line 3194 of file CreateDBInstanceRequest.h.

◆ WithTimezone() [2/3]

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::WithTimezone ( Aws::String &&  value)
inline

The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.

Definition at line 3202 of file CreateDBInstanceRequest.h.

◆ WithTimezone() [3/3]

CreateDBInstanceRequest& Aws::RDS::Model::CreateDBInstanceRequest::WithTimezone ( const char *  value)
inline

The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.

Definition at line 3210 of file CreateDBInstanceRequest.h.

◆ WithVpcSecurityGroupIds() [1/2]

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

A list of Amazon EC2 VPC security groups to associate with this DB instance.

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster.

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

Definition at line 1149 of file CreateDBInstanceRequest.h.

◆ WithVpcSecurityGroupIds() [2/2]

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

A list of Amazon EC2 VPC security groups to associate with this DB instance.

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster.

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

Definition at line 1157 of file CreateDBInstanceRequest.h.


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