@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ModifyDBClusterRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
ModifyDBClusterRequest() |
Modifier and Type | Method and Description |
---|---|
ModifyDBClusterRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Integer |
getAllocatedStorage()
The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
|
Boolean |
getAllowEngineModeChange()
Specifies whether engine mode changes from
serverless to provisioned are allowed. |
Boolean |
getAllowMajorVersionUpgrade()
Specifies whether major version upgrades are allowed.
|
Boolean |
getApplyImmediately()
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as
soon as possible, regardless of the
PreferredMaintenanceWindow setting for the DB cluster. |
Boolean |
getAutoMinorVersionUpgrade()
Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance
window.
|
String |
getAwsBackupRecoveryPointArn()
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
|
Long |
getBacktrackWindow()
The target backtrack window, in seconds.
|
Integer |
getBackupRetentionPeriod()
The number of days for which automated backups are retained.
|
String |
getCACertificateIdentifier()
The CA certificate identifier to use for the DB cluster's server certificate.
|
CloudwatchLogsExportConfiguration |
getCloudwatchLogsExportConfiguration()
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB
cluster.
|
Boolean |
getCopyTagsToSnapshot()
Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster.
|
String |
getDBClusterIdentifier()
The DB cluster identifier for the cluster being modified.
|
String |
getDBClusterInstanceClass()
The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example
db.m6gd.xlarge . |
String |
getDBClusterParameterGroupName()
The name of the DB cluster parameter group to use for the DB cluster.
|
String |
getDBInstanceParameterGroupName()
The name of the DB parameter group to apply to all instances of the DB cluster.
|
Boolean |
getDeletionProtection()
Specifies whether the DB cluster has deletion protection enabled.
|
String |
getDomain()
The Active Directory directory ID to move the DB cluster to.
|
String |
getDomainIAMRoleName()
The name of the IAM role to use when making API calls to the Directory Service.
|
Boolean |
getEnableGlobalWriteForwarding()
Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global
cluster (Aurora global database).
|
Boolean |
getEnableHttpEndpoint()
Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster.
|
Boolean |
getEnableIAMDatabaseAuthentication()
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to
database accounts.
|
Boolean |
getEnableLimitlessDatabase()
Specifies whether to enable Aurora Limitless Database.
|
Boolean |
getEnableLocalWriteForwarding()
Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster.
|
Boolean |
getEnablePerformanceInsights()
Specifies whether to turn on Performance Insights for the DB cluster.
|
String |
getEngineMode()
The DB engine mode of the DB cluster, either
provisioned or serverless . |
String |
getEngineVersion()
The version number of the database engine to which you want to upgrade.
|
Integer |
getIops()
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB
instance in the Multi-AZ DB cluster.
|
Boolean |
getManageMasterUserPassword()
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
|
String |
getMasterUserPassword()
The new password for the master database user.
|
String |
getMasterUserSecretKmsKeyId()
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in
Amazon Web Services Secrets Manager.
|
Integer |
getMonitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
|
String |
getMonitoringRoleArn()
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon
CloudWatch Logs.
|
String |
getNetworkType()
The network type of the DB cluster.
|
String |
getNewDBClusterIdentifier()
The new DB cluster identifier for the DB cluster when renaming a DB cluster.
|
String |
getOptionGroupName()
The option group to associate the DB cluster with.
|
String |
getPerformanceInsightsKMSKeyId()
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
|
Integer |
getPerformanceInsightsRetentionPeriod()
The number of days to retain Performance Insights data.
|
Integer |
getPort()
The port number on which the DB cluster accepts connections.
|
String |
getPreferredBackupWindow()
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod parameter. |
String |
getPreferredMaintenanceWindow()
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
Boolean |
getRotateMasterUserPassword()
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user
password.
|
ScalingConfiguration |
getScalingConfiguration()
The scaling properties of the DB cluster.
|
ServerlessV2ScalingConfiguration |
getServerlessV2ScalingConfiguration() |
String |
getStorageType()
The storage type to associate with the DB cluster.
|
List<String> |
getVpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with this DB cluster.
|
int |
hashCode() |
Boolean |
isAllowEngineModeChange()
Specifies whether engine mode changes from
serverless to provisioned are allowed. |
Boolean |
isAllowMajorVersionUpgrade()
Specifies whether major version upgrades are allowed.
|
Boolean |
isApplyImmediately()
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as
soon as possible, regardless of the
PreferredMaintenanceWindow setting for the DB cluster. |
Boolean |
isAutoMinorVersionUpgrade()
Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance
window.
|
Boolean |
isCopyTagsToSnapshot()
Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster.
|
Boolean |
isDeletionProtection()
Specifies whether the DB cluster has deletion protection enabled.
|
Boolean |
isEnableGlobalWriteForwarding()
Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global
cluster (Aurora global database).
|
Boolean |
isEnableHttpEndpoint()
Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster.
|
Boolean |
isEnableIAMDatabaseAuthentication()
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to
database accounts.
|
Boolean |
isEnableLimitlessDatabase()
Specifies whether to enable Aurora Limitless Database.
|
Boolean |
isEnableLocalWriteForwarding()
Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster.
|
Boolean |
isEnablePerformanceInsights()
Specifies whether to turn on Performance Insights for the DB cluster.
|
Boolean |
isManageMasterUserPassword()
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
|
Boolean |
isRotateMasterUserPassword()
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user
password.
|
void |
setAllocatedStorage(Integer allocatedStorage)
The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
|
void |
setAllowEngineModeChange(Boolean allowEngineModeChange)
Specifies whether engine mode changes from
serverless to provisioned are allowed. |
void |
setAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)
Specifies whether major version upgrades are allowed.
|
void |
setApplyImmediately(Boolean applyImmediately)
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as
soon as possible, regardless of the
PreferredMaintenanceWindow setting for the DB cluster. |
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance
window.
|
void |
setAwsBackupRecoveryPointArn(String awsBackupRecoveryPointArn)
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
|
void |
setBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds.
|
void |
setBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained.
|
void |
setCACertificateIdentifier(String cACertificateIdentifier)
The CA certificate identifier to use for the DB cluster's server certificate.
|
void |
setCloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration)
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB
cluster.
|
void |
setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster.
|
void |
setDBClusterIdentifier(String dBClusterIdentifier)
The DB cluster identifier for the cluster being modified.
|
void |
setDBClusterInstanceClass(String dBClusterInstanceClass)
The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example
db.m6gd.xlarge . |
void |
setDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to use for the DB cluster.
|
void |
setDBInstanceParameterGroupName(String dBInstanceParameterGroupName)
The name of the DB parameter group to apply to all instances of the DB cluster.
|
void |
setDeletionProtection(Boolean deletionProtection)
Specifies whether the DB cluster has deletion protection enabled.
|
void |
setDomain(String domain)
The Active Directory directory ID to move the DB cluster to.
|
void |
setDomainIAMRoleName(String domainIAMRoleName)
The name of the IAM role to use when making API calls to the Directory Service.
|
void |
setEnableGlobalWriteForwarding(Boolean enableGlobalWriteForwarding)
Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global
cluster (Aurora global database).
|
void |
setEnableHttpEndpoint(Boolean enableHttpEndpoint)
Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster.
|
void |
setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to
database accounts.
|
void |
setEnableLimitlessDatabase(Boolean enableLimitlessDatabase)
Specifies whether to enable Aurora Limitless Database.
|
void |
setEnableLocalWriteForwarding(Boolean enableLocalWriteForwarding)
Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster.
|
void |
setEnablePerformanceInsights(Boolean enablePerformanceInsights)
Specifies whether to turn on Performance Insights for the DB cluster.
|
void |
setEngineMode(String engineMode)
The DB engine mode of the DB cluster, either
provisioned or serverless . |
void |
setEngineVersion(String engineVersion)
The version number of the database engine to which you want to upgrade.
|
void |
setIops(Integer iops)
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB
instance in the Multi-AZ DB cluster.
|
void |
setManageMasterUserPassword(Boolean manageMasterUserPassword)
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
|
void |
setMasterUserPassword(String masterUserPassword)
The new password for the master database user.
|
void |
setMasterUserSecretKmsKeyId(String masterUserSecretKmsKeyId)
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in
Amazon Web Services Secrets Manager.
|
void |
setMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
|
void |
setMonitoringRoleArn(String monitoringRoleArn)
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon
CloudWatch Logs.
|
void |
setNetworkType(String networkType)
The network type of the DB cluster.
|
void |
setNewDBClusterIdentifier(String newDBClusterIdentifier)
The new DB cluster identifier for the DB cluster when renaming a DB cluster.
|
void |
setOptionGroupName(String optionGroupName)
The option group to associate the DB cluster with.
|
void |
setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
|
void |
setPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The number of days to retain Performance Insights data.
|
void |
setPort(Integer port)
The port number on which the DB cluster accepts connections.
|
void |
setPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod parameter. |
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
void |
setRotateMasterUserPassword(Boolean rotateMasterUserPassword)
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user
password.
|
void |
setScalingConfiguration(ScalingConfiguration scalingConfiguration)
The scaling properties of the DB cluster.
|
void |
setServerlessV2ScalingConfiguration(ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration) |
void |
setStorageType(String storageType)
The storage type to associate with the DB cluster.
|
void |
setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB cluster.
|
String |
toString()
Returns a string representation of this object.
|
ModifyDBClusterRequest |
withAllocatedStorage(Integer allocatedStorage)
The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
|
ModifyDBClusterRequest |
withAllowEngineModeChange(Boolean allowEngineModeChange)
Specifies whether engine mode changes from
serverless to provisioned are allowed. |
ModifyDBClusterRequest |
withAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)
Specifies whether major version upgrades are allowed.
|
ModifyDBClusterRequest |
withApplyImmediately(Boolean applyImmediately)
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as
soon as possible, regardless of the
PreferredMaintenanceWindow setting for the DB cluster. |
ModifyDBClusterRequest |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance
window.
|
ModifyDBClusterRequest |
withAwsBackupRecoveryPointArn(String awsBackupRecoveryPointArn)
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
|
ModifyDBClusterRequest |
withBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds.
|
ModifyDBClusterRequest |
withBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained.
|
ModifyDBClusterRequest |
withCACertificateIdentifier(String cACertificateIdentifier)
The CA certificate identifier to use for the DB cluster's server certificate.
|
ModifyDBClusterRequest |
withCloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration)
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB
cluster.
|
ModifyDBClusterRequest |
withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster.
|
ModifyDBClusterRequest |
withDBClusterIdentifier(String dBClusterIdentifier)
The DB cluster identifier for the cluster being modified.
|
ModifyDBClusterRequest |
withDBClusterInstanceClass(String dBClusterInstanceClass)
The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example
db.m6gd.xlarge . |
ModifyDBClusterRequest |
withDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to use for the DB cluster.
|
ModifyDBClusterRequest |
withDBInstanceParameterGroupName(String dBInstanceParameterGroupName)
The name of the DB parameter group to apply to all instances of the DB cluster.
|
ModifyDBClusterRequest |
withDeletionProtection(Boolean deletionProtection)
Specifies whether the DB cluster has deletion protection enabled.
|
ModifyDBClusterRequest |
withDomain(String domain)
The Active Directory directory ID to move the DB cluster to.
|
ModifyDBClusterRequest |
withDomainIAMRoleName(String domainIAMRoleName)
The name of the IAM role to use when making API calls to the Directory Service.
|
ModifyDBClusterRequest |
withEnableGlobalWriteForwarding(Boolean enableGlobalWriteForwarding)
Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global
cluster (Aurora global database).
|
ModifyDBClusterRequest |
withEnableHttpEndpoint(Boolean enableHttpEndpoint)
Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster.
|
ModifyDBClusterRequest |
withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to
database accounts.
|
ModifyDBClusterRequest |
withEnableLimitlessDatabase(Boolean enableLimitlessDatabase)
Specifies whether to enable Aurora Limitless Database.
|
ModifyDBClusterRequest |
withEnableLocalWriteForwarding(Boolean enableLocalWriteForwarding)
Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster.
|
ModifyDBClusterRequest |
withEnablePerformanceInsights(Boolean enablePerformanceInsights)
Specifies whether to turn on Performance Insights for the DB cluster.
|
ModifyDBClusterRequest |
withEngineMode(String engineMode)
The DB engine mode of the DB cluster, either
provisioned or serverless . |
ModifyDBClusterRequest |
withEngineVersion(String engineVersion)
The version number of the database engine to which you want to upgrade.
|
ModifyDBClusterRequest |
withIops(Integer iops)
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB
instance in the Multi-AZ DB cluster.
|
ModifyDBClusterRequest |
withManageMasterUserPassword(Boolean manageMasterUserPassword)
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
|
ModifyDBClusterRequest |
withMasterUserPassword(String masterUserPassword)
The new password for the master database user.
|
ModifyDBClusterRequest |
withMasterUserSecretKmsKeyId(String masterUserSecretKmsKeyId)
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in
Amazon Web Services Secrets Manager.
|
ModifyDBClusterRequest |
withMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
|
ModifyDBClusterRequest |
withMonitoringRoleArn(String monitoringRoleArn)
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon
CloudWatch Logs.
|
ModifyDBClusterRequest |
withNetworkType(String networkType)
The network type of the DB cluster.
|
ModifyDBClusterRequest |
withNewDBClusterIdentifier(String newDBClusterIdentifier)
The new DB cluster identifier for the DB cluster when renaming a DB cluster.
|
ModifyDBClusterRequest |
withOptionGroupName(String optionGroupName)
The option group to associate the DB cluster with.
|
ModifyDBClusterRequest |
withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
|
ModifyDBClusterRequest |
withPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The number of days to retain Performance Insights data.
|
ModifyDBClusterRequest |
withPort(Integer port)
The port number on which the DB cluster accepts connections.
|
ModifyDBClusterRequest |
withPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod parameter. |
ModifyDBClusterRequest |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
ModifyDBClusterRequest |
withRotateMasterUserPassword(Boolean rotateMasterUserPassword)
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user
password.
|
ModifyDBClusterRequest |
withScalingConfiguration(ScalingConfiguration scalingConfiguration)
The scaling properties of the DB cluster.
|
ModifyDBClusterRequest |
withServerlessV2ScalingConfiguration(ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration) |
ModifyDBClusterRequest |
withStorageType(String storageType)
The storage type to associate with the DB cluster.
|
ModifyDBClusterRequest |
withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB cluster.
|
ModifyDBClusterRequest |
withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB cluster.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setDBClusterIdentifier(String dBClusterIdentifier)
The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must match the identifier of an existing DB cluster.
dBClusterIdentifier
- The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must match the identifier of an existing DB cluster.
public String getDBClusterIdentifier()
The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must match the identifier of an existing DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must match the identifier of an existing DB cluster.
public ModifyDBClusterRequest withDBClusterIdentifier(String dBClusterIdentifier)
The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must match the identifier of an existing DB cluster.
dBClusterIdentifier
- The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must match the identifier of an existing DB cluster.
public void setNewDBClusterIdentifier(String newDBClusterIdentifier)
The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster2
newDBClusterIdentifier
- The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a
lowercase string.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster2
public String getNewDBClusterIdentifier()
The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster2
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster2
public ModifyDBClusterRequest withNewDBClusterIdentifier(String newDBClusterIdentifier)
The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster2
newDBClusterIdentifier
- The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a
lowercase string.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster2
public void setApplyImmediately(Boolean applyImmediately)
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as
soon as possible, regardless of the PreferredMaintenanceWindow
setting for the DB cluster. If this
parameter is disabled, changes to the DB cluster are applied during the next maintenance window.
Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them.
By default, this parameter is disabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
applyImmediately
- Specifies whether the modifications in this request and any pending modifications are asynchronously
applied as soon as possible, regardless of the PreferredMaintenanceWindow
setting for the DB
cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance
window.
Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them.
By default, this parameter is disabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public Boolean getApplyImmediately()
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as
soon as possible, regardless of the PreferredMaintenanceWindow
setting for the DB cluster. If this
parameter is disabled, changes to the DB cluster are applied during the next maintenance window.
Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them.
By default, this parameter is disabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
PreferredMaintenanceWindow
setting for the DB
cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance
window.
Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them.
By default, this parameter is disabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public ModifyDBClusterRequest withApplyImmediately(Boolean applyImmediately)
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as
soon as possible, regardless of the PreferredMaintenanceWindow
setting for the DB cluster. If this
parameter is disabled, changes to the DB cluster are applied during the next maintenance window.
Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them.
By default, this parameter is disabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
applyImmediately
- Specifies whether the modifications in this request and any pending modifications are asynchronously
applied as soon as possible, regardless of the PreferredMaintenanceWindow
setting for the DB
cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance
window.
Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them.
By default, this parameter is disabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public Boolean isApplyImmediately()
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as
soon as possible, regardless of the PreferredMaintenanceWindow
setting for the DB cluster. If this
parameter is disabled, changes to the DB cluster are applied during the next maintenance window.
Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them.
By default, this parameter is disabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
PreferredMaintenanceWindow
setting for the DB
cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance
window.
Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them.
By default, this parameter is disabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public void setBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained. Specify a minimum value of 1
.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Default: 1
Constraints:
Must be a value from 1 to 35.
backupRetentionPeriod
- The number of days for which automated backups are retained. Specify a minimum value of 1
.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Default: 1
Constraints:
Must be a value from 1 to 35.
public Integer getBackupRetentionPeriod()
The number of days for which automated backups are retained. Specify a minimum value of 1
.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Default: 1
Constraints:
Must be a value from 1 to 35.
1
.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Default: 1
Constraints:
Must be a value from 1 to 35.
public ModifyDBClusterRequest withBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained. Specify a minimum value of 1
.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Default: 1
Constraints:
Must be a value from 1 to 35.
backupRetentionPeriod
- The number of days for which automated backups are retained. Specify a minimum value of 1
.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Default: 1
Constraints:
Must be a value from 1 to 35.
public void setDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to use for the DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
dBClusterParameterGroupName
- The name of the DB cluster parameter group to use for the DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public String getDBClusterParameterGroupName()
The name of the DB cluster parameter group to use for the DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public ModifyDBClusterRequest withDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to use for the DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
dBClusterParameterGroupName
- The name of the DB cluster parameter group to use for the DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public List<String> getVpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public ModifyDBClusterRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
NOTE: This method appends the values to the existing list (if any). Use
setVpcSecurityGroupIds(java.util.Collection)
or withVpcSecurityGroupIds(java.util.Collection)
if you want to override the existing values.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public ModifyDBClusterRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public void setPort(Integer port)
The port number on which the DB cluster accepts connections.
Valid for Cluster Type: Aurora DB clusters only
Valid Values: 1150-65535
Default: The same port as the original DB cluster.
port
- The port number on which the DB cluster accepts connections.
Valid for Cluster Type: Aurora DB clusters only
Valid Values: 1150-65535
Default: The same port as the original DB cluster.
public Integer getPort()
The port number on which the DB cluster accepts connections.
Valid for Cluster Type: Aurora DB clusters only
Valid Values: 1150-65535
Default: The same port as the original DB cluster.
Valid for Cluster Type: Aurora DB clusters only
Valid Values: 1150-65535
Default: The same port as the original DB cluster.
public ModifyDBClusterRequest withPort(Integer port)
The port number on which the DB cluster accepts connections.
Valid for Cluster Type: Aurora DB clusters only
Valid Values: 1150-65535
Default: The same port as the original DB cluster.
port
- The port number on which the DB cluster accepts connections.
Valid for Cluster Type: Aurora DB clusters only
Valid Values: 1150-65535
Default: The same port as the original DB cluster.
public void setMasterUserPassword(String masterUserPassword)
The new password for the master database user.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 8 to 41 characters.
Can contain any printable ASCII character except "/", """, or "@".
Can't be specified if ManageMasterUserPassword
is turned on.
masterUserPassword
- The new password for the master database user.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 8 to 41 characters.
Can contain any printable ASCII character except "/", """, or "@".
Can't be specified if ManageMasterUserPassword
is turned on.
public String getMasterUserPassword()
The new password for the master database user.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 8 to 41 characters.
Can contain any printable ASCII character except "/", """, or "@".
Can't be specified if ManageMasterUserPassword
is turned on.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 8 to 41 characters.
Can contain any printable ASCII character except "/", """, or "@".
Can't be specified if ManageMasterUserPassword
is turned on.
public ModifyDBClusterRequest withMasterUserPassword(String masterUserPassword)
The new password for the master database user.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 8 to 41 characters.
Can contain any printable ASCII character except "/", """, or "@".
Can't be specified if ManageMasterUserPassword
is turned on.
masterUserPassword
- The new password for the master database user.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 8 to 41 characters.
Can contain any printable ASCII character except "/", """, or "@".
Can't be specified if ManageMasterUserPassword
is turned on.
public void setOptionGroupName(String optionGroupName)
The option group to associate the DB cluster with.
DB clusters are associated with a default option group that can't be modified.
optionGroupName
- The option group to associate the DB cluster with.
DB clusters are associated with a default option group that can't be modified.
public String getOptionGroupName()
The option group to associate the DB cluster with.
DB clusters are associated with a default option group that can't be modified.
DB clusters are associated with a default option group that can't be modified.
public ModifyDBClusterRequest withOptionGroupName(String optionGroupName)
The option group to associate the DB cluster with.
DB clusters are associated with a default option group that can't be modified.
optionGroupName
- The option group to associate the DB cluster with.
DB clusters are associated with a default option group that can't be modified.
public void setPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
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.
preferredBackupWindow
- The daily time range during which automated backups are created if automated backups are enabled, using
the BackupRetentionPeriod
parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
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.
public String getPreferredBackupWindow()
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
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.
BackupRetentionPeriod
parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
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.
public ModifyDBClusterRequest withPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
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.
preferredBackupWindow
- The daily time range during which automated backups are created if automated backups are enabled, using
the BackupRetentionPeriod
parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
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.
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi
.
Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun
.
Must be in Universal Coordinated Time (UTC).
Must be at least 30 minutes.
preferredMaintenanceWindow
- The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi
.
Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun
.
Must be in Universal Coordinated Time (UTC).
Must be at least 30 minutes.
public String getPreferredMaintenanceWindow()
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi
.
Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun
.
Must be in Universal Coordinated Time (UTC).
Must be at least 30 minutes.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi
.
Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun
.
Must be in Universal Coordinated Time (UTC).
Must be at least 30 minutes.
public ModifyDBClusterRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi
.
Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun
.
Must be in Universal Coordinated Time (UTC).
Must be at least 30 minutes.
preferredMaintenanceWindow
- The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi
.
Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun
.
Must be in Universal Coordinated Time (UTC).
Must be at least 30 minutes.
public void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
enableIAMDatabaseAuthentication
- Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts
to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
public Boolean getEnableIAMDatabaseAuthentication()
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
public ModifyDBClusterRequest withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
enableIAMDatabaseAuthentication
- Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts
to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
public Boolean isEnableIAMDatabaseAuthentication()
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
public void setBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds. To disable backtracking, set this value to 0
.
Valid for Cluster Type: Aurora MySQL DB clusters only
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
backtrackWindow
- The target backtrack window, in seconds. To disable backtracking, set this value to 0
.
Valid for Cluster Type: Aurora MySQL DB clusters only
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
public Long getBacktrackWindow()
The target backtrack window, in seconds. To disable backtracking, set this value to 0
.
Valid for Cluster Type: Aurora MySQL DB clusters only
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
0
.
Valid for Cluster Type: Aurora MySQL DB clusters only
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
public ModifyDBClusterRequest withBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds. To disable backtracking, set this value to 0
.
Valid for Cluster Type: Aurora MySQL DB clusters only
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
backtrackWindow
- The target backtrack window, in seconds. To disable backtracking, set this value to 0
.
Valid for Cluster Type: Aurora MySQL DB clusters only
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
public void setCloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration)
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The following values are valid for each DB engine:
Aurora MySQL - audit | error | general | slowquery
Aurora PostgreSQL - postgresql
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
cloudwatchLogsExportConfiguration
- The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB
cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The following values are valid for each DB engine:
Aurora MySQL - audit | error | general | slowquery
Aurora PostgreSQL - postgresql
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
public CloudwatchLogsExportConfiguration getCloudwatchLogsExportConfiguration()
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The following values are valid for each DB engine:
Aurora MySQL - audit | error | general | slowquery
Aurora PostgreSQL - postgresql
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The following values are valid for each DB engine:
Aurora MySQL - audit | error | general | slowquery
Aurora PostgreSQL - postgresql
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
public ModifyDBClusterRequest withCloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration)
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The following values are valid for each DB engine:
Aurora MySQL - audit | error | general | slowquery
Aurora PostgreSQL - postgresql
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
cloudwatchLogsExportConfiguration
- The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB
cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The following values are valid for each DB engine:
Aurora MySQL - audit | error | general | slowquery
Aurora PostgreSQL - postgresql
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
public void setEngineVersion(String engineVersion)
The version number of the database engine to which you want to upgrade. Changing this parameter results in an
outage. The change is applied during the next maintenance window unless ApplyImmediately
is enabled.
If the cluster that you're modifying has one or more read replicas, all replicas must be running an engine version that's the same or later than the version you specify.
To list all of the available engine versions for Aurora MySQL, 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"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
engineVersion
- The version number of the database engine to which you want to upgrade. Changing this parameter results in
an outage. The change is applied during the next maintenance window unless ApplyImmediately
is enabled.
If the cluster that you're modifying has one or more read replicas, all replicas must be running an engine version that's the same or later than the version you specify.
To list all of the available engine versions for Aurora MySQL, 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"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public String getEngineVersion()
The version number of the database engine to which you want to upgrade. Changing this parameter results in an
outage. The change is applied during the next maintenance window unless ApplyImmediately
is enabled.
If the cluster that you're modifying has one or more read replicas, all replicas must be running an engine version that's the same or later than the version you specify.
To list all of the available engine versions for Aurora MySQL, 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"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
ApplyImmediately
is enabled.
If the cluster that you're modifying has one or more read replicas, all replicas must be running an engine version that's the same or later than the version you specify.
To list all of the available engine versions for Aurora MySQL, 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"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public ModifyDBClusterRequest withEngineVersion(String engineVersion)
The version number of the database engine to which you want to upgrade. Changing this parameter results in an
outage. The change is applied during the next maintenance window unless ApplyImmediately
is enabled.
If the cluster that you're modifying has one or more read replicas, all replicas must be running an engine version that's the same or later than the version you specify.
To list all of the available engine versions for Aurora MySQL, 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"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
engineVersion
- The version number of the database engine to which you want to upgrade. Changing this parameter results in
an outage. The change is applied during the next maintenance window unless ApplyImmediately
is enabled.
If the cluster that you're modifying has one or more read replicas, all replicas must be running an engine version that's the same or later than the version you specify.
To list all of the available engine versions for Aurora MySQL, 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"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public void setAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)
Specifies whether major version upgrades are allowed.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
You must allow major version upgrades when specifying a value for the EngineVersion
parameter that
is a different major version than the DB cluster's current version.
allowMajorVersionUpgrade
- Specifies whether major version upgrades are allowed.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
You must allow major version upgrades when specifying a value for the EngineVersion
parameter
that is a different major version than the DB cluster's current version.
public Boolean getAllowMajorVersionUpgrade()
Specifies whether major version upgrades are allowed.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
You must allow major version upgrades when specifying a value for the EngineVersion
parameter that
is a different major version than the DB cluster's current version.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
You must allow major version upgrades when specifying a value for the EngineVersion
parameter that is a different major version than the DB cluster's current version.
public ModifyDBClusterRequest withAllowMajorVersionUpgrade(Boolean allowMajorVersionUpgrade)
Specifies whether major version upgrades are allowed.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
You must allow major version upgrades when specifying a value for the EngineVersion
parameter that
is a different major version than the DB cluster's current version.
allowMajorVersionUpgrade
- Specifies whether major version upgrades are allowed.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
You must allow major version upgrades when specifying a value for the EngineVersion
parameter
that is a different major version than the DB cluster's current version.
public Boolean isAllowMajorVersionUpgrade()
Specifies whether major version upgrades are allowed.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
You must allow major version upgrades when specifying a value for the EngineVersion
parameter that
is a different major version than the DB cluster's current version.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
You must allow major version upgrades when specifying a value for the EngineVersion
parameter that is a different major version than the DB cluster's current version.
public void setDBInstanceParameterGroupName(String dBInstanceParameterGroupName)
The name of the DB parameter group to apply to all instances of the DB cluster.
When you apply a parameter group using the DBInstanceParameterGroupName
parameter, the DB cluster
isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next
maintenance window.
Valid for Cluster Type: Aurora DB clusters only
Default: The existing name setting
Constraints:
The DB parameter group must be in the same DB parameter group family as this DB cluster.
The DBInstanceParameterGroupName
parameter is valid in combination with the
AllowMajorVersionUpgrade
parameter for a major version upgrade only.
dBInstanceParameterGroupName
- The name of the DB parameter group to apply to all instances of the DB cluster.
When you apply a parameter group using the DBInstanceParameterGroupName
parameter, the DB
cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during
the next maintenance window.
Valid for Cluster Type: Aurora DB clusters only
Default: The existing name setting
Constraints:
The DB parameter group must be in the same DB parameter group family as this DB cluster.
The DBInstanceParameterGroupName
parameter is valid in combination with the
AllowMajorVersionUpgrade
parameter for a major version upgrade only.
public String getDBInstanceParameterGroupName()
The name of the DB parameter group to apply to all instances of the DB cluster.
When you apply a parameter group using the DBInstanceParameterGroupName
parameter, the DB cluster
isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next
maintenance window.
Valid for Cluster Type: Aurora DB clusters only
Default: The existing name setting
Constraints:
The DB parameter group must be in the same DB parameter group family as this DB cluster.
The DBInstanceParameterGroupName
parameter is valid in combination with the
AllowMajorVersionUpgrade
parameter for a major version upgrade only.
When you apply a parameter group using the DBInstanceParameterGroupName
parameter, the DB
cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during
the next maintenance window.
Valid for Cluster Type: Aurora DB clusters only
Default: The existing name setting
Constraints:
The DB parameter group must be in the same DB parameter group family as this DB cluster.
The DBInstanceParameterGroupName
parameter is valid in combination with the
AllowMajorVersionUpgrade
parameter for a major version upgrade only.
public ModifyDBClusterRequest withDBInstanceParameterGroupName(String dBInstanceParameterGroupName)
The name of the DB parameter group to apply to all instances of the DB cluster.
When you apply a parameter group using the DBInstanceParameterGroupName
parameter, the DB cluster
isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next
maintenance window.
Valid for Cluster Type: Aurora DB clusters only
Default: The existing name setting
Constraints:
The DB parameter group must be in the same DB parameter group family as this DB cluster.
The DBInstanceParameterGroupName
parameter is valid in combination with the
AllowMajorVersionUpgrade
parameter for a major version upgrade only.
dBInstanceParameterGroupName
- The name of the DB parameter group to apply to all instances of the DB cluster.
When you apply a parameter group using the DBInstanceParameterGroupName
parameter, the DB
cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during
the next maintenance window.
Valid for Cluster Type: Aurora DB clusters only
Default: The existing name setting
Constraints:
The DB parameter group must be in the same DB parameter group family as this DB cluster.
The DBInstanceParameterGroupName
parameter is valid in combination with the
AllowMajorVersionUpgrade
parameter for a major version upgrade only.
public void setDomain(String domain)
The Active Directory directory ID to move the DB cluster to. Specify none
to remove the cluster from
its current domain. The domain must be created prior to this operation.
For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
domain
- The Active Directory directory ID to move the DB cluster to. Specify none
to remove the
cluster from its current domain. The domain must be created prior to this operation.
For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
public String getDomain()
The Active Directory directory ID to move the DB cluster to. Specify none
to remove the cluster from
its current domain. The domain must be created prior to this operation.
For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
none
to remove the
cluster from its current domain. The domain must be created prior to this operation.
For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
public ModifyDBClusterRequest withDomain(String domain)
The Active Directory directory ID to move the DB cluster to. Specify none
to remove the cluster from
its current domain. The domain must be created prior to this operation.
For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
domain
- The Active Directory directory ID to move the DB cluster to. Specify none
to remove the
cluster from its current domain. The domain must be created prior to this operation.
For more information, see Kerberos Authentication in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
public void setDomainIAMRoleName(String domainIAMRoleName)
The name of the IAM role to use when making API calls to the Directory Service.
Valid for Cluster Type: Aurora DB clusters only
domainIAMRoleName
- The name of the IAM role to use when making API calls to the Directory Service.
Valid for Cluster Type: Aurora DB clusters only
public String getDomainIAMRoleName()
The name of the IAM role to use when making API calls to the Directory Service.
Valid for Cluster Type: Aurora DB clusters only
Valid for Cluster Type: Aurora DB clusters only
public ModifyDBClusterRequest withDomainIAMRoleName(String domainIAMRoleName)
The name of the IAM role to use when making API calls to the Directory Service.
Valid for Cluster Type: Aurora DB clusters only
domainIAMRoleName
- The name of the IAM role to use when making API calls to the Directory Service.
Valid for Cluster Type: Aurora DB clusters only
public void setScalingConfiguration(ScalingConfiguration scalingConfiguration)
The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in
serverless
DB engine mode.
Valid for Cluster Type: Aurora DB clusters only
scalingConfiguration
- The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in
serverless
DB engine mode.
Valid for Cluster Type: Aurora DB clusters only
public ScalingConfiguration getScalingConfiguration()
The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in
serverless
DB engine mode.
Valid for Cluster Type: Aurora DB clusters only
serverless
DB engine mode.
Valid for Cluster Type: Aurora DB clusters only
public ModifyDBClusterRequest withScalingConfiguration(ScalingConfiguration scalingConfiguration)
The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in
serverless
DB engine mode.
Valid for Cluster Type: Aurora DB clusters only
scalingConfiguration
- The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in
serverless
DB engine mode.
Valid for Cluster Type: Aurora DB clusters only
public void setDeletionProtection(Boolean deletionProtection)
Specifies whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
deletionProtection
- Specifies whether the DB cluster has deletion protection enabled. The database can't be deleted when
deletion protection is enabled. By default, deletion protection isn't enabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public Boolean getDeletionProtection()
Specifies whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public ModifyDBClusterRequest withDeletionProtection(Boolean deletionProtection)
Specifies whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
deletionProtection
- Specifies whether the DB cluster has deletion protection enabled. The database can't be deleted when
deletion protection is enabled. By default, deletion protection isn't enabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public Boolean isDeletionProtection()
Specifies whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public void setEnableHttpEndpoint(Boolean enableHttpEndpoint)
Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint isn't enabled.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
This parameter applies only to Aurora Serverless v1 DB clusters. To enable or disable the HTTP endpoint for an
Aurora PostgreSQL Serverless v2 or provisioned DB cluster, use the EnableHttpEndpoint
and
DisableHttpEndpoint
operations.
Valid for Cluster Type: Aurora DB clusters only
enableHttpEndpoint
- Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP
endpoint isn't enabled.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
This parameter applies only to Aurora Serverless v1 DB clusters. To enable or disable the HTTP endpoint
for an Aurora PostgreSQL Serverless v2 or provisioned DB cluster, use the EnableHttpEndpoint
and DisableHttpEndpoint
operations.
Valid for Cluster Type: Aurora DB clusters only
public Boolean getEnableHttpEndpoint()
Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint isn't enabled.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
This parameter applies only to Aurora Serverless v1 DB clusters. To enable or disable the HTTP endpoint for an
Aurora PostgreSQL Serverless v2 or provisioned DB cluster, use the EnableHttpEndpoint
and
DisableHttpEndpoint
operations.
Valid for Cluster Type: Aurora DB clusters only
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
This parameter applies only to Aurora Serverless v1 DB clusters. To enable or disable the HTTP endpoint
for an Aurora PostgreSQL Serverless v2 or provisioned DB cluster, use the EnableHttpEndpoint
and DisableHttpEndpoint
operations.
Valid for Cluster Type: Aurora DB clusters only
public ModifyDBClusterRequest withEnableHttpEndpoint(Boolean enableHttpEndpoint)
Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint isn't enabled.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
This parameter applies only to Aurora Serverless v1 DB clusters. To enable or disable the HTTP endpoint for an
Aurora PostgreSQL Serverless v2 or provisioned DB cluster, use the EnableHttpEndpoint
and
DisableHttpEndpoint
operations.
Valid for Cluster Type: Aurora DB clusters only
enableHttpEndpoint
- Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP
endpoint isn't enabled.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
This parameter applies only to Aurora Serverless v1 DB clusters. To enable or disable the HTTP endpoint
for an Aurora PostgreSQL Serverless v2 or provisioned DB cluster, use the EnableHttpEndpoint
and DisableHttpEndpoint
operations.
Valid for Cluster Type: Aurora DB clusters only
public Boolean isEnableHttpEndpoint()
Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint isn't enabled.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
This parameter applies only to Aurora Serverless v1 DB clusters. To enable or disable the HTTP endpoint for an
Aurora PostgreSQL Serverless v2 or provisioned DB cluster, use the EnableHttpEndpoint
and
DisableHttpEndpoint
operations.
Valid for Cluster Type: Aurora DB clusters only
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
This parameter applies only to Aurora Serverless v1 DB clusters. To enable or disable the HTTP endpoint
for an Aurora PostgreSQL Serverless v2 or provisioned DB cluster, use the EnableHttpEndpoint
and DisableHttpEndpoint
operations.
Valid for Cluster Type: Aurora DB clusters only
public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
copyTagsToSnapshot
- Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not
to copy them.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public Boolean getCopyTagsToSnapshot()
Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public ModifyDBClusterRequest withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
copyTagsToSnapshot
- Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not
to copy them.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public Boolean isCopyTagsToSnapshot()
Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public void setEnableGlobalWriteForwarding(Boolean enableGlobalWriteForwarding)
Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). 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 a global cluster API operation, but it does nothing until then.
Valid for Cluster Type: Aurora DB clusters only
enableGlobalWriteForwarding
- Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global
cluster (Aurora global database). 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 a global cluster API operation, but it does nothing until then.
Valid for Cluster Type: Aurora DB clusters only
public Boolean getEnableGlobalWriteForwarding()
Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). 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 a global cluster API operation, but it does nothing until then.
Valid for Cluster Type: Aurora DB clusters only
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 a global cluster API operation, but it does nothing until then.
Valid for Cluster Type: Aurora DB clusters only
public ModifyDBClusterRequest withEnableGlobalWriteForwarding(Boolean enableGlobalWriteForwarding)
Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). 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 a global cluster API operation, but it does nothing until then.
Valid for Cluster Type: Aurora DB clusters only
enableGlobalWriteForwarding
- Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global
cluster (Aurora global database). 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 a global cluster API operation, but it does nothing until then.
Valid for Cluster Type: Aurora DB clusters only
public Boolean isEnableGlobalWriteForwarding()
Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). 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 a global cluster API operation, but it does nothing until then.
Valid for Cluster Type: Aurora DB clusters only
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 a global cluster API operation, but it does nothing until then.
Valid for Cluster Type: Aurora DB clusters only
public void setDBClusterInstanceClass(String dBClusterInstanceClass)
The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example
db.m6gd.xlarge
. Not all DB instance classes are available in all Amazon Web Services Regions, or for
all database engines.
For the full list of DB instance classes and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
dBClusterInstanceClass
- The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example
db.m6gd.xlarge
. Not all DB instance classes are available in all Amazon Web Services Regions,
or for all database engines.
For the full list of DB instance classes and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
public String getDBClusterInstanceClass()
The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example
db.m6gd.xlarge
. Not all DB instance classes are available in all Amazon Web Services Regions, or for
all database engines.
For the full list of DB instance classes and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
db.m6gd.xlarge
. Not all DB instance classes are available in all Amazon Web Services
Regions, or for all database engines.
For the full list of DB instance classes and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
public ModifyDBClusterRequest withDBClusterInstanceClass(String dBClusterInstanceClass)
The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example
db.m6gd.xlarge
. Not all DB instance classes are available in all Amazon Web Services Regions, or for
all database engines.
For the full list of DB instance classes and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
dBClusterInstanceClass
- The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example
db.m6gd.xlarge
. Not all DB instance classes are available in all Amazon Web Services Regions,
or for all database engines.
For the full list of DB instance classes and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
public void setAllocatedStorage(Integer allocatedStorage)
The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
allocatedStorage
- The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
public Integer getAllocatedStorage()
The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid for Cluster Type: Multi-AZ DB clusters only
public ModifyDBClusterRequest withAllocatedStorage(Integer allocatedStorage)
The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
allocatedStorage
- The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
public void setStorageType(String storageType)
The storage type to associate with the DB cluster.
For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters.
When specified for a Multi-AZ DB cluster, a value for the Iops
parameter is required.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
Aurora DB clusters - aurora | aurora-iopt1
Multi-AZ DB clusters - io1 | io2 | gp3
Default:
Aurora DB clusters - aurora
Multi-AZ DB clusters - io1
storageType
- The storage type to associate with the DB cluster.
For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters.
When specified for a Multi-AZ DB cluster, a value for the Iops
parameter is required.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
Aurora DB clusters - aurora | aurora-iopt1
Multi-AZ DB clusters - io1 | io2 | gp3
Default:
Aurora DB clusters - aurora
Multi-AZ DB clusters - io1
public String getStorageType()
The storage type to associate with the DB cluster.
For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters.
When specified for a Multi-AZ DB cluster, a value for the Iops
parameter is required.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
Aurora DB clusters - aurora | aurora-iopt1
Multi-AZ DB clusters - io1 | io2 | gp3
Default:
Aurora DB clusters - aurora
Multi-AZ DB clusters - io1
For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters.
When specified for a Multi-AZ DB cluster, a value for the Iops
parameter is required.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
Aurora DB clusters - aurora | aurora-iopt1
Multi-AZ DB clusters - io1 | io2 | gp3
Default:
Aurora DB clusters - aurora
Multi-AZ DB clusters - io1
public ModifyDBClusterRequest withStorageType(String storageType)
The storage type to associate with the DB cluster.
For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters.
When specified for a Multi-AZ DB cluster, a value for the Iops
parameter is required.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
Aurora DB clusters - aurora | aurora-iopt1
Multi-AZ DB clusters - io1 | io2 | gp3
Default:
Aurora DB clusters - aurora
Multi-AZ DB clusters - io1
storageType
- The storage type to associate with the DB cluster.
For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters.
When specified for a Multi-AZ DB cluster, a value for the Iops
parameter is required.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
Aurora DB clusters - aurora | aurora-iopt1
Multi-AZ DB clusters - io1 | io2 | gp3
Default:
Aurora DB clusters - aurora
Multi-AZ DB clusters - io1
public void setIops(Integer iops)
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
Constraints:
Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
iops
- The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB
instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
Constraints:
Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
public Integer getIops()
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
Constraints:
Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
Constraints:
Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
public ModifyDBClusterRequest withIops(Integer iops)
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
Constraints:
Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
iops
- The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB
instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
Constraints:
Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
Valid for Cluster Type: Multi-AZ DB clusters only
autoMinorVersionUpgrade
- Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance
window. By default, minor engine upgrades are applied automatically.
Valid for Cluster Type: Multi-AZ DB clusters only
public Boolean getAutoMinorVersionUpgrade()
Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid for Cluster Type: Multi-AZ DB clusters only
public ModifyDBClusterRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
Valid for Cluster Type: Multi-AZ DB clusters only
autoMinorVersionUpgrade
- Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance
window. By default, minor engine upgrades are applied automatically.
Valid for Cluster Type: Multi-AZ DB clusters only
public Boolean isAutoMinorVersionUpgrade()
Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid for Cluster Type: Multi-AZ DB clusters only
public void setMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To
turn off collecting Enhanced Monitoring metrics, specify 0
.
If MonitoringRoleArn
is specified, also set MonitoringInterval
to a value other than
0
.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB
cluster. To turn off collecting Enhanced Monitoring metrics, specify 0
.
If MonitoringRoleArn
is specified, also set MonitoringInterval
to a value other
than 0
.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
public Integer getMonitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To
turn off collecting Enhanced Monitoring metrics, specify 0
.
If MonitoringRoleArn
is specified, also set MonitoringInterval
to a value other than
0
.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
0
.
If MonitoringRoleArn
is specified, also set MonitoringInterval
to a value other
than 0
.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
public ModifyDBClusterRequest withMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To
turn off collecting Enhanced Monitoring metrics, specify 0
.
If MonitoringRoleArn
is specified, also set MonitoringInterval
to a value other than
0
.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB
cluster. To turn off collecting Enhanced Monitoring metrics, specify 0
.
If MonitoringRoleArn
is specified, also set MonitoringInterval
to a value other
than 0
.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
public void setMonitoringRoleArn(String monitoringRoleArn)
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon
CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess
. For information on creating a
monitoring role, see To
create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval
is set to a value other than 0
, supply a
MonitoringRoleArn
value.
Valid for Cluster Type: Multi-AZ DB clusters only
monitoringRoleArn
- The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to
Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess
. For information
on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval
is set to a value other than 0
, supply a
MonitoringRoleArn
value.
Valid for Cluster Type: Multi-AZ DB clusters only
public String getMonitoringRoleArn()
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon
CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess
. For information on creating a
monitoring role, see To
create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval
is set to a value other than 0
, supply a
MonitoringRoleArn
value.
Valid for Cluster Type: Multi-AZ DB clusters only
arn:aws:iam:123456789012:role/emaccess
. For
information on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval
is set to a value other than 0
, supply a
MonitoringRoleArn
value.
Valid for Cluster Type: Multi-AZ DB clusters only
public ModifyDBClusterRequest withMonitoringRoleArn(String monitoringRoleArn)
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon
CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess
. For information on creating a
monitoring role, see To
create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval
is set to a value other than 0
, supply a
MonitoringRoleArn
value.
Valid for Cluster Type: Multi-AZ DB clusters only
monitoringRoleArn
- The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to
Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess
. For information
on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval
is set to a value other than 0
, supply a
MonitoringRoleArn
value.
Valid for Cluster Type: Multi-AZ DB clusters only
public void setEnablePerformanceInsights(Boolean enablePerformanceInsights)
Specifies whether to turn on Performance Insights for the DB cluster.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
enablePerformanceInsights
- Specifies whether to turn on Performance Insights for the DB cluster.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
public Boolean getEnablePerformanceInsights()
Specifies whether to turn on Performance Insights for the DB cluster.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
public ModifyDBClusterRequest withEnablePerformanceInsights(Boolean enablePerformanceInsights)
Specifies whether to turn on Performance Insights for the DB cluster.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
enablePerformanceInsights
- Specifies whether to turn on Performance Insights for the DB cluster.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
public Boolean isEnablePerformanceInsights()
Specifies whether to turn on Performance Insights for the DB cluster.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
public void setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don't specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS
key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a
different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Multi-AZ DB clusters only
performanceInsightsKMSKeyId
- The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don't specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your
default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services
account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Multi-AZ DB clusters only
public String getPerformanceInsightsKMSKeyId()
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don't specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS
key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a
different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Multi-AZ DB clusters only
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don't specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your
default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web
Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Multi-AZ DB clusters only
public ModifyDBClusterRequest withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don't specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS
key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a
different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Multi-AZ DB clusters only
performanceInsightsKMSKeyId
- The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don't specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your
default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services
account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Multi-AZ DB clusters only
public void setPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The number of days to retain Performance Insights data.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93
(3 months * 31),
341
(11 months * 31), 589
(19 months * 31)
731
Default: 7
days
If you specify a retention period that isn't valid, such as 94
, Amazon RDS issues an error.
performanceInsightsRetentionPeriod
- The number of days to retain Performance Insights data.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93
(3 months
* 31), 341
(11 months * 31), 589
(19 months * 31)
731
Default: 7
days
If you specify a retention period that isn't valid, such as 94
, Amazon RDS issues an error.
public Integer getPerformanceInsightsRetentionPeriod()
The number of days to retain Performance Insights data.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93
(3 months * 31),
341
(11 months * 31), 589
(19 months * 31)
731
Default: 7
days
If you specify a retention period that isn't valid, such as 94
, Amazon RDS issues an error.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93
(3
months * 31), 341
(11 months * 31), 589
(19 months * 31)
731
Default: 7
days
If you specify a retention period that isn't valid, such as 94
, Amazon RDS issues an error.
public ModifyDBClusterRequest withPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The number of days to retain Performance Insights data.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93
(3 months * 31),
341
(11 months * 31), 589
(19 months * 31)
731
Default: 7
days
If you specify a retention period that isn't valid, such as 94
, Amazon RDS issues an error.
performanceInsightsRetentionPeriod
- The number of days to retain Performance Insights data.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values:
7
month * 31, where month is a number of months from 1-23. Examples: 93
(3 months
* 31), 341
(11 months * 31), 589
(19 months * 31)
731
Default: 7
days
If you specify a retention period that isn't valid, such as 94
, Amazon RDS issues an error.
public void setServerlessV2ScalingConfiguration(ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration)
serverlessV2ScalingConfiguration
- public ServerlessV2ScalingConfiguration getServerlessV2ScalingConfiguration()
public ModifyDBClusterRequest withServerlessV2ScalingConfiguration(ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration)
serverlessV2ScalingConfiguration
- public void setNetworkType(String networkType)
The network type of the DB cluster.
The network type is determined by the DBSubnetGroup
specified for the DB cluster. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
Valid Values: IPV4 | DUAL
networkType
- The network type of the DB cluster.
The network type is determined by the DBSubnetGroup
specified for the DB cluster. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
Valid Values: IPV4 | DUAL
public String getNetworkType()
The network type of the DB cluster.
The network type is determined by the DBSubnetGroup
specified for the DB cluster. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
Valid Values: IPV4 | DUAL
The network type is determined by the DBSubnetGroup
specified for the DB cluster. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
Valid Values: IPV4 | DUAL
public ModifyDBClusterRequest withNetworkType(String networkType)
The network type of the DB cluster.
The network type is determined by the DBSubnetGroup
specified for the DB cluster. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
Valid Values: IPV4 | DUAL
networkType
- The network type of the DB cluster.
The network type is determined by the DBSubnetGroup
specified for the DB cluster. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
Valid Values: IPV4 | DUAL
public void setManageMasterUserPassword(Boolean manageMasterUserPassword)
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn
on this management. In this case, you can't specify MasterUserPassword
.
If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you
specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must
specify MasterUserPassword
. In this case, RDS deletes the secret and uses the new password for the
master user specified by MasterUserPassword
.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
manageMasterUserPassword
- Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you
can turn on this management. In this case, you can't specify MasterUserPassword
.
If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and
you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then
you must specify MasterUserPassword
. In this case, RDS deletes the secret and uses the new
password for the master user specified by MasterUserPassword
.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public Boolean getManageMasterUserPassword()
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn
on this management. In this case, you can't specify MasterUserPassword
.
If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you
specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must
specify MasterUserPassword
. In this case, RDS deletes the secret and uses the new password for the
master user specified by MasterUserPassword
.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you
can turn on this management. In this case, you can't specify MasterUserPassword
.
If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and
you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then
you must specify MasterUserPassword
. In this case, RDS deletes the secret and uses the new
password for the master user specified by MasterUserPassword
.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public ModifyDBClusterRequest withManageMasterUserPassword(Boolean manageMasterUserPassword)
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn
on this management. In this case, you can't specify MasterUserPassword
.
If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you
specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must
specify MasterUserPassword
. In this case, RDS deletes the secret and uses the new password for the
master user specified by MasterUserPassword
.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
manageMasterUserPassword
- Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you
can turn on this management. In this case, you can't specify MasterUserPassword
.
If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and
you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then
you must specify MasterUserPassword
. In this case, RDS deletes the secret and uses the new
password for the master user specified by MasterUserPassword
.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public Boolean isManageMasterUserPassword()
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn
on this management. In this case, you can't specify MasterUserPassword
.
If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you
specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must
specify MasterUserPassword
. In this case, RDS deletes the secret and uses the new password for the
master user specified by MasterUserPassword
.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you
can turn on this management. In this case, you can't specify MasterUserPassword
.
If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and
you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then
you must specify MasterUserPassword
. In this case, RDS deletes the secret and uses the new
password for the master user specified by MasterUserPassword
.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public void setRotateMasterUserPassword(Boolean rotateMasterUserPassword)
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
You must apply the change immediately when rotating the master user password.
rotateMasterUserPassword
- Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user
password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
You must apply the change immediately when rotating the master user password.
public Boolean getRotateMasterUserPassword()
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
You must apply the change immediately when rotating the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
You must apply the change immediately when rotating the master user password.
public ModifyDBClusterRequest withRotateMasterUserPassword(Boolean rotateMasterUserPassword)
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
You must apply the change immediately when rotating the master user password.
rotateMasterUserPassword
- Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user
password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
You must apply the change immediately when rotating the master user password.
public Boolean isRotateMasterUserPassword()
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
You must apply the change immediately when rotating the master user password.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. The secret value contains the updated password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
You must apply the change immediately when rotating the master user password.
public void setMasterUserSecretKmsKeyId(String masterUserSecretKmsKeyId)
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
The DB cluster doesn't manage the master user password in Amazon Web Services Secrets Manager.
If the DB cluster already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key that is used to encrypt the secret.
You are turning on ManageMasterUserPassword
to manage the master user password in Amazon Web
Services Secrets Manager.
If you are turning on ManageMasterUserPassword
and don't specify
MasterUserSecretKmsKeyId
, then the aws/secretsmanager
KMS key is used to encrypt the
secret. If the secret is in a different Amazon Web Services account, then you can't use the
aws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
masterUserSecretKmsKeyId
- The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed
in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
The DB cluster doesn't manage the master user password in Amazon Web Services Secrets Manager.
If the DB cluster already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key that is used to encrypt the secret.
You are turning on ManageMasterUserPassword
to manage the master user password in Amazon Web
Services Secrets Manager.
If you are turning on ManageMasterUserPassword
and don't specify
MasterUserSecretKmsKeyId
, then the aws/secretsmanager
KMS key is used to encrypt
the secret. If the secret is in a different Amazon Web Services account, then you can't use the
aws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS
key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public String getMasterUserSecretKmsKeyId()
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
The DB cluster doesn't manage the master user password in Amazon Web Services Secrets Manager.
If the DB cluster already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key that is used to encrypt the secret.
You are turning on ManageMasterUserPassword
to manage the master user password in Amazon Web
Services Secrets Manager.
If you are turning on ManageMasterUserPassword
and don't specify
MasterUserSecretKmsKeyId
, then the aws/secretsmanager
KMS key is used to encrypt the
secret. If the secret is in a different Amazon Web Services account, then you can't use the
aws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
This setting is valid only if both of the following conditions are met:
The DB cluster doesn't manage the master user password in Amazon Web Services Secrets Manager.
If the DB cluster already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key that is used to encrypt the secret.
You are turning on ManageMasterUserPassword
to manage the master user password in Amazon Web
Services Secrets Manager.
If you are turning on ManageMasterUserPassword
and don't specify
MasterUserSecretKmsKeyId
, then the aws/secretsmanager
KMS key is used to
encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the
aws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS
key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public ModifyDBClusterRequest withMasterUserSecretKmsKeyId(String masterUserSecretKmsKeyId)
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
The DB cluster doesn't manage the master user password in Amazon Web Services Secrets Manager.
If the DB cluster already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key that is used to encrypt the secret.
You are turning on ManageMasterUserPassword
to manage the master user password in Amazon Web
Services Secrets Manager.
If you are turning on ManageMasterUserPassword
and don't specify
MasterUserSecretKmsKeyId
, then the aws/secretsmanager
KMS key is used to encrypt the
secret. If the secret is in a different Amazon Web Services account, then you can't use the
aws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
masterUserSecretKmsKeyId
- The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed
in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
The DB cluster doesn't manage the master user password in Amazon Web Services Secrets Manager.
If the DB cluster already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key that is used to encrypt the secret.
You are turning on ManageMasterUserPassword
to manage the master user password in Amazon Web
Services Secrets Manager.
If you are turning on ManageMasterUserPassword
and don't specify
MasterUserSecretKmsKeyId
, then the aws/secretsmanager
KMS key is used to encrypt
the secret. If the secret is in a different Amazon Web Services account, then you can't use the
aws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS
key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
public void setEngineMode(String engineMode)
The DB engine mode of the DB cluster, either provisioned
or serverless
.
The DB engine mode can be modified only from serverless
to provisioned
.
For more information, see CreateDBCluster.
Valid for Cluster Type: Aurora DB clusters only
engineMode
- The DB engine mode of the DB cluster, either provisioned
or serverless
.
The DB engine mode can be modified only from serverless
to provisioned
.
For more information, see CreateDBCluster.
Valid for Cluster Type: Aurora DB clusters only
public String getEngineMode()
The DB engine mode of the DB cluster, either provisioned
or serverless
.
The DB engine mode can be modified only from serverless
to provisioned
.
For more information, see CreateDBCluster.
Valid for Cluster Type: Aurora DB clusters only
provisioned
or serverless
.
The DB engine mode can be modified only from serverless
to provisioned
.
For more information, see CreateDBCluster.
Valid for Cluster Type: Aurora DB clusters only
public ModifyDBClusterRequest withEngineMode(String engineMode)
The DB engine mode of the DB cluster, either provisioned
or serverless
.
The DB engine mode can be modified only from serverless
to provisioned
.
For more information, see CreateDBCluster.
Valid for Cluster Type: Aurora DB clusters only
engineMode
- The DB engine mode of the DB cluster, either provisioned
or serverless
.
The DB engine mode can be modified only from serverless
to provisioned
.
For more information, see CreateDBCluster.
Valid for Cluster Type: Aurora DB clusters only
public void setAllowEngineModeChange(Boolean allowEngineModeChange)
Specifies whether engine mode changes from serverless
to provisioned
are allowed.
Valid for Cluster Type: Aurora Serverless v1 DB clusters only
Constraints:
You must allow engine mode changes when specifying a different value for the EngineMode
parameter
from the DB cluster's current engine mode.
allowEngineModeChange
- Specifies whether engine mode changes from serverless
to provisioned
are
allowed.
Valid for Cluster Type: Aurora Serverless v1 DB clusters only
Constraints:
You must allow engine mode changes when specifying a different value for the EngineMode
parameter from the DB cluster's current engine mode.
public Boolean getAllowEngineModeChange()
Specifies whether engine mode changes from serverless
to provisioned
are allowed.
Valid for Cluster Type: Aurora Serverless v1 DB clusters only
Constraints:
You must allow engine mode changes when specifying a different value for the EngineMode
parameter
from the DB cluster's current engine mode.
serverless
to provisioned
are
allowed.
Valid for Cluster Type: Aurora Serverless v1 DB clusters only
Constraints:
You must allow engine mode changes when specifying a different value for the EngineMode
parameter from the DB cluster's current engine mode.
public ModifyDBClusterRequest withAllowEngineModeChange(Boolean allowEngineModeChange)
Specifies whether engine mode changes from serverless
to provisioned
are allowed.
Valid for Cluster Type: Aurora Serverless v1 DB clusters only
Constraints:
You must allow engine mode changes when specifying a different value for the EngineMode
parameter
from the DB cluster's current engine mode.
allowEngineModeChange
- Specifies whether engine mode changes from serverless
to provisioned
are
allowed.
Valid for Cluster Type: Aurora Serverless v1 DB clusters only
Constraints:
You must allow engine mode changes when specifying a different value for the EngineMode
parameter from the DB cluster's current engine mode.
public Boolean isAllowEngineModeChange()
Specifies whether engine mode changes from serverless
to provisioned
are allowed.
Valid for Cluster Type: Aurora Serverless v1 DB clusters only
Constraints:
You must allow engine mode changes when specifying a different value for the EngineMode
parameter
from the DB cluster's current engine mode.
serverless
to provisioned
are
allowed.
Valid for Cluster Type: Aurora Serverless v1 DB clusters only
Constraints:
You must allow engine mode changes when specifying a different value for the EngineMode
parameter from the DB cluster's current engine mode.
public void setEnableLocalWriteForwarding(Boolean enableLocalWriteForwarding)
Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
enableLocalWriteForwarding
- Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster.
By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
public Boolean getEnableLocalWriteForwarding()
Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
Valid for: Aurora DB clusters only
public ModifyDBClusterRequest withEnableLocalWriteForwarding(Boolean enableLocalWriteForwarding)
Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
enableLocalWriteForwarding
- Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster.
By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
public Boolean isEnableLocalWriteForwarding()
Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
Valid for: Aurora DB clusters only
public void setAwsBackupRecoveryPointArn(String awsBackupRecoveryPointArn)
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
awsBackupRecoveryPointArn
- The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.public String getAwsBackupRecoveryPointArn()
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
public ModifyDBClusterRequest withAwsBackupRecoveryPointArn(String awsBackupRecoveryPointArn)
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
awsBackupRecoveryPointArn
- The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.public void setEnableLimitlessDatabase(Boolean enableLimitlessDatabase)
Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.
Valid for: Aurora DB clusters only
enableLimitlessDatabase
- Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create
a DB shard group.
Valid for: Aurora DB clusters only
public Boolean getEnableLimitlessDatabase()
Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.
Valid for: Aurora DB clusters only
Valid for: Aurora DB clusters only
public ModifyDBClusterRequest withEnableLimitlessDatabase(Boolean enableLimitlessDatabase)
Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.
Valid for: Aurora DB clusters only
enableLimitlessDatabase
- Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create
a DB shard group.
Valid for: Aurora DB clusters only
public Boolean isEnableLimitlessDatabase()
Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.
Valid for: Aurora DB clusters only
Valid for: Aurora DB clusters only
public void setCACertificateIdentifier(String cACertificateIdentifier)
The CA certificate identifier to use for the DB cluster's server certificate.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters
cACertificateIdentifier
- The CA certificate identifier to use for the DB cluster's server certificate.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters
public String getCACertificateIdentifier()
The CA certificate identifier to use for the DB cluster's server certificate.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters
public ModifyDBClusterRequest withCACertificateIdentifier(String cACertificateIdentifier)
The CA certificate identifier to use for the DB cluster's server certificate.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters
cACertificateIdentifier
- The CA certificate identifier to use for the DB cluster's server certificate.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters
public String toString()
toString
in class Object
Object.toString()
public ModifyDBClusterRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()