Package software.amazon.awssdk.services.rds.model

Class DBCluster

  • All Implemented Interfaces:
    Serializable, SdkPojo, ToCopyableBuilder<DBCluster.Builder,​DBCluster>
    @Generated("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.

    See Also:
    Serialized Form

    • Method Detail

      • allocatedStorage

        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.

        Returns:
        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.

      • hasAvailabilityZones

        public final boolean hasAvailabilityZones()
        For responses, this returns true if the service returned a value for the AvailabilityZones property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

      • availabilityZones

        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.

        Returns:
        The list of Availability Zones (AZs) where instances in the DB cluster can be created.

      • backupRetentionPeriod

        public final Integer backupRetentionPeriod()

        The number of days for which automatic DB snapshots are retained.

        Returns:
        The number of days for which automatic DB snapshots are retained.

      • characterSetName

        public final String characterSetName()

        If present, specifies the name of the character set that this cluster is associated with.

        Returns:
        If present, specifies the name of the character set that this cluster is associated with.

      • databaseName

        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.

        Returns:
        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.

      • dbClusterIdentifier

        public final String dbClusterIdentifier()

        The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.

        Returns:
        The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.

      • dbClusterParameterGroup

        public final String dbClusterParameterGroup()

        The name of the DB cluster parameter group for the DB cluster.

        Returns:
        The name of the DB cluster parameter group for the DB cluster.

      • dbSubnetGroup

        public final String dbSubnetGroup()

        Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

        Returns:
        Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

      • status

        public final String status()

        The current state of this DB cluster.

        Returns:
        The current state of this DB cluster.

      • automaticRestartTime

        public final Instant automaticRestartTime()

        The time when a stopped DB cluster is restarted automatically.

        Returns:
        The time when a stopped DB cluster is restarted automatically.

      • percentProgress

        public final String percentProgress()

        The progress of the operation as a percentage.

        Returns:
        The progress of the operation as a percentage.

      • earliestRestorableTime

        public final Instant earliestRestorableTime()

        The earliest time to which a database can be restored with point-in-time restore.

        Returns:
        The earliest time to which a database can be restored with point-in-time restore.

      • endpoint

        public final String endpoint()

        The connection endpoint for the primary instance of the DB cluster.

        Returns:
        The connection endpoint for the primary instance of the DB cluster.

      • readerEndpoint

        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.

        Returns:
        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.

      • hasCustomEndpoints

        public final boolean hasCustomEndpoints()
        For responses, this returns true if the service returned a value for the CustomEndpoints property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

      • customEndpoints

        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.

        Returns:
        The custom endpoints associated with the DB cluster.

      • multiAZ

        public final Boolean multiAZ()

        Indicates whether the DB cluster has instances in multiple Availability Zones.

        Returns:
        Indicates whether the DB cluster has instances in multiple Availability Zones.

      • engine

        public final String engine()

        The database engine used for this DB cluster.

        Returns:
        The database engine used for this DB cluster.

      • engineVersion

        public final String engineVersion()

        The version of the database engine.

        Returns:
        The version of the database engine.

      • latestRestorableTime

        public final Instant latestRestorableTime()

        The latest time to which a database can be restored with point-in-time restore.

        Returns:
        The latest time to which a database can be restored with point-in-time restore.

      • port

        public final Integer port()

        The port that the database engine is listening on.

        Returns:
        The port that the database engine is listening on.

      • masterUsername

        public final String masterUsername()

        The master username for the DB cluster.

        Returns:
        The master username for the DB cluster.

      • hasDbClusterOptionGroupMemberships

        public final boolean hasDbClusterOptionGroupMemberships()
        For responses, this returns true if the service returned a value for the DBClusterOptionGroupMemberships property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

      • dbClusterOptionGroupMemberships

        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.

        Returns:
        The list of option group memberships for this DB cluster.

      • preferredBackupWindow

        public final String preferredBackupWindow()

        The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        Returns:
        The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

      • preferredMaintenanceWindow

        public final String preferredMaintenanceWindow()

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

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

      • replicationSourceIdentifier

        public final String replicationSourceIdentifier()

        The identifier of the source DB cluster if this DB cluster is a read replica.

        Returns:
        The identifier of the source DB cluster if this DB cluster is a read replica.

      • hasReadReplicaIdentifiers

        public final boolean hasReadReplicaIdentifiers()
        For responses, this returns true if the service returned a value for the ReadReplicaIdentifiers property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

      • readReplicaIdentifiers

        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.

        Returns:
        Contains one or more identifiers of the read replicas associated with this DB cluster.

      • hasStatusInfos

        public final boolean hasStatusInfos()
        For responses, this returns true if the service returned a value for the StatusInfos property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

      • statusInfos

        public final List<DBClusterStatusInfo> statusInfos()

        Reserved for future use.

        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 hasStatusInfos() method.

        Returns:
        Reserved for future use.

      • hasDbClusterMembers

        public final boolean hasDbClusterMembers()
        For responses, this returns true if the service returned a value for the DBClusterMembers property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

      • dbClusterMembers

        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.

        Returns:
        The list of DB instances that make up the DB cluster.

      • hasVpcSecurityGroups

        public final boolean hasVpcSecurityGroups()
        For responses, this returns true if the service returned a value for the VpcSecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

      • vpcSecurityGroups

        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.

        Returns:
        The list of VPC security groups that the DB cluster belongs to.

      • hostedZoneId

        public final String hostedZoneId()

        The ID that Amazon Route 53 assigns when you create a hosted zone.

        Returns:
        The ID that Amazon Route 53 assigns when you create a hosted zone.

      • storageEncrypted

        public final Boolean storageEncrypted()

        Indicates whether the DB cluster is encrypted.

        Returns:
        Indicates whether the DB cluster is encrypted.

      • kmsKeyId

        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.

        Returns:
        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.

      • dbClusterResourceId

        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.

        Returns:
        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.

      • dbClusterArn

        public final String dbClusterArn()

        The Amazon Resource Name (ARN) for the DB cluster.

        Returns:
        The Amazon Resource Name (ARN) for the DB cluster.

      • hasAssociatedRoles

        public final boolean hasAssociatedRoles()
        For responses, this returns true if the service returned a value for the AssociatedRoles property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

      • associatedRoles

        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.

        Returns:
        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.

      • iamDatabaseAuthenticationEnabled

        public final Boolean iamDatabaseAuthenticationEnabled()

        Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

        Returns:
        Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

      • cloneGroupId

        public final String cloneGroupId()

        The ID of the clone group with which the DB cluster is associated.

        Returns:
        The ID of the clone group with which the DB cluster is associated.

      • clusterCreateTime

        public final Instant clusterCreateTime()

        The time when the DB cluster was created, in Universal Coordinated Time (UTC).

        Returns:
        The time when the DB cluster was created, in Universal Coordinated Time (UTC).

      • earliestBacktrackTime

        public final Instant earliestBacktrackTime()

        The earliest time to which a DB cluster can be backtracked.

        Returns:
        The earliest time to which a DB cluster can be backtracked.

      • backtrackWindow

        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.

        Returns:
        The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.

      • backtrackConsumedChangeRecords

        public final Long backtrackConsumedChangeRecords()

        The number of change records stored for Backtrack.

        Returns:
        The number of change records stored for Backtrack.

      • hasEnabledCloudwatchLogsExports

        public final boolean hasEnabledCloudwatchLogsExports()
        For responses, this returns true if the service returned a value for the EnabledCloudwatchLogsExports property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

      • enabledCloudwatchLogsExports

        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.

        Returns:
        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.

      • capacity

        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.

        Returns:
        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.

      • engineMode

        public final String engineMode()

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

        For more information, see CreateDBCluster.

        Returns:
        The DB engine mode of the DB cluster, either provisioned or serverless.

        For more information, see CreateDBCluster.

      • scalingConfigurationInfo

        public final ScalingConfigurationInfo scalingConfigurationInfo()
        Returns the value of the ScalingConfigurationInfo property for this object.
        Returns:
        The value of the ScalingConfigurationInfo property for this object.

      • rdsCustomClusterConfiguration

        public final RdsCustomClusterConfiguration rdsCustomClusterConfiguration()

        Reserved for future use.

        Returns:
        Reserved for future use.

      • deletionProtection

        public final Boolean deletionProtection()

        Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

        Returns:
        Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

      • httpEndpointEnabled

        public final Boolean httpEndpointEnabled()

        Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.

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

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

        Returns:
        Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.

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

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

      • activityStreamMode

        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().

        Returns:
        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.
        See Also:
        ActivityStreamMode

      • activityStreamModeAsString

        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().

        Returns:
        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.
        See Also:
        ActivityStreamMode

      • activityStreamKmsKeyId

        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.

        Returns:
        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.

      • activityStreamKinesisStreamName

        public final String activityStreamKinesisStreamName()

        The name of the Amazon Kinesis data stream used for the database activity stream.

        Returns:
        The name of the Amazon Kinesis data stream used for the database activity stream.

      • copyTagsToSnapshot

        public final Boolean copyTagsToSnapshot()

        Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.

        Returns:
        Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.

      • crossAccountClone

        public final Boolean crossAccountClone()

        Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

        Returns:
        Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

      • hasDomainMemberships

        public final boolean hasDomainMemberships()
        For responses, this returns true if the service returned a value for the DomainMemberships property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

      • domainMemberships

        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.

        Returns:
        The Active Directory Domain membership records associated with the DB cluster.

      • hasTagList

        public final boolean hasTagList()
        For responses, this returns true if the service returned a value for the TagList property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

      • tagList

        public final List<Tag> tagList()
        Returns the value of the TagList property for this object.

        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.

        Returns:
        The value of the TagList property for this object.

      • globalWriteForwardingStatusAsString

        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().

        Returns:
        The status of write forwarding for a secondary cluster in an Aurora global database.
        See Also:
        WriteForwardingStatus

      • globalWriteForwardingRequested

        public final Boolean globalWriteForwardingRequested()

        Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.

        Returns:
        Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.

      • pendingModifiedValues

        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.

        Returns:
        Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.

      • dbClusterInstanceClass

        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.

        Returns:
        The name of the compute and memory capacity class of the DB instance.

        This setting is only for non-Aurora Multi-AZ DB clusters.

      • storageType

        public final String storageType()

        The storage type associated with the DB cluster.

        Returns:
        The storage type associated with the DB cluster.

      • iops

        public final Integer iops()

        The Provisioned IOPS (I/O operations per second) value.

        This setting is only for non-Aurora Multi-AZ DB clusters.

        Returns:
        The Provisioned IOPS (I/O operations per second) value.

        This setting is only for non-Aurora Multi-AZ DB clusters.

      • publiclyAccessible

        public final Boolean publiclyAccessible()

        Indicates whether the DB cluster is publicly accessible.

        When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

        When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

        For more information, see CreateDBCluster.

        This setting is only for non-Aurora Multi-AZ DB clusters.

        Returns:
        Indicates whether the DB cluster is publicly accessible.

        When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

        When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

        For more information, see CreateDBCluster.

        This setting is only for non-Aurora Multi-AZ DB clusters.

      • autoMinorVersionUpgrade

        public final Boolean autoMinorVersionUpgrade()

        Indicates whether minor version patches are applied automatically.

        This setting is only for non-Aurora Multi-AZ DB clusters.

        Returns:
        Indicates whether minor version patches are applied automatically.

        This setting is only for non-Aurora Multi-AZ DB clusters.

      • monitoringInterval

        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.

        Returns:
        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.

      • monitoringRoleArn

        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.

        Returns:
        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.

      • performanceInsightsEnabled

        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.

        Returns:
        Indicates whether Performance Insights is enabled for the DB cluster.

        This setting is only for non-Aurora Multi-AZ DB clusters.

      • performanceInsightsKMSKeyId

        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.

        Returns:
        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.

      • performanceInsightsRetentionPeriod

        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

        Returns:
        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

      • serverlessV2ScalingConfiguration

        public final ServerlessV2ScalingConfigurationInfo serverlessV2ScalingConfiguration()
        Returns the value of the ServerlessV2ScalingConfiguration property for this object.
        Returns:
        The value of the ServerlessV2ScalingConfiguration property for this object.

      • networkType

        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

        Returns:
        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

      • dbSystemId

        public final String dbSystemId()

        Reserved for future use.

        Returns:
        Reserved for future use.

      • ioOptimizedNextAllowedModificationTime

        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.

        Returns:
        The next time you can modify the DB cluster to use the aurora-iopt1 storage type.

        This setting is only for Aurora DB clusters.

      • localWriteForwardingStatus

        public final LocalWriteForwardingStatus localWriteForwardingStatus()

        Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.

        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().

        Returns:
        Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
        See Also:
        LocalWriteForwardingStatus

      • localWriteForwardingStatusAsString

        public final String localWriteForwardingStatusAsString()

        Indicates 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().

        Returns:
        Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
        See Also:
        LocalWriteForwardingStatus

      • awsBackupRecoveryPointArn

        public final String awsBackupRecoveryPointArn()

        The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

        Returns:
        The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

      • limitlessDatabase

        public final LimitlessDatabase limitlessDatabase()

        The details for Aurora Limitless Database.

        Returns:
        The details for Aurora Limitless Database.

      • storageThroughput

        public final Integer storageThroughput()

        The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

        This setting is only for non-Aurora Multi-AZ DB clusters.

        Returns:
        The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

        This setting is only for non-Aurora Multi-AZ DB clusters.

      • clusterScalabilityType

        public final ClusterScalabilityType clusterScalabilityType()

        The scalability mode of the Aurora DB cluster. When set to limitless, the cluster operates as an Aurora Limitless Database. When set to standard (the default), the cluster uses normal DB instance creation.

        If the service returns an enum value that is not available in the current SDK version, clusterScalabilityType will return ClusterScalabilityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from clusterScalabilityTypeAsString().

        Returns:
        The scalability mode of the Aurora DB cluster. When set to limitless, the cluster operates as an Aurora Limitless Database. When set to standard (the default), the cluster uses normal DB instance creation.
        See Also:
        ClusterScalabilityType

      • clusterScalabilityTypeAsString

        public final String clusterScalabilityTypeAsString()

        The scalability mode of the Aurora DB cluster. When set to limitless, the cluster operates as an Aurora Limitless Database. When set to standard (the default), the cluster uses normal DB instance creation.

        If the service returns an enum value that is not available in the current SDK version, clusterScalabilityType will return ClusterScalabilityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from clusterScalabilityTypeAsString().

        Returns:
        The scalability mode of the Aurora DB cluster. When set to limitless, the cluster operates as an Aurora Limitless Database. When set to standard (the default), the cluster uses normal DB instance creation.
        See Also:
        ClusterScalabilityType

      • certificateDetails

        public final CertificateDetails certificateDetails()
        Returns the value of the CertificateDetails property for this object.
        Returns:
        The value of the CertificateDetails property for this object.

      • engineLifecycleSupport

        public final String engineLifecycleSupport()

        The life cycle type for the DB cluster.

        For more information, see CreateDBCluster.

        Returns:
        The life cycle type for the DB cluster.

        For more information, see CreateDBCluster.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)