Package software.amazon.awssdk.services.securityhub.model

Class AwsRdsDbInstanceDetails

    • Method Detail

      • 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<AwsRdsDbInstanceAssociatedRole> associatedRoles()

        The IAM roles associated with the DB instance.

        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:
        The IAM roles associated with the DB instance.

      • caCertificateIdentifier

        public final String caCertificateIdentifier()

        The identifier of the CA certificate for this DB instance.

        Returns:
        The identifier of the CA certificate for this DB instance.

      • dbClusterIdentifier

        public final String dbClusterIdentifier()

        If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

        Returns:
        If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

      • dbInstanceIdentifier

        public final String dbInstanceIdentifier()

        Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

        Returns:
        Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

      • dbInstanceClass

        public final String dbInstanceClass()

        Contains the name of the compute and memory capacity class of the DB instance.

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

      • dbInstancePort

        public final Integer dbInstancePort()

        Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

        Returns:
        Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

      • dbiResourceId

        public final String dbiResourceId()

        The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in CloudTrail log entries whenever the KMS key for the DB instance is accessed.

        Returns:
        The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in CloudTrail log entries whenever the KMS key for the DB instance is accessed.

      • dbName

        public final String dbName()

        The meaning of this parameter differs according to the database engine you use.

        MySQL, MariaDB, SQL Server, PostgreSQL

        Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

        Oracle

        Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters don't apply to an Oracle DB instance.

        Returns:
        The meaning of this parameter differs according to the database engine you use.

        MySQL, MariaDB, SQL Server, PostgreSQL

        Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

        Oracle

        Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters don't apply to an Oracle DB instance.

      • deletionProtection

        public final Boolean deletionProtection()

        Indicates whether the DB instance has deletion protection enabled.

        When deletion protection is enabled, the database cannot be deleted.

        Returns:
        Indicates whether the DB instance has deletion protection enabled.

        When deletion protection is enabled, the database cannot be deleted.

      • endpoint

        public final AwsRdsDbInstanceEndpoint endpoint()

        Specifies the connection endpoint.

        Returns:
        Specifies the connection endpoint.

      • engine

        public final String engine()

        Provides the name of the database engine to use for this DB instance.

        Returns:
        Provides the name of the database engine to use for this DB instance.

      • engineVersion

        public final String engineVersion()

        Indicates the database engine version.

        Returns:
        Indicates the database engine version.

      • iamDatabaseAuthenticationEnabled

        public final Boolean iamDatabaseAuthenticationEnabled()

        True if mapping of IAM accounts to database accounts is enabled, and otherwise false.

        IAM database authentication can be enabled for the following database engines.

        • For MySQL 5.6, minor version 5.6.34 or higher

        • For MySQL 5.7, minor version 5.7.16 or higher

        • Aurora 5.6 or higher

        Returns:
        True if mapping of IAM accounts to database accounts is enabled, and otherwise false.

        IAM database authentication can be enabled for the following database engines.

        • For MySQL 5.6, minor version 5.6.34 or higher

        • For MySQL 5.7, minor version 5.7.16 or higher

        • Aurora 5.6 or higher

      • instanceCreateTime

        public final String instanceCreateTime()

        Indicates when the DB instance was created.

        For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

        Returns:
        Indicates when the DB instance was created.

        For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

      • kmsKeyId

        public final String kmsKeyId()

        If StorageEncrypted is true, the KMS key identifier for the encrypted DB instance.

        Returns:
        If StorageEncrypted is true, the KMS key identifier for the encrypted DB instance.

      • publiclyAccessible

        public final Boolean publiclyAccessible()

        Specifies the accessibility options for the DB instance.

        A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address.

        A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

        Returns:
        Specifies the accessibility options for the DB instance.

        A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address.

        A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

      • storageEncrypted

        public final Boolean storageEncrypted()

        Specifies whether the DB instance is encrypted.

        Returns:
        Specifies whether the DB instance is encrypted.

      • tdeCredentialArn

        public final String tdeCredentialArn()

        The ARN from the key store with which the instance is associated for TDE encryption.

        Returns:
        The ARN from the key store with which the instance is associated for TDE encryption.

      • 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<AwsRdsDbInstanceVpcSecurityGroup> vpcSecurityGroups()

        A list of VPC security groups that the DB instance 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 instance belongs to.

      • multiAz

        public final Boolean multiAz()

        Whether the DB instance is a multiple Availability Zone deployment.

        Returns:
        Whether the DB instance is a multiple Availability Zone deployment.

      • enhancedMonitoringResourceArn

        public final String enhancedMonitoringResourceArn()

        The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics data for the DB instance.

        Returns:
        The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics data for the DB instance.

      • dbInstanceStatus

        public final String dbInstanceStatus()

        The current status of the DB instance.

        Returns:
        The current status of the DB instance.

      • masterUsername

        public final String masterUsername()

        The master user name of the DB instance.

        Returns:
        The master user name of the DB instance.

      • allocatedStorage

        public final Integer allocatedStorage()

        The amount of storage (in gigabytes) to initially allocate for the DB instance.

        Returns:
        The amount of storage (in gigabytes) to initially allocate for the DB instance.

      • 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.

      • backupRetentionPeriod

        public final Integer backupRetentionPeriod()

        The number of days for which to retain automated backups.

        Returns:
        The number of days for which to retain automated backups.

      • hasDbSecurityGroups

        public final boolean hasDbSecurityGroups()
        For responses, this returns true if the service returned a value for the DbSecurityGroups 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.

      • dbSecurityGroups

        public final List<String> dbSecurityGroups()

        A list of the DB security groups to assign to the DB instance.

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

        Returns:
        A list of the DB security groups to assign to the DB instance.

      • hasDbParameterGroups

        public final boolean hasDbParameterGroups()
        For responses, this returns true if the service returned a value for the DbParameterGroups 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.

      • dbParameterGroups

        public final List<AwsRdsDbParameterGroup> dbParameterGroups()

        A list of the DB parameter groups to assign to the DB instance.

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

        Returns:
        A list of the DB parameter groups to assign to the DB instance.

      • availabilityZone

        public final String availabilityZone()

        The Availability Zone where the DB instance will be created.

        Returns:
        The Availability Zone where the DB instance will be created.

      • dbSubnetGroup

        public final AwsRdsDbSubnetGroup dbSubnetGroup()

        Information about the subnet group that is associated with the DB instance.

        Returns:
        Information about the subnet group that is associated with the DB instance.

      • 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.

      • pendingModifiedValues

        public final AwsRdsDbPendingModifiedValues pendingModifiedValues()

        Changes to the DB instance that are currently pending.

        Returns:
        Changes to the DB instance that are currently pending.

      • latestRestorableTime

        public final String latestRestorableTime()

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

        For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

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

        For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

      • autoMinorVersionUpgrade

        public final Boolean autoMinorVersionUpgrade()

        Indicates whether minor version patches are applied automatically.

        Returns:
        Indicates whether minor version patches are applied automatically.

      • readReplicaSourceDBInstanceIdentifier

        public final String readReplicaSourceDBInstanceIdentifier()

        If this DB instance is a read replica, contains the identifier of the source DB instance.

        Returns:
        If this DB instance is a read replica, contains the identifier of the source DB instance.

      • hasReadReplicaDBInstanceIdentifiers

        public final boolean hasReadReplicaDBInstanceIdentifiers()
        For responses, this returns true if the service returned a value for the ReadReplicaDBInstanceIdentifiers 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.

      • readReplicaDBInstanceIdentifiers

        public final List<String> readReplicaDBInstanceIdentifiers()

        List of identifiers of the read replicas associated with this DB instance.

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

        Returns:
        List of identifiers of the read replicas associated with this DB instance.

      • hasReadReplicaDBClusterIdentifiers

        public final boolean hasReadReplicaDBClusterIdentifiers()
        For responses, this returns true if the service returned a value for the ReadReplicaDBClusterIdentifiers 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.

      • readReplicaDBClusterIdentifiers

        public final List<String> readReplicaDBClusterIdentifiers()

        List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.

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

        Returns:
        List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.

      • licenseModel

        public final String licenseModel()

        License model information for this DB instance.

        Returns:
        License model information for this DB instance.

      • iops

        public final Integer iops()

        Specifies the provisioned IOPS (I/O operations per second) for this DB instance.

        Returns:
        Specifies the provisioned IOPS (I/O operations per second) for this DB instance.

      • hasOptionGroupMemberships

        public final boolean hasOptionGroupMemberships()
        For responses, this returns true if the service returned a value for the OptionGroupMemberships 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.

      • optionGroupMemberships

        public final List<AwsRdsDbOptionGroupMembership> optionGroupMemberships()

        The list of option group memberships for this DB instance.

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

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

      • characterSetName

        public final String characterSetName()

        The name of the character set that this DB instance is associated with.

        Returns:
        The name of the character set that this DB instance is associated with.

      • secondaryAvailabilityZone

        public final String secondaryAvailabilityZone()

        For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.

        Returns:
        For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.

      • 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<AwsRdsDbStatusInfo> statusInfos()

        The status of a read replica. If the instance isn't a read replica, this is empty.

        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:
        The status of a read replica. If the instance isn't a read replica, this is empty.

      • storageType

        public final String storageType()

        The storage type for the DB instance.

        Returns:
        The storage type for the DB instance.

      • 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<AwsRdsDbDomainMembership> domainMemberships()

        The Active Directory domain membership records associated with the DB instance.

        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 instance.

      • copyTagsToSnapshot

        public final Boolean copyTagsToSnapshot()

        Whether to copy resource tags to snapshots of the DB instance.

        Returns:
        Whether to copy resource tags to snapshots of the DB instance.

      • monitoringInterval

        public final Integer monitoringInterval()

        The interval, in seconds, between points when enhanced monitoring metrics are collected for the DB instance.

        Returns:
        The interval, in seconds, between points when enhanced monitoring metrics are collected for the DB instance.

      • monitoringRoleArn

        public final String monitoringRoleArn()

        The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring metrics to CloudWatch Logs.

        Returns:
        The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring metrics to CloudWatch Logs.

      • promotionTier

        public final Integer promotionTier()

        The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.

        Returns:
        The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.

      • timezone

        public final String timezone()

        The time zone of the DB instance.

        Returns:
        The time zone of the DB instance.

      • performanceInsightsEnabled

        public final Boolean performanceInsightsEnabled()

        Indicates whether Performance Insights is enabled for the DB instance.

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

      • performanceInsightsKmsKeyId

        public final String performanceInsightsKmsKeyId()

        The identifier of the KMS key used to encrypt the Performance Insights data.

        Returns:
        The identifier of the KMS key used to encrypt the Performance Insights data.

      • performanceInsightsRetentionPeriod

        public final Integer performanceInsightsRetentionPeriod()

        The number of days to retain Performance Insights data.

        Returns:
        The number of days to retain Performance Insights data.

      • 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 instance 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 instance is configured to export to CloudWatch Logs.

      • hasProcessorFeatures

        public final boolean hasProcessorFeatures()
        For responses, this returns true if the service returned a value for the ProcessorFeatures 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.

      • processorFeatures

        public final List<AwsRdsDbProcessorFeature> processorFeatures()

        The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

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

        Returns:
        The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

      • listenerEndpoint

        public final AwsRdsDbInstanceEndpoint listenerEndpoint()
        Returns the value of the ListenerEndpoint property for this object.
        Returns:
        The value of the ListenerEndpoint property for this object.

      • maxAllocatedStorage

        public final Integer maxAllocatedStorage()

        The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

        Returns:
        The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

      • 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)