@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.
This data type is used as a response element in the DescribeDBClusters
, StopDBCluster
, and
StartDBCluster
actions.
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()
Provides 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.
|
List<String> |
getAvailabilityZones()
Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
|
Long |
getBacktrackConsumedChangeRecords()
The number of change records stored for Backtrack.
|
Long |
getBacktrackWindow()
The target backtrack window, in seconds.
|
Integer |
getBackupRetentionPeriod()
Specifies the number of days for which automatic DB snapshots are retained.
|
Integer |
getCapacity()
The current capacity of an Aurora Serverless DB cluster.
|
String |
getCharacterSetName()
If present, specifies the name of the character set that this cluster is associated with.
|
String |
getCloneGroupId()
Identifies the clone group to which the DB cluster is associated.
|
Date |
getClusterCreateTime()
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
|
Boolean |
getCopyTagsToSnapshot()
Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
|
Boolean |
getCrossAccountClone()
Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
|
List<String> |
getCustomEndpoints()
Identifies all custom endpoints associated with the cluster.
|
String |
getDatabaseName()
Contains the name of the initial database of this DB cluster that was provided at create time, if one was
specified when the DB cluster was created.
|
String |
getDBClusterArn()
The Amazon Resource Name (ARN) for the DB cluster.
|
String |
getDBClusterIdentifier()
Contains a user-supplied DB cluster identifier.
|
List<DBClusterMember> |
getDBClusterMembers()
Provides the list of instances that make up the DB cluster.
|
List<DBClusterOptionGroupStatus> |
getDBClusterOptionGroupMemberships()
Provides the list of option group memberships for this DB cluster.
|
String |
getDBClusterParameterGroup()
Specifies 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()
Specifies information on the subnet group associated with the DB cluster, including the name, description, and
subnets in the subnet group.
|
Boolean |
getDeletionProtection()
Indicates if 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()
Specifies the connection endpoint for the primary instance of the DB cluster.
|
String |
getEngine()
The name of the database engine to be used for this DB cluster.
|
String |
getEngineMode()
The DB engine mode of the DB cluster, either
provisioned , serverless ,
parallelquery , global , or multimaster . |
String |
getEngineVersion()
Indicates the database engine version.
|
Boolean |
getGlobalWriteForwardingRequested()
Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global
database.
|
String |
getGlobalWriteForwardingStatus()
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or
is in the process of enabling it.
|
String |
getHostedZoneId()
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
|
Boolean |
getHttpEndpointEnabled()
A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
|
Boolean |
getIAMDatabaseAuthenticationEnabled()
A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts
to database accounts is enabled.
|
String |
getKmsKeyId()
If
StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB
cluster. |
Date |
getLatestRestorableTime()
Specifies the latest time to which a database can be restored with point-in-time restore.
|
String |
getMasterUsername()
Contains the master username for the DB cluster.
|
Boolean |
getMultiAZ()
Specifies whether the DB cluster has instances in multiple Availability Zones.
|
ClusterPendingModifiedValues |
getPendingModifiedValues()
A value that specifies that changes to the DB cluster are pending.
|
String |
getPercentProgress()
Specifies the progress of the operation as a percentage.
|
Integer |
getPort()
Specifies the port that the database engine is listening on.
|
String |
getPreferredBackupWindow()
Specifies the daily time range during which automated backups are created if automated backups are enabled, as
determined by the
BackupRetentionPeriod . |
String |
getPreferredMaintenanceWindow()
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
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()
Contains the identifier of the source DB cluster if this DB cluster is a read replica.
|
ScalingConfigurationInfo |
getScalingConfigurationInfo() |
String |
getStatus()
Specifies the current state of this DB cluster.
|
Boolean |
getStorageEncrypted()
Specifies whether the DB cluster is encrypted.
|
List<Tag> |
getTagList() |
List<VpcSecurityGroupMembership> |
getVpcSecurityGroups()
Provides a list of VPC security groups that the DB cluster belongs to.
|
int |
hashCode() |
Boolean |
isCopyTagsToSnapshot()
Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
|
Boolean |
isCrossAccountClone()
Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
|
Boolean |
isDeletionProtection()
Indicates if the DB cluster has deletion protection enabled.
|
Boolean |
isGlobalWriteForwardingRequested()
Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global
database.
|
Boolean |
isHttpEndpointEnabled()
A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
|
Boolean |
isIAMDatabaseAuthenticationEnabled()
A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts
to database accounts is enabled.
|
Boolean |
isMultiAZ()
Specifies whether the DB cluster has instances in multiple Availability Zones.
|
Boolean |
isStorageEncrypted()
Specifies 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)
Provides 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 |
setAvailabilityZones(Collection<String> availabilityZones)
Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
|
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)
Specifies the number of days for which automatic DB snapshots are retained.
|
void |
setCapacity(Integer capacity)
The current capacity of an Aurora Serverless DB cluster.
|
void |
setCharacterSetName(String characterSetName)
If present, specifies the name of the character set that this cluster is associated with.
|
void |
setCloneGroupId(String cloneGroupId)
Identifies the clone group to which the DB cluster is associated.
|
void |
setClusterCreateTime(Date clusterCreateTime)
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
|
void |
setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
|
void |
setCrossAccountClone(Boolean crossAccountClone)
Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
|
void |
setCustomEndpoints(Collection<String> customEndpoints)
Identifies all custom endpoints associated with the cluster.
|
void |
setDatabaseName(String databaseName)
Contains the name of the initial database of this DB cluster that was provided at create time, if one was
specified when the DB cluster was created.
|
void |
setDBClusterArn(String dBClusterArn)
The Amazon Resource Name (ARN) for the DB cluster.
|
void |
setDBClusterIdentifier(String dBClusterIdentifier)
Contains a user-supplied DB cluster identifier.
|
void |
setDBClusterMembers(Collection<DBClusterMember> dBClusterMembers)
Provides the list of instances that make up the DB cluster.
|
void |
setDBClusterOptionGroupMemberships(Collection<DBClusterOptionGroupStatus> dBClusterOptionGroupMemberships)
Provides the list of option group memberships for this DB cluster.
|
void |
setDBClusterParameterGroup(String dBClusterParameterGroup)
Specifies 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)
Specifies information on the subnet group associated with the DB cluster, including the name, description, and
subnets in the subnet group.
|
void |
setDeletionProtection(Boolean deletionProtection)
Indicates if 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)
Specifies the connection endpoint for the primary instance of the DB cluster.
|
void |
setEngine(String engine)
The name of the database engine to be used for this DB cluster.
|
void |
setEngineMode(String engineMode)
The DB engine mode of the DB cluster, either
provisioned , serverless ,
parallelquery , global , or multimaster . |
void |
setEngineVersion(String engineVersion)
Indicates the database engine version.
|
void |
setGlobalWriteForwardingRequested(Boolean globalWriteForwardingRequested)
Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global
database.
|
void |
setGlobalWriteForwardingStatus(String globalWriteForwardingStatus)
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or
is in the process of enabling it.
|
void |
setHostedZoneId(String hostedZoneId)
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
|
void |
setHttpEndpointEnabled(Boolean httpEndpointEnabled)
A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
|
void |
setIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts
to database accounts is enabled.
|
void |
setKmsKeyId(String kmsKeyId)
If
StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB
cluster. |
void |
setLatestRestorableTime(Date latestRestorableTime)
Specifies the latest time to which a database can be restored with point-in-time restore.
|
void |
setMasterUsername(String masterUsername)
Contains the master username for the DB cluster.
|
void |
setMultiAZ(Boolean multiAZ)
Specifies whether the DB cluster has instances in multiple Availability Zones.
|
void |
setPendingModifiedValues(ClusterPendingModifiedValues pendingModifiedValues)
A value that specifies that changes to the DB cluster are pending.
|
void |
setPercentProgress(String percentProgress)
Specifies the progress of the operation as a percentage.
|
void |
setPort(Integer port)
Specifies the port that the database engine is listening on.
|
void |
setPreferredBackupWindow(String preferredBackupWindow)
Specifies the daily time range during which automated backups are created if automated backups are enabled, as
determined by the
BackupRetentionPeriod . |
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
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)
Contains the identifier of the source DB cluster if this DB cluster is a read replica.
|
void |
setScalingConfigurationInfo(ScalingConfigurationInfo scalingConfigurationInfo) |
void |
setStatus(String status)
Specifies the current state of this DB cluster.
|
void |
setStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB cluster is encrypted.
|
void |
setTagList(Collection<Tag> tagList) |
void |
setVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Provides a 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)
Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with
the DB cluster.
|
DBCluster |
withAssociatedRoles(DBClusterRole... associatedRoles)
Provides 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 |
withAvailabilityZones(Collection<String> availabilityZones)
Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
|
DBCluster |
withAvailabilityZones(String... availabilityZones)
Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
|
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)
Specifies the number of days for which automatic DB snapshots are retained.
|
DBCluster |
withCapacity(Integer capacity)
The current capacity of an Aurora Serverless DB cluster.
|
DBCluster |
withCharacterSetName(String characterSetName)
If present, specifies the name of the character set that this cluster is associated with.
|
DBCluster |
withCloneGroupId(String cloneGroupId)
Identifies the clone group to which the DB cluster is associated.
|
DBCluster |
withClusterCreateTime(Date clusterCreateTime)
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
|
DBCluster |
withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
|
DBCluster |
withCrossAccountClone(Boolean crossAccountClone)
Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
|
DBCluster |
withCustomEndpoints(Collection<String> customEndpoints)
Identifies all custom endpoints associated with the cluster.
|
DBCluster |
withCustomEndpoints(String... customEndpoints)
Identifies all custom endpoints associated with the cluster.
|
DBCluster |
withDatabaseName(String databaseName)
Contains the name of the initial database of this DB cluster that was provided at create time, if one was
specified when the DB cluster was created.
|
DBCluster |
withDBClusterArn(String dBClusterArn)
The Amazon Resource Name (ARN) for the DB cluster.
|
DBCluster |
withDBClusterIdentifier(String dBClusterIdentifier)
Contains a user-supplied DB cluster identifier.
|
DBCluster |
withDBClusterMembers(Collection<DBClusterMember> dBClusterMembers)
Provides the list of instances that make up the DB cluster.
|
DBCluster |
withDBClusterMembers(DBClusterMember... dBClusterMembers)
Provides the list of instances that make up the DB cluster.
|
DBCluster |
withDBClusterOptionGroupMemberships(Collection<DBClusterOptionGroupStatus> dBClusterOptionGroupMemberships)
Provides the list of option group memberships for this DB cluster.
|
DBCluster |
withDBClusterOptionGroupMemberships(DBClusterOptionGroupStatus... dBClusterOptionGroupMemberships)
Provides the list of option group memberships for this DB cluster.
|
DBCluster |
withDBClusterParameterGroup(String dBClusterParameterGroup)
Specifies 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)
Specifies information on the subnet group associated with the DB cluster, including the name, description, and
subnets in the subnet group.
|
DBCluster |
withDeletionProtection(Boolean deletionProtection)
Indicates if 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)
Specifies the connection endpoint for the primary instance of the DB cluster.
|
DBCluster |
withEngine(String engine)
The name of the database engine to be used for this DB cluster.
|
DBCluster |
withEngineMode(String engineMode)
The DB engine mode of the DB cluster, either
provisioned , serverless ,
parallelquery , global , or multimaster . |
DBCluster |
withEngineVersion(String engineVersion)
Indicates the database engine version.
|
DBCluster |
withGlobalWriteForwardingRequested(Boolean globalWriteForwardingRequested)
Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global
database.
|
DBCluster |
withGlobalWriteForwardingStatus(String globalWriteForwardingStatus)
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or
is in the process of enabling it.
|
DBCluster |
withGlobalWriteForwardingStatus(WriteForwardingStatus globalWriteForwardingStatus)
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or
is in the process of enabling it.
|
DBCluster |
withHostedZoneId(String hostedZoneId)
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
|
DBCluster |
withHttpEndpointEnabled(Boolean httpEndpointEnabled)
A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
|
DBCluster |
withIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts
to database accounts is enabled.
|
DBCluster |
withKmsKeyId(String kmsKeyId)
If
StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB
cluster. |
DBCluster |
withLatestRestorableTime(Date latestRestorableTime)
Specifies the latest time to which a database can be restored with point-in-time restore.
|
DBCluster |
withMasterUsername(String masterUsername)
Contains the master username for the DB cluster.
|
DBCluster |
withMultiAZ(Boolean multiAZ)
Specifies whether the DB cluster has instances in multiple Availability Zones.
|
DBCluster |
withPendingModifiedValues(ClusterPendingModifiedValues pendingModifiedValues)
A value that specifies that changes to the DB cluster are pending.
|
DBCluster |
withPercentProgress(String percentProgress)
Specifies the progress of the operation as a percentage.
|
DBCluster |
withPort(Integer port)
Specifies the port that the database engine is listening on.
|
DBCluster |
withPreferredBackupWindow(String preferredBackupWindow)
Specifies the daily time range during which automated backups are created if automated backups are enabled, as
determined by the
BackupRetentionPeriod . |
DBCluster |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
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)
Contains the identifier of the source DB cluster if this DB cluster is a read replica.
|
DBCluster |
withScalingConfigurationInfo(ScalingConfigurationInfo scalingConfigurationInfo) |
DBCluster |
withStatus(String status)
Specifies the current state of this DB cluster.
|
DBCluster |
withStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB cluster is encrypted.
|
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)
Provides a list of VPC security groups that the DB cluster belongs to.
|
DBCluster |
withVpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
Provides a 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()
Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
public void setAvailabilityZones(Collection<String> availabilityZones)
Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
availabilityZones
- Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.public DBCluster withAvailabilityZones(String... availabilityZones)
Provides 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
- Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.public DBCluster withAvailabilityZones(Collection<String> availabilityZones)
Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
availabilityZones
- Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.public void setBackupRetentionPeriod(Integer backupRetentionPeriod)
Specifies the number of days for which automatic DB snapshots are retained.
backupRetentionPeriod
- Specifies the number of days for which automatic DB snapshots are retained.public Integer getBackupRetentionPeriod()
Specifies the number of days for which automatic DB snapshots are retained.
public DBCluster withBackupRetentionPeriod(Integer backupRetentionPeriod)
Specifies the number of days for which automatic DB snapshots are retained.
backupRetentionPeriod
- Specifies 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)
Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
databaseName
- Contains the name of the initial database of this DB cluster that was provided at create time, if one was
specified when the DB cluster was created. This same name is returned for the life of the DB cluster.public String getDatabaseName()
Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
public DBCluster withDatabaseName(String databaseName)
Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
databaseName
- Contains the name of the initial database of this DB cluster that was provided at create time, if one was
specified when the DB cluster was created. This same name is returned for the life of the DB cluster.public void setDBClusterIdentifier(String dBClusterIdentifier)
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
dBClusterIdentifier
- Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB
cluster.public String getDBClusterIdentifier()
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
public DBCluster withDBClusterIdentifier(String dBClusterIdentifier)
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
dBClusterIdentifier
- Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB
cluster.public void setDBClusterParameterGroup(String dBClusterParameterGroup)
Specifies the name of the DB cluster parameter group for the DB cluster.
dBClusterParameterGroup
- Specifies the name of the DB cluster parameter group for the DB cluster.public String getDBClusterParameterGroup()
Specifies the name of the DB cluster parameter group for the DB cluster.
public DBCluster withDBClusterParameterGroup(String dBClusterParameterGroup)
Specifies the name of the DB cluster parameter group for the DB cluster.
dBClusterParameterGroup
- Specifies the name of the DB cluster parameter group for the DB cluster.public void setDBSubnetGroup(String dBSubnetGroup)
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
dBSubnetGroup
- Specifies information on the subnet group associated with the DB cluster, including the name, description,
and subnets in the subnet group.public String getDBSubnetGroup()
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
public DBCluster withDBSubnetGroup(String dBSubnetGroup)
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
dBSubnetGroup
- Specifies information on the subnet group associated with the DB cluster, including the name, description,
and subnets in the subnet group.public void setStatus(String status)
Specifies the current state of this DB cluster.
status
- Specifies the current state of this DB cluster.public String getStatus()
Specifies the current state of this DB cluster.
public DBCluster withStatus(String status)
Specifies the current state of this DB cluster.
status
- Specifies 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)
Specifies the progress of the operation as a percentage.
percentProgress
- Specifies the progress of the operation as a percentage.public String getPercentProgress()
Specifies the progress of the operation as a percentage.
public DBCluster withPercentProgress(String percentProgress)
Specifies the progress of the operation as a percentage.
percentProgress
- Specifies 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)
Specifies the connection endpoint for the primary instance of the DB cluster.
endpoint
- Specifies the connection endpoint for the primary instance of the DB cluster.public String getEndpoint()
Specifies the connection endpoint for the primary instance of the DB cluster.
public DBCluster withEndpoint(String endpoint)
Specifies the connection endpoint for the primary instance of the DB cluster.
endpoint
- Specifies 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()
Identifies all custom endpoints associated with the cluster.
public void setCustomEndpoints(Collection<String> customEndpoints)
Identifies all custom endpoints associated with the cluster.
customEndpoints
- Identifies all custom endpoints associated with the cluster.public DBCluster withCustomEndpoints(String... customEndpoints)
Identifies all custom endpoints associated with the 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
- Identifies all custom endpoints associated with the cluster.public DBCluster withCustomEndpoints(Collection<String> customEndpoints)
Identifies all custom endpoints associated with the cluster.
customEndpoints
- Identifies all custom endpoints associated with the cluster.public void setMultiAZ(Boolean multiAZ)
Specifies whether the DB cluster has instances in multiple Availability Zones.
multiAZ
- Specifies whether the DB cluster has instances in multiple Availability Zones.public Boolean getMultiAZ()
Specifies whether the DB cluster has instances in multiple Availability Zones.
public DBCluster withMultiAZ(Boolean multiAZ)
Specifies whether the DB cluster has instances in multiple Availability Zones.
multiAZ
- Specifies whether the DB cluster has instances in multiple Availability Zones.public Boolean isMultiAZ()
Specifies whether the DB cluster has instances in multiple Availability Zones.
public void setEngine(String engine)
The name of the database engine to be used for this DB cluster.
engine
- The name of the database engine to be used for this DB cluster.public String getEngine()
The name of the database engine to be used for this DB cluster.
public DBCluster withEngine(String engine)
The name of the database engine to be used for this DB cluster.
engine
- The name of the database engine to be used for this DB cluster.public void setEngineVersion(String engineVersion)
Indicates the database engine version.
engineVersion
- Indicates the database engine version.public String getEngineVersion()
Indicates the database engine version.
public DBCluster withEngineVersion(String engineVersion)
Indicates the database engine version.
engineVersion
- Indicates the database engine version.public void setLatestRestorableTime(Date latestRestorableTime)
Specifies the latest time to which a database can be restored with point-in-time restore.
latestRestorableTime
- Specifies the latest time to which a database can be restored with point-in-time restore.public Date getLatestRestorableTime()
Specifies the latest time to which a database can be restored with point-in-time restore.
public DBCluster withLatestRestorableTime(Date latestRestorableTime)
Specifies the latest time to which a database can be restored with point-in-time restore.
latestRestorableTime
- Specifies the latest time to which a database can be restored with point-in-time restore.public void setPort(Integer port)
Specifies the port that the database engine is listening on.
port
- Specifies the port that the database engine is listening on.public Integer getPort()
Specifies the port that the database engine is listening on.
public DBCluster withPort(Integer port)
Specifies the port that the database engine is listening on.
port
- Specifies the port that the database engine is listening on.public void setMasterUsername(String masterUsername)
Contains the master username for the DB cluster.
masterUsername
- Contains the master username for the DB cluster.public String getMasterUsername()
Contains the master username for the DB cluster.
public DBCluster withMasterUsername(String masterUsername)
Contains the master username for the DB cluster.
masterUsername
- Contains the master username for the DB cluster.public List<DBClusterOptionGroupStatus> getDBClusterOptionGroupMemberships()
Provides the list of option group memberships for this DB cluster.
public void setDBClusterOptionGroupMemberships(Collection<DBClusterOptionGroupStatus> dBClusterOptionGroupMemberships)
Provides the list of option group memberships for this DB cluster.
dBClusterOptionGroupMemberships
- Provides the list of option group memberships for this DB cluster.public DBCluster withDBClusterOptionGroupMemberships(DBClusterOptionGroupStatus... dBClusterOptionGroupMemberships)
Provides 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
- Provides the list of option group memberships for this DB cluster.public DBCluster withDBClusterOptionGroupMemberships(Collection<DBClusterOptionGroupStatus> dBClusterOptionGroupMemberships)
Provides the list of option group memberships for this DB cluster.
dBClusterOptionGroupMemberships
- Provides the list of option group memberships for this DB cluster.public void setPreferredBackupWindow(String preferredBackupWindow)
Specifies the daily time range during which automated backups are created if automated backups are enabled, as
determined by the BackupRetentionPeriod
.
preferredBackupWindow
- Specifies the daily time range during which automated backups are created if automated backups are
enabled, as determined by the BackupRetentionPeriod
.public String getPreferredBackupWindow()
Specifies 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)
Specifies the daily time range during which automated backups are created if automated backups are enabled, as
determined by the BackupRetentionPeriod
.
preferredBackupWindow
- Specifies 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)
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
preferredMaintenanceWindow
- Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time
(UTC).public String getPreferredMaintenanceWindow()
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
public DBCluster withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
preferredMaintenanceWindow
- Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time
(UTC).public void setReplicationSourceIdentifier(String replicationSourceIdentifier)
Contains the identifier of the source DB cluster if this DB cluster is a read replica.
replicationSourceIdentifier
- Contains the identifier of the source DB cluster if this DB cluster is a read replica.public String getReplicationSourceIdentifier()
Contains the identifier of the source DB cluster if this DB cluster is a read replica.
public DBCluster withReplicationSourceIdentifier(String replicationSourceIdentifier)
Contains the identifier of the source DB cluster if this DB cluster is a read replica.
replicationSourceIdentifier
- Contains 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<DBClusterMember> getDBClusterMembers()
Provides the list of instances that make up the DB cluster.
public void setDBClusterMembers(Collection<DBClusterMember> dBClusterMembers)
Provides the list of instances that make up the DB cluster.
dBClusterMembers
- Provides the list of instances that make up the DB cluster.public DBCluster withDBClusterMembers(DBClusterMember... dBClusterMembers)
Provides the list of 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
- Provides the list of instances that make up the DB cluster.public DBCluster withDBClusterMembers(Collection<DBClusterMember> dBClusterMembers)
Provides the list of instances that make up the DB cluster.
dBClusterMembers
- Provides the list of instances that make up the DB cluster.public List<VpcSecurityGroupMembership> getVpcSecurityGroups()
Provides a list of VPC security groups that the DB cluster belongs to.
public void setVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Provides a list of VPC security groups that the DB cluster belongs to.
vpcSecurityGroups
- Provides a list of VPC security groups that the DB cluster belongs to.public DBCluster withVpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
Provides a 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
- Provides a list of VPC security groups that the DB cluster belongs to.public DBCluster withVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
Provides a list of VPC security groups that the DB cluster belongs to.
vpcSecurityGroups
- Provides a list of VPC security groups that the DB cluster belongs to.public void setHostedZoneId(String hostedZoneId)
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
hostedZoneId
- Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.public String getHostedZoneId()
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
public DBCluster withHostedZoneId(String hostedZoneId)
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
hostedZoneId
- Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.public void setStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB cluster is encrypted.
storageEncrypted
- Specifies whether the DB cluster is encrypted.public Boolean getStorageEncrypted()
Specifies whether the DB cluster is encrypted.
public DBCluster withStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB cluster is encrypted.
storageEncrypted
- Specifies whether the DB cluster is encrypted.public Boolean isStorageEncrypted()
Specifies 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 Amazon Web Services KMS customer master key (CMK).
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 Amazon Web Services KMS customer master key (CMK).
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 Amazon Web Services KMS customer master key (CMK).
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 Amazon Web Services KMS customer master key (CMK).
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 Amazon Web Services KMS customer master key (CMK).
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 Amazon Web Services KMS customer master key (CMK).
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 Amazon Web Services KMS CMK 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 Amazon Web Services KMS CMK 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 Amazon Web Services KMS CMK 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 Amazon Web Services KMS CMK 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 Amazon Web Services KMS CMK 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()
Provides 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)
Provides 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
- Provides 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)
Provides 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
- Provides 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)
Provides 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
- Provides 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)
A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
iAMDatabaseAuthenticationEnabled
- A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM)
accounts to database accounts is enabled.public Boolean getIAMDatabaseAuthenticationEnabled()
A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
public DBCluster withIAMDatabaseAuthenticationEnabled(Boolean iAMDatabaseAuthenticationEnabled)
A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
iAMDatabaseAuthenticationEnabled
- A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM)
accounts to database accounts is enabled.public Boolean isIAMDatabaseAuthenticationEnabled()
A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
public void setCloneGroupId(String cloneGroupId)
Identifies the clone group to which the DB cluster is associated.
cloneGroupId
- Identifies the clone group to which the DB cluster is associated.public String getCloneGroupId()
Identifies the clone group to which the DB cluster is associated.
public DBCluster withCloneGroupId(String cloneGroupId)
Identifies the clone group to which the DB cluster is associated.
cloneGroupId
- Identifies the clone group to which the DB cluster is associated.public void setClusterCreateTime(Date clusterCreateTime)
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
clusterCreateTime
- Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).public Date getClusterCreateTime()
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
public DBCluster withClusterCreateTime(Date clusterCreateTime)
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
clusterCreateTime
- Specifies 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.
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 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
capacity
- The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) when the cluster is
paused.
For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
public Integer getCapacity()
The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
public DBCluster withCapacity(Integer capacity)
The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
capacity
- The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) when the cluster is
paused.
For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
public void setEngineMode(String engineMode)
The DB engine mode of the DB cluster, either provisioned
, serverless
,
parallelquery
, global
, or multimaster
.
For more information, see CreateDBCluster.
engineMode
- The DB engine mode of the DB cluster, either provisioned
, serverless
,
parallelquery
, global
, or multimaster
.
For more information, see CreateDBCluster.
public String getEngineMode()
The DB engine mode of the DB cluster, either provisioned
, serverless
,
parallelquery
, global
, or multimaster
.
For more information, see CreateDBCluster.
provisioned
, serverless
,
parallelquery
, global
, or multimaster
.
For more information, see CreateDBCluster.
public DBCluster withEngineMode(String engineMode)
The DB engine mode of the DB cluster, either provisioned
, serverless
,
parallelquery
, global
, or multimaster
.
For more information, see CreateDBCluster.
engineMode
- The DB engine mode of the DB cluster, either provisioned
, serverless
,
parallelquery
, global
, or multimaster
.
For more information, see CreateDBCluster.
public void setScalingConfigurationInfo(ScalingConfigurationInfo scalingConfigurationInfo)
scalingConfigurationInfo
- public ScalingConfigurationInfo getScalingConfigurationInfo()
public DBCluster withScalingConfigurationInfo(ScalingConfigurationInfo scalingConfigurationInfo)
scalingConfigurationInfo
- public void setDeletionProtection(Boolean deletionProtection)
Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
deletionProtection
- Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion
protection is enabled.public Boolean getDeletionProtection()
Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
public DBCluster withDeletionProtection(Boolean deletionProtection)
Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
deletionProtection
- Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion
protection is enabled.public Boolean isDeletionProtection()
Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
public void setHttpEndpointEnabled(Boolean httpEndpointEnabled)
A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
httpEndpointEnabled
- A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
public Boolean getHttpEndpointEnabled()
A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
public DBCluster withHttpEndpointEnabled(Boolean httpEndpointEnabled)
A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
httpEndpointEnabled
- A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
public Boolean isHttpEndpointEnabled()
A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.
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 Amazon Web Services KMS customer master key (CMK).
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 Amazon Web Services KMS customer master key (CMK).
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 Amazon Web Services KMS customer master key (CMK).
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
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 Amazon Web Services KMS customer master key (CMK).
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 Amazon Web Services KMS customer master key (CMK).
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)
Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
copyTagsToSnapshot
- Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.public Boolean getCopyTagsToSnapshot()
Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
public DBCluster withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
copyTagsToSnapshot
- Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.public Boolean isCopyTagsToSnapshot()
Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
public void setCrossAccountClone(Boolean crossAccountClone)
Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
crossAccountClone
- Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services
account.public Boolean getCrossAccountClone()
Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
public DBCluster withCrossAccountClone(Boolean crossAccountClone)
Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
crossAccountClone
- Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services
account.public Boolean isCrossAccountClone()
Specifies 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)
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
globalWriteForwardingStatus
- Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not
enabled, or is in the process of enabling it.WriteForwardingStatus
public String getGlobalWriteForwardingStatus()
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
WriteForwardingStatus
public DBCluster withGlobalWriteForwardingStatus(String globalWriteForwardingStatus)
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
globalWriteForwardingStatus
- Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not
enabled, or is in the process of enabling it.WriteForwardingStatus
public DBCluster withGlobalWriteForwardingStatus(WriteForwardingStatus globalWriteForwardingStatus)
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
globalWriteForwardingStatus
- Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not
enabled, or is in the process of enabling it.WriteForwardingStatus
public void setGlobalWriteForwardingRequested(Boolean globalWriteForwardingRequested)
Specifies whether you have requested to enable write forwarding 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
- Specifies whether you have requested to enable write forwarding 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()
Specifies whether you have requested to enable write forwarding 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)
Specifies whether you have requested to enable write forwarding 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
- Specifies whether you have requested to enable write forwarding 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()
Specifies whether you have requested to enable write forwarding 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)
A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
pendingModifiedValues
- A value that specifies that changes to the DB cluster are pending. This element is only included when
changes are pending. Specific changes are identified by subelements.public ClusterPendingModifiedValues getPendingModifiedValues()
A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
public DBCluster withPendingModifiedValues(ClusterPendingModifiedValues pendingModifiedValues)
A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
pendingModifiedValues
- A value that specifies that changes to the DB cluster are pending. This element is only included when
changes are pending. Specific changes are identified by subelements.public String toString()
toString
in class Object
Object.toString()