Class: Aws::RDS::Types::DBInstance

Inherits:

Struct

Object
Struct
Aws::RDS::Types::DBInstance

show all

Includes:: Structure

Defined in:: lib/aws-sdk-rds/types.rb

Overview

Contains the details of an Amazon RDS DB instance.

This data type is used as a response element in the operations ‘CreateDBInstance`, `CreateDBInstanceReadReplica`, `DeleteDBInstance`, `DescribeDBInstances`, `ModifyDBInstance`, `PromoteReadReplica`, `RebootDBInstance`, `RestoreDBInstanceFromDBSnapshot`, `RestoreDBInstanceFromS3`, `RestoreDBInstanceToPointInTime`, `StartDBInstance`, and `StopDBInstance`.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#activity_stream_engine_native_audit_fields_included ⇒ Boolean

Indicates whether engine-native audit fields are included in the database activity stream.
#activity_stream_kinesis_stream_name ⇒ String

The name of the Amazon Kinesis data stream used for the database activity stream.
#activity_stream_kms_key_id ⇒ String

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
#activity_stream_mode ⇒ String

The mode of the database activity stream.
#activity_stream_policy_status ⇒ String

The status of the policy state of the activity stream.
#activity_stream_status ⇒ String

The status of the database activity stream.
#allocated_storage ⇒ Integer

The amount of storage in gibibytes (GiB) allocated for the DB instance.
#associated_roles ⇒ Array<Types::DBInstanceRole>

The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
#auto_minor_version_upgrade ⇒ Boolean

Indicates whether minor version patches are applied automatically.
#automatic_restart_time ⇒ Time

The time when a stopped DB instance is restarted automatically.
#automation_mode ⇒ String

The automation mode of the RDS Custom DB instance: ‘full` or `all paused`.
#availability_zone ⇒ String

The name of the Availability Zone where the DB instance is located.
#aws_backup_recovery_point_arn ⇒ String

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
#backup_retention_period ⇒ Integer

The number of days for which automatic DB snapshots are retained.
#backup_target ⇒ String

The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
#ca_certificate_identifier ⇒ String

The identifier of the CA certificate for this DB instance.
#certificate_details ⇒ Types::CertificateDetails

The details of the DB instance’s server certificate.
#character_set_name ⇒ String

If present, specifies the name of the character set that this instance is associated with.
#copy_tags_to_snapshot ⇒ Boolean

Indicates whether tags are copied from the DB instance to snapshots of the DB instance.
#custom_iam_instance_profile ⇒ String

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
#customer_owned_ip_enabled ⇒ Boolean

Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
#db_cluster_identifier ⇒ String

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 ⇒ String

The Amazon Resource Name (ARN) for the DB instance.
#db_instance_automated_backups_replications ⇒ Array<Types::DBInstanceAutomatedBackupsReplication>

The list of replicated automated backups associated with the DB instance.
#db_instance_class ⇒ String

The name of the compute and memory capacity class of the DB instance.
#db_instance_identifier ⇒ String

The user-supplied database identifier.
#db_instance_port ⇒ Integer

The port that the DB instance listens on.
#db_instance_status ⇒ String

The current state of this database.
#db_name ⇒ String

The initial database name that you provided (if required) when you created the DB instance.
#db_parameter_groups ⇒ Array<Types::DBParameterGroupStatus>

The list of DB parameter groups applied to this DB instance.
#db_security_groups ⇒ Array<Types::DBSecurityGroupMembership>

A list of DB security group elements containing ‘DBSecurityGroup.Name` and `DBSecurityGroup.Status` subelements.
#db_subnet_group ⇒ Types::DBSubnetGroup

Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
#db_system_id ⇒ String

The Oracle system ID (Oracle SID) for a container database (CDB).
#dbi_resource_id ⇒ String

The Amazon Web Services Region-unique, immutable identifier for the DB instance.
#dedicated_log_volume ⇒ Boolean

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
#deletion_protection ⇒ Boolean

Indicates whether the DB instance has deletion protection enabled.
#domain_memberships ⇒ Array<Types::DomainMembership>

The Active Directory Domain membership records associated with the DB instance.
#enabled_cloudwatch_logs_exports ⇒ Array<String>

A list of log types that this DB instance is configured to export to CloudWatch Logs.
#endpoint ⇒ Types::Endpoint

The connection endpoint for the DB instance.
#engine ⇒ String

The database engine used for this DB instance.
#engine_lifecycle_support ⇒ String

The life cycle type for the DB instance.
#engine_version ⇒ String

The version of the database engine.
#enhanced_monitoring_resource_arn ⇒ String

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 ⇒ Boolean

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance.
#instance_create_time ⇒ Time

The date and time when the DB instance was created.
#iops ⇒ Integer

The Provisioned IOPS (I/O operations per second) value for the DB instance.
#is_storage_config_upgrade_available ⇒ Boolean

Indicates whether an upgrade is recommended for the storage file system configuration on the DB instance.
#kms_key_id ⇒ String

If ‘StorageEncrypted` is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance.
#latest_restorable_time ⇒ Time

The latest time to which a database in this DB instance can be restored with point-in-time restore.
#license_model ⇒ String

The license model information for this DB instance.
#listener_endpoint ⇒ Types::Endpoint

The listener connection endpoint for SQL Server Always On.
#master_user_secret ⇒ Types::MasterUserSecret

The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
#master_username ⇒ String

The master username for the DB instance.
#max_allocated_storage ⇒ Integer

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
#monitoring_interval ⇒ Integer

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
#monitoring_role_arn ⇒ String

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
#multi_az ⇒ Boolean

Indicates whether the DB instance is a Multi-AZ deployment.
#multi_tenant ⇒ Boolean

Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
#nchar_character_set_name ⇒ String

The name of the NCHAR character set for the Oracle DB instance.
#network_type ⇒ String

The network type of the DB instance.
#option_group_memberships ⇒ Array<Types::OptionGroupMembership>

The list of option group memberships for this DB instance.
#pending_modified_values ⇒ Types::PendingModifiedValues

Information about pending changes to the DB instance.
#percent_progress ⇒ String

The progress of the storage optimization operation as a percentage.
#performance_insights_enabled ⇒ Boolean

Indicates whether Performance Insights is enabled for the DB instance.
#performance_insights_kms_key_id ⇒ String

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
#performance_insights_retention_period ⇒ Integer

The number of days to retain Performance Insights data.
#preferred_backup_window ⇒ String

The daily time range during which automated backups are created if automated backups are enabled, as determined by the ‘BackupRetentionPeriod`.
#preferred_maintenance_window ⇒ String

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
#processor_features ⇒ Array<Types::ProcessorFeature>

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
#promotion_tier ⇒ Integer

The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.
#publicly_accessible ⇒ Boolean

Indicates whether the DB instance is publicly accessible.
#read_replica_db_cluster_identifiers ⇒ Array<String>

The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.
#read_replica_db_instance_identifiers ⇒ Array<String>

The identifiers of the read replicas associated with this DB instance.
#read_replica_source_db_cluster_identifier ⇒ String

The identifier of the source DB cluster if this DB instance is a read replica.
#read_replica_source_db_instance_identifier ⇒ String

The identifier of the source DB instance if this DB instance is a read replica.
#replica_mode ⇒ String

The open mode of an Oracle read replica.
#resume_full_automation_mode_time ⇒ Time

The number of minutes to pause the automation.
#secondary_availability_zone ⇒ String

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
#status_infos ⇒ Array<Types::DBInstanceStatusInfo>

The status of a read replica.
#storage_encrypted ⇒ Boolean

Indicates whether the DB instance is encrypted.
#storage_throughput ⇒ Integer

The storage throughput for the DB instance.
#storage_type ⇒ String

The storage type associated with the DB instance.
#tag_list ⇒ Array<Types::Tag>

A list of tags.
#tde_credential_arn ⇒ String

The ARN from the key store with which the instance is associated for TDE encryption.
#timezone ⇒ String

The time zone of the DB instance.
#vpc_security_groups ⇒ Array<Types::VpcSecurityGroupMembership>

The list of Amazon EC2 VPC security groups that the DB instance belongs to.

Instance Attribute Details

#activity_stream_engine_native_audit_fields_included ⇒ `Boolean`

Indicates whether engine-native audit fields are included in the database activity stream.

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#activity_stream_kinesis_stream_name ⇒ `String`

The name of the Amazon Kinesis data stream used for the database activity stream.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#activity_stream_kms_key_id ⇒ `String`

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.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#activity_stream_mode ⇒ `String`

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.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#activity_stream_policy_status ⇒ `String`

The status of the policy state of the activity stream.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#activity_stream_status ⇒ `String`

The status of the database activity stream.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#allocated_storage ⇒ `Integer`

The amount of storage in gibibytes (GiB) allocated for the DB instance.

Returns:

(Integer)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#associated_roles ⇒ `Array<Types::DBInstanceRole>`

The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.

Returns:

(Array<Types::DBInstanceRole>)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#auto_minor_version_upgrade ⇒ `Boolean`

Indicates whether minor version patches are applied automatically.

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#automatic_restart_time ⇒ `Time`

The time when a stopped DB instance is restarted automatically.

Returns:

(Time)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#automation_mode ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone ⇒ `String`

The name of the Availability Zone where the DB instance is located.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#aws_backup_recovery_point_arn ⇒ `String`

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#backup_retention_period ⇒ `Integer`

The number of days for which automatic DB snapshots are retained.

Returns:

(Integer)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#backup_target ⇒ `String`

The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#ca_certificate_identifier ⇒ `String`

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

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html [2]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_details ⇒ `Types::CertificateDetails`

The details of the DB instance’s server certificate.

Returns:

(Types::CertificateDetails)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#character_set_name ⇒ `String`

If present, specifies the name of the character set that this instance is associated with.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#copy_tags_to_snapshot ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#custom_iam_instance_profile ⇒ `String`

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

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#customer_owned_ip_enabled ⇒ `Boolean`

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

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html [2]: docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_identifier ⇒ `String`

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.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_arn ⇒ `String`

The Amazon Resource Name (ARN) for the DB instance.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_automated_backups_replications ⇒ `Array<Types::DBInstanceAutomatedBackupsReplication>`

The list of replicated automated backups associated with the DB instance.

Returns:

(Array<Types::DBInstanceAutomatedBackupsReplication>)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_class ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_identifier ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_port ⇒ `Integer`

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:

(Integer)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_status ⇒ `String`

The current state of this database.

For information about DB instance statuses, see [Viewing DB instance status] in the *Amazon RDS User Guide.*

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/accessing-monitoring.html#Overview.DBInstance.Status

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#db_name ⇒ `String`

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.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#db_parameter_groups ⇒ `Array<Types::DBParameterGroupStatus>`

The list of DB parameter groups applied to this DB instance.

Returns:

(Array<Types::DBParameterGroupStatus>)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#db_security_groups ⇒ `Array<Types::DBSecurityGroupMembership>`

A list of DB security group elements containing ‘DBSecurityGroup.Name` and `DBSecurityGroup.Status` subelements.

Returns:

(Array<Types::DBSecurityGroupMembership>)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#db_subnet_group ⇒ `Types::DBSubnetGroup`

Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

Returns:

(Types::DBSubnetGroup)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#db_system_id ⇒ `String`

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.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#dbi_resource_id ⇒ `String`

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.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#dedicated_log_volume ⇒ `Boolean`

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection ⇒ `Boolean`

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

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#domain_memberships ⇒ `Array<Types::DomainMembership>`

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

Returns:

(Array<Types::DomainMembership>)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#enabled_cloudwatch_logs_exports ⇒ `Array<String>`

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

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html

Returns:

(Array<String>)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint ⇒ `Types::Endpoint`

The connection endpoint for the DB instance.

<note markdown=“1”> The endpoint might not be shown for instances with the status of ‘creating`.

</note>

Returns:

(Types::Endpoint)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ `String`

The database engine used for this DB instance.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#engine_lifecycle_support ⇒ `String`

The life cycle type for the DB instance.

For more information, see CreateDBInstance.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ `String`

The version of the database engine.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#enhanced_monitoring_resource_arn ⇒ `String`

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#iam_database_authentication_enabled ⇒ `Boolean`

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

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RDS_Fea_Regions_DB-eng.Feature.IamDatabaseAuthentication.html [2]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.Aurora_Fea_Regions_DB-eng.Feature.IAMdbauth.html

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#instance_create_time ⇒ `Time`

The date and time when the DB instance was created.

Returns:

(Time)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#iops ⇒ `Integer`

The Provisioned IOPS (I/O operations per second) value for the DB instance.

Returns:

(Integer)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#is_storage_config_upgrade_available ⇒ `Boolean`

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

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.UpgradeFileSystem

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ `String`

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.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#latest_restorable_time ⇒ `Time`

The latest time to which a database in this DB instance can be restored with point-in-time restore.

Returns:

(Time)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#license_model ⇒ `String`

The license model information for this DB instance. This setting doesn’t apply to Amazon Aurora or RDS Custom DB instances.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#listener_endpoint ⇒ `Types::Endpoint`

The listener connection endpoint for SQL Server Always On.

Returns:

(Types::Endpoint)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#master_user_secret ⇒ `Types::MasterUserSecret`

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

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html

Returns:

(Types::MasterUserSecret)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#master_username ⇒ `String`

The master username for the DB instance.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#max_allocated_storage ⇒ `Integer`

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

Returns:

(Integer)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#monitoring_interval ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#monitoring_role_arn ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#multi_az ⇒ `Boolean`

Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn’t apply to RDS Custom DB instances.

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#multi_tenant ⇒ `Boolean`

Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#nchar_character_set_name ⇒ `String`

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.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#network_type ⇒ `String`

The network type of the DB instance.

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

Valid Values: ‘IPV4 | DUAL`

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html [2]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#option_group_memberships ⇒ `Array<Types::OptionGroupMembership>`

The list of option group memberships for this DB instance.

Returns:

(Array<Types::OptionGroupMembership>)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#pending_modified_values ⇒ `Types::PendingModifiedValues`

Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.

Returns:

(Types::PendingModifiedValues)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#percent_progress ⇒ `String`

The progress of the storage optimization operation as a percentage.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#performance_insights_enabled ⇒ `Boolean`

Indicates whether Performance Insights is enabled for the DB instance.

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#performance_insights_kms_key_id ⇒ `String`

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.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#performance_insights_retention_period ⇒ `Integer`

The number of days to retain Performance Insights data.

Valid Values:

‘7`
month * 31, where month is a number of months from 1-23. Examples: ‘93` (3 months * 31), `341` (11 months * 31), `589` (19 months * 31)
‘731`

Default: ‘7` days

Returns:

(Integer)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_backup_window ⇒ `String`

The daily time range during which automated backups are created if automated backups are enabled, as determined by the ‘BackupRetentionPeriod`.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_maintenance_window ⇒ `String`

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#processor_features ⇒ `Array<Types::ProcessorFeature>`

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

Returns:

(Array<Types::ProcessorFeature>)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#promotion_tier ⇒ `Integer`

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

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance

Returns:

(Integer)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#publicly_accessible ⇒ `Boolean`

Indicates whether the DB instance is publicly accessible.

When the DB instance is publicly accessible and you connect from outside of the DB instance’s virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. 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.

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#read_replica_db_cluster_identifiers ⇒ `Array<String>`

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.

<note markdown=“1”> Currently, each RDS DB instance can have only one Aurora read replica.

</note>

Returns:

(Array<String>)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#read_replica_db_instance_identifiers ⇒ `Array<String>`

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

Returns:

(Array<String>)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#read_replica_source_db_cluster_identifier ⇒ `String`

The identifier of the source DB cluster if this DB instance is a read replica.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#read_replica_source_db_instance_identifier ⇒ `String`

The identifier of the source DB instance if this DB instance is a read replica.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#replica_mode ⇒ `String`

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

<note markdown=“1”> This attribute is only supported in RDS for Oracle.

</note>

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#resume_full_automation_mode_time ⇒ `Time`

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.

Returns:

(Time)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#secondary_availability_zone ⇒ `String`

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#status_infos ⇒ `Array<Types::DBInstanceStatusInfo>`

The status of a read replica. If the DB instance isn’t a read replica, the value is blank.

Returns:

(Array<Types::DBInstanceStatusInfo>)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#storage_encrypted ⇒ `Boolean`

Indicates whether the DB instance is encrypted.

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#storage_throughput ⇒ `Integer`

The storage throughput for the DB instance.

This setting applies only to the ‘gp3` storage type.

Returns:

(Integer)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#storage_type ⇒ `String`

The storage type associated with the DB instance.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

A list of tags.

For more information, see [Tagging Amazon RDS resources] in the *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS resources] in the *Amazon Aurora User Guide*.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html [2]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html

Returns:

(Array<Types::Tag>)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#tde_credential_arn ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#timezone ⇒ `String`

The time zone of the DB instance. In most cases, the ‘Timezone` element is empty. `Timezone` content appears only for RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_security_groups ⇒ `Array<Types::VpcSecurityGroupMembership>`

The list of Amazon EC2 VPC security groups that the DB instance belongs to.

Returns:

(Array<Types::VpcSecurityGroupMembership>)

# File 'lib/aws-sdk-rds/types.rb', line 9313

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :automatic_restart_time,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :replica_mode,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :nchar_character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enabled_cloudwatch_logs_exports,
  :processor_features,
  :deletion_protection,
  :associated_roles,
  :listener_endpoint,
  :max_allocated_storage,
  :tag_list,
  :db_instance_automated_backups_replications,
  :customer_owned_ip_enabled,
  :aws_backup_recovery_point_arn,
  :activity_stream_status,
  :activity_stream_kms_key_id,
  :activity_stream_kinesis_stream_name,
  :activity_stream_mode,
  :activity_stream_engine_native_audit_fields_included,
  :automation_mode,
  :resume_full_automation_mode_time,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type,
  :activity_stream_policy_status,
  :storage_throughput,
  :db_system_id,
  :master_user_secret,
  :certificate_details,
  :read_replica_source_db_cluster_identifier,
  :percent_progress,
  :dedicated_log_volume,
  :is_storage_config_upgrade_available,
  :multi_tenant,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::RDS::Types::DBInstance

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#activity_stream_engine_native_audit_fields_included ⇒ Boolean

#activity_stream_kinesis_stream_name ⇒ String

#activity_stream_kms_key_id ⇒ String

#activity_stream_mode ⇒ String

#activity_stream_policy_status ⇒ String

#activity_stream_status ⇒ String

#allocated_storage ⇒ Integer

#associated_roles ⇒ Array<Types::DBInstanceRole>

#auto_minor_version_upgrade ⇒ Boolean

#automatic_restart_time ⇒ Time

#automation_mode ⇒ String

#availability_zone ⇒ String

#aws_backup_recovery_point_arn ⇒ String

#backup_retention_period ⇒ Integer

#backup_target ⇒ String

#ca_certificate_identifier ⇒ String

#certificate_details ⇒ Types::CertificateDetails

#character_set_name ⇒ String

#copy_tags_to_snapshot ⇒ Boolean

#custom_iam_instance_profile ⇒ String

#customer_owned_ip_enabled ⇒ Boolean

#db_cluster_identifier ⇒ String

#db_instance_arn ⇒ String

#db_instance_automated_backups_replications ⇒ Array<Types::DBInstanceAutomatedBackupsReplication>

#db_instance_class ⇒ String

#db_instance_identifier ⇒ String

#db_instance_port ⇒ Integer

#db_instance_status ⇒ String

#db_name ⇒ String

#db_parameter_groups ⇒ Array<Types::DBParameterGroupStatus>

#db_security_groups ⇒ Array<Types::DBSecurityGroupMembership>

#db_subnet_group ⇒ Types::DBSubnetGroup

#db_system_id ⇒ String

#dbi_resource_id ⇒ String

#dedicated_log_volume ⇒ Boolean

#deletion_protection ⇒ Boolean

#domain_memberships ⇒ Array<Types::DomainMembership>

#enabled_cloudwatch_logs_exports ⇒ Array<String>

#endpoint ⇒ Types::Endpoint

#engine ⇒ String

#engine_lifecycle_support ⇒ String

#engine_version ⇒ String

#enhanced_monitoring_resource_arn ⇒ String

#iam_database_authentication_enabled ⇒ Boolean

#instance_create_time ⇒ Time

#iops ⇒ Integer

#is_storage_config_upgrade_available ⇒ Boolean

#kms_key_id ⇒ String

#latest_restorable_time ⇒ Time

#license_model ⇒ String

#listener_endpoint ⇒ Types::Endpoint

#master_user_secret ⇒ Types::MasterUserSecret

#master_username ⇒ String

#max_allocated_storage ⇒ Integer

#monitoring_interval ⇒ Integer

#monitoring_role_arn ⇒ String

#multi_az ⇒ Boolean

#multi_tenant ⇒ Boolean

#nchar_character_set_name ⇒ String

#network_type ⇒ String

#option_group_memberships ⇒ Array<Types::OptionGroupMembership>

#pending_modified_values ⇒ Types::PendingModifiedValues

#percent_progress ⇒ String

#performance_insights_enabled ⇒ Boolean

#performance_insights_kms_key_id ⇒ String

#performance_insights_retention_period ⇒ Integer

#preferred_backup_window ⇒ String

#preferred_maintenance_window ⇒ String

#processor_features ⇒ Array<Types::ProcessorFeature>

#promotion_tier ⇒ Integer

#publicly_accessible ⇒ Boolean

#read_replica_db_cluster_identifiers ⇒ Array<String>

#read_replica_db_instance_identifiers ⇒ Array<String>

#read_replica_source_db_cluster_identifier ⇒ String

#read_replica_source_db_instance_identifier ⇒ String

#activity_stream_engine_native_audit_fields_included ⇒ `Boolean`

#activity_stream_kinesis_stream_name ⇒ `String`

#activity_stream_kms_key_id ⇒ `String`

#activity_stream_mode ⇒ `String`

#activity_stream_policy_status ⇒ `String`

#activity_stream_status ⇒ `String`

#allocated_storage ⇒ `Integer`

#associated_roles ⇒ `Array<Types::DBInstanceRole>`

#auto_minor_version_upgrade ⇒ `Boolean`

#automatic_restart_time ⇒ `Time`

#automation_mode ⇒ `String`

#availability_zone ⇒ `String`

#aws_backup_recovery_point_arn ⇒ `String`

#backup_retention_period ⇒ `Integer`

#backup_target ⇒ `String`

#ca_certificate_identifier ⇒ `String`

#certificate_details ⇒ `Types::CertificateDetails`

#character_set_name ⇒ `String`

#copy_tags_to_snapshot ⇒ `Boolean`

#custom_iam_instance_profile ⇒ `String`

#customer_owned_ip_enabled ⇒ `Boolean`

#db_cluster_identifier ⇒ `String`

#db_instance_arn ⇒ `String`

#db_instance_automated_backups_replications ⇒ `Array<Types::DBInstanceAutomatedBackupsReplication>`

#db_instance_class ⇒ `String`

#db_instance_identifier ⇒ `String`

#db_instance_port ⇒ `Integer`

#db_instance_status ⇒ `String`

#db_name ⇒ `String`

#db_parameter_groups ⇒ `Array<Types::DBParameterGroupStatus>`

#db_security_groups ⇒ `Array<Types::DBSecurityGroupMembership>`

#db_subnet_group ⇒ `Types::DBSubnetGroup`

#db_system_id ⇒ `String`

#dbi_resource_id ⇒ `String`

#dedicated_log_volume ⇒ `Boolean`

#deletion_protection ⇒ `Boolean`

#domain_memberships ⇒ `Array<Types::DomainMembership>`

#enabled_cloudwatch_logs_exports ⇒ `Array<String>`

#endpoint ⇒ `Types::Endpoint`

#engine ⇒ `String`

#engine_lifecycle_support ⇒ `String`

#engine_version ⇒ `String`

#enhanced_monitoring_resource_arn ⇒ `String`

#iam_database_authentication_enabled ⇒ `Boolean`

#instance_create_time ⇒ `Time`

#iops ⇒ `Integer`

#is_storage_config_upgrade_available ⇒ `Boolean`

#kms_key_id ⇒ `String`

#latest_restorable_time ⇒ `Time`

#license_model ⇒ `String`

#listener_endpoint ⇒ `Types::Endpoint`

#master_user_secret ⇒ `Types::MasterUserSecret`

#master_username ⇒ `String`

#max_allocated_storage ⇒ `Integer`

#monitoring_interval ⇒ `Integer`

#monitoring_role_arn ⇒ `String`

#multi_az ⇒ `Boolean`

#multi_tenant ⇒ `Boolean`

#nchar_character_set_name ⇒ `String`

#network_type ⇒ `String`

#option_group_memberships ⇒ `Array<Types::OptionGroupMembership>`

#pending_modified_values ⇒ `Types::PendingModifiedValues`

#percent_progress ⇒ `String`

#performance_insights_enabled ⇒ `Boolean`

#performance_insights_kms_key_id ⇒ `String`

#performance_insights_retention_period ⇒ `Integer`

#preferred_backup_window ⇒ `String`

#preferred_maintenance_window ⇒ `String`

#processor_features ⇒ `Array<Types::ProcessorFeature>`

#promotion_tier ⇒ `Integer`

#publicly_accessible ⇒ `Boolean`

#read_replica_db_cluster_identifiers ⇒ `Array<String>`

#read_replica_db_instance_identifiers ⇒ `Array<String>`

#read_replica_source_db_cluster_identifier ⇒ `String`

#read_replica_source_db_instance_identifier ⇒ `String`

#replica_mode ⇒ `String`

#resume_full_automation_mode_time ⇒ `Time`

#secondary_availability_zone ⇒ `String`

#status_infos ⇒ `Array<Types::DBInstanceStatusInfo>`

#storage_encrypted ⇒ `Boolean`