aws_rds_instance

account_id

Type: STRING

activity_stream_engine_native_audit_fields_included

Type: BOOLEAN
Provider name: ActivityStreamEngineNativeAuditFieldsIncluded
Description: Indicates whether engine-native audit fields are included in the database activity stream.

activity_stream_kinesis_stream_name

Type: STRING
Provider name: ActivityStreamKinesisStreamName
Description: The name of the Amazon Kinesis data stream used for the database activity stream.

activity_stream_kms_key_id

Type: STRING
Provider name: ActivityStreamKmsKeyId
Description: 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.

activity_stream_mode

Type: STRING
Provider name: ActivityStreamMode
Description: The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.

activity_stream_policy_status

Type: STRING
Provider name: ActivityStreamPolicyStatus
Description: The status of the policy state of the activity stream.

activity_stream_status

Type: STRING
Provider name: ActivityStreamStatus
Description: The status of the database activity stream.

allocated_storage

Type: INT32
Provider name: AllocatedStorage
Description: The amount of storage in gibibytes (GiB) allocated for the DB instance.

associated_roles

Type: UNORDERED_LIST_STRUCT
Provider name: AssociatedRoles
Description: The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.

  • feature_name
    Type: STRING
    Provider name: FeatureName
    Description: The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.
  • role_arn
    Type: STRING
    Provider name: RoleArn
    Description: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
  • status
    Type: STRING
    Provider name: Status
    Description: Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
    • ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.
    • PENDING - the IAM role ARN is being associated with the DB instance.
    • INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.

auto_minor_version_upgrade

Type: BOOLEAN
Provider name: AutoMinorVersionUpgrade
Description: Indicates whether minor version patches are applied automatically.

automatic_restart_time

Type: TIMESTAMP
Provider name: AutomaticRestartTime
Description: The time when a stopped DB instance is restarted automatically.

automation_mode

Type: STRING
Provider name: AutomationMode
Description: The automation mode of the RDS Custom DB instance: full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by –resume-full-automation-mode-minutes.

availability_zone

Type: STRING
Provider name: AvailabilityZone
Description: The name of the Availability Zone where the DB instance is located.

aws_backup_recovery_point_arn

Type: STRING
Provider name: AwsBackupRecoveryPointArn
Description: The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

backup_retention_period

Type: INT32
Provider name: BackupRetentionPeriod
Description: The number of days for which automatic DB snapshots are retained.

backup_target

Type: STRING
Provider name: BackupTarget
Description: The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

ca_certificate_identifier

Type: STRING
Provider name: CACertificateIdentifier
Description: The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

certificate_details

Type: STRUCT
Provider name: CertificateDetails
Description: The details of the DB instance’s server certificate.

  • ca_identifier
    Type: STRING
    Provider name: CAIdentifier
    Description: The CA identifier of the CA certificate used for the DB instance’s server certificate.
  • valid_till
    Type: TIMESTAMP
    Provider name: ValidTill
    Description: The expiration date of the DB instance’s server certificate.

character_set_name

Type: STRING
Provider name: CharacterSetName
Description: If present, specifies the name of the character set that this instance is associated with.

copy_tags_to_snapshot

Type: BOOLEAN
Provider name: CopyTagsToSnapshot
Description: Indicates whether tags are copied from the DB instance to snapshots of the DB instance. This setting doesn’t apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.

custom_iam_instance_profile

Type: STRING
Provider name: CustomIamInstanceProfile
Description: The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

  • The profile must exist in your account.
  • The profile must have an IAM role that Amazon EC2 has permissions to assume.
  • The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

customer_owned_ip_enabled

Type: BOOLEAN
Provider name: CustomerOwnedIpEnabled
Description: Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance. A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network. For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

db_cluster_identifier

Type: STRING
Provider name: DBClusterIdentifier
Description: If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of.

db_instance_arn

Type: STRING
Provider name: DBInstanceArn
Description: The Amazon Resource Name (ARN) for the DB instance.

db_instance_automated_backups_replications

Type: UNORDERED_LIST_STRUCT
Provider name: DBInstanceAutomatedBackupsReplications
Description: The list of replicated automated backups associated with the DB instance.

  • db_instance_automated_backups_arn
    Type: STRING
    Provider name: DBInstanceAutomatedBackupsArn
    Description: The Amazon Resource Name (ARN) of the replicated automated backups.

db_instance_class

Type: STRING
Provider name: DBInstanceClass
Description: The name of the compute and memory capacity class of the DB instance.

db_instance_identifier

Type: STRING
Provider name: DBInstanceIdentifier
Description: The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

db_instance_port

Type: INT32
Provider name: DbInstancePort
Description: 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

Type: STRING
Provider name: DBInstanceStatus
Description: The current state of this database. For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.

db_name

Type: STRING
Provider name: DBName
Description: The initial database name that you provided (if required) when you created the DB instance. This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB.

db_parameter_groups

Type: UNORDERED_LIST_STRUCT
Provider name: DBParameterGroups
Description: The list of DB parameter groups applied to this DB instance.

  • db_parameter_group_name
    Type: STRING
    Provider name: DBParameterGroupName
    Description: The name of the DB parameter group.
  • parameter_apply_status
    Type: STRING
    Provider name: ParameterApplyStatus
    Description: The status of parameter updates.

db_security_groups

Type: UNORDERED_LIST_STRUCT
Provider name: DBSecurityGroups
Description: A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

  • db_security_group_name
    Type: STRING
    Provider name: DBSecurityGroupName
    Description: The name of the DB security group.
  • status
    Type: STRING
    Provider name: Status
    Description: The status of the DB security group.

db_subnet_group

Type: STRUCT
Provider name: DBSubnetGroup
Description: Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

  • db_subnet_group_arn
    Type: STRING
    Provider name: DBSubnetGroupArn
    Description: The Amazon Resource Name (ARN) for the DB subnet group.
  • db_subnet_group_description
    Type: STRING
    Provider name: DBSubnetGroupDescription
    Description: Provides the description of the DB subnet group.
  • db_subnet_group_name
    Type: STRING
    Provider name: DBSubnetGroupName
    Description: The name of the DB subnet group.
  • subnet_group_status
    Type: STRING
    Provider name: SubnetGroupStatus
    Description: Provides the status of the DB subnet group.
  • subnets
    Type: UNORDERED_LIST_STRUCT
    Provider name: Subnets
    Description: Contains a list of Subnet elements.
    • subnet_availability_zone
      Type: STRUCT
      Provider name: SubnetAvailabilityZone
      • name
        Type: STRING
        Provider name: Name
        Description: The name of the Availability Zone.
    • subnet_identifier
      Type: STRING
      Provider name: SubnetIdentifier
      Description: The identifier of the subnet.
    • subnet_outpost
      Type: STRUCT
      Provider name: SubnetOutpost
      Description: If the subnet is associated with an Outpost, this value specifies the Outpost. For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
      • arn
        Type: STRING
        Provider name: Arn
        Description: The Amazon Resource Name (ARN) of the Outpost.
    • subnet_status
      Type: STRING
      Provider name: SubnetStatus
      Description: The status of the subnet.
  • supported_network_types
    Type: UNORDERED_LIST_STRING
    Provider name: SupportedNetworkTypes
    Description: The network type of the DB subnet group. Valid values:
    • IPV4
    • DUAL
    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 RDS User Guide.
  • vpc_id
    Type: STRING
    Provider name: VpcId
    Description: Provides the VpcId of the DB subnet group.

db_system_id

Type: STRING
Provider name: DBSystemId
Description: The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is only valid for RDS Custom DB instances.

dbi_resource_id

Type: STRING
Provider name: DbiResourceId
Description: The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.

dedicated_log_volume

Type: BOOLEAN
Provider name: DedicatedLogVolume
Description: Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

deletion_protection

Type: BOOLEAN
Provider name: DeletionProtection
Description: Indicates whether the DB instance has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.

domain_memberships

Type: UNORDERED_LIST_STRUCT
Provider name: DomainMemberships
Description: The Active Directory Domain membership records associated with the DB instance.

  • auth_secret_arn
    Type: STRING
    Provider name: AuthSecretArn
    Description: The ARN for the Secrets Manager secret with the credentials for the user that’s a member of the domain.
  • dns_ips
    Type: UNORDERED_LIST_STRING
    Provider name: DnsIps
    Description: The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers.
  • domain
    Type: STRING
    Provider name: Domain
    Description: The identifier of the Active Directory Domain.
  • fqdn
    Type: STRING
    Provider name: FQDN
    Description: The fully qualified domain name (FQDN) of the Active Directory Domain.
  • iam_role_name
    Type: STRING
    Provider name: IAMRoleName
    Description: The name of the IAM role used when making API calls to the Directory Service.
  • ou
    Type: STRING
    Provider name: OU
    Description: The Active Directory organizational unit for the DB instance or cluster.
  • status
    Type: STRING
    Provider name: Status
    Description: The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.

enabled_cloudwatch_logs_exports

Type: UNORDERED_LIST_STRING
Provider name: EnabledCloudwatchLogsExports
Description: A list of log types that this DB instance is configured to export to CloudWatch Logs. Log types vary by DB engine. For information about the log types for each DB engine, see Monitoring Amazon RDS log files in the Amazon RDS User Guide.

endpoint

Type: STRUCT
Provider name: Endpoint
Description: The connection endpoint for the DB instance. The endpoint might not be shown for instances with the status of creating.

  • address
    Type: STRING
    Provider name: Address
    Description: Specifies the DNS address of the DB instance.
  • hosted_zone_id
    Type: STRING
    Provider name: HostedZoneId
    Description: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
  • port
    Type: INT32
    Provider name: Port
    Description: Specifies the port that the database engine is listening on.

engine

Type: STRING
Provider name: Engine
Description: The database engine used for this DB instance.

engine_version

Type: STRING
Provider name: EngineVersion
Description: The version of the database engine.

enhanced_monitoring_resource_arn

Type: STRING
Provider name: EnhancedMonitoringResourceArn
Description: The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

iam_database_authentication_enabled

Type: BOOLEAN
Provider name: IAMDatabaseAuthenticationEnabled
Description: Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance. For a list of engine versions that support IAM database authentication, see IAM database authentication in the Amazon RDS User Guide and IAM database authentication in Aurora in the Amazon Aurora User Guide.

instance_create_time

Type: TIMESTAMP
Provider name: InstanceCreateTime
Description: The date and time when the DB instance was created.

iops

Type: INT32
Provider name: Iops
Description: The Provisioned IOPS (I/O operations per second) value for the DB instance.

is_storage_config_upgrade_available

Type: BOOLEAN
Provider name: IsStorageConfigUpgradeAvailable
Description: Indicates whether an upgrade is recommended for the storage file system configuration on the DB instance. To migrate to the preferred configuration, you can either create a blue/green deployment, or create a read replica from the DB instance. For more information, see Upgrading the storage file system for a DB instance.

kms_key_id

Type: STRING
Provider name: KmsKeyId
Description: If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

latest_restorable_time

Type: TIMESTAMP
Provider name: LatestRestorableTime
Description: The latest time to which a database in this DB instance can be restored with point-in-time restore.

license_model

Type: STRING
Provider name: LicenseModel
Description: The license model information for this DB instance. This setting doesn’t apply to RDS Custom DB instances.

listener_endpoint

Type: STRUCT
Provider name: ListenerEndpoint
Description: The listener connection endpoint for SQL Server Always On.

  • address
    Type: STRING
    Provider name: Address
    Description: Specifies the DNS address of the DB instance.
  • hosted_zone_id
    Type: STRING
    Provider name: HostedZoneId
    Description: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
  • port
    Type: INT32
    Provider name: Port
    Description: Specifies the port that the database engine is listening on.

master_user_secret

Type: STRUCT
Provider name: MasterUserSecret
Description: The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password. For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.

  • kms_key_id
    Type: STRING
    Provider name: KmsKeyId
    Description: The Amazon Web Services KMS key identifier that is used to encrypt the secret.
  • secret_arn
    Type: STRING
    Provider name: SecretArn
    Description: The Amazon Resource Name (ARN) of the secret.
  • secret_status
    Type: STRING
    Provider name: SecretStatus
    Description: The status of the secret. The possible status values include the following:
    • creating - The secret is being created.
    • active - The secret is available for normal use and rotation.
    • rotating - The secret is being rotated.
    • impaired - The secret can be used to access database credentials, but it can’t be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.

master_username

Type: STRING
Provider name: MasterUsername
Description: The master username for the DB instance.

max_allocated_storage

Type: INT32
Provider name: MaxAllocatedStorage
Description: The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

monitoring_interval

Type: INT32
Provider name: MonitoringInterval
Description: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

monitoring_role_arn

Type: STRING
Provider name: MonitoringRoleArn
Description: The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

multi_az

Type: BOOLEAN
Provider name: MultiAZ
Description: Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn’t apply to RDS Custom DB instances.

multi_tenant

Type: BOOLEAN
Provider name: MultiTenant
Description: Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

nchar_character_set_name

Type: STRING
Provider name: NcharCharacterSetName
Description: The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

network_type

Type: STRING
Provider name: NetworkType
Description: The network type of the DB instance. Valid values:

  • IPV4
  • DUAL
The network type is determined by the DBSubnetGroup specified for the DB instance. 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 RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.

option_group_memberships

Type: UNORDERED_LIST_STRUCT
Provider name: OptionGroupMemberships
Description: The list of option group memberships for this DB instance.

  • option_group_name
    Type: STRING
    Provider name: OptionGroupName
    Description: The name of the option group that the instance belongs to.
  • status
    Type: STRING
    Provider name: Status
    Description: The status of the DB instance’s option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.

pending_modified_values

Type: STRUCT
Provider name: PendingModifiedValues
Description: Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.

  • allocated_storage
    Type: INT32
    Provider name: AllocatedStorage
    Description: The allocated storage size for the DB instance specified in gibibytes (GiB).
  • automation_mode
    Type: STRING
    Provider name: AutomationMode
    Description: The automation mode of the RDS Custom DB instance: full or all-paused. If full, the DB instance automates monitoring and instance recovery. If all-paused, the instance pauses automation for the duration set by –resume-full-automation-mode-minutes.
  • backup_retention_period
    Type: INT32
    Provider name: BackupRetentionPeriod
    Description: The number of days for which automated backups are retained.
  • ca_certificate_identifier
    Type: STRING
    Provider name: CACertificateIdentifier
    Description: The identifier of the CA certificate for the DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
  • db_instance_class
    Type: STRING
    Provider name: DBInstanceClass
    Description: The name of the compute and memory capacity class for the DB instance.
  • db_instance_identifier
    Type: STRING
    Provider name: DBInstanceIdentifier
    Description: The database identifier for the DB instance.
  • db_subnet_group_name
    Type: STRING
    Provider name: DBSubnetGroupName
    Description: The DB subnet group for the DB instance.
  • dedicated_log_volume
    Type: BOOLEAN
    Provider name: DedicatedLogVolume
    Description: Indicates whether the DB instance has a dedicated log volume (DLV) enabled.>
  • engine
    Type: STRING
    Provider name: Engine
    Description: The database engine of the DB instance.
  • engine_version
    Type: STRING
    Provider name: EngineVersion
    Description: The database engine version.
  • iam_database_authentication_enabled
    Type: BOOLEAN
    Provider name: IAMDatabaseAuthenticationEnabled
    Description: Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
  • iops
    Type: INT32
    Provider name: Iops
    Description: The Provisioned IOPS value for the DB instance.
  • license_model
    Type: STRING
    Provider name: LicenseModel
    Description: The license model for the DB instance. Valid values: license-included | bring-your-own-license | general-public-license
  • master_user_password
    Type: STRING
    Provider name: MasterUserPassword
    Description: The master credentials for the DB instance.
  • multi_az
    Type: BOOLEAN
    Provider name: MultiAZ
    Description: Indicates whether the Single-AZ DB instance will change to a Multi-AZ deployment.
  • multi_tenant
    Type: BOOLEAN
    Provider name: MultiTenant
    Description: Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
  • pending_cloudwatch_logs_exports
    Type: STRUCT
    Provider name: PendingCloudwatchLogsExports
    • log_types_to_disable
      Type: UNORDERED_LIST_STRING
      Provider name: LogTypesToDisable
      Description: Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
    • log_types_to_enable
      Type: UNORDERED_LIST_STRING
      Provider name: LogTypesToEnable
      Description: Log types that are in the process of being deactivated. After they are deactivated, these log types aren’t exported to CloudWatch Logs.
  • port
    Type: INT32
    Provider name: Port
    Description: The port for the DB instance.
  • processor_features
    Type: UNORDERED_LIST_STRUCT
    Provider name: ProcessorFeatures
    Description: The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
    • name
      Type: STRING
      Provider name: Name
      Description: The name of the processor feature. Valid names are coreCount and threadsPerCore.
    • value
      Type: STRING
      Provider name: Value
      Description: The value of a processor feature name.
  • resume_full_automation_mode_time
    Type: TIMESTAMP
    Provider name: ResumeFullAutomationModeTime
    Description: The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
  • storage_throughput
    Type: INT32
    Provider name: StorageThroughput
    Description: The storage throughput of the DB instance.
  • storage_type
    Type: STRING
    Provider name: StorageType
    Description: The storage type of the DB instance.

percent_progress

Type: STRING
Provider name: PercentProgress
Description: The progress of the storage optimization operation as a percentage.

performance_insights_enabled

Type: BOOLEAN
Provider name: PerformanceInsightsEnabled
Description: Indicates whether Performance Insights is enabled for the DB instance.

performance_insights_kms_key_id

Type: STRING
Provider name: PerformanceInsightsKMSKeyId
Description: 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.

performance_insights_retention_period

Type: INT32
Provider name: PerformanceInsightsRetentionPeriod
Description: The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

  • 7
  • month * 31, where month is a number of months from 1-23
  • 731
For example, the following values are valid:
  • 93 (3 months * 31)
  • 341 (11 months * 31)
  • 589 (19 months * 31)
  • 731

preferred_backup_window

Type: STRING
Provider name: PreferredBackupWindow
Description: The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

preferred_maintenance_window

Type: STRING
Provider name: PreferredMaintenanceWindow
Description: The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

processor_features

Type: UNORDERED_LIST_STRUCT
Provider name: ProcessorFeatures
Description: The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

  • name
    Type: STRING
    Provider name: Name
    Description: The name of the processor feature. Valid names are coreCount and threadsPerCore.
  • value
    Type: STRING
    Provider name: Value
    Description: The value of a processor feature name.

promotion_tier

Type: INT32
Provider name: PromotionTier
Description: The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

publicly_accessible

Type: BOOLEAN
Provider name: PubliclyAccessible
Description: Indicates whether the DB instance is publicly accessible. When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster’s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster’s VPC. 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 instance isn’t publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

read_replica_db_cluster_identifiers

Type: UNORDERED_LIST_STRING
Provider name: ReadReplicaDBClusterIdentifiers
Description: The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn’t contain information about cross-Region Aurora read replicas. Currently, each RDS DB instance can have only one Aurora read replica.

read_replica_db_instance_identifiers

Type: UNORDERED_LIST_STRING
Provider name: ReadReplicaDBInstanceIdentifiers
Description: The identifiers of the read replicas associated with this DB instance.

read_replica_source_db_cluster_identifier

Type: STRING
Provider name: ReadReplicaSourceDBClusterIdentifier
Description: The identifier of the source DB cluster if this DB instance is a read replica.

read_replica_source_db_instance_identifier

Type: STRING
Provider name: ReadReplicaSourceDBInstanceIdentifier
Description: The identifier of the source DB instance if this DB instance is a read replica.

replica_mode

Type: STRING
Provider name: ReplicaMode
Description: The open mode of an Oracle read replica. The default is open-read-only. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This attribute is only supported in RDS for Oracle.

resume_full_automation_mode_time

Type: TIMESTAMP
Provider name: ResumeFullAutomationModeTime
Description: The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.

secondary_availability_zone

Type: STRING
Provider name: SecondaryAvailabilityZone
Description: If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

status_infos

Type: UNORDERED_LIST_STRUCT
Provider name: StatusInfos
Description: The status of a read replica. If the DB instance isn’t a read replica, the value is blank.

  • message
    Type: STRING
    Provider name: Message
    Description: Details of the error if there is an error for the instance. If the instance isn’t in an error state, this value is blank.
  • normal
    Type: BOOLEAN
    Provider name: Normal
    Description: Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE).
  • status
    Type: STRING
    Provider name: Status
    Description: The status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
  • status_type
    Type: STRING
    Provider name: StatusType
    Description: This value is currently “read replication."

storage_encrypted

Type: BOOLEAN
Provider name: StorageEncrypted
Description: Indicates whether the DB instance is encrypted.

storage_throughput

Type: INT32
Provider name: StorageThroughput
Description: The storage throughput for the DB instance. This setting applies only to the gp3 storage type.

storage_type

Type: STRING
Provider name: StorageType
Description: The storage type associated with the DB instance.

tags

Type: UNORDERED_LIST_STRING

tde_credential_arn

Type: STRING
Provider name: TdeCredentialArn
Description: The ARN from the key store with which the instance is associated for TDE encryption.

timezone

Type: STRING
Provider name: Timezone
Description: The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

vpc_security_groups

Type: UNORDERED_LIST_STRUCT
Provider name: VpcSecurityGroups
Description: The list of Amazon EC2 VPC security groups that the DB instance belongs to.

  • status
    Type: STRING
    Provider name: Status
    Description: The membership status of the VPC security group. Currently, the only valid status is active.
  • vpc_security_group_id
    Type: STRING
    Provider name: VpcSecurityGroupId
    Description: The name of the VPC security group.