@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DBCluster extends Object implements Serializable, Cloneable
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
CreateDBCluster
, DeleteDBCluster
, DescribeDBClusters
,
FailoverDBCluster
, ModifyDBCluster
, PromoteReadReplicaDBCluster
,
RestoreDBClusterFromS3
, RestoreDBClusterFromSnapshot
,
RestoreDBClusterToPointInTime
, StartDBCluster
, and StopDBCluster
.
For a Multi-AZ DB cluster, this data type is used as a response element in the operations
CreateDBCluster
, DeleteDBCluster
, DescribeDBClusters
,
FailoverDBCluster
, ModifyDBCluster
, RebootDBCluster
,
RestoreDBClusterFromSnapshot
, and RestoreDBClusterToPointInTime
.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
Constructor and Description |
---|
DBCluster() |
Modifier and Type | Method and Description |
---|---|
DBCluster |
clone() |
boolean |
equals(Object obj) |
String |
getActivityStreamKinesisStreamName()
The name of the Amazon Kinesis data stream used for the database activity stream.
|
String |
getActivityStreamKmsKeyId()
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
|
String |
getActivityStreamMode()
The mode of the database activity stream.
|
String |
getActivityStreamStatus()
The status of the database activity stream.
|
Integer |
getAllocatedStorage()
For all database engines except Amazon Aurora,
AllocatedStorage specifies the allocated storage size
in gibibytes (GiB). |
List<DBClusterRole> |
getAssociatedRoles()
A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB
cluster.
|
Date |
getAutomaticRestartTime()
The time when a stopped DB cluster is restarted automatically.
|
Boolean |
getAutoMinorVersionUpgrade()
Indicates whether minor version patches are applied automatically.
|
List<String> |
getAvailabilityZones()
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
|
String |
getAwsBackupRecoveryPointArn()
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
|
Long |
getBacktrackConsumedChangeRecords()
The number of change records stored for Backtrack.
|
Long |
getBacktrackWindow()
The target backtrack window, in seconds.
|
Integer |
getBackupRetentionPeriod()
The number of days for which automatic DB snapshots are retained.
|
Integer |
getCapacity()
The current capacity of an Aurora Serverless v1 DB cluster.
|
CertificateDetails |
getCertificateDetails() |
String |
getCharacterSetName()
If present, specifies the name of the character set that this cluster is associated with.
|
String |
getCloneGroupId()
The ID of the clone group with which the DB cluster is associated.
|
Date |
getClusterCreateTime()
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
|
Boolean |
getCopyTagsToSnapshot()
Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
|
Boolean |
getCrossAccountClone()
Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
|
List<String> |
getCustomEndpoints()
The custom endpoints associated with the DB cluster.
|
String |
getDatabaseName()
The name of the initial database that was specified for the DB cluster when it was created, if one was provided.
|
String |
getDBClusterArn()
The Amazon Resource Name (ARN) for the DB cluster.
|
String |
getDBClusterIdentifier()
The user-supplied identifier for the DB cluster.
|
String |
getDBClusterInstanceClass()
The name of the compute and memory capacity class of the DB instance.
|
List<DBClusterMember> |
getDBClusterMembers()
The list of DB instances that make up the DB cluster.
|
List<DBClusterOptionGroupStatus> |
getDBClusterOptionGroupMemberships()
The list of option group memberships for this DB cluster.
|
String |
getDBClusterParameterGroup()
The name of the DB cluster parameter group for the DB cluster.
|
String |
getDbClusterResourceId()
The Amazon Web Services Region-unique, immutable identifier for the DB cluster.
|
String |
getDBSubnetGroup()
Information about the subnet group associated with the DB cluster, including the name, description, and subnets
in the subnet group.
|
String |
getDBSystemId()
Reserved for future use.
|
Boolean |
getDeletionProtection()
Indicates whether the DB cluster has deletion protection enabled.
|
List<DomainMembership> |
getDomainMemberships()
The Active Directory Domain membership records associated with the DB cluster.
|
Date |
getEarliestBacktrackTime()
The earliest time to which a DB cluster can be backtracked.
|
Date |
getEarliestRestorableTime()
The earliest time to which a database can be restored with point-in-time restore.
|
List<String> |
getEnabledCloudwatchLogsExports()
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
|
String |
getEndpoint()
The connection endpoint for the primary instance of the DB cluster.
|
String |
getEngine()
The database engine used for this DB cluster.
|
String |
getEngineLifecycleSupport()
The life cycle type for the DB cluster.
|
String |
getEngineMode()
The DB engine mode of the DB cluster, either
provisioned or serverless . |
String |
getEngineVersion()
The version of the database engine.
|
Boolean |
getGlobalWriteForwardingRequested()
Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database.
|
String |
getGlobalWriteForwardingStatus()
The status of write forwarding for a secondary cluster in an Aurora global database.
|
String |
getHostedZoneId()
The ID that Amazon Route 53 assigns when you create a hosted zone.
|
Boolean |
getHttpEndpointEnabled()
Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.
|
Boolean |
getIAMDatabaseAuthenticationEnabled()
Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database
accounts is enabled.
|
Date |
getIOOptimizedNextAllowedModificationTime()
The next time you can modify the DB cluster to use the
aurora-iopt1 storage type. |
Integer |
getIops()
The Provisioned IOPS (I/O operations per second) value.
|
String |
getKmsKeyId()
If
StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB
cluster. |
Date |
getLatestRestorableTime()
The latest time to which a database can be restored with point-in-time restore.
|
LimitlessDatabase |
getLimitlessDatabase()
The details for Aurora Limitless Database.
|
String |
getLocalWriteForwardingStatus()
Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in
the process of enabling it.
|
String |
getMasterUsername()
The master username for the DB cluster.
|
MasterUserSecret |
getMasterUserSecret()
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
|
Integer |
getMonitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
|
String |
getMonitoringRoleArn()
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
|
Boolean |
getMultiAZ()
Indicates whether the DB cluster has instances in multiple Availability Zones.
|
String |
getNetworkType()
The network type of the DB instance.
|
ClusterPendingModifiedValues |
getPendingModifiedValues()
Information about pending changes to the DB cluster.
|
String |
getPercentProgress()
The progress of the operation as a percentage.
|
Boolean |
getPerformanceInsightsEnabled()
Indicates whether Performance Insights is enabled for the DB cluster.
|
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 that the database engine is listening on.
|
String |
getPreferredBackupWindow()
The daily time range during which automated backups are created if automated backups are enabled, as determined
by the
BackupRetentionPeriod . |
String |
getPreferredMaintenanceWindow()
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
Boolean |
getPubliclyAccessible()
Indicates whether the DB cluster is publicly accessible.
|
RdsCustomClusterConfiguration |
getRdsCustomClusterConfiguration()
Reserved for future use.
|
String |
getReaderEndpoint()
The reader endpoint for the DB cluster.
|
List<String> |
getReadReplicaIdentifiers()
Contains one or more identifiers of the read replicas associated with this DB cluster.
|
String |
getReplicationSourceIdentifier()
The identifier of the source DB cluster if this DB cluster is a read replica.
|
ScalingConfigurationInfo |
getScalingConfigurationInfo() |
ServerlessV2ScalingConfigurationInfo |
getServerlessV2ScalingConfiguration() |
String |
getStatus()
The current state of this DB cluster.
|
List<DBClusterStatusInfo> |
getStatusInfos()
Reserved for future use.
|
Boolean |
getStorageEncrypted()
Indicates whether the DB cluster is encrypted.
|
Integer |
getStorageThroughput()
The storage throughput for the DB cluster.
|
String |
getStorageType()
The storage type associated with the DB cluster.
|
List<Tag> |
getTagList() |
List<VpcSecurityGroupMembership> |
getVpcSecurityGroups()
The list of VPC security groups that the DB cluster belongs to.
|
int |
hashCode() |
Boolean |
isAutoMinorVersionUpgrade()
Indicates whether minor version patches are applied automatically.
|
Boolean |
isCopyTagsToSnapshot()
Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
|
Boolean |
isCrossAccountClone()
Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
|
Boolean |
isDeletionProtection()
Indicates whether the DB cluster has deletion protection enabled.
|
Boolean |
isGlobalWriteForwardingRequested()
Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database.
|
Boolean |
isHttpEndpointEnabled()
Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.
|
Boolean |
isIAMDatabaseAuthenticationEnabled()
Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database
accounts is enabled.
|
Boolean |
isMultiAZ()
Indicates whether the DB cluster has instances in multiple Availability Zones.
|
Boolean |
isPerformanceInsightsEnabled()
Indicates whether Performance Insights is enabled for the DB cluster.
|
Boolean |
isPubliclyAccessible()
Indicates whether the DB cluster is publicly accessible.
|
Boolean |
isStorageEncrypted()
Indicates whether the DB cluster is encrypted.
|
void |
setActivityStreamKinesisStreamName(String activityStreamKinesisStreamName)
The name of the Amazon Kinesis data stream used for the database activity stream.
|
void |
setActivityStreamKmsKeyId(String activityStreamKmsKeyId)
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
|
void |
setActivityStreamMode(String activityStreamMode)
The mode of the database activity stream.
|
void |
setActivityStreamStatus(String activityStreamStatus)
The status of the database activity stream.
|
void |
setAllocatedStorage(Integer allocatedStorage)
For all database engines except Amazon Aurora,
AllocatedStorage specifies the allocated storage size
in gibibytes (GiB). |
void |
setAssociatedRoles(Collection<DBClusterRole> associatedRoles)
A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB
cluster.
|
void |
setAutomaticRestartTime(Date automaticRestartTime)
The time when a stopped DB cluster is restarted automatically.
|
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates whether minor version patches are applied automatically.
|
void |
setAvailabilityZones(Collection<String> availabilityZones)
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
|
void |
setAwsBackupRecoveryPointArn(String awsBackupRecoveryPointArn)
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
|
void |
setBacktrackConsumedChangeRecords(Long backtrackConsumedChangeRecords)
The number of change records stored for Backtrack.
|
void |
setBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds.
|
void |
setBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automatic DB snapshots are retained.
|
void |
setCapacity(Integer capacity)
The current capacity of an Aurora Serverless v1 DB cluster.
|
void |
setCertificateDetails(CertificateDetails certificateDetails) |
void |
setCharacterSetName(String characterSetName)
If present, specifies the name of the character set that this cluster is associated with.
|
void |
setCloneGroupId(String cloneGroupId)
The ID of the clone group with which the DB cluster is associated.
|
void |
setClusterCreateTime(Date clusterCreateTime)
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
|
void |
setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
|
void |
setCrossAccountClone(Boolean crossAccountClone)
Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
|
void |
setCustomEndpoints(Collection<String> customEndpoints)
The custom endpoints associated with the DB cluster.
|
void |
setDatabaseName(String databaseName)
The name of the initial database that was specified for the DB cluster when it was created, if one was provided.
|
void |
setDBClusterArn(String dBClusterArn)
The Amazon Resource Name (ARN) for the DB cluster.
|
void |
setDBClusterIdentifier(String dBClusterIdentifier)
The user-supplied identifier for the DB cluster.
|
void |
setDBClusterInstanceClass(String dBClusterInstanceClass)
The name of the compute and memory capacity class of the DB instance.
|
void |
setDBClusterMembers(Collection<DBClusterMember> dBClusterMembers)
The list of DB instances that make up the DB cluster.
|
void |
setDBClusterOptionGroupMemberships(Collection<DBClusterOptionGroupStatus> dBClusterOptionGroupMemberships)
The list of option group memberships for this DB cluster.
|
void |
setDBClusterParameterGroup(String dBClusterParameterGroup)
The name of the DB cluster parameter group for the DB cluster.
|
void |
setDbClusterResourceId(String dbClusterResourceId)
The Amazon Web Services Region-unique, immutable identifier for the DB cluster.
|
void |
setDBSubnetGroup(String dBSubnetGroup)
Information about the subnet group associated with the DB cluster, including the name, description, and subnets
in the subnet group.
|
void |
setDBSystemId(String dBSystemId)
Reserved for future use.
|
void |
setDeletionProtection(Boolean deletionProtection)
Indicates whether the DB cluster has deletion protection enabled.
|
void |
setDomainMemberships(Collection<DomainMembership> domainMemberships)
The Active Directory Domain membership records associated with the DB cluster.
|
void |
setEarliestBacktrackTime(Date earliestBacktrackTime)
The earliest time to which a DB cluster can be backtracked.
|
void |
setEarliestRestorableTime(Date earliestRestorableTime)
The earliest time to which a database can be restored with point-in-time restore.
|
void |
setEnabledCloudwatchLogsExports(Collection<String> enabledCloudwatchLogsExports)
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
|
void |
setEndpoint(String endpoint)
The connection endpoint for the primary instance of the DB cluster.
|
void |
setEngine(String engine)
The database engine used for this DB cluster.
|
void |
setEngineLifecycleSupport(String engineLifecycleSupport)
The life cycle type 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 of the database engine.
|
void |
setGlobalWriteForwardingRequested(Boolean globalWriteForwardingRequested)
Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database.
|
void |
setGlobalWriteForwardingStatus(String globalWriteForwardingStatus)
The status of write forwarding for a secondary cluster in an Aurora global database.
|
void |
setHostedZoneId(String hostedZoneId)
The ID that Amazon Route 53 assigns when you create a hosted zone.
|
void |
setHttpEndpointEnabled(Boolean httpEndpointEnabled)
Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.
|
void |
setIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database
accounts is enabled.
|
void |
setIOOptimizedNextAllowedModificationTime(Date iOOptimizedNextAllowedModificationTime)
The next time you can modify the DB cluster to use the
aurora-iopt1 storage type. |
void |
setIops(Integer iops)
The Provisioned IOPS (I/O operations per second) value.
|
void |
setKmsKeyId(String kmsKeyId)
If
StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB
cluster. |
void |
setLatestRestorableTime(Date latestRestorableTime)
The latest time to which a database can be restored with point-in-time restore.
|
void |
setLimitlessDatabase(LimitlessDatabase limitlessDatabase)
The details for Aurora Limitless Database.
|
void |
setLocalWriteForwardingStatus(String localWriteForwardingStatus)
Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in
the process of enabling it.
|
void |
setMasterUsername(String masterUsername)
The master username for the DB cluster.
|
void |
setMasterUserSecret(MasterUserSecret masterUserSecret)
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
|
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 ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
|
void |
setMultiAZ(Boolean multiAZ)
Indicates whether the DB cluster has instances in multiple Availability Zones.
|
void |
setNetworkType(String networkType)
The network type of the DB instance.
|
void |
setPendingModifiedValues(ClusterPendingModifiedValues pendingModifiedValues)
Information about pending changes to the DB cluster.
|
void |
setPercentProgress(String percentProgress)
The progress of the operation as a percentage.
|
void |
setPerformanceInsightsEnabled(Boolean performanceInsightsEnabled)
Indicates whether Performance Insights is enabled for the DB cluster.
|
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 that the database engine is listening on.
|
void |
setPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled, as determined
by the
BackupRetentionPeriod . |
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
void |
setPubliclyAccessible(Boolean publiclyAccessible)
Indicates whether the DB cluster is publicly accessible.
|
void |
setRdsCustomClusterConfiguration(RdsCustomClusterConfiguration rdsCustomClusterConfiguration)
Reserved for future use.
|
void |
setReaderEndpoint(String readerEndpoint)
The reader endpoint for the DB cluster.
|
void |
setReadReplicaIdentifiers(Collection<String> readReplicaIdentifiers)
Contains one or more identifiers of the read replicas associated with this DB cluster.
|
void |
setReplicationSourceIdentifier(String replicationSourceIdentifier)
The identifier of the source DB cluster if this DB cluster is a read replica.
|
void |
setScalingConfigurationInfo(ScalingConfigurationInfo scalingConfigurationInfo) |
void |
setServerlessV2ScalingConfiguration(ServerlessV2ScalingConfigurationInfo serverlessV2ScalingConfiguration) |
void |
setStatus(String status)
The current state of this DB cluster.
|
void |
setStatusInfos(Collection<DBClusterStatusInfo> statusInfos)
Reserved for future use.
|
void |
setStorageEncrypted(Boolean storageEncrypted)
Indicates whether the DB cluster is encrypted.
|
void |
setStorageThroughput(Integer storageThroughput)
The storage throughput for the DB cluster.
|
void |
setStorageType(String storageType)
The storage type associated with the DB cluster.
|
void |
setTagList(Collection<Tag> tagList) |
void |
setVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
The list of VPC security groups that the DB cluster belongs to.
|
String |
toString()
Returns a string representation of this object.
|
DBCluster |
withActivityStreamKinesisStreamName(String activityStreamKinesisStreamName)
The name of the Amazon Kinesis data stream used for the database activity stream.
|
DBCluster |
withActivityStreamKmsKeyId(String activityStreamKmsKeyId)
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
|
DBCluster |
withActivityStreamMode(ActivityStreamMode activityStreamMode)
The mode of the database activity stream.
|
DBCluster |
withActivityStreamMode(String activityStreamMode)
The mode of the database activity stream.
|
DBCluster |
withActivityStreamStatus(ActivityStreamStatus activityStreamStatus)
The status of the database activity stream.
|
DBCluster |
withActivityStreamStatus(String activityStreamStatus)
The status of the database activity stream.
|
DBCluster |
withAllocatedStorage(Integer allocatedStorage)
For all database engines except Amazon Aurora,
AllocatedStorage specifies the allocated storage size
in gibibytes (GiB). |
DBCluster |
withAssociatedRoles(Collection<DBClusterRole> associatedRoles)
A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB
cluster.
|
DBCluster |
withAssociatedRoles(DBClusterRole... associatedRoles)
A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB
cluster.
|
DBCluster |
withAutomaticRestartTime(Date automaticRestartTime)
The time when a stopped DB cluster is restarted automatically.
|
DBCluster |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates whether minor version patches are applied automatically.
|
DBCluster |
withAvailabilityZones(Collection<String> availabilityZones)
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
|
DBCluster |
withAvailabilityZones(String... availabilityZones)
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
|
DBCluster |
withAwsBackupRecoveryPointArn(String awsBackupRecoveryPointArn)
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
|
DBCluster |
withBacktrackConsumedChangeRecords(Long backtrackConsumedChangeRecords)
The number of change records stored for Backtrack.
|
DBCluster |
withBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds.
|
DBCluster |
withBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automatic DB snapshots are retained.
|
DBCluster |
withCapacity(Integer capacity)
The current capacity of an Aurora Serverless v1 DB cluster.
|
DBCluster |
withCertificateDetails(CertificateDetails certificateDetails) |
DBCluster |
withCharacterSetName(String characterSetName)
If present, specifies the name of the character set that this cluster is associated with.
|
DBCluster |
withCloneGroupId(String cloneGroupId)
The ID of the clone group with which the DB cluster is associated.
|
DBCluster |
withClusterCreateTime(Date clusterCreateTime)
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
|
DBCluster |
withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
|
DBCluster |
withCrossAccountClone(Boolean crossAccountClone)
Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
|
DBCluster |
withCustomEndpoints(Collection<String> customEndpoints)
The custom endpoints associated with the DB cluster.
|
DBCluster |
withCustomEndpoints(String... customEndpoints)
The custom endpoints associated with the DB cluster.
|
DBCluster |
withDatabaseName(String databaseName)
The name of the initial database that was specified for the DB cluster when it was created, if one was provided.
|
DBCluster |
withDBClusterArn(String dBClusterArn)
The Amazon Resource Name (ARN) for the DB cluster.
|
DBCluster |
withDBClusterIdentifier(String dBClusterIdentifier)
The user-supplied identifier for the DB cluster.
|
DBCluster |
withDBClusterInstanceClass(String dBClusterInstanceClass)
The name of the compute and memory capacity class of the DB instance.
|
DBCluster |
withDBClusterMembers(Collection<DBClusterMember> dBClusterMembers)
The list of DB instances that make up the DB cluster.
|
DBCluster |
withDBClusterMembers(DBClusterMember... dBClusterMembers)
The list of DB instances that make up the DB cluster.
|
DBCluster |
withDBClusterOptionGroupMemberships(Collection<DBClusterOptionGroupStatus> dBClusterOptionGroupMemberships)
The list of option group memberships for this DB cluster.
|
DBCluster |
withDBClusterOptionGroupMemberships(DBClusterOptionGroupStatus... dBClusterOptionGroupMemberships)
The list of option group memberships for this DB cluster.
|
DBCluster |
withDBClusterParameterGroup(String dBClusterParameterGroup)
The name of the DB cluster parameter group for the DB cluster.
|
DBCluster |
withDbClusterResourceId(String dbClusterResourceId)
The Amazon Web Services Region-unique, immutable identifier for the DB cluster.
|
DBCluster |
withDBSubnetGroup(String dBSubnetGroup)
Information about the subnet group associated with the DB cluster, including the name, description, and subnets
in the subnet group.
|
DBCluster |
withDBSystemId(String dBSystemId)
Reserved for future use.
|
DBCluster |
withDeletionProtection(Boolean deletionProtection)
Indicates whether the DB cluster has deletion protection enabled.
|
DBCluster |
withDomainMemberships(Collection<DomainMembership> domainMemberships)
The Active Directory Domain membership records associated with the DB cluster.
|
DBCluster |
withDomainMemberships(DomainMembership... domainMemberships)
The Active Directory Domain membership records associated with the DB cluster.
|
DBCluster |
withEarliestBacktrackTime(Date earliestBacktrackTime)
The earliest time to which a DB cluster can be backtracked.
|
DBCluster |
withEarliestRestorableTime(Date earliestRestorableTime)
The earliest time to which a database can be restored with point-in-time restore.
|
DBCluster |
withEnabledCloudwatchLogsExports(Collection<String> enabledCloudwatchLogsExports)
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
|
DBCluster |
withEnabledCloudwatchLogsExports(String... enabledCloudwatchLogsExports)
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
|
DBCluster |
withEndpoint(String endpoint)
The connection endpoint for the primary instance of the DB cluster.
|
DBCluster |
withEngine(String engine)
The database engine used for this DB cluster.
|
DBCluster |
withEngineLifecycleSupport(String engineLifecycleSupport)
The life cycle type for the DB cluster.
|
DBCluster |
withEngineMode(String engineMode)
The DB engine mode of the DB cluster, either
provisioned or serverless . |
DBCluster |
withEngineVersion(String engineVersion)
The version of the database engine.
|
DBCluster |
withGlobalWriteForwardingRequested(Boolean globalWriteForwardingRequested)
Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database.
|
DBCluster |
withGlobalWriteForwardingStatus(String globalWriteForwardingStatus)
The status of write forwarding for a secondary cluster in an Aurora global database.
|
DBCluster |
withGlobalWriteForwardingStatus(WriteForwardingStatus globalWriteForwardingStatus)
The status of write forwarding for a secondary cluster in an Aurora global database.
|
DBCluster |
withHostedZoneId(String hostedZoneId)
The ID that Amazon Route 53 assigns when you create a hosted zone.
|
DBCluster |
withHttpEndpointEnabled(Boolean httpEndpointEnabled)
Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.
|
DBCluster |
withIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database
accounts is enabled.
|
DBCluster |
withIOOptimizedNextAllowedModificationTime(Date iOOptimizedNextAllowedModificationTime)
The next time you can modify the DB cluster to use the
aurora-iopt1 storage type. |
DBCluster |
withIops(Integer iops)
The Provisioned IOPS (I/O operations per second) value.
|
DBCluster |
withKmsKeyId(String kmsKeyId)
If
StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB
cluster. |
DBCluster |
withLatestRestorableTime(Date latestRestorableTime)
The latest time to which a database can be restored with point-in-time restore.
|
DBCluster |
withLimitlessDatabase(LimitlessDatabase limitlessDatabase)
The details for Aurora Limitless Database.
|
DBCluster |
withLocalWriteForwardingStatus(LocalWriteForwardingStatus localWriteForwardingStatus)
Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in
the process of enabling it.
|
DBCluster |
withLocalWriteForwardingStatus(String localWriteForwardingStatus)
Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in
the process of enabling it.
|
DBCluster |
withMasterUsername(String masterUsername)
The master username for the DB cluster.
|
DBCluster |
withMasterUserSecret(MasterUserSecret masterUserSecret)
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
|
DBCluster |
withMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
|
DBCluster |
withMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
|
DBCluster |
withMultiAZ(Boolean multiAZ)
Indicates whether the DB cluster has instances in multiple Availability Zones.
|
DBCluster |
withNetworkType(String networkType)
The network type of the DB instance.
|
DBCluster |
withPendingModifiedValues(ClusterPendingModifiedValues pendingModifiedValues)
Information about pending changes to the DB cluster.
|
DBCluster |
withPercentProgress(String percentProgress)
The progress of the operation as a percentage.
|
DBCluster |
withPerformanceInsightsEnabled(Boolean performanceInsightsEnabled)
Indicates whether Performance Insights is enabled for the DB cluster.
|
DBCluster |
withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
|
DBCluster |
withPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The number of days to retain Performance Insights data.
|
DBCluster |
withPort(Integer port)
The port that the database engine is listening on.
|
DBCluster |
withPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled, as determined
by the
BackupRetentionPeriod . |
DBCluster |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
DBCluster |
withPubliclyAccessible(Boolean publiclyAccessible)
Indicates whether the DB cluster is publicly accessible.
|
DBCluster |
withRdsCustomClusterConfiguration(RdsCustomClusterConfiguration rdsCustomClusterConfiguration)
Reserved for future use.
|
DBCluster |
withReaderEndpoint(String readerEndpoint)
The reader endpoint for the DB cluster.
|
DBCluster |
withReadReplicaIdentifiers(Collection<String> readReplicaIdentifiers)
Contains one or more identifiers of the read replicas associated with this DB cluster.
|
DBCluster |
withReadReplicaIdentifiers(String... readReplicaIdentifiers)
Contains one or more identifiers of the read replicas associated with this DB cluster.
|
DBCluster |
withReplicationSourceIdentifier(String replicationSourceIdentifier)
The identifier of the source DB cluster if this DB cluster is a read replica.
|
DBCluster |
withScalingConfigurationInfo(ScalingConfigurationInfo scalingConfigurationInfo) |
DBCluster |
withServerlessV2ScalingConfiguration(ServerlessV2ScalingConfigurationInfo serverlessV2ScalingConfiguration) |
DBCluster |
withStatus(String status)
The current state of this DB cluster.
|
DBCluster |
withStatusInfos(Collection<DBClusterStatusInfo> statusInfos)
Reserved for future use.
|
DBCluster |
withStatusInfos(DBClusterStatusInfo... statusInfos)
Reserved for future use.
|
DBCluster |
withStorageEncrypted(Boolean storageEncrypted)
Indicates whether the DB cluster is encrypted.
|
DBCluster |
withStorageThroughput(Integer storageThroughput)
The storage throughput for the DB cluster.
|
DBCluster |
withStorageType(String storageType)
The storage type associated with the DB cluster.
|
DBCluster |
withTagList(Collection<Tag> tagList) |
DBCluster |
withTagList(Tag... tagList)
NOTE: This method appends the values to the existing list (if any).
|
DBCluster |
withVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
The list of VPC security groups that the DB cluster belongs to.
|
DBCluster |
withVpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
The list of VPC security groups that the DB cluster belongs to.
|
public void setAllocatedStorage(Integer allocatedStorage)
For all database engines except Amazon Aurora, AllocatedStorage
specifies the allocated storage size
in gibibytes (GiB). For Aurora, AllocatedStorage
always returns 1, because Aurora DB cluster storage
size isn't fixed, but instead automatically adjusts as needed.
allocatedStorage
- For all database engines except Amazon Aurora, AllocatedStorage
specifies the allocated
storage size in gibibytes (GiB). For Aurora, AllocatedStorage
always returns 1, because
Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.public Integer getAllocatedStorage()
For all database engines except Amazon Aurora, AllocatedStorage
specifies the allocated storage size
in gibibytes (GiB). For Aurora, AllocatedStorage
always returns 1, because Aurora DB cluster storage
size isn't fixed, but instead automatically adjusts as needed.
AllocatedStorage
specifies the allocated
storage size in gibibytes (GiB). For Aurora, AllocatedStorage
always returns 1, because
Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.public DBCluster withAllocatedStorage(Integer allocatedStorage)
For all database engines except Amazon Aurora, AllocatedStorage
specifies the allocated storage size
in gibibytes (GiB). For Aurora, AllocatedStorage
always returns 1, because Aurora DB cluster storage
size isn't fixed, but instead automatically adjusts as needed.
allocatedStorage
- For all database engines except Amazon Aurora, AllocatedStorage
specifies the allocated
storage size in gibibytes (GiB). For Aurora, AllocatedStorage
always returns 1, because
Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.public List<String> getAvailabilityZones()
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
public void setAvailabilityZones(Collection<String> availabilityZones)
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
availabilityZones
- The list of Availability Zones (AZs) where instances in the DB cluster can be created.public DBCluster withAvailabilityZones(String... availabilityZones)
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
NOTE: This method appends the values to the existing list (if any). Use
setAvailabilityZones(java.util.Collection)
or withAvailabilityZones(java.util.Collection)
if
you want to override the existing values.
availabilityZones
- The list of Availability Zones (AZs) where instances in the DB cluster can be created.public DBCluster withAvailabilityZones(Collection<String> availabilityZones)
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
availabilityZones
- The list of Availability Zones (AZs) where instances in the DB cluster can be created.public void setBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automatic DB snapshots are retained.
backupRetentionPeriod
- The number of days for which automatic DB snapshots are retained.public Integer getBackupRetentionPeriod()
The number of days for which automatic DB snapshots are retained.
public DBCluster withBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automatic DB snapshots are retained.
backupRetentionPeriod
- The number of days for which automatic DB snapshots are retained.public void setCharacterSetName(String characterSetName)
If present, specifies the name of the character set that this cluster is associated with.
characterSetName
- If present, specifies the name of the character set that this cluster is associated with.public String getCharacterSetName()
If present, specifies the name of the character set that this cluster is associated with.
public DBCluster withCharacterSetName(String characterSetName)
If present, specifies the name of the character set that this cluster is associated with.
characterSetName
- If present, specifies the name of the character set that this cluster is associated with.public void setDatabaseName(String databaseName)
The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.
databaseName
- The name of the initial database that was specified for the DB cluster when it was created, if one was
provided. This same name is returned for the life of the DB cluster.public String getDatabaseName()
The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.
public DBCluster withDatabaseName(String databaseName)
The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.
databaseName
- The name of the initial database that was specified for the DB cluster when it was created, if one was
provided. This same name is returned for the life of the DB cluster.public void setDBClusterIdentifier(String dBClusterIdentifier)
The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.
dBClusterIdentifier
- The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB
cluster.public String getDBClusterIdentifier()
The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.
public DBCluster withDBClusterIdentifier(String dBClusterIdentifier)
The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.
dBClusterIdentifier
- The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB
cluster.public void setDBClusterParameterGroup(String dBClusterParameterGroup)
The name of the DB cluster parameter group for the DB cluster.
dBClusterParameterGroup
- The name of the DB cluster parameter group for the DB cluster.public String getDBClusterParameterGroup()
The name of the DB cluster parameter group for the DB cluster.
public DBCluster withDBClusterParameterGroup(String dBClusterParameterGroup)
The name of the DB cluster parameter group for the DB cluster.
dBClusterParameterGroup
- The name of the DB cluster parameter group for the DB cluster.public void setDBSubnetGroup(String dBSubnetGroup)
Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
dBSubnetGroup
- Information about the subnet group associated with the DB cluster, including the name, description, and
subnets in the subnet group.public String getDBSubnetGroup()
Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
public DBCluster withDBSubnetGroup(String dBSubnetGroup)
Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
dBSubnetGroup
- Information about the subnet group associated with the DB cluster, including the name, description, and
subnets in the subnet group.public void setStatus(String status)
The current state of this DB cluster.
status
- The current state of this DB cluster.public String getStatus()
The current state of this DB cluster.
public DBCluster withStatus(String status)
The current state of this DB cluster.
status
- The current state of this DB cluster.public void setAutomaticRestartTime(Date automaticRestartTime)
The time when a stopped DB cluster is restarted automatically.
automaticRestartTime
- The time when a stopped DB cluster is restarted automatically.public Date getAutomaticRestartTime()
The time when a stopped DB cluster is restarted automatically.
public DBCluster withAutomaticRestartTime(Date automaticRestartTime)
The time when a stopped DB cluster is restarted automatically.
automaticRestartTime
- The time when a stopped DB cluster is restarted automatically.public void setPercentProgress(String percentProgress)
The progress of the operation as a percentage.
percentProgress
- The progress of the operation as a percentage.public String getPercentProgress()
The progress of the operation as a percentage.
public DBCluster withPercentProgress(String percentProgress)
The progress of the operation as a percentage.
percentProgress
- The progress of the operation as a percentage.public void setEarliestRestorableTime(Date earliestRestorableTime)
The earliest time to which a database can be restored with point-in-time restore.
earliestRestorableTime
- The earliest time to which a database can be restored with point-in-time restore.public Date getEarliestRestorableTime()
The earliest time to which a database can be restored with point-in-time restore.
public DBCluster withEarliestRestorableTime(Date earliestRestorableTime)
The earliest time to which a database can be restored with point-in-time restore.
earliestRestorableTime
- The earliest time to which a database can be restored with point-in-time restore.public void setEndpoint(String endpoint)
The connection endpoint for the primary instance of the DB cluster.
endpoint
- The connection endpoint for the primary instance of the DB cluster.public String getEndpoint()
The connection endpoint for the primary instance of the DB cluster.
public DBCluster withEndpoint(String endpoint)
The connection endpoint for the primary instance of the DB cluster.
endpoint
- The connection endpoint for the primary instance of the DB cluster.public void setReaderEndpoint(String readerEndpoint)
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
readerEndpoint
- The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections
across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the
reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster.
This functionality can help balance your read workload across multiple Aurora Replicas in your DB
cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
public String getReaderEndpoint()
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
public DBCluster withReaderEndpoint(String readerEndpoint)
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
readerEndpoint
- The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections
across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the
reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster.
This functionality can help balance your read workload across multiple Aurora Replicas in your DB
cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
public List<String> getCustomEndpoints()
The custom endpoints associated with the DB cluster.
public void setCustomEndpoints(Collection<String> customEndpoints)
The custom endpoints associated with the DB cluster.
customEndpoints
- The custom endpoints associated with the DB cluster.public DBCluster withCustomEndpoints(String... customEndpoints)
The custom endpoints associated with the DB cluster.
NOTE: This method appends the values to the existing list (if any). Use
setCustomEndpoints(java.util.Collection)
or withCustomEndpoints(java.util.Collection)
if you
want to override the existing values.
customEndpoints
- The custom endpoints associated with the DB cluster.public DBCluster withCustomEndpoints(Collection<String> customEndpoints)
The custom endpoints associated with the DB cluster.
customEndpoints
- The custom endpoints associated with the DB cluster.public void setMultiAZ(Boolean multiAZ)
Indicates whether the DB cluster has instances in multiple Availability Zones.
multiAZ
- Indicates whether the DB cluster has instances in multiple Availability Zones.public Boolean getMultiAZ()
Indicates whether the DB cluster has instances in multiple Availability Zones.
public DBCluster withMultiAZ(Boolean multiAZ)
Indicates whether the DB cluster has instances in multiple Availability Zones.
multiAZ
- Indicates whether the DB cluster has instances in multiple Availability Zones.public Boolean isMultiAZ()
Indicates whether the DB cluster has instances in multiple Availability Zones.
public void setEngine(String engine)
The database engine used for this DB cluster.
engine
- The database engine used for this DB cluster.public String getEngine()
The database engine used for this DB cluster.
public DBCluster withEngine(String engine)
The database engine used for this DB cluster.
engine
- The database engine used for this DB cluster.public void setEngineVersion(String engineVersion)
The version of the database engine.
engineVersion
- The version of the database engine.public String getEngineVersion()
The version of the database engine.
public DBCluster withEngineVersion(String engineVersion)
The version of the database engine.
engineVersion
- The version of the database engine.public void setLatestRestorableTime(Date latestRestorableTime)
The latest time to which a database can be restored with point-in-time restore.
latestRestorableTime
- The latest time to which a database can be restored with point-in-time restore.public Date getLatestRestorableTime()
The latest time to which a database can be restored with point-in-time restore.
public DBCluster withLatestRestorableTime(Date latestRestorableTime)
The latest time to which a database can be restored with point-in-time restore.
latestRestorableTime
- The latest time to which a database can be restored with point-in-time restore.public void setPort(Integer port)
The port that the database engine is listening on.
port
- The port that the database engine is listening on.public Integer getPort()
The port that the database engine is listening on.
public DBCluster withPort(Integer port)
The port that the database engine is listening on.
port
- The port that the database engine is listening on.public void setMasterUsername(String masterUsername)
The master username for the DB cluster.
masterUsername
- The master username for the DB cluster.public String getMasterUsername()
The master username for the DB cluster.
public DBCluster withMasterUsername(String masterUsername)
The master username for the DB cluster.
masterUsername
- The master username for the DB cluster.public List<DBClusterOptionGroupStatus> getDBClusterOptionGroupMemberships()
The list of option group memberships for this DB cluster.
public void setDBClusterOptionGroupMemberships(Collection<DBClusterOptionGroupStatus> dBClusterOptionGroupMemberships)
The list of option group memberships for this DB cluster.
dBClusterOptionGroupMemberships
- The list of option group memberships for this DB cluster.public DBCluster withDBClusterOptionGroupMemberships(DBClusterOptionGroupStatus... dBClusterOptionGroupMemberships)
The list of option group memberships for this DB cluster.
NOTE: This method appends the values to the existing list (if any). Use
setDBClusterOptionGroupMemberships(java.util.Collection)
or
withDBClusterOptionGroupMemberships(java.util.Collection)
if you want to override the existing values.
dBClusterOptionGroupMemberships
- The list of option group memberships for this DB cluster.public DBCluster withDBClusterOptionGroupMemberships(Collection<DBClusterOptionGroupStatus> dBClusterOptionGroupMemberships)
The list of option group memberships for this DB cluster.
dBClusterOptionGroupMemberships
- The list of option group memberships for this DB cluster.public void setPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled, as determined
by the BackupRetentionPeriod
.
preferredBackupWindow
- The daily time range during which automated backups are created if automated backups are enabled, as
determined by the BackupRetentionPeriod
.public String getPreferredBackupWindow()
The daily time range during which automated backups are created if automated backups are enabled, as determined
by the BackupRetentionPeriod
.
BackupRetentionPeriod
.public DBCluster withPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled, as determined
by the BackupRetentionPeriod
.
preferredBackupWindow
- The daily time range during which automated backups are created if automated backups are enabled, as
determined by the BackupRetentionPeriod
.public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
preferredMaintenanceWindow
- The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).public String getPreferredMaintenanceWindow()
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
public DBCluster withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
preferredMaintenanceWindow
- The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).public void setReplicationSourceIdentifier(String replicationSourceIdentifier)
The identifier of the source DB cluster if this DB cluster is a read replica.
replicationSourceIdentifier
- The identifier of the source DB cluster if this DB cluster is a read replica.public String getReplicationSourceIdentifier()
The identifier of the source DB cluster if this DB cluster is a read replica.
public DBCluster withReplicationSourceIdentifier(String replicationSourceIdentifier)
The identifier of the source DB cluster if this DB cluster is a read replica.
replicationSourceIdentifier
- The identifier of the source DB cluster if this DB cluster is a read replica.public List<String> getReadReplicaIdentifiers()
Contains one or more identifiers of the read replicas associated with this DB cluster.
public void setReadReplicaIdentifiers(Collection<String> readReplicaIdentifiers)
Contains one or more identifiers of the read replicas associated with this DB cluster.
readReplicaIdentifiers
- Contains one or more identifiers of the read replicas associated with this DB cluster.public DBCluster withReadReplicaIdentifiers(String... readReplicaIdentifiers)
Contains one or more identifiers of the read replicas associated with this DB cluster.
NOTE: This method appends the values to the existing list (if any). Use
setReadReplicaIdentifiers(java.util.Collection)
or
withReadReplicaIdentifiers(java.util.Collection)
if you want to override the existing values.
readReplicaIdentifiers
- Contains one or more identifiers of the read replicas associated with this DB cluster.public DBCluster withReadReplicaIdentifiers(Collection<String> readReplicaIdentifiers)
Contains one or more identifiers of the read replicas associated with this DB cluster.
readReplicaIdentifiers
- Contains one or more identifiers of the read replicas associated with this DB cluster.public List<DBClusterStatusInfo> getStatusInfos()
Reserved for future use.
public void setStatusInfos(Collection<DBClusterStatusInfo> statusInfos)
Reserved for future use.
statusInfos
- Reserved for future use.public DBCluster withStatusInfos(DBClusterStatusInfo... statusInfos)
Reserved for future use.
NOTE: This method appends the values to the existing list (if any). Use
setStatusInfos(java.util.Collection)
or withStatusInfos(java.util.Collection)
if you want to
override the existing values.
statusInfos
- Reserved for future use.public DBCluster withStatusInfos(Collection<DBClusterStatusInfo> statusInfos)
Reserved for future use.
statusInfos
- Reserved for future use.public List<DBClusterMember> getDBClusterMembers()
The list of DB instances that make up the DB cluster.
public void setDBClusterMembers(Collection<DBClusterMember> dBClusterMembers)
The list of DB instances that make up the DB cluster.
dBClusterMembers
- The list of DB instances that make up the DB cluster.public DBCluster withDBClusterMembers(DBClusterMember... dBClusterMembers)
The list of DB instances that make up the DB cluster.
NOTE: This method appends the values to the existing list (if any). Use
setDBClusterMembers(java.util.Collection)
or withDBClusterMembers(java.util.Collection)
if you
want to override the existing values.
dBClusterMembers
- The list of DB instances that make up the DB cluster.public DBCluster withDBClusterMembers(Collection<DBClusterMember> dBClusterMembers)
The list of DB instances that make up the DB cluster.
dBClusterMembers
- The list of DB instances that make up the DB cluster.public List<VpcSecurityGroupMembership> getVpcSecurityGroups()
The list of VPC security groups that the DB cluster belongs to.
public void setVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
The list of VPC security groups that the DB cluster belongs to.
vpcSecurityGroups
- The list of VPC security groups that the DB cluster belongs to.public DBCluster withVpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
The list of VPC security groups that the DB cluster belongs to.
NOTE: This method appends the values to the existing list (if any). Use
setVpcSecurityGroups(java.util.Collection)
or withVpcSecurityGroups(java.util.Collection)
if
you want to override the existing values.
vpcSecurityGroups
- The list of VPC security groups that the DB cluster belongs to.public DBCluster withVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
The list of VPC security groups that the DB cluster belongs to.
vpcSecurityGroups
- The list of VPC security groups that the DB cluster belongs to.public void setHostedZoneId(String hostedZoneId)
The ID that Amazon Route 53 assigns when you create a hosted zone.
hostedZoneId
- The ID that Amazon Route 53 assigns when you create a hosted zone.public String getHostedZoneId()
The ID that Amazon Route 53 assigns when you create a hosted zone.
public DBCluster withHostedZoneId(String hostedZoneId)
The ID that Amazon Route 53 assigns when you create a hosted zone.
hostedZoneId
- The ID that Amazon Route 53 assigns when you create a hosted zone.public void setStorageEncrypted(Boolean storageEncrypted)
Indicates whether the DB cluster is encrypted.
storageEncrypted
- Indicates whether the DB cluster is encrypted.public Boolean getStorageEncrypted()
Indicates whether the DB cluster is encrypted.
public DBCluster withStorageEncrypted(Boolean storageEncrypted)
Indicates whether the DB cluster is encrypted.
storageEncrypted
- Indicates whether the DB cluster is encrypted.public Boolean isStorageEncrypted()
Indicates whether the DB cluster is encrypted.
public void setKmsKeyId(String kmsKeyId)
If StorageEncrypted
is enabled, the Amazon Web Services KMS key identifier for the encrypted DB
cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
kmsKeyId
- If StorageEncrypted
is enabled, the Amazon Web Services KMS key identifier for the encrypted
DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
public String getKmsKeyId()
If StorageEncrypted
is enabled, the Amazon Web Services KMS key identifier for the encrypted DB
cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
StorageEncrypted
is enabled, the Amazon Web Services KMS key identifier for the encrypted
DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
public DBCluster withKmsKeyId(String kmsKeyId)
If StorageEncrypted
is enabled, the Amazon Web Services KMS key identifier for the encrypted DB
cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
kmsKeyId
- If StorageEncrypted
is enabled, the Amazon Web Services KMS key identifier for the encrypted
DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
public void setDbClusterResourceId(String dbClusterResourceId)
The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
dbClusterResourceId
- The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found
in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.public String getDbClusterResourceId()
The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
public DBCluster withDbClusterResourceId(String dbClusterResourceId)
The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
dbClusterResourceId
- The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found
in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.public void setDBClusterArn(String dBClusterArn)
The Amazon Resource Name (ARN) for the DB cluster.
dBClusterArn
- The Amazon Resource Name (ARN) for the DB cluster.public String getDBClusterArn()
The Amazon Resource Name (ARN) for the DB cluster.
public DBCluster withDBClusterArn(String dBClusterArn)
The Amazon Resource Name (ARN) for the DB cluster.
dBClusterArn
- The Amazon Resource Name (ARN) for the DB cluster.public List<DBClusterRole> getAssociatedRoles()
A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
public void setAssociatedRoles(Collection<DBClusterRole> associatedRoles)
A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
associatedRoles
- A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the
DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access
other Amazon Web Services on your behalf.public DBCluster withAssociatedRoles(DBClusterRole... associatedRoles)
A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
NOTE: This method appends the values to the existing list (if any). Use
setAssociatedRoles(java.util.Collection)
or withAssociatedRoles(java.util.Collection)
if you
want to override the existing values.
associatedRoles
- A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the
DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access
other Amazon Web Services on your behalf.public DBCluster withAssociatedRoles(Collection<DBClusterRole> associatedRoles)
A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
associatedRoles
- A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the
DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access
other Amazon Web Services on your behalf.public void setIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
iAMDatabaseAuthenticationEnabled
- Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to
database accounts is enabled.public Boolean getIAMDatabaseAuthenticationEnabled()
Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
public DBCluster withIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
iAMDatabaseAuthenticationEnabled
- Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to
database accounts is enabled.public Boolean isIAMDatabaseAuthenticationEnabled()
Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
public void setCloneGroupId(String cloneGroupId)
The ID of the clone group with which the DB cluster is associated.
cloneGroupId
- The ID of the clone group with which the DB cluster is associated.public String getCloneGroupId()
The ID of the clone group with which the DB cluster is associated.
public DBCluster withCloneGroupId(String cloneGroupId)
The ID of the clone group with which the DB cluster is associated.
cloneGroupId
- The ID of the clone group with which the DB cluster is associated.public void setClusterCreateTime(Date clusterCreateTime)
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
clusterCreateTime
- The time when the DB cluster was created, in Universal Coordinated Time (UTC).public Date getClusterCreateTime()
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
public DBCluster withClusterCreateTime(Date clusterCreateTime)
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
clusterCreateTime
- The time when the DB cluster was created, in Universal Coordinated Time (UTC).public void setEarliestBacktrackTime(Date earliestBacktrackTime)
The earliest time to which a DB cluster can be backtracked.
earliestBacktrackTime
- The earliest time to which a DB cluster can be backtracked.public Date getEarliestBacktrackTime()
The earliest time to which a DB cluster can be backtracked.
public DBCluster withEarliestBacktrackTime(Date earliestBacktrackTime)
The earliest time to which a DB cluster can be backtracked.
earliestBacktrackTime
- The earliest time to which a DB cluster can be backtracked.public void setBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds. If this value is set to 0
, backtracking is disabled for the
DB cluster. Otherwise, backtracking is enabled.
backtrackWindow
- The target backtrack window, in seconds. If this value is set to 0
, backtracking is disabled
for the DB cluster. Otherwise, backtracking is enabled.public Long getBacktrackWindow()
The target backtrack window, in seconds. If this value is set to 0
, backtracking is disabled for the
DB cluster. Otherwise, backtracking is enabled.
0
, backtracking is disabled
for the DB cluster. Otherwise, backtracking is enabled.public DBCluster withBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds. If this value is set to 0
, backtracking is disabled for the
DB cluster. Otherwise, backtracking is enabled.
backtrackWindow
- The target backtrack window, in seconds. If this value is set to 0
, backtracking is disabled
for the DB cluster. Otherwise, backtracking is enabled.public void setBacktrackConsumedChangeRecords(Long backtrackConsumedChangeRecords)
The number of change records stored for Backtrack.
backtrackConsumedChangeRecords
- The number of change records stored for Backtrack.public Long getBacktrackConsumedChangeRecords()
The number of change records stored for Backtrack.
public DBCluster withBacktrackConsumedChangeRecords(Long backtrackConsumedChangeRecords)
The number of change records stored for Backtrack.
backtrackConsumedChangeRecords
- The number of change records stored for Backtrack.public List<String> getEnabledCloudwatchLogsExports()
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
public void setEnabledCloudwatchLogsExports(Collection<String> enabledCloudwatchLogsExports)
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
enabledCloudwatchLogsExports
- A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
public DBCluster withEnabledCloudwatchLogsExports(String... enabledCloudwatchLogsExports)
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
NOTE: This method appends the values to the existing list (if any). Use
setEnabledCloudwatchLogsExports(java.util.Collection)
or
withEnabledCloudwatchLogsExports(java.util.Collection)
if you want to override the existing values.
enabledCloudwatchLogsExports
- A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
public DBCluster withEnabledCloudwatchLogsExports(Collection<String> enabledCloudwatchLogsExports)
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
enabledCloudwatchLogsExports
- A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
public void setCapacity(Integer capacity)
The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0
(zero) when the
cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
capacity
- The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0
(zero) when the
cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
public Integer getCapacity()
The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0
(zero) when the
cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
0
(zero) when
the cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
public DBCluster withCapacity(Integer capacity)
The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0
(zero) when the
cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
capacity
- The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0
(zero) when the
cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
public void setEngineMode(String engineMode)
The DB engine mode of the DB cluster, either provisioned
or serverless
.
For more information, see CreateDBCluster.
engineMode
- The DB engine mode of the DB cluster, either provisioned
or serverless
.
For more information, see CreateDBCluster.
public String getEngineMode()
The DB engine mode of the DB cluster, either provisioned
or serverless
.
For more information, see CreateDBCluster.
provisioned
or serverless
.
For more information, see CreateDBCluster.
public DBCluster withEngineMode(String engineMode)
The DB engine mode of the DB cluster, either provisioned
or serverless
.
For more information, see CreateDBCluster.
engineMode
- The DB engine mode of the DB cluster, either provisioned
or serverless
.
For more information, see CreateDBCluster.
public void setScalingConfigurationInfo(ScalingConfigurationInfo scalingConfigurationInfo)
scalingConfigurationInfo
- public ScalingConfigurationInfo getScalingConfigurationInfo()
public DBCluster withScalingConfigurationInfo(ScalingConfigurationInfo scalingConfigurationInfo)
scalingConfigurationInfo
- public void setRdsCustomClusterConfiguration(RdsCustomClusterConfiguration rdsCustomClusterConfiguration)
Reserved for future use.
rdsCustomClusterConfiguration
- Reserved for future use.public RdsCustomClusterConfiguration getRdsCustomClusterConfiguration()
Reserved for future use.
public DBCluster withRdsCustomClusterConfiguration(RdsCustomClusterConfiguration rdsCustomClusterConfiguration)
Reserved for future use.
rdsCustomClusterConfiguration
- Reserved for future use.public void setDeletionProtection(Boolean deletionProtection)
Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
deletionProtection
- Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when
deletion protection is enabled.public Boolean getDeletionProtection()
Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
public DBCluster withDeletionProtection(Boolean deletionProtection)
Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
deletionProtection
- Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when
deletion protection is enabled.public Boolean isDeletionProtection()
Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
public void setHttpEndpointEnabled(Boolean httpEndpointEnabled)
Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the 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.
httpEndpointEnabled
- Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the 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.
public Boolean getHttpEndpointEnabled()
Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the 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.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the 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.
public DBCluster withHttpEndpointEnabled(Boolean httpEndpointEnabled)
Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the 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.
httpEndpointEnabled
- Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the 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.
public Boolean isHttpEndpointEnabled()
Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the 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.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the 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.
public void setActivityStreamMode(String activityStreamMode)
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
activityStreamMode
- The mode of the database activity stream. Database events such as a change or access generate an activity
stream event. The database session can handle these events either synchronously or asynchronously.ActivityStreamMode
public String getActivityStreamMode()
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
ActivityStreamMode
public DBCluster withActivityStreamMode(String activityStreamMode)
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
activityStreamMode
- The mode of the database activity stream. Database events such as a change or access generate an activity
stream event. The database session can handle these events either synchronously or asynchronously.ActivityStreamMode
public DBCluster withActivityStreamMode(ActivityStreamMode activityStreamMode)
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
activityStreamMode
- The mode of the database activity stream. Database events such as a change or access generate an activity
stream event. The database session can handle these events either synchronously or asynchronously.ActivityStreamMode
public void setActivityStreamStatus(String activityStreamStatus)
The status of the database activity stream.
activityStreamStatus
- The status of the database activity stream.ActivityStreamStatus
public String getActivityStreamStatus()
The status of the database activity stream.
ActivityStreamStatus
public DBCluster withActivityStreamStatus(String activityStreamStatus)
The status of the database activity stream.
activityStreamStatus
- The status of the database activity stream.ActivityStreamStatus
public DBCluster withActivityStreamStatus(ActivityStreamStatus activityStreamStatus)
The status of the database activity stream.
activityStreamStatus
- The status of the database activity stream.ActivityStreamStatus
public void setActivityStreamKmsKeyId(String activityStreamKmsKeyId)
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
activityStreamKmsKeyId
- The Amazon Web Services KMS key identifier used for encrypting messages in the database activity
stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
public String getActivityStreamKmsKeyId()
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
public DBCluster withActivityStreamKmsKeyId(String activityStreamKmsKeyId)
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
activityStreamKmsKeyId
- The Amazon Web Services KMS key identifier used for encrypting messages in the database activity
stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
public void setActivityStreamKinesisStreamName(String activityStreamKinesisStreamName)
The name of the Amazon Kinesis data stream used for the database activity stream.
activityStreamKinesisStreamName
- The name of the Amazon Kinesis data stream used for the database activity stream.public String getActivityStreamKinesisStreamName()
The name of the Amazon Kinesis data stream used for the database activity stream.
public DBCluster withActivityStreamKinesisStreamName(String activityStreamKinesisStreamName)
The name of the Amazon Kinesis data stream used for the database activity stream.
activityStreamKinesisStreamName
- The name of the Amazon Kinesis data stream used for the database activity stream.public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
copyTagsToSnapshot
- Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.public Boolean getCopyTagsToSnapshot()
Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
public DBCluster withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
copyTagsToSnapshot
- Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.public Boolean isCopyTagsToSnapshot()
Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
public void setCrossAccountClone(Boolean crossAccountClone)
Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
crossAccountClone
- Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services
account.public Boolean getCrossAccountClone()
Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
public DBCluster withCrossAccountClone(Boolean crossAccountClone)
Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
crossAccountClone
- Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services
account.public Boolean isCrossAccountClone()
Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
public List<DomainMembership> getDomainMemberships()
The Active Directory Domain membership records associated with the DB cluster.
public void setDomainMemberships(Collection<DomainMembership> domainMemberships)
The Active Directory Domain membership records associated with the DB cluster.
domainMemberships
- The Active Directory Domain membership records associated with the DB cluster.public DBCluster withDomainMemberships(DomainMembership... domainMemberships)
The Active Directory Domain membership records associated with the DB cluster.
NOTE: This method appends the values to the existing list (if any). Use
setDomainMemberships(java.util.Collection)
or withDomainMemberships(java.util.Collection)
if
you want to override the existing values.
domainMemberships
- The Active Directory Domain membership records associated with the DB cluster.public DBCluster withDomainMemberships(Collection<DomainMembership> domainMemberships)
The Active Directory Domain membership records associated with the DB cluster.
domainMemberships
- The Active Directory Domain membership records associated with the DB cluster.public void setTagList(Collection<Tag> tagList)
tagList
- public DBCluster withTagList(Tag... tagList)
NOTE: This method appends the values to the existing list (if any). Use
setTagList(java.util.Collection)
or withTagList(java.util.Collection)
if you want to override
the existing values.
tagList
- public DBCluster withTagList(Collection<Tag> tagList)
tagList
- public void setGlobalWriteForwardingStatus(String globalWriteForwardingStatus)
The status of write forwarding for a secondary cluster in an Aurora global database.
globalWriteForwardingStatus
- The status of write forwarding for a secondary cluster in an Aurora global database.WriteForwardingStatus
public String getGlobalWriteForwardingStatus()
The status of write forwarding for a secondary cluster in an Aurora global database.
WriteForwardingStatus
public DBCluster withGlobalWriteForwardingStatus(String globalWriteForwardingStatus)
The status of write forwarding for a secondary cluster in an Aurora global database.
globalWriteForwardingStatus
- The status of write forwarding for a secondary cluster in an Aurora global database.WriteForwardingStatus
public DBCluster withGlobalWriteForwardingStatus(WriteForwardingStatus globalWriteForwardingStatus)
The status of write forwarding for a secondary cluster in an Aurora global database.
globalWriteForwardingStatus
- The status of write forwarding for a secondary cluster in an Aurora global database.WriteForwardingStatus
public void setGlobalWriteForwardingRequested(Boolean globalWriteForwardingRequested)
Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write
forwarding takes time to enable, check the value of GlobalWriteForwardingStatus
to confirm that the
request has completed before using the write forwarding feature for this cluster.
globalWriteForwardingRequested
- Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database.
Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus
to confirm that the request has completed before using the write forwarding feature for this cluster.public Boolean getGlobalWriteForwardingRequested()
Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write
forwarding takes time to enable, check the value of GlobalWriteForwardingStatus
to confirm that the
request has completed before using the write forwarding feature for this cluster.
GlobalWriteForwardingStatus
to confirm that the request has completed before using the write
forwarding feature for this cluster.public DBCluster withGlobalWriteForwardingRequested(Boolean globalWriteForwardingRequested)
Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write
forwarding takes time to enable, check the value of GlobalWriteForwardingStatus
to confirm that the
request has completed before using the write forwarding feature for this cluster.
globalWriteForwardingRequested
- Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database.
Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus
to confirm that the request has completed before using the write forwarding feature for this cluster.public Boolean isGlobalWriteForwardingRequested()
Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write
forwarding takes time to enable, check the value of GlobalWriteForwardingStatus
to confirm that the
request has completed before using the write forwarding feature for this cluster.
GlobalWriteForwardingStatus
to confirm that the request has completed before using the write
forwarding feature for this cluster.public void setPendingModifiedValues(ClusterPendingModifiedValues pendingModifiedValues)
Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.
pendingModifiedValues
- Information about pending changes to the DB cluster. This information is returned only when there are
pending changes. Specific changes are identified by subelements.public ClusterPendingModifiedValues getPendingModifiedValues()
Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.
public DBCluster withPendingModifiedValues(ClusterPendingModifiedValues pendingModifiedValues)
Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.
pendingModifiedValues
- Information about pending changes to the DB cluster. This information is returned only when there are
pending changes. Specific changes are identified by subelements.public void setDBClusterInstanceClass(String dBClusterInstanceClass)
The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
dBClusterInstanceClass
- The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
public String getDBClusterInstanceClass()
The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
This setting is only for non-Aurora Multi-AZ DB clusters.
public DBCluster withDBClusterInstanceClass(String dBClusterInstanceClass)
The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
dBClusterInstanceClass
- The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
public void setStorageType(String storageType)
The storage type associated with the DB cluster.
storageType
- The storage type associated with the DB cluster.public String getStorageType()
The storage type associated with the DB cluster.
public DBCluster withStorageType(String storageType)
The storage type associated with the DB cluster.
storageType
- The storage type associated with the DB cluster.public void setIops(Integer iops)
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
iops
- The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
public Integer getIops()
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
This setting is only for non-Aurora Multi-AZ DB clusters.
public DBCluster withIops(Integer iops)
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
iops
- The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
public void setPubliclyAccessible(Boolean publiclyAccessible)
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
publiclyAccessible
- Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
public Boolean getPubliclyAccessible()
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
public DBCluster withPubliclyAccessible(Boolean publiclyAccessible)
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
publiclyAccessible
- Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
public Boolean isPubliclyAccessible()
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
autoMinorVersionUpgrade
- Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
public Boolean getAutoMinorVersionUpgrade()
Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
This setting is only for non-Aurora Multi-AZ DB clusters.
public DBCluster withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
autoMinorVersionUpgrade
- Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
public Boolean isAutoMinorVersionUpgrade()
Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
This setting is only for non-Aurora Multi-AZ DB clusters.
public void setMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB
cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
public Integer getMonitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
This setting is only for non-Aurora Multi-AZ DB clusters.
public DBCluster withMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB
cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
public void setMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for non-Aurora Multi-AZ DB clusters.
monitoringRoleArn
- The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch
Logs.
This setting is only for non-Aurora Multi-AZ DB clusters.
public String getMonitoringRoleArn()
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for non-Aurora Multi-AZ DB clusters.
This setting is only for non-Aurora Multi-AZ DB clusters.
public DBCluster withMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for non-Aurora Multi-AZ DB clusters.
monitoringRoleArn
- The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch
Logs.
This setting is only for non-Aurora Multi-AZ DB clusters.
public void setPerformanceInsightsEnabled(Boolean performanceInsightsEnabled)
Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
performanceInsightsEnabled
- Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
public Boolean getPerformanceInsightsEnabled()
Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
This setting is only for non-Aurora Multi-AZ DB clusters.
public DBCluster withPerformanceInsightsEnabled(Boolean performanceInsightsEnabled)
Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
performanceInsightsEnabled
- Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
public Boolean isPerformanceInsightsEnabled()
Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
This setting is only for non-Aurora Multi-AZ DB clusters.
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.
This setting is only for non-Aurora Multi-AZ DB clusters.
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.
This setting is only for non-Aurora Multi-AZ DB clusters.
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.
This setting is only for non-Aurora Multi-AZ DB clusters.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
This setting is only for non-Aurora Multi-AZ DB clusters.
public DBCluster 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.
This setting is only for non-Aurora Multi-AZ DB clusters.
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.
This setting is only for non-Aurora Multi-AZ DB clusters.
public void setPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The number of days to retain Performance Insights data.
This setting is only for non-Aurora Multi-AZ DB clusters.
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
performanceInsightsRetentionPeriod
- The number of days to retain Performance Insights data.
This setting is only for non-Aurora Multi-AZ DB clusters.
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
public Integer getPerformanceInsightsRetentionPeriod()
The number of days to retain Performance Insights data.
This setting is only for non-Aurora Multi-AZ DB clusters.
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
This setting is only for non-Aurora Multi-AZ DB clusters.
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
public DBCluster withPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The number of days to retain Performance Insights data.
This setting is only for non-Aurora Multi-AZ DB clusters.
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
performanceInsightsRetentionPeriod
- The number of days to retain Performance Insights data.
This setting is only for non-Aurora Multi-AZ DB clusters.
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
public void setServerlessV2ScalingConfiguration(ServerlessV2ScalingConfigurationInfo serverlessV2ScalingConfiguration)
serverlessV2ScalingConfiguration
- public ServerlessV2ScalingConfigurationInfo getServerlessV2ScalingConfiguration()
public DBCluster withServerlessV2ScalingConfiguration(ServerlessV2ScalingConfigurationInfo serverlessV2ScalingConfiguration)
serverlessV2ScalingConfiguration
- public void setNetworkType(String networkType)
The network type of the DB instance.
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.
This setting is only for Aurora DB clusters.
Valid Values: IPV4 | DUAL
networkType
- The network type of the DB instance.
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.
This setting is only for Aurora DB clusters.
Valid Values: IPV4 | DUAL
public String getNetworkType()
The network type of the DB instance.
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.
This setting is only for Aurora DB clusters.
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.
This setting is only for Aurora DB clusters.
Valid Values: IPV4 | DUAL
public DBCluster withNetworkType(String networkType)
The network type of the DB instance.
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.
This setting is only for Aurora DB clusters.
Valid Values: IPV4 | DUAL
networkType
- The network type of the DB instance.
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.
This setting is only for Aurora DB clusters.
Valid Values: IPV4 | DUAL
public void setDBSystemId(String dBSystemId)
Reserved for future use.
dBSystemId
- Reserved for future use.public String getDBSystemId()
Reserved for future use.
public DBCluster withDBSystemId(String dBSystemId)
Reserved for future use.
dBSystemId
- Reserved for future use.public void setMasterUserSecret(MasterUserSecret masterUserSecret)
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user 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.
masterUserSecret
- The secret managed by RDS in Amazon Web Services Secrets Manager for the master user 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.
public MasterUserSecret getMasterUserSecret()
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user 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.
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.
public DBCluster withMasterUserSecret(MasterUserSecret masterUserSecret)
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user 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.
masterUserSecret
- The secret managed by RDS in Amazon Web Services Secrets Manager for the master user 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.
public void setIOOptimizedNextAllowedModificationTime(Date iOOptimizedNextAllowedModificationTime)
The next time you can modify the DB cluster to use the aurora-iopt1
storage type.
This setting is only for Aurora DB clusters.
iOOptimizedNextAllowedModificationTime
- The next time you can modify the DB cluster to use the aurora-iopt1
storage type.
This setting is only for Aurora DB clusters.
public Date getIOOptimizedNextAllowedModificationTime()
The next time you can modify the DB cluster to use the aurora-iopt1
storage type.
This setting is only for Aurora DB clusters.
aurora-iopt1
storage type.
This setting is only for Aurora DB clusters.
public DBCluster withIOOptimizedNextAllowedModificationTime(Date iOOptimizedNextAllowedModificationTime)
The next time you can modify the DB cluster to use the aurora-iopt1
storage type.
This setting is only for Aurora DB clusters.
iOOptimizedNextAllowedModificationTime
- The next time you can modify the DB cluster to use the aurora-iopt1
storage type.
This setting is only for Aurora DB clusters.
public void setLocalWriteForwardingStatus(String localWriteForwardingStatus)
Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
localWriteForwardingStatus
- Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or
is in the process of enabling it.LocalWriteForwardingStatus
public String getLocalWriteForwardingStatus()
Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
LocalWriteForwardingStatus
public DBCluster withLocalWriteForwardingStatus(String localWriteForwardingStatus)
Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
localWriteForwardingStatus
- Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or
is in the process of enabling it.LocalWriteForwardingStatus
public DBCluster withLocalWriteForwardingStatus(LocalWriteForwardingStatus localWriteForwardingStatus)
Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
localWriteForwardingStatus
- Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or
is in the process of enabling it.LocalWriteForwardingStatus
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 DBCluster 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 setLimitlessDatabase(LimitlessDatabase limitlessDatabase)
The details for Aurora Limitless Database.
limitlessDatabase
- The details for Aurora Limitless Database.public LimitlessDatabase getLimitlessDatabase()
The details for Aurora Limitless Database.
public DBCluster withLimitlessDatabase(LimitlessDatabase limitlessDatabase)
The details for Aurora Limitless Database.
limitlessDatabase
- The details for Aurora Limitless Database.public void setStorageThroughput(Integer storageThroughput)
The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
storageThroughput
- The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you
provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
public Integer getStorageThroughput()
The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
This setting is only for non-Aurora Multi-AZ DB clusters.
public DBCluster withStorageThroughput(Integer storageThroughput)
The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
storageThroughput
- The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you
provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
public void setCertificateDetails(CertificateDetails certificateDetails)
certificateDetails
- public CertificateDetails getCertificateDetails()
public DBCluster withCertificateDetails(CertificateDetails certificateDetails)
certificateDetails
- public void setEngineLifecycleSupport(String engineLifecycleSupport)
The life cycle type for the DB cluster.
For more information, see CreateDBCluster.
engineLifecycleSupport
- The life cycle type for the DB cluster.
For more information, see CreateDBCluster.
public String getEngineLifecycleSupport()
The life cycle type for the DB cluster.
For more information, see CreateDBCluster.
For more information, see CreateDBCluster.
public DBCluster withEngineLifecycleSupport(String engineLifecycleSupport)
The life cycle type for the DB cluster.
For more information, see CreateDBCluster.
engineLifecycleSupport
- The life cycle type for the DB cluster.
For more information, see CreateDBCluster.
public String toString()
toString
in class Object
Object.toString()