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

#include <CreateDBClusterRequest.h>

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

Public Member Functions

 CreateDBClusterRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::Vector< Aws::String > & GetAvailabilityZones () const
 
bool AvailabilityZonesHasBeenSet () const
 
void SetAvailabilityZones (const Aws::Vector< Aws::String > &value)
 
void SetAvailabilityZones (Aws::Vector< Aws::String > &&value)
 
CreateDBClusterRequestWithAvailabilityZones (const Aws::Vector< Aws::String > &value)
 
CreateDBClusterRequestWithAvailabilityZones (Aws::Vector< Aws::String > &&value)
 
CreateDBClusterRequestAddAvailabilityZones (const Aws::String &value)
 
CreateDBClusterRequestAddAvailabilityZones (Aws::String &&value)
 
CreateDBClusterRequestAddAvailabilityZones (const char *value)
 
int GetBackupRetentionPeriod () const
 
bool BackupRetentionPeriodHasBeenSet () const
 
void SetBackupRetentionPeriod (int value)
 
CreateDBClusterRequestWithBackupRetentionPeriod (int value)
 
const Aws::StringGetCharacterSetName () const
 
bool CharacterSetNameHasBeenSet () const
 
void SetCharacterSetName (const Aws::String &value)
 
void SetCharacterSetName (Aws::String &&value)
 
void SetCharacterSetName (const char *value)
 
CreateDBClusterRequestWithCharacterSetName (const Aws::String &value)
 
CreateDBClusterRequestWithCharacterSetName (Aws::String &&value)
 
CreateDBClusterRequestWithCharacterSetName (const char *value)
 
const Aws::StringGetDatabaseName () const
 
bool DatabaseNameHasBeenSet () const
 
void SetDatabaseName (const Aws::String &value)
 
void SetDatabaseName (Aws::String &&value)
 
void SetDatabaseName (const char *value)
 
CreateDBClusterRequestWithDatabaseName (const Aws::String &value)
 
CreateDBClusterRequestWithDatabaseName (Aws::String &&value)
 
CreateDBClusterRequestWithDatabaseName (const char *value)
 
const Aws::StringGetDBClusterIdentifier () const
 
bool DBClusterIdentifierHasBeenSet () const
 
void SetDBClusterIdentifier (const Aws::String &value)
 
void SetDBClusterIdentifier (Aws::String &&value)
 
void SetDBClusterIdentifier (const char *value)
 
CreateDBClusterRequestWithDBClusterIdentifier (const Aws::String &value)
 
CreateDBClusterRequestWithDBClusterIdentifier (Aws::String &&value)
 
CreateDBClusterRequestWithDBClusterIdentifier (const char *value)
 
const Aws::StringGetDBClusterParameterGroupName () const
 
bool DBClusterParameterGroupNameHasBeenSet () const
 
void SetDBClusterParameterGroupName (const Aws::String &value)
 
void SetDBClusterParameterGroupName (Aws::String &&value)
 
void SetDBClusterParameterGroupName (const char *value)
 
CreateDBClusterRequestWithDBClusterParameterGroupName (const Aws::String &value)
 
CreateDBClusterRequestWithDBClusterParameterGroupName (Aws::String &&value)
 
CreateDBClusterRequestWithDBClusterParameterGroupName (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)
 
CreateDBClusterRequestWithVpcSecurityGroupIds (const Aws::Vector< Aws::String > &value)
 
CreateDBClusterRequestWithVpcSecurityGroupIds (Aws::Vector< Aws::String > &&value)
 
CreateDBClusterRequestAddVpcSecurityGroupIds (const Aws::String &value)
 
CreateDBClusterRequestAddVpcSecurityGroupIds (Aws::String &&value)
 
CreateDBClusterRequestAddVpcSecurityGroupIds (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)
 
CreateDBClusterRequestWithDBSubnetGroupName (const Aws::String &value)
 
CreateDBClusterRequestWithDBSubnetGroupName (Aws::String &&value)
 
CreateDBClusterRequestWithDBSubnetGroupName (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)
 
CreateDBClusterRequestWithEngine (const Aws::String &value)
 
CreateDBClusterRequestWithEngine (Aws::String &&value)
 
CreateDBClusterRequestWithEngine (const char *value)
 
const Aws::StringGetEngineVersion () const
 
bool EngineVersionHasBeenSet () const
 
void SetEngineVersion (const Aws::String &value)
 
void SetEngineVersion (Aws::String &&value)
 
void SetEngineVersion (const char *value)
 
CreateDBClusterRequestWithEngineVersion (const Aws::String &value)
 
CreateDBClusterRequestWithEngineVersion (Aws::String &&value)
 
CreateDBClusterRequestWithEngineVersion (const char *value)
 
int GetPort () const
 
bool PortHasBeenSet () const
 
void SetPort (int value)
 
CreateDBClusterRequestWithPort (int value)
 
const Aws::StringGetMasterUsername () const
 
bool MasterUsernameHasBeenSet () const
 
void SetMasterUsername (const Aws::String &value)
 
void SetMasterUsername (Aws::String &&value)
 
void SetMasterUsername (const char *value)
 
CreateDBClusterRequestWithMasterUsername (const Aws::String &value)
 
CreateDBClusterRequestWithMasterUsername (Aws::String &&value)
 
CreateDBClusterRequestWithMasterUsername (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)
 
CreateDBClusterRequestWithMasterUserPassword (const Aws::String &value)
 
CreateDBClusterRequestWithMasterUserPassword (Aws::String &&value)
 
CreateDBClusterRequestWithMasterUserPassword (const char *value)
 
const Aws::StringGetOptionGroupName () const
 
bool OptionGroupNameHasBeenSet () const
 
void SetOptionGroupName (const Aws::String &value)
 
void SetOptionGroupName (Aws::String &&value)
 
void SetOptionGroupName (const char *value)
 
CreateDBClusterRequestWithOptionGroupName (const Aws::String &value)
 
CreateDBClusterRequestWithOptionGroupName (Aws::String &&value)
 
CreateDBClusterRequestWithOptionGroupName (const char *value)
 
const Aws::StringGetPreferredBackupWindow () const
 
bool PreferredBackupWindowHasBeenSet () const
 
void SetPreferredBackupWindow (const Aws::String &value)
 
void SetPreferredBackupWindow (Aws::String &&value)
 
void SetPreferredBackupWindow (const char *value)
 
CreateDBClusterRequestWithPreferredBackupWindow (const Aws::String &value)
 
CreateDBClusterRequestWithPreferredBackupWindow (Aws::String &&value)
 
CreateDBClusterRequestWithPreferredBackupWindow (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)
 
CreateDBClusterRequestWithPreferredMaintenanceWindow (const Aws::String &value)
 
CreateDBClusterRequestWithPreferredMaintenanceWindow (Aws::String &&value)
 
CreateDBClusterRequestWithPreferredMaintenanceWindow (const char *value)
 
const Aws::StringGetReplicationSourceIdentifier () const
 
bool ReplicationSourceIdentifierHasBeenSet () const
 
void SetReplicationSourceIdentifier (const Aws::String &value)
 
void SetReplicationSourceIdentifier (Aws::String &&value)
 
void SetReplicationSourceIdentifier (const char *value)
 
CreateDBClusterRequestWithReplicationSourceIdentifier (const Aws::String &value)
 
CreateDBClusterRequestWithReplicationSourceIdentifier (Aws::String &&value)
 
CreateDBClusterRequestWithReplicationSourceIdentifier (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateDBClusterRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateDBClusterRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateDBClusterRequestAddTags (const Tag &value)
 
CreateDBClusterRequestAddTags (Tag &&value)
 
bool GetStorageEncrypted () const
 
bool StorageEncryptedHasBeenSet () const
 
void SetStorageEncrypted (bool value)
 
CreateDBClusterRequestWithStorageEncrypted (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)
 
CreateDBClusterRequestWithKmsKeyId (const Aws::String &value)
 
CreateDBClusterRequestWithKmsKeyId (Aws::String &&value)
 
CreateDBClusterRequestWithKmsKeyId (const char *value)
 
const Aws::StringGetPreSignedUrl () const
 
bool PreSignedUrlHasBeenSet () const
 
void SetPreSignedUrl (const Aws::String &value)
 
void SetPreSignedUrl (Aws::String &&value)
 
void SetPreSignedUrl (const char *value)
 
CreateDBClusterRequestWithPreSignedUrl (const Aws::String &value)
 
CreateDBClusterRequestWithPreSignedUrl (Aws::String &&value)
 
CreateDBClusterRequestWithPreSignedUrl (const char *value)
 
bool GetEnableIAMDatabaseAuthentication () const
 
bool EnableIAMDatabaseAuthenticationHasBeenSet () const
 
void SetEnableIAMDatabaseAuthentication (bool value)
 
CreateDBClusterRequestWithEnableIAMDatabaseAuthentication (bool value)
 
long long GetBacktrackWindow () const
 
bool BacktrackWindowHasBeenSet () const
 
void SetBacktrackWindow (long long value)
 
CreateDBClusterRequestWithBacktrackWindow (long long value)
 
const Aws::Vector< Aws::String > & GetEnableCloudwatchLogsExports () const
 
bool EnableCloudwatchLogsExportsHasBeenSet () const
 
void SetEnableCloudwatchLogsExports (const Aws::Vector< Aws::String > &value)
 
void SetEnableCloudwatchLogsExports (Aws::Vector< Aws::String > &&value)
 
CreateDBClusterRequestWithEnableCloudwatchLogsExports (const Aws::Vector< Aws::String > &value)
 
CreateDBClusterRequestWithEnableCloudwatchLogsExports (Aws::Vector< Aws::String > &&value)
 
CreateDBClusterRequestAddEnableCloudwatchLogsExports (const Aws::String &value)
 
CreateDBClusterRequestAddEnableCloudwatchLogsExports (Aws::String &&value)
 
CreateDBClusterRequestAddEnableCloudwatchLogsExports (const char *value)
 
const Aws::StringGetEngineMode () const
 
bool EngineModeHasBeenSet () const
 
void SetEngineMode (const Aws::String &value)
 
void SetEngineMode (Aws::String &&value)
 
void SetEngineMode (const char *value)
 
CreateDBClusterRequestWithEngineMode (const Aws::String &value)
 
CreateDBClusterRequestWithEngineMode (Aws::String &&value)
 
CreateDBClusterRequestWithEngineMode (const char *value)
 
const ScalingConfigurationGetScalingConfiguration () const
 
bool ScalingConfigurationHasBeenSet () const
 
void SetScalingConfiguration (const ScalingConfiguration &value)
 
void SetScalingConfiguration (ScalingConfiguration &&value)
 
CreateDBClusterRequestWithScalingConfiguration (const ScalingConfiguration &value)
 
CreateDBClusterRequestWithScalingConfiguration (ScalingConfiguration &&value)
 
bool GetDeletionProtection () const
 
bool DeletionProtectionHasBeenSet () const
 
void SetDeletionProtection (bool value)
 
CreateDBClusterRequestWithDeletionProtection (bool value)
 
const Aws::StringGetGlobalClusterIdentifier () const
 
bool GlobalClusterIdentifierHasBeenSet () const
 
void SetGlobalClusterIdentifier (const Aws::String &value)
 
void SetGlobalClusterIdentifier (Aws::String &&value)
 
void SetGlobalClusterIdentifier (const char *value)
 
CreateDBClusterRequestWithGlobalClusterIdentifier (const Aws::String &value)
 
CreateDBClusterRequestWithGlobalClusterIdentifier (Aws::String &&value)
 
CreateDBClusterRequestWithGlobalClusterIdentifier (const char *value)
 
bool GetEnableHttpEndpoint () const
 
bool EnableHttpEndpointHasBeenSet () const
 
void SetEnableHttpEndpoint (bool value)
 
CreateDBClusterRequestWithEnableHttpEndpoint (bool value)
 
bool GetCopyTagsToSnapshot () const
 
bool CopyTagsToSnapshotHasBeenSet () const
 
void SetCopyTagsToSnapshot (bool value)
 
CreateDBClusterRequestWithCopyTagsToSnapshot (bool value)
 
const Aws::StringGetDomain () const
 
bool DomainHasBeenSet () const
 
void SetDomain (const Aws::String &value)
 
void SetDomain (Aws::String &&value)
 
void SetDomain (const char *value)
 
CreateDBClusterRequestWithDomain (const Aws::String &value)
 
CreateDBClusterRequestWithDomain (Aws::String &&value)
 
CreateDBClusterRequestWithDomain (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)
 
CreateDBClusterRequestWithDomainIAMRoleName (const Aws::String &value)
 
CreateDBClusterRequestWithDomainIAMRoleName (Aws::String &&value)
 
CreateDBClusterRequestWithDomainIAMRoleName (const char *value)
 
bool GetEnableGlobalWriteForwarding () const
 
bool EnableGlobalWriteForwardingHasBeenSet () const
 
void SetEnableGlobalWriteForwarding (bool value)
 
CreateDBClusterRequestWithEnableGlobalWriteForwarding (bool value)
 
const Aws::StringGetSourceRegion () const
 
bool SourceRegionHasBeenSet () const
 
void SetSourceRegion (const Aws::String &value)
 
void SetSourceRegion (Aws::String &&value)
 
void SetSourceRegion (const char *value)
 
CreateDBClusterRequestWithSourceRegion (const Aws::String &value)
 
CreateDBClusterRequestWithSourceRegion (Aws::String &&value)
 
CreateDBClusterRequestWithSourceRegion (const char *value)
 
- Public Member Functions inherited from Aws::RDS::RDSRequest
virtual ~RDSRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

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

Detailed Description

See Also:

AWS API Reference

Definition at line 27 of file CreateDBClusterRequest.h.

Constructor & Destructor Documentation

◆ CreateDBClusterRequest()

Aws::RDS::Model::CreateDBClusterRequest::CreateDBClusterRequest ( )

Member Function Documentation

◆ AddAvailabilityZones() [1/3]

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

A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.

Definition at line 115 of file CreateDBClusterRequest.h.

◆ AddAvailabilityZones() [2/3]

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

A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.

Definition at line 106 of file CreateDBClusterRequest.h.

◆ AddAvailabilityZones() [3/3]

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

A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.

Definition at line 124 of file CreateDBClusterRequest.h.

◆ AddEnableCloudwatchLogsExports() [1/3]

CreateDBClusterRequest& Aws::RDS::Model::CreateDBClusterRequest::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 Aurora User Guide.

Aurora MySQL

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

Aurora PostgreSQL

Possible value is postgresql.

Definition at line 1900 of file CreateDBClusterRequest.h.

◆ AddEnableCloudwatchLogsExports() [2/3]

CreateDBClusterRequest& Aws::RDS::Model::CreateDBClusterRequest::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 Aurora User Guide.

Aurora MySQL

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

Aurora PostgreSQL

Possible value is postgresql.

Definition at line 1887 of file CreateDBClusterRequest.h.

◆ AddEnableCloudwatchLogsExports() [3/3]

CreateDBClusterRequest& Aws::RDS::Model::CreateDBClusterRequest::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 Aurora User Guide.

Aurora MySQL

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

Aurora PostgreSQL

Possible value is postgresql.

Definition at line 1913 of file CreateDBClusterRequest.h.

◆ AddTags() [1/2]

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

Tags to assign to the DB cluster.

Definition at line 1245 of file CreateDBClusterRequest.h.

◆ AddTags() [2/2]

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

Tags to assign to the DB cluster.

Definition at line 1250 of file CreateDBClusterRequest.h.

◆ AddVpcSecurityGroupIds() [1/3]

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

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

Definition at line 446 of file CreateDBClusterRequest.h.

◆ AddVpcSecurityGroupIds() [2/3]

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

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

Definition at line 441 of file CreateDBClusterRequest.h.

◆ AddVpcSecurityGroupIds() [3/3]

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

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

Definition at line 451 of file CreateDBClusterRequest.h.

◆ AvailabilityZonesHasBeenSet()

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

A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.

Definition at line 61 of file CreateDBClusterRequest.h.

◆ BacktrackWindowHasBeenSet()

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

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

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

Default: 0

Constraints:

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

Definition at line 1777 of file CreateDBClusterRequest.h.

◆ BackupRetentionPeriodHasBeenSet()

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

The number of days for which automated backups are retained.

Default: 1

Constraints:

  • Must be a value from 1 to 35

Definition at line 139 of file CreateDBClusterRequest.h.

◆ CharacterSetNameHasBeenSet()

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

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

Definition at line 166 of file CreateDBClusterRequest.h.

◆ CopyTagsToSnapshotHasBeenSet()

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

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

Definition at line 2303 of file CreateDBClusterRequest.h.

◆ DatabaseNameHasBeenSet()

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

The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.

Definition at line 217 of file CreateDBClusterRequest.h.

◆ DBClusterIdentifierHasBeenSet()

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

The DB cluster 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: my-cluster1

Definition at line 278 of file CreateDBClusterRequest.h.

◆ DBClusterParameterGroupNameHasBeenSet()

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

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

Constraints:

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

Definition at line 351 of file CreateDBClusterRequest.h.

◆ DBSubnetGroupNameHasBeenSet()

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

A DB subnet group to associate with this DB cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

Definition at line 466 of file CreateDBClusterRequest.h.

◆ DeletionProtectionHasBeenSet()

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

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

Definition at line 2174 of file CreateDBClusterRequest.h.

◆ DomainHasBeenSet()

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

The Active Directory directory ID to create the DB cluster in.

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

Definition at line 2334 of file CreateDBClusterRequest.h.

◆ DomainIAMRoleNameHasBeenSet()

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

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

Definition at line 2401 of file CreateDBClusterRequest.h.

◆ DumpBodyToUrl()

void Aws::RDS::Model::CreateDBClusterRequest::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::CreateDBClusterRequest::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 Aurora User Guide.

Aurora MySQL

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

Aurora PostgreSQL

Possible value is postgresql.

Definition at line 1822 of file CreateDBClusterRequest.h.

◆ EnableGlobalWriteForwardingHasBeenSet()

bool Aws::RDS::Model::CreateDBClusterRequest::EnableGlobalWriteForwardingHasBeenSet ( ) const
inline

A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.

Definition at line 2466 of file CreateDBClusterRequest.h.

◆ EnableHttpEndpointHasBeenSet()

bool Aws::RDS::Model::CreateDBClusterRequest::EnableHttpEndpointHasBeenSet ( ) const
inline

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.

Definition at line 2264 of file CreateDBClusterRequest.h.

◆ EnableIAMDatabaseAuthenticationHasBeenSet()

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

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

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

Definition at line 1740 of file CreateDBClusterRequest.h.

◆ EngineHasBeenSet()

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

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

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

Definition at line 525 of file CreateDBClusterRequest.h.

◆ EngineModeHasBeenSet()

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

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

The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.

The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn't required for any 2.x versions.

The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.

For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery and the multimaster engine modes currently aren't supported.

Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide:

Definition at line 1966 of file CreateDBClusterRequest.h.

◆ EngineVersionHasBeenSet()

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

The version number of the database engine to use.

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

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

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

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

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

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

Aurora MySQL

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

Aurora PostgreSQL

Example: 9.6.3, 10.7

Definition at line 612 of file CreateDBClusterRequest.h.

◆ GetAvailabilityZones()

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

A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.

Definition at line 52 of file CreateDBClusterRequest.h.

◆ GetBacktrackWindow()

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

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

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

Default: 0

Constraints:

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

Definition at line 1768 of file CreateDBClusterRequest.h.

◆ GetBackupRetentionPeriod()

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

The number of days for which automated backups are retained.

Default: 1

Constraints:

  • Must be a value from 1 to 35

Definition at line 132 of file CreateDBClusterRequest.h.

◆ GetCharacterSetName()

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

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

Definition at line 160 of file CreateDBClusterRequest.h.

◆ GetCopyTagsToSnapshot()

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

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

Definition at line 2297 of file CreateDBClusterRequest.h.

◆ GetDatabaseName()

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

The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.

Definition at line 210 of file CreateDBClusterRequest.h.

◆ GetDBClusterIdentifier()

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

The DB cluster 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: my-cluster1

Definition at line 269 of file CreateDBClusterRequest.h.

◆ GetDBClusterParameterGroupName()

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

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

Constraints:

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

Definition at line 342 of file CreateDBClusterRequest.h.

◆ GetDBSubnetGroupName()

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

A DB subnet group to associate with this DB cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

Definition at line 459 of file CreateDBClusterRequest.h.

◆ GetDeletionProtection()

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

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

Definition at line 2167 of file CreateDBClusterRequest.h.

◆ GetDomain()

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

The Active Directory directory ID to create the DB cluster in.

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

Definition at line 2325 of file CreateDBClusterRequest.h.

◆ GetDomainIAMRoleName()

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

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

Definition at line 2395 of file CreateDBClusterRequest.h.

◆ GetEnableCloudwatchLogsExports()

const Aws::Vector<Aws::String>& Aws::RDS::Model::CreateDBClusterRequest::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 Aurora User Guide.

Aurora MySQL

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

Aurora PostgreSQL

Possible value is postgresql.

Definition at line 1809 of file CreateDBClusterRequest.h.

◆ GetEnableGlobalWriteForwarding()

bool Aws::RDS::Model::CreateDBClusterRequest::GetEnableGlobalWriteForwarding ( ) const
inline

A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.

Definition at line 2452 of file CreateDBClusterRequest.h.

◆ GetEnableHttpEndpoint()

bool Aws::RDS::Model::CreateDBClusterRequest::GetEnableHttpEndpoint ( ) const
inline

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.

Definition at line 2251 of file CreateDBClusterRequest.h.

◆ GetEnableIAMDatabaseAuthentication()

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

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

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

Definition at line 1731 of file CreateDBClusterRequest.h.

◆ GetEngine()

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

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

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

Definition at line 517 of file CreateDBClusterRequest.h.

◆ GetEngineMode()

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

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

The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.

The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn't required for any 2.x versions.

The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.

For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery and the multimaster engine modes currently aren't supported.

Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide:

Definition at line 1940 of file CreateDBClusterRequest.h.

◆ GetEngineVersion()

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

The version number of the database engine to use.

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

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

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

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

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

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

Aurora MySQL

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

Aurora PostgreSQL

Example: 9.6.3, 10.7

Definition at line 593 of file CreateDBClusterRequest.h.

◆ GetGlobalClusterIdentifier()

const Aws::String& Aws::RDS::Model::CreateDBClusterRequest::GetGlobalClusterIdentifier ( ) const
inline

The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.

Definition at line 2195 of file CreateDBClusterRequest.h.

◆ GetKmsKeyId()

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

The AWS KMS key identifier for an encrypted DB cluster.

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

When a CMK isn't specified in KmsKeyId:

  • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the CMK used to encrypt the source. Otherwise, Amazon RDS will use your default CMK.

  • If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS will use your default CMK.

There is a default CMK for your AWS account. Your AWS account has a different default CMK for each AWS Region.

If you create a read replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a AWS KMS key identifier that is valid in the destination AWS Region. This CMK is used to encrypt the read replica in that AWS Region.

Definition at line 1292 of file CreateDBClusterRequest.h.

◆ GetMasterUsername()

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

The name of the master user for the DB cluster.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

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

Definition at line 764 of file CreateDBClusterRequest.h.

◆ GetMasterUserPassword()

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

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

Constraints: Must contain from 8 to 41 characters.

Definition at line 828 of file CreateDBClusterRequest.h.

◆ GetOptionGroupName()

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

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

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

Definition at line 886 of file CreateDBClusterRequest.h.

◆ GetPort()

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

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

Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.

Definition at line 734 of file CreateDBClusterRequest.h.

◆ GetPreferredBackupWindow()

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

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

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

Constraints:

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

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 957 of file CreateDBClusterRequest.h.

◆ GetPreferredMaintenanceWindow()

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

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

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

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

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

Constraints: Minimum 30-minute window.

Definition at line 1069 of file CreateDBClusterRequest.h.

◆ GetPreSignedUrl()

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

A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.

The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied.

The pre-signed URL request must contain the following parameter values:

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same AWS KMS CMK for both the CreateDBCluster action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

  • DestinationRegion - The name of the AWS Region that Aurora read replica will be created in.

  • ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

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

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

Definition at line 1469 of file CreateDBClusterRequest.h.

◆ GetReplicationSourceIdentifier()

const Aws::String& Aws::RDS::Model::CreateDBClusterRequest::GetReplicationSourceIdentifier ( ) const
inline

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.

Definition at line 1167 of file CreateDBClusterRequest.h.

◆ GetScalingConfiguration()

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

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

Definition at line 2129 of file CreateDBClusterRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file CreateDBClusterRequest.h.

◆ GetSourceRegion()

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

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

Definition at line 2500 of file CreateDBClusterRequest.h.

◆ GetStorageEncrypted()

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

A value that indicates whether the DB cluster is encrypted.

Definition at line 1256 of file CreateDBClusterRequest.h.

◆ GetTags()

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

Tags to assign to the DB cluster.

Definition at line 1215 of file CreateDBClusterRequest.h.

◆ GetVpcSecurityGroupIds()

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

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

Definition at line 411 of file CreateDBClusterRequest.h.

◆ GlobalClusterIdentifierHasBeenSet()

bool Aws::RDS::Model::CreateDBClusterRequest::GlobalClusterIdentifierHasBeenSet ( ) const
inline

The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.

Definition at line 2201 of file CreateDBClusterRequest.h.

◆ KmsKeyIdHasBeenSet()

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

The AWS KMS key identifier for an encrypted DB cluster.

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

When a CMK isn't specified in KmsKeyId:

  • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the CMK used to encrypt the source. Otherwise, Amazon RDS will use your default CMK.

  • If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS will use your default CMK.

There is a default CMK for your AWS account. Your AWS account has a different default CMK for each AWS Region.

If you create a read replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a AWS KMS key identifier that is valid in the destination AWS Region. This CMK is used to encrypt the read replica in that AWS Region.

Definition at line 1312 of file CreateDBClusterRequest.h.

◆ MasterUsernameHasBeenSet()

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

The name of the master user for the DB cluster.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

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

Definition at line 772 of file CreateDBClusterRequest.h.

◆ MasterUserPasswordHasBeenSet()

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

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

Constraints: Must contain from 8 to 41 characters.

Definition at line 835 of file CreateDBClusterRequest.h.

◆ OptionGroupNameHasBeenSet()

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

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

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

Definition at line 894 of file CreateDBClusterRequest.h.

◆ PortHasBeenSet()

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

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

Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.

Definition at line 741 of file CreateDBClusterRequest.h.

◆ PreferredBackupWindowHasBeenSet()

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

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

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

Constraints:

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

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 971 of file CreateDBClusterRequest.h.

◆ PreferredMaintenanceWindowHasBeenSet()

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

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

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

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

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

Constraints: Minimum 30-minute window.

Definition at line 1082 of file CreateDBClusterRequest.h.

◆ PreSignedUrlHasBeenSet()

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

A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.

The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied.

The pre-signed URL request must contain the following parameter values:

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same AWS KMS CMK for both the CreateDBCluster action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

  • DestinationRegion - The name of the AWS Region that Aurora read replica will be created in.

  • ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

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

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

Definition at line 1505 of file CreateDBClusterRequest.h.

◆ ReplicationSourceIdentifierHasBeenSet()

bool Aws::RDS::Model::CreateDBClusterRequest::ReplicationSourceIdentifierHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.

Definition at line 1173 of file CreateDBClusterRequest.h.

◆ ScalingConfigurationHasBeenSet()

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

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

Definition at line 2135 of file CreateDBClusterRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAvailabilityZones() [1/2]

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

A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.

Definition at line 79 of file CreateDBClusterRequest.h.

◆ SetAvailabilityZones() [2/2]

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

A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.

Definition at line 70 of file CreateDBClusterRequest.h.

◆ SetBacktrackWindow()

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

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

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

Default: 0

Constraints:

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

Definition at line 1786 of file CreateDBClusterRequest.h.

◆ SetBackupRetentionPeriod()

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

The number of days for which automated backups are retained.

Default: 1

Constraints:

  • Must be a value from 1 to 35

Definition at line 146 of file CreateDBClusterRequest.h.

◆ SetCharacterSetName() [1/3]

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

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

Definition at line 178 of file CreateDBClusterRequest.h.

◆ SetCharacterSetName() [2/3]

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

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

Definition at line 172 of file CreateDBClusterRequest.h.

◆ SetCharacterSetName() [3/3]

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

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

Definition at line 184 of file CreateDBClusterRequest.h.

◆ SetCopyTagsToSnapshot()

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

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

Definition at line 2309 of file CreateDBClusterRequest.h.

◆ SetDatabaseName() [1/3]

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

The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.

Definition at line 231 of file CreateDBClusterRequest.h.

◆ SetDatabaseName() [2/3]

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

The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.

Definition at line 224 of file CreateDBClusterRequest.h.

◆ SetDatabaseName() [3/3]

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

The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.

Definition at line 238 of file CreateDBClusterRequest.h.

◆ SetDBClusterIdentifier() [1/3]

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

The DB cluster 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: my-cluster1

Definition at line 296 of file CreateDBClusterRequest.h.

◆ SetDBClusterIdentifier() [2/3]

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

The DB cluster 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: my-cluster1

Definition at line 287 of file CreateDBClusterRequest.h.

◆ SetDBClusterIdentifier() [3/3]

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

The DB cluster 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: my-cluster1

Definition at line 305 of file CreateDBClusterRequest.h.

◆ SetDBClusterParameterGroupName() [1/3]

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

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

Constraints:

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

Definition at line 369 of file CreateDBClusterRequest.h.

◆ SetDBClusterParameterGroupName() [2/3]

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

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

Constraints:

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

Definition at line 360 of file CreateDBClusterRequest.h.

◆ SetDBClusterParameterGroupName() [3/3]

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

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

Constraints:

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

Definition at line 378 of file CreateDBClusterRequest.h.

◆ SetDBSubnetGroupName() [1/3]

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

A DB subnet group to associate with this DB cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

Definition at line 480 of file CreateDBClusterRequest.h.

◆ SetDBSubnetGroupName() [2/3]

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

A DB subnet group to associate with this DB cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

Definition at line 473 of file CreateDBClusterRequest.h.

◆ SetDBSubnetGroupName() [3/3]

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

A DB subnet group to associate with this DB cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

Definition at line 487 of file CreateDBClusterRequest.h.

◆ SetDeletionProtection()

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

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

Definition at line 2181 of file CreateDBClusterRequest.h.

◆ SetDomain() [1/3]

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

The Active Directory directory ID to create the DB cluster in.

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

Definition at line 2352 of file CreateDBClusterRequest.h.

◆ SetDomain() [2/3]

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

The Active Directory directory ID to create the DB cluster in.

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

Definition at line 2343 of file CreateDBClusterRequest.h.

◆ SetDomain() [3/3]

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

The Active Directory directory ID to create the DB cluster in.

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

Definition at line 2361 of file CreateDBClusterRequest.h.

◆ SetDomainIAMRoleName() [1/3]

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

◆ SetDomainIAMRoleName() [2/3]

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

◆ SetDomainIAMRoleName() [3/3]

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

◆ SetEnableCloudwatchLogsExports() [1/2]

void Aws::RDS::Model::CreateDBClusterRequest::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 Aurora User Guide.

Aurora MySQL

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

Aurora PostgreSQL

Possible value is postgresql.

Definition at line 1848 of file CreateDBClusterRequest.h.

◆ SetEnableCloudwatchLogsExports() [2/2]

void Aws::RDS::Model::CreateDBClusterRequest::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 Aurora User Guide.

Aurora MySQL

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

Aurora PostgreSQL

Possible value is postgresql.

Definition at line 1835 of file CreateDBClusterRequest.h.

◆ SetEnableGlobalWriteForwarding()

void Aws::RDS::Model::CreateDBClusterRequest::SetEnableGlobalWriteForwarding ( bool  value)
inline

A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.

Definition at line 2480 of file CreateDBClusterRequest.h.

◆ SetEnableHttpEndpoint()

void Aws::RDS::Model::CreateDBClusterRequest::SetEnableHttpEndpoint ( bool  value)
inline

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.

Definition at line 2277 of file CreateDBClusterRequest.h.

◆ SetEnableIAMDatabaseAuthentication()

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

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

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

Definition at line 1749 of file CreateDBClusterRequest.h.

◆ SetEngine() [1/3]

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

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

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

Definition at line 541 of file CreateDBClusterRequest.h.

◆ SetEngine() [2/3]

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

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

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

Definition at line 533 of file CreateDBClusterRequest.h.

◆ SetEngine() [3/3]

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

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

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

Definition at line 549 of file CreateDBClusterRequest.h.

◆ SetEngineMode() [1/3]

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

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

The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.

The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn't required for any 2.x versions.

The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.

For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery and the multimaster engine modes currently aren't supported.

Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide:

Definition at line 2018 of file CreateDBClusterRequest.h.

◆ SetEngineMode() [2/3]

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

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

The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.

The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn't required for any 2.x versions.

The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.

For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery and the multimaster engine modes currently aren't supported.

Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide:

Definition at line 1992 of file CreateDBClusterRequest.h.

◆ SetEngineMode() [3/3]

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

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

The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.

The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn't required for any 2.x versions.

The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.

For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery and the multimaster engine modes currently aren't supported.

Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide:

Definition at line 2044 of file CreateDBClusterRequest.h.

◆ SetEngineVersion() [1/3]

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

The version number of the database engine to use.

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

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

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

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

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

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

Aurora MySQL

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

Aurora PostgreSQL

Example: 9.6.3, 10.7

Definition at line 650 of file CreateDBClusterRequest.h.

◆ SetEngineVersion() [2/3]

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

The version number of the database engine to use.

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

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

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

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

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

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

Aurora MySQL

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

Aurora PostgreSQL

Example: 9.6.3, 10.7

Definition at line 631 of file CreateDBClusterRequest.h.

◆ SetEngineVersion() [3/3]

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

The version number of the database engine to use.

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

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

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

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

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

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

Aurora MySQL

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

Aurora PostgreSQL

Example: 9.6.3, 10.7

Definition at line 669 of file CreateDBClusterRequest.h.

◆ SetGlobalClusterIdentifier() [1/3]

void Aws::RDS::Model::CreateDBClusterRequest::SetGlobalClusterIdentifier ( Aws::String &&  value)
inline

The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.

Definition at line 2213 of file CreateDBClusterRequest.h.

◆ SetGlobalClusterIdentifier() [2/3]

void Aws::RDS::Model::CreateDBClusterRequest::SetGlobalClusterIdentifier ( const Aws::String value)
inline

The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.

Definition at line 2207 of file CreateDBClusterRequest.h.

◆ SetGlobalClusterIdentifier() [3/3]

void Aws::RDS::Model::CreateDBClusterRequest::SetGlobalClusterIdentifier ( const char *  value)
inline

The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.

Definition at line 2219 of file CreateDBClusterRequest.h.

◆ SetKmsKeyId() [1/3]

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

The AWS KMS key identifier for an encrypted DB cluster.

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

When a CMK isn't specified in KmsKeyId:

  • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the CMK used to encrypt the source. Otherwise, Amazon RDS will use your default CMK.

  • If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS will use your default CMK.

There is a default CMK for your AWS account. Your AWS account has a different default CMK for each AWS Region.

If you create a read replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a AWS KMS key identifier that is valid in the destination AWS Region. This CMK is used to encrypt the read replica in that AWS Region.

Definition at line 1352 of file CreateDBClusterRequest.h.

◆ SetKmsKeyId() [2/3]

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

The AWS KMS key identifier for an encrypted DB cluster.

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

When a CMK isn't specified in KmsKeyId:

  • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the CMK used to encrypt the source. Otherwise, Amazon RDS will use your default CMK.

  • If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS will use your default CMK.

There is a default CMK for your AWS account. Your AWS account has a different default CMK for each AWS Region.

If you create a read replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a AWS KMS key identifier that is valid in the destination AWS Region. This CMK is used to encrypt the read replica in that AWS Region.

Definition at line 1332 of file CreateDBClusterRequest.h.

◆ SetKmsKeyId() [3/3]

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

The AWS KMS key identifier for an encrypted DB cluster.

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

When a CMK isn't specified in KmsKeyId:

  • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the CMK used to encrypt the source. Otherwise, Amazon RDS will use your default CMK.

  • If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS will use your default CMK.

There is a default CMK for your AWS account. Your AWS account has a different default CMK for each AWS Region.

If you create a read replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a AWS KMS key identifier that is valid in the destination AWS Region. This CMK is used to encrypt the read replica in that AWS Region.

Definition at line 1372 of file CreateDBClusterRequest.h.

◆ SetMasterUsername() [1/3]

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

The name of the master user for the DB cluster.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

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

Definition at line 788 of file CreateDBClusterRequest.h.

◆ SetMasterUsername() [2/3]

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

The name of the master user for the DB cluster.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

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

Definition at line 780 of file CreateDBClusterRequest.h.

◆ SetMasterUsername() [3/3]

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

The name of the master user for the DB cluster.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

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

Definition at line 796 of file CreateDBClusterRequest.h.

◆ SetMasterUserPassword() [1/3]

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

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

Constraints: Must contain from 8 to 41 characters.

Definition at line 849 of file CreateDBClusterRequest.h.

◆ SetMasterUserPassword() [2/3]

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

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

Constraints: Must contain from 8 to 41 characters.

Definition at line 842 of file CreateDBClusterRequest.h.

◆ SetMasterUserPassword() [3/3]

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

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

Constraints: Must contain from 8 to 41 characters.

Definition at line 856 of file CreateDBClusterRequest.h.

◆ SetOptionGroupName() [1/3]

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

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

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

Definition at line 910 of file CreateDBClusterRequest.h.

◆ SetOptionGroupName() [2/3]

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

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

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

Definition at line 902 of file CreateDBClusterRequest.h.

◆ SetOptionGroupName() [3/3]

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

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

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

Definition at line 918 of file CreateDBClusterRequest.h.

◆ SetPort()

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

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

Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.

Definition at line 748 of file CreateDBClusterRequest.h.

◆ SetPreferredBackupWindow() [1/3]

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

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

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

Constraints:

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

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 999 of file CreateDBClusterRequest.h.

◆ SetPreferredBackupWindow() [2/3]

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

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

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

Constraints:

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

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 985 of file CreateDBClusterRequest.h.

◆ SetPreferredBackupWindow() [3/3]

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

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

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

Constraints:

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

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 1013 of file CreateDBClusterRequest.h.

◆ SetPreferredMaintenanceWindow() [1/3]

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

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

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

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

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

Constraints: Minimum 30-minute window.

Definition at line 1108 of file CreateDBClusterRequest.h.

◆ SetPreferredMaintenanceWindow() [2/3]

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

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

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

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

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

Constraints: Minimum 30-minute window.

Definition at line 1095 of file CreateDBClusterRequest.h.

◆ SetPreferredMaintenanceWindow() [3/3]

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

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

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

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

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

Constraints: Minimum 30-minute window.

Definition at line 1121 of file CreateDBClusterRequest.h.

◆ SetPreSignedUrl() [1/3]

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

A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.

The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied.

The pre-signed URL request must contain the following parameter values:

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same AWS KMS CMK for both the CreateDBCluster action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

  • DestinationRegion - The name of the AWS Region that Aurora read replica will be created in.

  • ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

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

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

Definition at line 1577 of file CreateDBClusterRequest.h.

◆ SetPreSignedUrl() [2/3]

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

A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.

The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied.

The pre-signed URL request must contain the following parameter values:

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same AWS KMS CMK for both the CreateDBCluster action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

  • DestinationRegion - The name of the AWS Region that Aurora read replica will be created in.

  • ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

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

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

Definition at line 1541 of file CreateDBClusterRequest.h.

◆ SetPreSignedUrl() [3/3]

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

A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.

The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied.

The pre-signed URL request must contain the following parameter values:

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same AWS KMS CMK for both the CreateDBCluster action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

  • DestinationRegion - The name of the AWS Region that Aurora read replica will be created in.

  • ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

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

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

Definition at line 1613 of file CreateDBClusterRequest.h.

◆ SetReplicationSourceIdentifier() [1/3]

void Aws::RDS::Model::CreateDBClusterRequest::SetReplicationSourceIdentifier ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.

Definition at line 1185 of file CreateDBClusterRequest.h.

◆ SetReplicationSourceIdentifier() [2/3]

void Aws::RDS::Model::CreateDBClusterRequest::SetReplicationSourceIdentifier ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.

Definition at line 1179 of file CreateDBClusterRequest.h.

◆ SetReplicationSourceIdentifier() [3/3]

void Aws::RDS::Model::CreateDBClusterRequest::SetReplicationSourceIdentifier ( const char *  value)
inline

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.

Definition at line 1191 of file CreateDBClusterRequest.h.

◆ SetScalingConfiguration() [1/2]

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

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

Definition at line 2141 of file CreateDBClusterRequest.h.

◆ SetScalingConfiguration() [2/2]

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

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

Definition at line 2147 of file CreateDBClusterRequest.h.

◆ SetSourceRegion() [1/3]

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

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

Definition at line 2515 of file CreateDBClusterRequest.h.

◆ SetSourceRegion() [2/3]

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

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

Definition at line 2510 of file CreateDBClusterRequest.h.

◆ SetSourceRegion() [3/3]

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

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

Definition at line 2520 of file CreateDBClusterRequest.h.

◆ SetStorageEncrypted()

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

A value that indicates whether the DB cluster is encrypted.

Definition at line 1266 of file CreateDBClusterRequest.h.

◆ SetTags() [1/2]

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

Tags to assign to the DB cluster.

Definition at line 1230 of file CreateDBClusterRequest.h.

◆ SetTags() [2/2]

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

Tags to assign to the DB cluster.

Definition at line 1225 of file CreateDBClusterRequest.h.

◆ SetVpcSecurityGroupIds() [1/2]

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

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

Definition at line 426 of file CreateDBClusterRequest.h.

◆ SetVpcSecurityGroupIds() [2/2]

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

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

Definition at line 421 of file CreateDBClusterRequest.h.

◆ SourceRegionHasBeenSet()

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

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

Definition at line 2505 of file CreateDBClusterRequest.h.

◆ StorageEncryptedHasBeenSet()

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

A value that indicates whether the DB cluster is encrypted.

Definition at line 1261 of file CreateDBClusterRequest.h.

◆ TagsHasBeenSet()

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

Tags to assign to the DB cluster.

Definition at line 1220 of file CreateDBClusterRequest.h.

◆ VpcSecurityGroupIdsHasBeenSet()

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

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

Definition at line 416 of file CreateDBClusterRequest.h.

◆ WithAvailabilityZones() [1/2]

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

A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.

Definition at line 97 of file CreateDBClusterRequest.h.

◆ WithAvailabilityZones() [2/2]

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

A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.

Definition at line 88 of file CreateDBClusterRequest.h.

◆ WithBacktrackWindow()

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

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

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

Default: 0

Constraints:

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

Definition at line 1795 of file CreateDBClusterRequest.h.

◆ WithBackupRetentionPeriod()

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

The number of days for which automated backups are retained.

Default: 1

Constraints:

  • Must be a value from 1 to 35

Definition at line 153 of file CreateDBClusterRequest.h.

◆ WithCharacterSetName() [1/3]

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

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

Definition at line 196 of file CreateDBClusterRequest.h.

◆ WithCharacterSetName() [2/3]

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

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

Definition at line 190 of file CreateDBClusterRequest.h.

◆ WithCharacterSetName() [3/3]

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

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

Definition at line 202 of file CreateDBClusterRequest.h.

◆ WithCopyTagsToSnapshot()

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

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

Definition at line 2315 of file CreateDBClusterRequest.h.

◆ WithDatabaseName() [1/3]

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

The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.

Definition at line 252 of file CreateDBClusterRequest.h.

◆ WithDatabaseName() [2/3]

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

The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.

Definition at line 245 of file CreateDBClusterRequest.h.

◆ WithDatabaseName() [3/3]

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

The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.

Definition at line 259 of file CreateDBClusterRequest.h.

◆ WithDBClusterIdentifier() [1/3]

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

The DB cluster 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: my-cluster1

Definition at line 323 of file CreateDBClusterRequest.h.

◆ WithDBClusterIdentifier() [2/3]

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

The DB cluster 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: my-cluster1

Definition at line 314 of file CreateDBClusterRequest.h.

◆ WithDBClusterIdentifier() [3/3]

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

The DB cluster 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: my-cluster1

Definition at line 332 of file CreateDBClusterRequest.h.

◆ WithDBClusterParameterGroupName() [1/3]

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

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

Constraints:

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

Definition at line 396 of file CreateDBClusterRequest.h.

◆ WithDBClusterParameterGroupName() [2/3]

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

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

Constraints:

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

Definition at line 387 of file CreateDBClusterRequest.h.

◆ WithDBClusterParameterGroupName() [3/3]

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

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

Constraints:

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

Definition at line 405 of file CreateDBClusterRequest.h.

◆ WithDBSubnetGroupName() [1/3]

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

A DB subnet group to associate with this DB cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

Definition at line 501 of file CreateDBClusterRequest.h.

◆ WithDBSubnetGroupName() [2/3]

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

A DB subnet group to associate with this DB cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

Definition at line 494 of file CreateDBClusterRequest.h.

◆ WithDBSubnetGroupName() [3/3]

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

A DB subnet group to associate with this DB cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

Definition at line 508 of file CreateDBClusterRequest.h.

◆ WithDeletionProtection()

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

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

Definition at line 2188 of file CreateDBClusterRequest.h.

◆ WithDomain() [1/3]

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

The Active Directory directory ID to create the DB cluster in.

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

Definition at line 2379 of file CreateDBClusterRequest.h.

◆ WithDomain() [2/3]

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

The Active Directory directory ID to create the DB cluster in.

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

Definition at line 2370 of file CreateDBClusterRequest.h.

◆ WithDomain() [3/3]

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

The Active Directory directory ID to create the DB cluster in.

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

Definition at line 2388 of file CreateDBClusterRequest.h.

◆ WithDomainIAMRoleName() [1/3]

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

◆ WithDomainIAMRoleName() [2/3]

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

◆ WithDomainIAMRoleName() [3/3]

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

◆ WithEnableCloudwatchLogsExports() [1/2]

CreateDBClusterRequest& Aws::RDS::Model::CreateDBClusterRequest::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 Aurora User Guide.

Aurora MySQL

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

Aurora PostgreSQL

Possible value is postgresql.

Definition at line 1874 of file CreateDBClusterRequest.h.

◆ WithEnableCloudwatchLogsExports() [2/2]

CreateDBClusterRequest& Aws::RDS::Model::CreateDBClusterRequest::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 Aurora User Guide.

Aurora MySQL

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

Aurora PostgreSQL

Possible value is postgresql.

Definition at line 1861 of file CreateDBClusterRequest.h.

◆ WithEnableGlobalWriteForwarding()

CreateDBClusterRequest& Aws::RDS::Model::CreateDBClusterRequest::WithEnableGlobalWriteForwarding ( bool  value)
inline

A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.

Definition at line 2494 of file CreateDBClusterRequest.h.

◆ WithEnableHttpEndpoint()

CreateDBClusterRequest& Aws::RDS::Model::CreateDBClusterRequest::WithEnableHttpEndpoint ( bool  value)
inline

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.

Definition at line 2290 of file CreateDBClusterRequest.h.

◆ WithEnableIAMDatabaseAuthentication()

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

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

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

Definition at line 1758 of file CreateDBClusterRequest.h.

◆ WithEngine() [1/3]

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

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

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

Definition at line 565 of file CreateDBClusterRequest.h.

◆ WithEngine() [2/3]

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

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

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

Definition at line 557 of file CreateDBClusterRequest.h.

◆ WithEngine() [3/3]

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

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

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

Definition at line 573 of file CreateDBClusterRequest.h.

◆ WithEngineMode() [1/3]

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

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

The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.

The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn't required for any 2.x versions.

The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.

For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery and the multimaster engine modes currently aren't supported.

Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide:

Definition at line 2096 of file CreateDBClusterRequest.h.

◆ WithEngineMode() [2/3]

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

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

The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.

The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn't required for any 2.x versions.

The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.

For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery and the multimaster engine modes currently aren't supported.

Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide:

Definition at line 2070 of file CreateDBClusterRequest.h.

◆ WithEngineMode() [3/3]

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

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

The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.

The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn't required for any 2.x versions.

The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.

For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery and the multimaster engine modes currently aren't supported.

Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide:

Definition at line 2122 of file CreateDBClusterRequest.h.

◆ WithEngineVersion() [1/3]

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

The version number of the database engine to use.

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

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

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

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

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

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

Aurora MySQL

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

Aurora PostgreSQL

Example: 9.6.3, 10.7

Definition at line 707 of file CreateDBClusterRequest.h.

◆ WithEngineVersion() [2/3]

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

The version number of the database engine to use.

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

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

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

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

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

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

Aurora MySQL

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

Aurora PostgreSQL

Example: 9.6.3, 10.7

Definition at line 688 of file CreateDBClusterRequest.h.

◆ WithEngineVersion() [3/3]

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

The version number of the database engine to use.

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

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

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

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

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

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

Aurora MySQL

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

Aurora PostgreSQL

Example: 9.6.3, 10.7

Definition at line 726 of file CreateDBClusterRequest.h.

◆ WithGlobalClusterIdentifier() [1/3]

CreateDBClusterRequest& Aws::RDS::Model::CreateDBClusterRequest::WithGlobalClusterIdentifier ( Aws::String &&  value)
inline

The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.

Definition at line 2231 of file CreateDBClusterRequest.h.

◆ WithGlobalClusterIdentifier() [2/3]

CreateDBClusterRequest& Aws::RDS::Model::CreateDBClusterRequest::WithGlobalClusterIdentifier ( const Aws::String value)
inline

The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.

Definition at line 2225 of file CreateDBClusterRequest.h.

◆ WithGlobalClusterIdentifier() [3/3]

CreateDBClusterRequest& Aws::RDS::Model::CreateDBClusterRequest::WithGlobalClusterIdentifier ( const char *  value)
inline

The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.

Definition at line 2237 of file CreateDBClusterRequest.h.

◆ WithKmsKeyId() [1/3]

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

The AWS KMS key identifier for an encrypted DB cluster.

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

When a CMK isn't specified in KmsKeyId:

  • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the CMK used to encrypt the source. Otherwise, Amazon RDS will use your default CMK.

  • If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS will use your default CMK.

There is a default CMK for your AWS account. Your AWS account has a different default CMK for each AWS Region.

If you create a read replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a AWS KMS key identifier that is valid in the destination AWS Region. This CMK is used to encrypt the read replica in that AWS Region.

Definition at line 1412 of file CreateDBClusterRequest.h.

◆ WithKmsKeyId() [2/3]

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

The AWS KMS key identifier for an encrypted DB cluster.

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

When a CMK isn't specified in KmsKeyId:

  • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the CMK used to encrypt the source. Otherwise, Amazon RDS will use your default CMK.

  • If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS will use your default CMK.

There is a default CMK for your AWS account. Your AWS account has a different default CMK for each AWS Region.

If you create a read replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a AWS KMS key identifier that is valid in the destination AWS Region. This CMK is used to encrypt the read replica in that AWS Region.

Definition at line 1392 of file CreateDBClusterRequest.h.

◆ WithKmsKeyId() [3/3]

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

The AWS KMS key identifier for an encrypted DB cluster.

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

When a CMK isn't specified in KmsKeyId:

  • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the CMK used to encrypt the source. Otherwise, Amazon RDS will use your default CMK.

  • If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS will use your default CMK.

There is a default CMK for your AWS account. Your AWS account has a different default CMK for each AWS Region.

If you create a read replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a AWS KMS key identifier that is valid in the destination AWS Region. This CMK is used to encrypt the read replica in that AWS Region.

Definition at line 1432 of file CreateDBClusterRequest.h.

◆ WithMasterUsername() [1/3]

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

The name of the master user for the DB cluster.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

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

Definition at line 812 of file CreateDBClusterRequest.h.

◆ WithMasterUsername() [2/3]

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

The name of the master user for the DB cluster.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

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

Definition at line 804 of file CreateDBClusterRequest.h.

◆ WithMasterUsername() [3/3]

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

The name of the master user for the DB cluster.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

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

Definition at line 820 of file CreateDBClusterRequest.h.

◆ WithMasterUserPassword() [1/3]

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

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

Constraints: Must contain from 8 to 41 characters.

Definition at line 870 of file CreateDBClusterRequest.h.

◆ WithMasterUserPassword() [2/3]

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

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

Constraints: Must contain from 8 to 41 characters.

Definition at line 863 of file CreateDBClusterRequest.h.

◆ WithMasterUserPassword() [3/3]

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

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

Constraints: Must contain from 8 to 41 characters.

Definition at line 877 of file CreateDBClusterRequest.h.

◆ WithOptionGroupName() [1/3]

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

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

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

Definition at line 934 of file CreateDBClusterRequest.h.

◆ WithOptionGroupName() [2/3]

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

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

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

Definition at line 926 of file CreateDBClusterRequest.h.

◆ WithOptionGroupName() [3/3]

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

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

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

Definition at line 942 of file CreateDBClusterRequest.h.

◆ WithPort()

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

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

Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.

Definition at line 755 of file CreateDBClusterRequest.h.

◆ WithPreferredBackupWindow() [1/3]

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

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

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

Constraints:

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

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 1041 of file CreateDBClusterRequest.h.

◆ WithPreferredBackupWindow() [2/3]

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

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

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

Constraints:

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

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 1027 of file CreateDBClusterRequest.h.

◆ WithPreferredBackupWindow() [3/3]

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

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

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

Constraints:

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

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

Definition at line 1055 of file CreateDBClusterRequest.h.

◆ WithPreferredMaintenanceWindow() [1/3]

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

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

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

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

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

Constraints: Minimum 30-minute window.

Definition at line 1147 of file CreateDBClusterRequest.h.

◆ WithPreferredMaintenanceWindow() [2/3]

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

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

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

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

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

Constraints: Minimum 30-minute window.

Definition at line 1134 of file CreateDBClusterRequest.h.

◆ WithPreferredMaintenanceWindow() [3/3]

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

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

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

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

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

Constraints: Minimum 30-minute window.

Definition at line 1160 of file CreateDBClusterRequest.h.

◆ WithPreSignedUrl() [1/3]

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

A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.

The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied.

The pre-signed URL request must contain the following parameter values:

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same AWS KMS CMK for both the CreateDBCluster action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

  • DestinationRegion - The name of the AWS Region that Aurora read replica will be created in.

  • ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

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

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

Definition at line 1685 of file CreateDBClusterRequest.h.

◆ WithPreSignedUrl() [2/3]

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

A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.

The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied.

The pre-signed URL request must contain the following parameter values:

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same AWS KMS CMK for both the CreateDBCluster action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

  • DestinationRegion - The name of the AWS Region that Aurora read replica will be created in.

  • ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

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

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

Definition at line 1649 of file CreateDBClusterRequest.h.

◆ WithPreSignedUrl() [3/3]

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

A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.

The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied.

The pre-signed URL request must contain the following parameter values:

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same AWS KMS CMK for both the CreateDBCluster action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

  • DestinationRegion - The name of the AWS Region that Aurora read replica will be created in.

  • ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

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

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

Definition at line 1721 of file CreateDBClusterRequest.h.

◆ WithReplicationSourceIdentifier() [1/3]

CreateDBClusterRequest& Aws::RDS::Model::CreateDBClusterRequest::WithReplicationSourceIdentifier ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.

Definition at line 1203 of file CreateDBClusterRequest.h.

◆ WithReplicationSourceIdentifier() [2/3]

CreateDBClusterRequest& Aws::RDS::Model::CreateDBClusterRequest::WithReplicationSourceIdentifier ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.

Definition at line 1197 of file CreateDBClusterRequest.h.

◆ WithReplicationSourceIdentifier() [3/3]

CreateDBClusterRequest& Aws::RDS::Model::CreateDBClusterRequest::WithReplicationSourceIdentifier ( const char *  value)
inline

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.

Definition at line 1209 of file CreateDBClusterRequest.h.

◆ WithScalingConfiguration() [1/2]

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

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

Definition at line 2153 of file CreateDBClusterRequest.h.

◆ WithScalingConfiguration() [2/2]

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

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

Definition at line 2159 of file CreateDBClusterRequest.h.

◆ WithSourceRegion() [1/3]

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

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

Definition at line 2530 of file CreateDBClusterRequest.h.

◆ WithSourceRegion() [2/3]

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

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

Definition at line 2525 of file CreateDBClusterRequest.h.

◆ WithSourceRegion() [3/3]

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

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

Definition at line 2535 of file CreateDBClusterRequest.h.

◆ WithStorageEncrypted()

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

A value that indicates whether the DB cluster is encrypted.

Definition at line 1271 of file CreateDBClusterRequest.h.

◆ WithTags() [1/2]

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

Tags to assign to the DB cluster.

Definition at line 1240 of file CreateDBClusterRequest.h.

◆ WithTags() [2/2]

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

Tags to assign to the DB cluster.

Definition at line 1235 of file CreateDBClusterRequest.h.

◆ WithVpcSecurityGroupIds() [1/2]

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

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

Definition at line 436 of file CreateDBClusterRequest.h.

◆ WithVpcSecurityGroupIds() [2/2]

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

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

Definition at line 431 of file CreateDBClusterRequest.h.


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