Class AwsRdsDbClusterDetails
- java.lang.Object
-
- software.amazon.awssdk.services.securityhub.model.AwsRdsDbClusterDetails
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<AwsRdsDbClusterDetails.Builder,AwsRdsDbClusterDetails>
@Generated("software.amazon.awssdk:codegen") public final class AwsRdsDbClusterDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AwsRdsDbClusterDetails.Builder,AwsRdsDbClusterDetails>
Information about an Amazon RDS DB cluster.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceAwsRdsDbClusterDetails.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringactivityStreamStatus()The status of the database activity stream.IntegerallocatedStorage()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.BooleanautoMinorVersionUpgrade()Indicates if minor version upgrades are automatically applied to the cluster.List<String>availabilityZones()A list of Availability Zones (AZs) where instances in the DB cluster can be created.IntegerbackupRetentionPeriod()The number of days for which automated backups are retained.static AwsRdsDbClusterDetails.Builderbuilder()StringclusterCreateTime()Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).BooleancopyTagsToSnapshot()Whether tags are copied from the DB cluster to snapshots of the DB cluster.BooleancrossAccountClone()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.StringdatabaseName()The name of the database.StringdbClusterIdentifier()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.StringdbClusterParameterGroup()The name of the DB cluster parameter group for the DB cluster.StringdbClusterResourceId()The identifier of the DB cluster.StringdbSubnetGroup()The subnet group that is associated with the DB cluster, including the name, description, and subnets in the subnet group.BooleandeletionProtection()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.Stringendpoint()The connection endpoint for the primary instance of the DB cluster.Stringengine()The name of the database engine to use for this DB cluster.StringengineMode()The database engine mode of the DB cluster.Valid values are as follows:StringengineVersion()The version number of the database engine to use.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAssociatedRoles()For responses, this returns true if the service returned a value for the AssociatedRoles property.booleanhasAvailabilityZones()For responses, this returns true if the service returned a value for the AvailabilityZones property.booleanhasCustomEndpoints()For responses, this returns true if the service returned a value for the CustomEndpoints property.booleanhasDbClusterMembers()For responses, this returns true if the service returned a value for the DbClusterMembers property.booleanhasDbClusterOptionGroupMemberships()For responses, this returns true if the service returned a value for the DbClusterOptionGroupMemberships property.booleanhasDomainMemberships()For responses, this returns true if the service returned a value for the DomainMemberships property.booleanhasEnabledCloudWatchLogsExports()For responses, this returns true if the service returned a value for the EnabledCloudWatchLogsExports property.inthashCode()booleanhasReadReplicaIdentifiers()For responses, this returns true if the service returned a value for the ReadReplicaIdentifiers property.booleanhasVpcSecurityGroups()For responses, this returns true if the service returned a value for the VpcSecurityGroups property.StringhostedZoneId()Specifies the identifier that Amazon Route 53 assigns when you create a hosted zone.BooleanhttpEndpointEnabled()Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.BooleaniamDatabaseAuthenticationEnabled()Whether the mapping of IAM accounts to database accounts is enabled.StringkmsKeyId()The ARN of the KMS master key that is used to encrypt the database instances in the DB cluster.StringmasterUsername()The name of the master user for the DB cluster.BooleanmultiAz()Whether the DB cluster has instances in multiple Availability Zones.Integerport()The port number on which the DB instances in the DB cluster accept connections.StringpreferredBackupWindow()The range of time each day when automated backups are created, if automated backups are enabled.StringpreferredMaintenanceWindow()The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).StringreaderEndpoint()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()Stringstatus()The current status of this DB cluster.BooleanstorageEncrypted()Whether the DB cluster is encrypted.AwsRdsDbClusterDetails.BuildertoBuilder()StringtoString()Returns a string representation of this object.List<AwsRdsDbInstanceVpcSecurityGroup>vpcSecurityGroups()A list of VPC security groups that the DB cluster belongs to.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
allocatedStorage
public final Integer allocatedStorage()
For all database engines except Aurora, specifies the allocated storage size in gibibytes (GiB).
- Returns:
- For all database engines except Aurora, specifies the allocated storage size in gibibytes (GiB).
-
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 theisEmpty()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()
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.- Returns:
- A 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 automated backups are retained.
- Returns:
- The number of days for which automated backups are retained.
-
databaseName
public final String databaseName()
The name of the database.
- Returns:
- The name of the database.
-
status
public final String status()
The current status of this DB cluster.
- Returns:
- The current status of this DB cluster.
-
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.
- Returns:
- The reader endpoint for the DB cluster.
-
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 theisEmpty()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()
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.- Returns:
- A list of custom endpoints for the DB cluster.
-
multiAz
public final Boolean multiAz()
Whether the DB cluster has instances in multiple Availability Zones.
- Returns:
- Whether the DB cluster has instances in multiple Availability Zones.
-
engine
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
- Returns:
- The name of the database engine to use for this DB cluster. Valid values are as follows:
-
aurora -
aurora-mysql -
aurora-postgresql
-
-
-
engineVersion
public final String engineVersion()
The version number of the database engine to use.
- Returns:
- The version number of the database engine to use.
-
port
public final Integer port()
The port number on which the DB instances in the DB cluster accept connections.
- Returns:
- The port number on which the DB instances in the DB cluster accept connections.
-
masterUsername
public final String masterUsername()
The name of the master user for the DB cluster.
- Returns:
- The name of the master user for the DB cluster.
-
preferredBackupWindow
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.- Returns:
- 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.
-
preferredMaintenanceWindow
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.- Returns:
- 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.
-
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 theisEmpty()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()
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.- Returns:
- The identifiers of the read replicas that are associated with this 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 theisEmpty()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<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.- Returns:
- A list of VPC security groups that the DB cluster belongs to.
-
hostedZoneId
public final String hostedZoneId()
Specifies the identifier that Amazon Route 53 assigns when you create a hosted zone.
- Returns:
- Specifies the identifier that Amazon Route 53 assigns when you create a hosted zone.
-
storageEncrypted
public final Boolean storageEncrypted()
Whether the DB cluster is encrypted.
- Returns:
- Whether the DB cluster is encrypted.
-
kmsKeyId
public final String kmsKeyId()
The ARN of the KMS master key that is used to encrypt the database instances in the DB cluster.
- Returns:
- The ARN of the KMS master key that is used to encrypt the database instances in the DB cluster.
-
dbClusterResourceId
public final String dbClusterResourceId()
The identifier of the DB cluster. The identifier must be unique within each Amazon Web Services Region and is immutable.
- Returns:
- The identifier of the DB cluster. The identifier must be unique within each Amazon Web Services Region and is immutable.
-
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 theisEmpty()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<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.- Returns:
- A list of the IAM roles that are associated with the DB cluster.
-
clusterCreateTime
public final String clusterCreateTime()
Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).
This field accepts only the specified formats. Timestamps can end with
Zor("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:-
YYYY-MM-DDTHH:MM:SSZ(for example,2019-01-31T23:00:00Z) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ(for example,2019-01-31T23:00:00.123456789Z) -
YYYY-MM-DDTHH:MM:SS+HH:MM(for example,2024-01-04T15:25:10+17:59) -
YYYY-MM-DDTHH:MM:SS-HHMM(for example,2024-01-04T15:25:10-1759) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM(for example,2024-01-04T15:25:10.123456789+17:59)
- Returns:
- Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).
This field accepts only the specified formats. Timestamps can end with
Zor("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:-
YYYY-MM-DDTHH:MM:SSZ(for example,2019-01-31T23:00:00Z) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ(for example,2019-01-31T23:00:00.123456789Z) -
YYYY-MM-DDTHH:MM:SS+HH:MM(for example,2024-01-04T15:25:10+17:59) -
YYYY-MM-DDTHH:MM:SS-HHMM(for example,2024-01-04T15:25:10-1759) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM(for example,2024-01-04T15:25:10.123456789+17:59)
-
-
-
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 theisEmpty()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.
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.
-
engineMode
public final String engineMode()
The database engine mode of the DB cluster.Valid values are as follows:
-
global -
multimaster -
parallelquery -
provisioned -
serverless
- Returns:
- The database engine mode of the DB cluster.Valid values are as follows:
-
global -
multimaster -
parallelquery -
provisioned -
serverless
-
-
-
deletionProtection
public final Boolean deletionProtection()
Whether the DB cluster has deletion protection enabled.
- Returns:
- Whether the DB cluster has deletion protection enabled.
-
httpEndpointEnabled
public final Boolean httpEndpointEnabled()
Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
- Returns:
- Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
-
activityStreamStatus
public final String activityStreamStatus()
The status of the database activity stream. Valid values are as follows:
-
started -
starting -
stopped -
stopping
- Returns:
- The status of the database activity stream. Valid values are as follows:
-
started -
starting -
stopped -
stopping
-
-
-
copyTagsToSnapshot
public final Boolean copyTagsToSnapshot()
Whether tags are copied from the DB cluster to snapshots of the DB cluster.
- Returns:
- Whether tags are copied from the DB cluster to snapshots of the DB cluster.
-
crossAccountClone
public final Boolean crossAccountClone()
Whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
- Returns:
- 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 theisEmpty()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<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.- Returns:
- The Active Directory domain membership records that are associated with the 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()
The subnet group that is associated with the DB cluster, including the name, description, and subnets in the subnet group.
- Returns:
- The subnet group that is associated with the DB cluster, including the name, description, and subnets in the subnet group.
-
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 theisEmpty()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<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.- Returns:
- The list of option group memberships for this DB cluster.
-
dbClusterIdentifier
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.
- Returns:
- The DB cluster identifier that the user assigned to the cluster. This identifier is the unique key that identifies a DB cluster.
-
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 theisEmpty()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<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.- Returns:
- The list of instances that make up the DB cluster.
-
iamDatabaseAuthenticationEnabled
public final Boolean iamDatabaseAuthenticationEnabled()
Whether the mapping of IAM accounts to database accounts is enabled.
- Returns:
- Whether the mapping of IAM accounts to database accounts is enabled.
-
autoMinorVersionUpgrade
public final Boolean autoMinorVersionUpgrade()
Indicates if minor version upgrades are automatically applied to the cluster.
- Returns:
- Indicates if minor version upgrades are automatically applied to the cluster.
-
toBuilder
public AwsRdsDbClusterDetails.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<AwsRdsDbClusterDetails.Builder,AwsRdsDbClusterDetails>
-
builder
public static AwsRdsDbClusterDetails.Builder builder()
-
serializableBuilderClass
public static Class<? extends AwsRdsDbClusterDetails.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-