@Generated(value="software.amazon.awssdk:codegen") public final class DBCluster extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DBCluster.Builder,DBCluster>
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.
Modifier and Type | Class and Description |
---|---|
static interface |
DBCluster.Builder |
Modifier and Type | Method and Description |
---|---|
String |
activityStreamKinesisStreamName()
The name of the Amazon Kinesis data stream used for the database activity stream.
|
String |
activityStreamKmsKeyId()
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
|
ActivityStreamMode |
activityStreamMode()
The mode of the database activity stream.
|
String |
activityStreamModeAsString()
The mode of the database activity stream.
|
ActivityStreamStatus |
activityStreamStatus()
The status of the database activity stream.
|
String |
activityStreamStatusAsString()
The status of the database activity stream.
|
Integer |
allocatedStorage()
For all database engines except Amazon Aurora,
AllocatedStorage specifies the allocated storage size
in gibibytes (GiB). |
List<DBClusterRole> |
associatedRoles()
A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB
cluster.
|
Instant |
automaticRestartTime()
The time when a stopped DB cluster is restarted automatically.
|
Boolean |
autoMinorVersionUpgrade()
Indicates whether minor version patches are applied automatically.
|
List<String> |
availabilityZones()
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
|
Long |
backtrackConsumedChangeRecords()
The number of change records stored for Backtrack.
|
Long |
backtrackWindow()
The target backtrack window, in seconds.
|
Integer |
backupRetentionPeriod()
The number of days for which automatic DB snapshots are retained.
|
static DBCluster.Builder |
builder() |
Integer |
capacity()
The current capacity of an Aurora Serverless v1 DB cluster.
|
String |
characterSetName()
If present, specifies the name of the character set that this cluster is associated with.
|
String |
cloneGroupId()
The ID of the clone group with which the DB cluster is associated.
|
Instant |
clusterCreateTime()
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
|
Boolean |
copyTagsToSnapshot()
Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
|
Boolean |
crossAccountClone()
Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
|
List<String> |
customEndpoints()
The custom endpoints associated with the DB cluster.
|
String |
databaseName()
The name of the initial database that was specified for the DB cluster when it was created, if one was provided.
|
String |
dbClusterArn()
The Amazon Resource Name (ARN) for the DB cluster.
|
String |
dbClusterIdentifier()
The user-supplied identifier for the DB cluster.
|
String |
dbClusterInstanceClass()
The name of the compute and memory capacity class of the DB instance.
|
List<DBClusterMember> |
dbClusterMembers()
The list of DB instances that make up the DB cluster.
|
List<DBClusterOptionGroupStatus> |
dbClusterOptionGroupMemberships()
The list of option group memberships for this DB cluster.
|
String |
dbClusterParameterGroup()
The name of the DB cluster parameter group for the DB cluster.
|
String |
dbClusterResourceId()
The Amazon Web Services Region-unique, immutable identifier for the DB cluster.
|
String |
dbSubnetGroup()
Information about the subnet group associated with the DB cluster, including the name, description, and subnets
in the subnet group.
|
String |
dbSystemId()
Reserved for future use.
|
Boolean |
deletionProtection()
Indicates whether the DB cluster has deletion protection enabled.
|
List<DomainMembership> |
domainMemberships()
The Active Directory Domain membership records associated with the DB cluster.
|
Instant |
earliestBacktrackTime()
The earliest time to which a DB cluster can be backtracked.
|
Instant |
earliestRestorableTime()
The earliest time to which a database can be restored with point-in-time restore.
|
List<String> |
enabledCloudwatchLogsExports()
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
|
String |
endpoint()
The connection endpoint for the primary instance of the DB cluster.
|
String |
engine()
The database engine used for this DB cluster.
|
String |
engineMode()
The DB engine mode of the DB cluster, either
provisioned or serverless . |
String |
engineVersion()
The version of the database engine.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
Boolean |
globalWriteForwardingRequested()
Specifies whether write forwarding is enabled for a secondary cluster in an Aurora global database.
|
WriteForwardingStatus |
globalWriteForwardingStatus()
The status of write forwarding for a secondary cluster in an Aurora global database.
|
String |
globalWriteForwardingStatusAsString()
The status of write forwarding for a secondary cluster in an Aurora global database.
|
boolean |
hasAssociatedRoles()
For responses, this returns true if the service returned a value for the AssociatedRoles property.
|
boolean |
hasAvailabilityZones()
For responses, this returns true if the service returned a value for the AvailabilityZones property.
|
boolean |
hasCustomEndpoints()
For responses, this returns true if the service returned a value for the CustomEndpoints property.
|
boolean |
hasDbClusterMembers()
For responses, this returns true if the service returned a value for the DBClusterMembers property.
|
boolean |
hasDbClusterOptionGroupMemberships()
For responses, this returns true if the service returned a value for the DBClusterOptionGroupMemberships
property.
|
boolean |
hasDomainMemberships()
For responses, this returns true if the service returned a value for the DomainMemberships property.
|
boolean |
hasEnabledCloudwatchLogsExports()
For responses, this returns true if the service returned a value for the EnabledCloudwatchLogsExports property.
|
int |
hashCode() |
boolean |
hasReadReplicaIdentifiers()
For responses, this returns true if the service returned a value for the ReadReplicaIdentifiers property.
|
boolean |
hasTagList()
For responses, this returns true if the service returned a value for the TagList property.
|
boolean |
hasVpcSecurityGroups()
For responses, this returns true if the service returned a value for the VpcSecurityGroups property.
|
String |
hostedZoneId()
The ID that Amazon Route 53 assigns when you create a hosted zone.
|
Boolean |
httpEndpointEnabled()
Indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
|
Boolean |
iamDatabaseAuthenticationEnabled()
Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database
accounts is enabled.
|
Instant |
ioOptimizedNextAllowedModificationTime()
The next time you can modify the DB cluster to use the
aurora-iopt1 storage type. |
Integer |
iops()
The Provisioned IOPS (I/O operations per second) value.
|
String |
kmsKeyId()
If
StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB
cluster. |
Instant |
latestRestorableTime()
The latest time to which a database can be restored with point-in-time restore.
|
LocalWriteForwardingStatus |
localWriteForwardingStatus()
Specifies whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in
the process of enabling it.
|
String |
localWriteForwardingStatusAsString()
Specifies whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in
the process of enabling it.
|
String |
masterUsername()
The master username for the DB cluster.
|
MasterUserSecret |
masterUserSecret()
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
|
Integer |
monitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
|
String |
monitoringRoleArn()
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
|
Boolean |
multiAZ()
Indicates whether the DB cluster has instances in multiple Availability Zones.
|
String |
networkType()
The network type of the DB instance.
|
ClusterPendingModifiedValues |
pendingModifiedValues()
Information about pending changes to the DB cluster.
|
String |
percentProgress()
The progress of the operation as a percentage.
|
Boolean |
performanceInsightsEnabled()
Indicates whether Performance Insights is enabled for the DB cluster.
|
String |
performanceInsightsKMSKeyId()
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
|
Integer |
performanceInsightsRetentionPeriod()
The number of days to retain Performance Insights data.
|
Integer |
port()
The port that the database engine is listening on.
|
String |
preferredBackupWindow()
The daily time range during which automated backups are created if automated backups are enabled, as determined
by the
BackupRetentionPeriod . |
String |
preferredMaintenanceWindow()
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
Boolean |
publiclyAccessible()
Indicates whether the DB cluster is publicly accessible.
|
String |
readerEndpoint()
The reader endpoint for the DB cluster.
|
List<String> |
readReplicaIdentifiers()
Contains one or more identifiers of the read replicas associated with this DB cluster.
|
String |
replicationSourceIdentifier()
The identifier of the source DB cluster if this DB cluster is a read replica.
|
ScalingConfigurationInfo |
scalingConfigurationInfo()
Returns the value of the ScalingConfigurationInfo property for this object.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DBCluster.Builder> |
serializableBuilderClass() |
ServerlessV2ScalingConfigurationInfo |
serverlessV2ScalingConfiguration()
Returns the value of the ServerlessV2ScalingConfiguration property for this object.
|
String |
status()
The current state of this DB cluster.
|
Boolean |
storageEncrypted()
Indicates whether the DB cluster is encrypted.
|
String |
storageType()
The storage type associated with the DB cluster.
|
List<Tag> |
tagList()
Returns the value of the TagList property for this object.
|
DBCluster.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
List<VpcSecurityGroupMembership> |
vpcSecurityGroups()
The list of VPC security groups that the DB cluster belongs to.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final 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
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 final boolean hasAvailabilityZones()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<String> availabilityZones()
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasAvailabilityZones()
method.
public final Integer backupRetentionPeriod()
The number of days for which automatic DB snapshots are retained.
public final String characterSetName()
If present, specifies the name of the character set that this cluster is associated with.
public final 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.
public final String dbClusterIdentifier()
The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.
public final String dbClusterParameterGroup()
The name of the DB cluster parameter group for the DB cluster.
public final String dbSubnetGroup()
Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
public final String status()
The current state of this DB cluster.
public final Instant automaticRestartTime()
The time when a stopped DB cluster is restarted automatically.
public final String percentProgress()
The progress of the operation as a percentage.
public final Instant earliestRestorableTime()
The earliest time to which a database can be restored with point-in-time restore.
public final String endpoint()
The connection endpoint for the primary instance of the DB cluster.
public final 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.
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 final boolean hasCustomEndpoints()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<String> customEndpoints()
The custom endpoints associated with the DB cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasCustomEndpoints()
method.
public final Boolean multiAZ()
Indicates whether the DB cluster has instances in multiple Availability Zones.
public final String engine()
The database engine used for this DB cluster.
public final String engineVersion()
The version of the database engine.
public final Instant latestRestorableTime()
The latest time to which a database can be restored with point-in-time restore.
public final Integer port()
The port that the database engine is listening on.
public final String masterUsername()
The master username for the DB cluster.
public final boolean hasDbClusterOptionGroupMemberships()
isEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may
need to differentiate between the service returning nothing (or null) and the service returning an empty
collection or map. For requests, this returns true if a value for the property was specified in the request
builder, and false if a value was not specified.public final List<DBClusterOptionGroupStatus> dbClusterOptionGroupMemberships()
The list of option group memberships for this DB cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasDbClusterOptionGroupMemberships()
method.
public final String preferredBackupWindow()
The daily time range during which automated backups are created if automated backups are enabled, as determined
by the BackupRetentionPeriod
.
BackupRetentionPeriod
.public final String preferredMaintenanceWindow()
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
public final String replicationSourceIdentifier()
The identifier of the source DB cluster if this DB cluster is a read replica.
public final boolean hasReadReplicaIdentifiers()
isEmpty()
method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final List<String> readReplicaIdentifiers()
Contains one or more identifiers of the read replicas associated with this DB cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasReadReplicaIdentifiers()
method.
public final boolean hasDbClusterMembers()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<DBClusterMember> dbClusterMembers()
The list of DB instances that make up the DB cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasDbClusterMembers()
method.
public final boolean hasVpcSecurityGroups()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<VpcSecurityGroupMembership> vpcSecurityGroups()
The list of VPC security groups that the DB cluster belongs to.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasVpcSecurityGroups()
method.
public final String hostedZoneId()
The ID that Amazon Route 53 assigns when you create a hosted zone.
public final Boolean storageEncrypted()
Indicates whether the DB cluster is encrypted.
public final 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.
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 final 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.
public final String dbClusterArn()
The Amazon Resource Name (ARN) for the DB cluster.
public final boolean hasAssociatedRoles()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasAssociatedRoles()
method.
public final Boolean iamDatabaseAuthenticationEnabled()
Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
public final String cloneGroupId()
The ID of the clone group with which the DB cluster is associated.
public final Instant clusterCreateTime()
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
public final Instant earliestBacktrackTime()
The earliest time to which a DB cluster can be backtracked.
public final 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.
0
, backtracking is disabled
for the DB cluster. Otherwise, backtracking is enabled.public final Long backtrackConsumedChangeRecords()
The number of change records stored for Backtrack.
public final boolean hasEnabledCloudwatchLogsExports()
isEmpty()
method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasEnabledCloudwatchLogsExports()
method.
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 final 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.
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 final String engineMode()
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 final ScalingConfigurationInfo scalingConfigurationInfo()
public final Boolean deletionProtection()
Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
public final Boolean httpEndpointEnabled()
Indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 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 v1 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 v1 in the Amazon Aurora User Guide.
public final 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.
If the service returns an enum value that is not available in the current SDK version,
activityStreamMode
will return ActivityStreamMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned
by the service is available from activityStreamModeAsString()
.
ActivityStreamMode
public final String activityStreamModeAsString()
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.
If the service returns an enum value that is not available in the current SDK version,
activityStreamMode
will return ActivityStreamMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned
by the service is available from activityStreamModeAsString()
.
ActivityStreamMode
public final ActivityStreamStatus activityStreamStatus()
The status of the database activity stream.
If the service returns an enum value that is not available in the current SDK version,
activityStreamStatus
will return ActivityStreamStatus.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from activityStreamStatusAsString()
.
ActivityStreamStatus
public final String activityStreamStatusAsString()
The status of the database activity stream.
If the service returns an enum value that is not available in the current SDK version,
activityStreamStatus
will return ActivityStreamStatus.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from activityStreamStatusAsString()
.
ActivityStreamStatus
public final 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.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
public final String activityStreamKinesisStreamName()
The name of the Amazon Kinesis data stream used for the database activity stream.
public final Boolean copyTagsToSnapshot()
Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
public final Boolean crossAccountClone()
Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
public final boolean hasDomainMemberships()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<DomainMembership> domainMemberships()
The Active Directory Domain membership records associated with the DB cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasDomainMemberships()
method.
public final boolean hasTagList()
isEmpty()
method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<Tag> tagList()
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTagList()
method.
public final WriteForwardingStatus globalWriteForwardingStatus()
The status of write forwarding for a secondary cluster in an Aurora global database.
If the service returns an enum value that is not available in the current SDK version,
globalWriteForwardingStatus
will return WriteForwardingStatus.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from globalWriteForwardingStatusAsString()
.
WriteForwardingStatus
public final String globalWriteForwardingStatusAsString()
The status of write forwarding for a secondary cluster in an Aurora global database.
If the service returns an enum value that is not available in the current SDK version,
globalWriteForwardingStatus
will return WriteForwardingStatus.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from globalWriteForwardingStatusAsString()
.
WriteForwardingStatus
public final Boolean globalWriteForwardingRequested()
Specifies 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 final 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.
public final 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.
This setting is only for non-Aurora Multi-AZ DB clusters.
public final String storageType()
The storage type associated with the DB cluster.
public final Integer iops()
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 final Boolean publiclyAccessible()
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. 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, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. 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 final Boolean autoMinorVersionUpgrade()
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 final 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.
This setting is only for non-Aurora Multi-AZ DB clusters.
public final 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.
This setting is only for non-Aurora Multi-AZ DB clusters.
public final Boolean performanceInsightsEnabled()
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 final 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.
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 final 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
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 final ServerlessV2ScalingConfigurationInfo serverlessV2ScalingConfiguration()
public final 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
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 final String dbSystemId()
Reserved for future use.
public final 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.
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 final Instant 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.
aurora-iopt1
storage type.
This setting is only for Aurora DB clusters.
public final LocalWriteForwardingStatus localWriteForwardingStatus()
Specifies whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
If the service returns an enum value that is not available in the current SDK version,
localWriteForwardingStatus
will return LocalWriteForwardingStatus.UNKNOWN_TO_SDK_VERSION
. The
raw value returned by the service is available from localWriteForwardingStatusAsString()
.
LocalWriteForwardingStatus
public final String localWriteForwardingStatusAsString()
Specifies whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
If the service returns an enum value that is not available in the current SDK version,
localWriteForwardingStatus
will return LocalWriteForwardingStatus.UNKNOWN_TO_SDK_VERSION
. The
raw value returned by the service is available from localWriteForwardingStatusAsString()
.
LocalWriteForwardingStatus
public DBCluster.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<DBCluster.Builder,DBCluster>
public static DBCluster.Builder builder()
public static Class<? extends DBCluster.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2023. All rights reserved.