AwsRdsDbInstanceDetails
¶
Source code in docs_src/capo_securityhub/types/aws_rds_db_instance_details.py
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 | |
allocated_storage
instance-attribute
¶
allocated_storage: NotRequired[Integer]
The amount of storage (in gigabytes) to initially allocate for the DB instance.
associated_roles
instance-attribute
¶
associated_roles: NotRequired[AwsRdsDbInstanceAssociatedRoles]
The IAM roles associated with the DB instance.
auto_minor_version_upgrade
instance-attribute
¶
auto_minor_version_upgrade: NotRequired[Boolean]
Indicates whether minor version patches are applied automatically.
availability_zone
instance-attribute
¶
availability_zone: NotRequired[NonEmptyString]
The Availability Zone where the DB instance will be created.
backup_retention_period
instance-attribute
¶
backup_retention_period: NotRequired[Integer]
The number of days for which to retain automated backups.
ca_certificate_identifier
instance-attribute
¶
ca_certificate_identifier: NotRequired[NonEmptyString]
The identifier of the CA certificate for this DB instance.
character_set_name
instance-attribute
¶
character_set_name: NotRequired[NonEmptyString]
The name of the character set that this DB instance is associated with.
copy_tags_to_snapshot
instance-attribute
¶
copy_tags_to_snapshot: NotRequired[Boolean]
Whether to copy resource tags to snapshots of the DB instance.
db_cluster_identifier
instance-attribute
¶
db_cluster_identifier: NotRequired[NonEmptyString]
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.
db_instance_class
instance-attribute
¶
db_instance_class: NotRequired[NonEmptyString]
Contains the name of the compute and memory capacity class of the DB instance.
db_instance_identifier
instance-attribute
¶
db_instance_identifier: NotRequired[NonEmptyString]
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
db_instance_port
instance-attribute
¶
db_instance_port: NotRequired[Integer]
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.
db_instance_status
instance-attribute
¶
db_instance_status: NotRequired[NonEmptyString]
The current status of the DB instance.
db_name
instance-attribute
¶
db_name: NotRequired[NonEmptyString]
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.
db_parameter_groups
instance-attribute
¶
db_parameter_groups: NotRequired[AwsRdsDbParameterGroups]
A list of the DB parameter groups to assign to the DB instance.
db_security_groups
instance-attribute
¶
db_security_groups: NotRequired[StringList]
A list of the DB security groups to assign to the DB instance.
db_subnet_group
instance-attribute
¶
db_subnet_group: NotRequired[AwsRdsDbSubnetGroup]
Information about the subnet group that is associated with the DB instance.
dbi_resource_id
instance-attribute
¶
dbi_resource_id: NotRequired[NonEmptyString]
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.
deletion_protection
instance-attribute
¶
deletion_protection: NotRequired[Boolean]
Indicates whether the DB instance has deletion protection enabled.
When deletion protection is enabled, the database cannot be deleted.
domain_memberships
instance-attribute
¶
domain_memberships: NotRequired[AwsRdsDbDomainMemberships]
The Active Directory domain membership records associated with the DB instance.
enabled_cloud_watch_logs_exports
instance-attribute
¶
enabled_cloud_watch_logs_exports: NotRequired[StringList]
A list of log types that this DB instance is configured to export to CloudWatch Logs.
endpoint
instance-attribute
¶
endpoint: NotRequired[AwsRdsDbInstanceEndpoint]
Specifies the connection endpoint.
engine
instance-attribute
¶
engine: NotRequired[NonEmptyString]
Provides the name of the database engine to use for this DB instance.
engine_version
instance-attribute
¶
engine_version: NotRequired[NonEmptyString]
Indicates the database engine version.
enhanced_monitoring_resource_arn
instance-attribute
¶
enhanced_monitoring_resource_arn: NotRequired[NonEmptyString]
The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics data for the DB instance.
iam_database_authentication_enabled
instance-attribute
¶
iam_database_authentication_enabled: NotRequired[Boolean]
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
instance_create_time
instance-attribute
¶
instance_create_time: NotRequired[NonEmptyString]
Indicates when the DB instance was created.
For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.
iops
instance-attribute
¶
iops: NotRequired[Integer]
Specifies the provisioned IOPS (I/O operations per second) for this DB instance.
kms_key_id
instance-attribute
¶
kms_key_id: NotRequired[NonEmptyString]
If StorageEncrypted is true, the KMS key identifier for the encrypted DB instance.
latest_restorable_time
instance-attribute
¶
latest_restorable_time: NotRequired[NonEmptyString]
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 CSPM, see Timestamps.
license_model
instance-attribute
¶
license_model: NotRequired[NonEmptyString]
License model information for this DB instance.
master_username
instance-attribute
¶
master_username: NotRequired[NonEmptyString]
The master user name of the DB instance.
max_allocated_storage
instance-attribute
¶
max_allocated_storage: NotRequired[Integer]
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
monitoring_interval
instance-attribute
¶
monitoring_interval: NotRequired[Integer]
The interval, in seconds, between points when enhanced monitoring metrics are collected for the DB instance.
monitoring_role_arn
instance-attribute
¶
monitoring_role_arn: NotRequired[NonEmptyString]
The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring metrics to CloudWatch Logs.
multi_az
instance-attribute
¶
multi_az: NotRequired[Boolean]
Whether the DB instance is a multiple Availability Zone deployment.
option_group_memberships
instance-attribute
¶
option_group_memberships: NotRequired[AwsRdsDbOptionGroupMemberships]
The list of option group memberships for this DB instance.
pending_modified_values
instance-attribute
¶
pending_modified_values: NotRequired[AwsRdsDbPendingModifiedValues]
Changes to the DB instance that are currently pending.
performance_insights_enabled
instance-attribute
¶
performance_insights_enabled: NotRequired[Boolean]
Indicates whether Performance Insights is enabled for the DB instance.
performance_insights_kms_key_id
instance-attribute
¶
performance_insights_kms_key_id: NotRequired[NonEmptyString]
The identifier of the KMS key used to encrypt the Performance Insights data.
performance_insights_retention_period
instance-attribute
¶
performance_insights_retention_period: NotRequired[Integer]
The number of days to retain Performance Insights data.
preferred_backup_window
instance-attribute
¶
preferred_backup_window: NotRequired[NonEmptyString]
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.
preferred_maintenance_window
instance-attribute
¶
preferred_maintenance_window: NotRequired[NonEmptyString]
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Uses the format .
For the day values, use mon|tue|wed|thu|fri|sat|sun.
For example, sun:09:32-sun:10:02.
processor_features
instance-attribute
¶
processor_features: NotRequired[AwsRdsDbProcessorFeatures]
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
promotion_tier
instance-attribute
¶
promotion_tier: NotRequired[Integer]
The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.
publicly_accessible
instance-attribute
¶
publicly_accessible: NotRequired[Boolean]
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.
read_replica_db_cluster_identifiers
instance-attribute
¶
read_replica_db_cluster_identifiers: NotRequired[StringList]
List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.
read_replica_db_instance_identifiers
instance-attribute
¶
read_replica_db_instance_identifiers: NotRequired[StringList]
List of identifiers of the read replicas associated with this DB instance.
read_replica_source_db_instance_identifier
instance-attribute
¶
read_replica_source_db_instance_identifier: NotRequired[NonEmptyString]
If this DB instance is a read replica, contains the identifier of the source DB instance.
secondary_availability_zone
instance-attribute
¶
secondary_availability_zone: NotRequired[NonEmptyString]
For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.
status_infos
instance-attribute
¶
status_infos: NotRequired[AwsRdsDbStatusInfos]
The status of a read replica. If the instance isn't a read replica, this is empty.
storage_encrypted
instance-attribute
¶
storage_encrypted: NotRequired[Boolean]
Specifies whether the DB instance is encrypted.
storage_type
instance-attribute
¶
storage_type: NotRequired[NonEmptyString]
The storage type for the DB instance.
tde_credential_arn
instance-attribute
¶
tde_credential_arn: NotRequired[NonEmptyString]
The ARN from the key store with which the instance is associated for TDE encryption.
timezone
instance-attribute
¶
timezone: NotRequired[NonEmptyString]
The time zone of the DB instance.
vpc_security_groups
instance-attribute
¶
vpc_security_groups: NotRequired[AwsRdsDbInstanceVpcSecurityGroups]
A list of VPC security groups that the DB instance belongs to.