Class: Aws::RDS::DBInstance
- Inherits:
-
Object
- Object
- Aws::RDS::DBInstance
- Defined in:
- gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes 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
orall 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_port ⇒ Integer
The port that the DB instance listens on.
-
#db_instance_status ⇒ String
The current state of this database.
-
#db_name ⇒ String
Contains 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
andDBSecurityGroup.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.
-
#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_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.
-
#id ⇒ String
(also: #db_instance_identifier)
-
#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.
-
#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.
-
#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.
Actions collapse
-
#create(options = {}) ⇒ DBInstance
-
#create_read_replica(options = {}) ⇒ DBInstance
-
#create_snapshot(options = {}) ⇒ DBSnapshot
-
#delete(options = {}) ⇒ DBInstance
-
#modify(options = {}) ⇒ DBInstance
-
#promote(options = {}) ⇒ DBInstance
-
#reboot(options = {}) ⇒ DBInstance
-
#restore(options = {}) ⇒ DBInstance
-
#subscribe_to(options = {}) ⇒ EventSubscription
-
#unsubscribe_from(options = {}) ⇒ EventSubscription
Associations collapse
-
#certificate ⇒ Certificate?
-
#cluster ⇒ DBCluster?
-
#events(options = {}) ⇒ Event::Collection
-
#log_files(options = {}) ⇒ DBLogFile::Collection
-
#option_groups ⇒ OptionGroup::Collection
-
#parameter_groups ⇒ DBParameterGroup::Collection
-
#pending_maintenance_actions(options = {}) ⇒ PendingMaintenanceAction::Collection
-
#read_replicas ⇒ DBInstance::Collection
-
#security_groups ⇒ DBSecurityGroup::Collection
-
#snapshots(options = {}) ⇒ DBSnapshot::Collection
-
#source ⇒ DBInstance?
-
#subnet_group ⇒ DBSubnetGroup?
Instance Method Summary collapse
-
#client ⇒ Client
-
#data ⇒ Types::DBInstance
Returns the data for this DBInstance.
-
#data_loaded? ⇒ Boolean
Returns
true
if this resource is loaded. -
#initialize(*args) ⇒ DBInstance
constructor
A new instance of DBInstance.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current DBInstance.
-
#wait_until(options = {}) {|resource| ... } ⇒ Resource
deprecated
Deprecated.
Use [Aws::RDS::Client] #wait_until instead
Constructor Details
#initialize(id, options = {}) ⇒ DBInstance #initialize(options = {}) ⇒ DBInstance
Returns a new instance of DBInstance.
22 23 24 25 26 27 28 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 22 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @id = extract_id(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#activity_stream_engine_native_audit_fields_included ⇒ Boolean
Indicates whether engine-native audit fields are included in the database activity stream.
633 634 635 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 633 def activity_stream_engine_native_audit_fields_included data[:activity_stream_engine_native_audit_fields_included] end |
#activity_stream_kinesis_stream_name ⇒ String
The name of the Amazon Kinesis data stream used for the database activity stream.
618 619 620 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 618 def activity_stream_kinesis_stream_name data[:activity_stream_kinesis_stream_name] 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.
611 612 613 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 611 def activity_stream_kms_key_id data[:activity_stream_kms_key_id] 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.
626 627 628 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 626 def activity_stream_mode data[:activity_stream_mode] end |
#activity_stream_policy_status ⇒ String
The status of the policy state of the activity stream.
707 708 709 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 707 def activity_stream_policy_status data[:activity_stream_policy_status] end |
#activity_stream_status ⇒ String
The status of the database activity stream.
602 603 604 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 602 def activity_stream_status data[:activity_stream_status] end |
#allocated_storage ⇒ Integer
The amount of storage in gibibytes (GiB) allocated for the DB instance.
98 99 100 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 98 def allocated_storage data[:allocated_storage] end |
#associated_roles ⇒ Array<Types::DBInstanceRole>
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
533 534 535 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 533 def associated_roles data[:associated_roles] end |
#auto_minor_version_upgrade ⇒ Boolean
Indicates whether minor version patches are applied automatically.
192 193 194 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 192 def auto_minor_version_upgrade data[:auto_minor_version_upgrade] end |
#automatic_restart_time ⇒ Time
The time when a stopped DB instance is restarted automatically.
65 66 67 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 65 def automatic_restart_time data[:automatic_restart_time] 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
.
642 643 644 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 642 def automation_mode data[:automation_mode] end |
#availability_zone ⇒ String
The name of the Availability Zone where the DB instance is located.
144 145 146 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 144 def availability_zone data[:availability_zone] end |
#aws_backup_recovery_point_arn ⇒ String
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
596 597 598 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 596 def aws_backup_recovery_point_arn data[:aws_backup_recovery_point_arn] end |
#backup_retention_period ⇒ Integer
The number of days for which automatic DB snapshots are retained.
118 119 120 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 118 def backup_retention_period data[:backup_retention_period] end |
#backup_target ⇒ String
The location where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
680 681 682 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 680 def backup_target data[:backup_target] 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.
372 373 374 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 372 def ca_certificate_identifier data[:ca_certificate_identifier] end |
#certificate ⇒ Certificate?
4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 4474 def certificate if data[:ca_certificate_identifier] Certificate.new( id: data[:ca_certificate_identifier], client: @client ) else nil end end |
#certificate_details ⇒ Types::CertificateDetails
The details of the DB instance's server certificate.
743 744 745 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 743 def certificate_details data[:certificate_details] end |
#character_set_name ⇒ String
If present, specifies the name of the character set that this instance is associated with.
262 263 264 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 262 def character_set_name data[:character_set_name] end |
#client ⇒ Client
763 764 765 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 763 def client @client end |
#cluster ⇒ DBCluster?
4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 4486 def cluster if data[:db_cluster_identifier] DBCluster.new( id: data[:db_cluster_identifier], client: @client ) else nil end 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
.
391 392 393 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 391 def data[:copy_tags_to_snapshot] end |
#create(options = {}) ⇒ DBInstance
2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 2069 def create( = {}) = .merge(db_instance_identifier: @id) resp = Aws::Plugins::UserAgent.feature('resource') do @client.create_db_instance() end DBInstance.new( id: resp.data.db_instance.db_instance_identifier, data: resp.data.db_instance, client: @client ) end |
#create_read_replica(options = {}) ⇒ DBInstance
2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 2692 def create_read_replica( = {}) = .merge(source_db_instance_identifier: @id) resp = Aws::Plugins::UserAgent.feature('resource') do @client.create_db_instance_read_replica() end DBInstance.new( id: resp.data.db_instance.db_instance_identifier, data: resp.data.db_instance, client: @client ) end |
#create_snapshot(options = {}) ⇒ DBSnapshot
2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 2738 def create_snapshot( = {}) = .merge(db_instance_identifier: @id) resp = Aws::Plugins::UserAgent.feature('resource') do @client.create_db_snapshot() end DBSnapshot.new( instance_id: resp.data.db_snapshot.db_instance_identifier, snapshot_id: resp.data.db_snapshot.db_snapshot_identifier, data: resp.data.db_snapshot, client: @client ) 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.
673 674 675 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 673 def custom_iam_instance_profile data[:custom_iam_instance_profile] 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.
589 590 591 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 589 def customer_owned_ip_enabled data[:customer_owned_ip_enabled] end |
#data ⇒ Types::DBInstance
Returns the data for this Aws::RDS::DBInstance. Calls
Client#describe_db_instances if #data_loaded? is false
.
785 786 787 788 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 785 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
793 794 795 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 793 def data_loaded? !!@data 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.
331 332 333 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 331 def db_cluster_identifier data[:db_cluster_identifier] end |
#db_instance_arn ⇒ String
The Amazon Resource Name (ARN) for the DB instance.
432 433 434 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 432 def db_instance_arn data[:db_instance_arn] end |
#db_instance_automated_backups_replications ⇒ Array<Types::DBInstanceAutomatedBackupsReplication>
The list of replicated automated backups associated with the DB instance.
564 565 566 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 564 def db_instance_automated_backups_replications data[:db_instance_automated_backups_replications] end |
#db_instance_class ⇒ String
The name of the compute and memory capacity class of the DB instance.
40 41 42 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 40 def db_instance_class data[:db_instance_class] 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.
324 325 326 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 324 def db_instance_port data[:db_instance_port] 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.
59 60 61 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 59 def db_instance_status data[:db_instance_status] end |
#db_name ⇒ String
Contains 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.
80 81 82 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 80 def db_name data[:db_name] end |
#db_parameter_groups ⇒ Array<Types::DBParameterGroupStatus>
The list of DB parameter groups applied to this DB instance.
138 139 140 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 138 def db_parameter_groups data[:db_parameter_groups] end |
#db_security_groups ⇒ Array<Types::DBSecurityGroupMembership>
A list of DB security group elements containing DBSecurityGroup.Name
and DBSecurityGroup.Status
subelements.
125 126 127 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 125 def db_security_groups data[:db_security_groups] 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.
151 152 153 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 151 def db_subnet_group data[:db_subnet_group] 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.
723 724 725 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 723 def db_system_id data[:db_system_id] 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.
356 357 358 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 356 def dbi_resource_id data[:dbi_resource_id] end |
#delete(options = {}) ⇒ DBInstance
2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 2806 def delete( = {}) = .merge(db_instance_identifier: @id) resp = Aws::Plugins::UserAgent.feature('resource') do @client.delete_db_instance() end DBInstance.new( id: resp.data.db_instance.db_instance_identifier, data: resp.data.db_instance, client: @client ) 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.
526 527 528 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 526 def deletion_protection data[:deletion_protection] end |
#domain_memberships ⇒ Array<Types::DomainMembership>
The Active Directory Domain membership records associated with the DB instance.
379 380 381 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 379 def domain_memberships data[:domain_memberships] 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.
507 508 509 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 507 def enabled_cloudwatch_logs_exports data[:enabled_cloudwatch_logs_exports] end |
#endpoint ⇒ Types::Endpoint
The connection endpoint for the DB instance.
creating
.
91 92 93 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 91 def endpoint data[:endpoint] end |
#engine ⇒ String
The database engine used for this DB instance.
46 47 48 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 46 def engine data[:engine] end |
#engine_version ⇒ String
The version of the database engine.
186 187 188 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 186 def engine_version data[:engine_version] 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.
406 407 408 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 406 def enhanced_monitoring_resource_arn data[:enhanced_monitoring_resource_arn] end |
#events(options = {}) ⇒ Event::Collection
4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 4542 def events( = {}) batches = Enumerator.new do |y| = .merge( source_type: "db-instance", source_identifier: @id ) resp = Aws::Plugins::UserAgent.feature('resource') do @client.describe_events() end resp.each_page do |page| batch = [] page.data.events.each do |e| batch << Event.new( source_id: e.source_identifier, date: e.date, data: e, client: @client ) end y.yield(batch) end end Event::Collection.new(batches) 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.
458 459 460 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 458 def iam_database_authentication_enabled data[:iam_database_authentication_enabled] end |
#id ⇒ String Also known as: db_instance_identifier
33 34 35 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 33 def id @id end |
#instance_create_time ⇒ Time
The date and time when the DB instance was created.
104 105 106 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 104 def instance_create_time data[:instance_create_time] end |
#iops ⇒ Integer
The Provisioned IOPS (I/O operations per second) value for the DB instance.
249 250 251 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 249 def iops data[:iops] 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.
347 348 349 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 347 def kms_key_id data[:kms_key_id] end |
#latest_restorable_time ⇒ Time
The latest time to which a database in this DB instance can be restored with point-in-time restore.
173 174 175 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 173 def latest_restorable_time data[:latest_restorable_time] end |
#license_model ⇒ String
The license model information for this DB instance. This setting doesn't apply to RDS Custom DB instances.
242 243 244 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 242 def license_model data[:license_model] end |
#listener_endpoint ⇒ Types::Endpoint
The listener connection endpoint for SQL Server Always On.
539 540 541 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 539 def listener_endpoint data[:listener_endpoint] end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::RDS::DBInstance.
Returns self
making it possible to chain methods.
db_instance.reload.data
773 774 775 776 777 778 779 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 773 def load resp = Aws::Plugins::UserAgent.feature('resource') do @client.describe_db_instances(db_instance_identifier: @id) end @data = resp.db_instances[0] self end |
#log_files(options = {}) ⇒ DBLogFile::Collection
4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 4593 def log_files( = {}) batches = Enumerator.new do |y| = .merge(db_instance_identifier: @id) resp = Aws::Plugins::UserAgent.feature('resource') do @client.describe_db_log_files() end resp.each_page do |page| batch = [] page.data.describe_db_log_files.each do |d| batch << DBLogFile.new( instance_id: @id, name: d.log_file_name, data: d, client: @client ) end y.yield(batch) end end DBLogFile::Collection.new(batches) 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.
737 738 739 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 737 def master_user_secret data[:master_user_secret] end |
#master_username ⇒ String
The master username for the DB instance.
71 72 73 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 71 def master_username data[:master_username] end |
#max_allocated_storage ⇒ Integer
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
546 547 548 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 546 def max_allocated_storage data[:max_allocated_storage] end |
#modify(options = {}) ⇒ DBInstance
3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 3835 def modify( = {}) = .merge(db_instance_identifier: @id) resp = Aws::Plugins::UserAgent.feature('resource') do @client.modify_db_instance() end DBInstance.new( id: resp.data.db_instance.db_instance_identifier, data: resp.data.db_instance, client: @client ) end |
#monitoring_interval ⇒ Integer
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
398 399 400 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 398 def monitoring_interval data[:monitoring_interval] end |
#monitoring_role_arn ⇒ String
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
413 414 415 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 413 def monitoring_role_arn data[:monitoring_role_arn] end |
#multi_az ⇒ Boolean
Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.
180 181 182 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 180 def multi_az data[:multi_az] 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.
270 271 272 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 270 def nchar_character_set_name data[:nchar_character_set_name] 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
701 702 703 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 701 def network_type data[:network_type] end |
#option_group_memberships ⇒ Array<Types::OptionGroupMembership>
The list of option group memberships for this DB instance.
255 256 257 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 255 def option_group_memberships data[:option_group_memberships] end |
#option_groups ⇒ OptionGroup::Collection
4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 4616 def option_groups batch = [] data[:option_group_memberships].each do |d| batch << OptionGroup.new( name: d[:option_group_name], client: @client ) end OptionGroup::Collection.new([batch], size: batch.size) end |
#parameter_groups ⇒ DBParameterGroup::Collection
4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 4628 def parameter_groups batch = [] data[:db_parameter_groups].each do |d| batch << DBParameterGroup.new( name: d[:db_parameter_group_name], client: @client ) end DBParameterGroup::Collection.new([batch], size: batch.size) end |
#pending_maintenance_actions(options = {}) ⇒ PendingMaintenanceAction::Collection
4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 4667 def pending_maintenance_actions( = {}) batches = Enumerator.new do |y| = Aws::Util.deep_merge(, filters: [{ name: "db-instance-id", values: [@id] }]) resp = Aws::Plugins::UserAgent.feature('resource') do @client.describe_pending_maintenance_actions() end resp.each_page do |page| batch = [] page.data.pending_maintenance_actions_0.pending_maintenance_action_details.each do |p| batch << PendingMaintenanceAction.new( target_arn: resp.data.pending_maintenance_actions[0].resource_identifier, name: p.action, data: p, client: @client ) end y.yield(batch) end end PendingMaintenanceAction::Collection.new(batches) 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.
166 167 168 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 166 def pending_modified_values data[:pending_modified_values] end |
#percent_progress ⇒ String
The progress of the storage optimization operation as a percentage.
756 757 758 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 756 def percent_progress data[:percent_progress] end |
#performance_insights_enabled ⇒ Boolean
Indicates whether Performance Insights is enabled for the DB instance.
464 465 466 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 464 def performance_insights_enabled data[:performance_insights_enabled] 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.
474 475 476 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 474 def performance_insights_kms_key_id data[:performance_insights_kms_key_id] 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
492 493 494 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 492 def performance_insights_retention_period data[:performance_insights_retention_period] 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
.
112 113 114 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 112 def preferred_backup_window data[:preferred_backup_window] end |
#preferred_maintenance_window ⇒ String
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
158 159 160 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 158 def preferred_maintenance_window data[:preferred_maintenance_window] 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.
514 515 516 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 514 def processor_features data[:processor_features] end |
#promote(options = {}) ⇒ DBInstance
3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 3890 def promote( = {}) = .merge(db_instance_identifier: @id) resp = Aws::Plugins::UserAgent.feature('resource') do @client.promote_read_replica() end DBInstance.new( id: resp.data.db_instance.db_instance_identifier, data: resp.data.db_instance, client: @client ) 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.
426 427 428 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 426 def promotion_tier data[:promotion_tier] end |
#publicly_accessible ⇒ Boolean
Indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
296 297 298 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 296 def publicly_accessible data[:publicly_accessible] 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.
219 220 221 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 219 def read_replica_db_cluster_identifiers data[:read_replica_db_cluster_identifiers] end |
#read_replica_db_instance_identifiers ⇒ Array<String>
The identifiers of the read replicas associated with this DB instance.
205 206 207 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 205 def read_replica_db_instance_identifiers data[:read_replica_db_instance_identifiers] end |
#read_replica_source_db_cluster_identifier ⇒ String
The identifier of the source DB cluster if this DB instance is a read replica.
750 751 752 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 750 def read_replica_source_db_cluster_identifier data[:read_replica_source_db_cluster_identifier] end |
#read_replica_source_db_instance_identifier ⇒ String
The identifier of the source DB instance if this DB instance is a read replica.
199 200 201 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 199 def read_replica_source_db_instance_identifier data[:read_replica_source_db_instance_identifier] end |
#read_replicas ⇒ DBInstance::Collection
4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 4693 def read_replicas batch = [] data[:read_replica_db_instance_identifiers].each do |d| batch << DBInstance.new( id: d, client: @client ) end DBInstance::Collection.new([batch], size: batch.size) end |
#reboot(options = {}) ⇒ DBInstance
3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 3915 def reboot( = {}) = .merge(db_instance_identifier: @id) resp = Aws::Plugins::UserAgent.feature('resource') do @client.reboot_db_instance() end DBInstance.new( id: resp.data.db_instance.db_instance_identifier, data: resp.data.db_instance, client: @client ) 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.
235 236 237 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 235 def replica_mode data[:replica_mode] end |
#restore(options = {}) ⇒ DBInstance
4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 4415 def restore( = {}) = .merge(source_db_instance_identifier: @id) resp = Aws::Plugins::UserAgent.feature('resource') do @client.restore_db_instance_to_point_in_time() end DBInstance.new( id: resp.data.db_instance.db_instance_identifier, data: resp.data.db_instance, client: @client ) 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.
650 651 652 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 650 def resume_full_automation_mode_time data[:resume_full_automation_mode_time] end |
#secondary_availability_zone ⇒ String
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
277 278 279 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 277 def secondary_availability_zone data[:secondary_availability_zone] end |
#security_groups ⇒ DBSecurityGroup::Collection
4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 4705 def security_groups batch = [] data[:db_security_groups].each do |d| batch << DBSecurityGroup.new( name: d[:db_security_group_name], client: @client ) end DBSecurityGroup::Collection.new([batch], size: batch.size) end |
#snapshots(options = {}) ⇒ DBSnapshot::Collection
4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 4819 def snapshots( = {}) batches = Enumerator.new do |y| = .merge(db_instance_identifier: @id) resp = Aws::Plugins::UserAgent.feature('resource') do @client.describe_db_snapshots() end resp.each_page do |page| batch = [] page.data.db_snapshots.each do |d| batch << DBSnapshot.new( instance_id: [:db_instance_identifier], snapshot_id: d.db_snapshot_identifier, data: d, client: @client ) end y.yield(batch) end end DBSnapshot::Collection.new(batches) end |
#source ⇒ DBInstance?
4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 4842 def source if data[:read_replica_source_db_instance_identifier] DBInstance.new( id: data[:read_replica_source_db_instance_identifier], client: @client ) else nil end 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.
303 304 305 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 303 def status_infos data[:status_infos] end |
#storage_encrypted ⇒ Boolean
Indicates whether the DB instance is encrypted.
337 338 339 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 337 def storage_encrypted data[:storage_encrypted] end |
#storage_throughput ⇒ Integer
The storage throughput for the DB instance.
This setting applies only to the gp3
storage type.
715 716 717 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 715 def storage_throughput data[:storage_throughput] end |
#storage_type ⇒ String
The storage type associated with the DB instance.
309 310 311 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 309 def storage_type data[:storage_type] end |
#subnet_group ⇒ DBSubnetGroup?
4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 4854 def subnet_group if data[:db_subnet_group][:db_subnet_group_name] DBSubnetGroup.new( name: data[:db_subnet_group][:db_subnet_group_name], client: @client ) else nil end end |
#subscribe_to(options = {}) ⇒ EventSubscription
4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 4437 def subscribe_to( = {}) = .merge(source_identifier: @id) resp = Aws::Plugins::UserAgent.feature('resource') do @client.add_source_identifier_to_subscription() end EventSubscription.new( name: resp.data.event_subscription.cust_subscription_id, data: resp.data.event_subscription, client: @client ) end |
#tag_list ⇒ Array<Types::Tag>
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
557 558 559 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 557 def tag_list data[:tag_list] end |
#tde_credential_arn ⇒ String
The ARN from the key store with which the instance is associated for TDE encryption.
316 317 318 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 316 def tde_credential_arn data[:tde_credential_arn] end |
#timezone ⇒ String
The time zone of the DB instance. In most cases, the Timezone
element is empty. Timezone
content appears only for Microsoft SQL
Server DB instances that were created with a time zone specified.
440 441 442 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 440 def timezone data[:timezone] end |
#unsubscribe_from(options = {}) ⇒ EventSubscription
4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 4459 def unsubscribe_from( = {}) = .merge(source_identifier: @id) resp = Aws::Plugins::UserAgent.feature('resource') do @client.remove_source_identifier_from_subscription() end EventSubscription.new( name: resp.data.event_subscription.cust_subscription_id, data: resp.data.event_subscription, client: @client ) end |
#vpc_security_groups ⇒ Array<Types::VpcSecurityGroupMembership>
The list of Amazon EC2 VPC security groups that the DB instance belongs to.
132 133 134 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 132 def vpc_security_groups data[:vpc_security_groups] end |
#wait_until(options = {}) {|resource| ... } ⇒ Resource
Use [Aws::RDS::Client] #wait_until instead
The waiting operation is performed on a copy. The original resource remains unchanged.
Waiter polls an API operation until a resource enters a desired state.
Basic Usage
Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.
# polls in a loop until condition is true
resource.wait_until() {|resource| condition}
Example
instance.wait_until(max_attempts:10, delay:5) do |instance|
instance.state.name == 'running'
end
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:
# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
throw :failure if Time.now - started_at > 3600
end
# disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}
Handling Errors
When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.
begin
resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
attempts attempt in seconds invoked before each attempt invoked before each wait
877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 877 def wait_until( = {}, &block) self_copy = self.dup attempts = 0 [:max_attempts] = 10 unless .key?(:max_attempts) [:delay] ||= 10 [:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == [:max_attempts] :retry end end Aws::Plugins::UserAgent.feature('resource') do Aws::Waiters::Waiter.new().wait({}) end end |