@Generated(value="software.amazon.awssdk:codegen") public final class AwsRdsDbClusterDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AwsRdsDbClusterDetails.Builder,AwsRdsDbClusterDetails>
Information about an Amazon RDS DB cluster.
| Modifier and Type | Class and Description |
|---|---|
static interface |
AwsRdsDbClusterDetails.Builder |
| Modifier and Type | Method and Description |
|---|---|
String |
activityStreamStatus()
The status of the database activity stream.
|
Integer |
allocatedStorage()
For all database engines except Aurora, specifies the allocated storage size in gibibytes (GiB).
|
List<AwsRdsDbClusterAssociatedRole> |
associatedRoles()
A list of the IAM roles that are associated with the DB cluster.
|
List<String> |
availabilityZones()
A list of Availability Zones (AZs) where instances in the DB cluster can be created.
|
Integer |
backupRetentionPeriod()
The number of days for which automated backups are retained.
|
static AwsRdsDbClusterDetails.Builder |
builder() |
String |
clusterCreateTime()
Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).
|
Boolean |
copyTagsToSnapshot()
Whether tags are copied from the DB cluster to snapshots of the DB cluster.
|
Boolean |
crossAccountClone()
Whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
|
List<String> |
customEndpoints()
A list of custom endpoints for the DB cluster.
|
String |
databaseName()
The name of the database.
|
String |
dbClusterIdentifier()
The DB cluster identifier that the user assigned to the cluster.
|
List<AwsRdsDbClusterMember> |
dbClusterMembers()
The list of instances that make up the DB cluster.
|
List<AwsRdsDbClusterOptionGroupMembership> |
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 identifier of the DB cluster.
|
String |
dbSubnetGroup()
The subnet group that is associated with the DB cluster, including the name, description, and subnets in the
subnet group.
|
Boolean |
deletionProtection()
Whether the DB cluster has deletion protection enabled.
|
List<AwsRdsDbDomainMembership> |
domainMemberships()
The Active Directory domain membership records that are associated with the DB cluster.
|
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 name of the database engine to use for this DB cluster.
|
String |
engineMode()
The database engine mode of the DB cluster.Valid values are as follows:
|
String |
engineVersion()
The version number of the database engine to use.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
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 |
hasVpcSecurityGroups()
For responses, this returns true if the service returned a value for the VpcSecurityGroups property.
|
String |
hostedZoneId()
Specifies the identifier that Amazon Route 53 assigns when you create a hosted zone.
|
Boolean |
httpEndpointEnabled()
Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
|
Boolean |
iamDatabaseAuthenticationEnabled()
Whether the mapping of IAM accounts to database accounts is enabled.
|
String |
kmsKeyId()
The ARN of the KMS master key that is used to encrypt the database instances in the DB cluster.
|
String |
masterUsername()
The name of the master user for the DB cluster.
|
Boolean |
multiAz()
Whether the DB cluster has instances in multiple Availability Zones.
|
Integer |
port()
The port number on which the DB instances in the DB cluster accept connections.
|
String |
preferredBackupWindow()
The range of time each day when automated backups are created, if automated backups are enabled.
|
String |
preferredMaintenanceWindow()
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
String |
readerEndpoint()
The reader endpoint for the DB cluster.
|
List<String> |
readReplicaIdentifiers()
The identifiers of the read replicas that are associated with this DB cluster.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends AwsRdsDbClusterDetails.Builder> |
serializableBuilderClass() |
String |
status()
The current status of this DB cluster.
|
Boolean |
storageEncrypted()
Whether the DB cluster is encrypted.
|
AwsRdsDbClusterDetails.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
List<AwsRdsDbInstanceVpcSecurityGroup> |
vpcSecurityGroups()
A list of VPC security groups that the DB cluster belongs to.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final Integer allocatedStorage()
For all database engines except Aurora, specifies the allocated storage size in gibibytes (GiB).
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()
A 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 automated backups are retained.
public final String databaseName()
The name of the database.
public final String status()
The current status of this DB cluster.
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.
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()
A list of custom endpoints for 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()
Whether the DB cluster has instances in multiple Availability Zones.
public final String engine()
The name of the database engine to use for this DB cluster. Valid values are as follows:
aurora
aurora-mysql
aurora-postgresql
aurora
aurora-mysql
aurora-postgresql
public final String engineVersion()
The version number of the database engine to use.
public final Integer port()
The port number on which the DB instances in the DB cluster accept connections.
public final String masterUsername()
The name of the master user for the DB cluster.
public final String preferredBackupWindow()
The range of time each day when automated backups are created, if automated backups are enabled.
Uses the format HH:MM-HH:MM. For example, 04:52-05:22.
Uses the format HH:MM-HH:MM. For example, 04:52-05:22.
public final String preferredMaintenanceWindow()
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Uses the format <day>:HH:MM-<day>:HH:MM.
For the day values, use mon|tue|wed|thu|fri|
sat|sun.
For example, sun:09:32-sun:10:02.
Uses the format <day>:HH:MM-<day>:HH:MM.
For the day values, use mon|tue|wed|thu|
fri|sat|sun.
For example, sun:09:32-sun:10:02.
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()
The identifiers of the read replicas that are 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 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<AwsRdsDbInstanceVpcSecurityGroup> vpcSecurityGroups()
A 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()
Specifies the identifier that Amazon Route 53 assigns when you create a hosted zone.
public final Boolean storageEncrypted()
Whether the DB cluster is encrypted.
public final String kmsKeyId()
The ARN of the KMS master key that is used to encrypt the database instances in the DB cluster.
public final String dbClusterResourceId()
The identifier of the DB cluster. The identifier must be unique within each Amazon Web Services Region and is immutable.
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<AwsRdsDbClusterAssociatedRole> associatedRoles()
A list of the IAM roles that are 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 hasAssociatedRoles() method.
public final String clusterCreateTime()
Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be
separated by T. For example, 2020-03-22T13:22:13.933Z.
Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
Format. The value cannot contain spaces, and date and time should be separated by T. For
example, 2020-03-22T13:22:13.933Z.
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.
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.
public final String engineMode()
The database engine mode of the DB cluster.Valid values are as follows:
global
multimaster
parallelquery
provisioned
serverless
global
multimaster
parallelquery
provisioned
serverless
public final Boolean deletionProtection()
Whether the DB cluster has deletion protection enabled.
public final Boolean httpEndpointEnabled()
Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
public final String activityStreamStatus()
The status of the database activity stream. Valid values are as follows:
started
starting
stopped
stopping
started
starting
stopped
stopping
public final Boolean copyTagsToSnapshot()
Whether tags are copied from the DB cluster to snapshots of the DB cluster.
public final Boolean crossAccountClone()
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<AwsRdsDbDomainMembership> domainMemberships()
The Active Directory domain membership records that are 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 String dbClusterParameterGroup()
The name of the DB cluster parameter group for the DB cluster.
public final String dbSubnetGroup()
The subnet group that is associated with the DB cluster, including the name, description, and subnets in the subnet group.
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<AwsRdsDbClusterOptionGroupMembership> 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 dbClusterIdentifier()
The DB cluster identifier that the user assigned to the cluster. This identifier is the unique key that identifies a DB cluster.
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<AwsRdsDbClusterMember> dbClusterMembers()
The list of 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 iamDatabaseAuthenticationEnabled()
Whether the mapping of IAM accounts to database accounts is enabled.
public AwsRdsDbClusterDetails.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<AwsRdsDbClusterDetails.Builder,AwsRdsDbClusterDetails>public static AwsRdsDbClusterDetails.Builder builder()
public static Class<? extends AwsRdsDbClusterDetails.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2023. All rights reserved.