You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::RDS::DBInstance

Inherits:

Object

Object
Aws::RDS::DBInstance

show all

Defined in:: gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb

Defined Under Namespace

Classes: Collection

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^?

Read-Only Attributes collapse

#allocated_storage ⇒ Integer
Specifies the allocated storage size specified in gibibytes.
#associated_roles ⇒ Array<Types::DBInstanceRole>
The AWS Identity and Access Management (IAM) roles associated with the DB instance.
#auto_minor_version_upgrade ⇒ Boolean
Indicates that minor version patches are applied automatically.
#availability_zone ⇒ String
Specifies the name of the Availability Zone the DB instance is located in.
#backup_retention_period ⇒ Integer
Specifies the number of days for which automatic DB snapshots are retained.
#ca_certificate_identifier ⇒ String
The identifier of the CA certificate for this DB instance.
#character_set_name ⇒ String
If present, specifies the name of the character set that this instance is associated with.
#copy_tags_to_snapshot ⇒ Boolean
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
#db_cluster_identifier ⇒ String
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
#db_instance_arn ⇒ String
The Amazon Resource Name (ARN) for the DB instance.
#db_instance_class ⇒ String
Contains the name of the compute and memory capacity class of the DB instance.
#db_instance_port ⇒ Integer
Specifies the port that the DB instance listens on.
#db_instance_status ⇒ String
Specifies the current state of this database.
#db_name ⇒ String
The meaning of this parameter differs according to the database engine you use.
#db_parameter_groups ⇒ Array<Types::DBParameterGroupStatus>
Provides 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
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
#dbi_resource_id ⇒ String
The AWS Region-unique, immutable identifier for the DB instance.
#deletion_protection ⇒ Boolean
Indicates if 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
Specifies the connection endpoint.
#engine ⇒ String
Provides the name of the database engine to be used for this DB instance.
#engine_version ⇒ String
Indicates the database engine version.
#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
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
#id ⇒ String (also: #db_instance_identifier)
#instance_create_time ⇒ Time
Provides the date and time the DB instance was created.
#iops ⇒ Integer
Specifies the Provisioned IOPS (I/O operations per second) value.
#kms_key_id ⇒ String
If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.
#latest_restorable_time ⇒ Time
Specifies the latest time to which a database can be restored with point-in-time restore.
#license_model ⇒ String
License model information for this DB instance.
#listener_endpoint ⇒ Types::Endpoint
Specifies the listener connection endpoint for SQL Server Always On.
#master_username ⇒ String
Contains the master username for the DB instance.
#max_allocated_storage ⇒ Integer
The upper limit 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
Specifies if the DB instance is a Multi-AZ deployment.
#option_group_memberships ⇒ Array<Types::OptionGroupMembership>
Provides the list of option group memberships for this DB instance.
#pending_modified_values ⇒ Types::PendingModifiedValues
Specifies that changes to the DB instance are pending.
#performance_insights_enabled ⇒ Boolean
True if Performance Insights is enabled for the DB instance, and otherwise false.
#performance_insights_kms_key_id ⇒ String
The AWS KMS key identifier for encryption of Performance Insights data.
#performance_insights_retention_period ⇒ Integer
The amount of time, in days, to retain Performance Insights data.
#preferred_backup_window ⇒ String
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
#preferred_maintenance_window ⇒ String
Specifies 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
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.
#publicly_accessible ⇒ Boolean
Specifies the accessibility options for the DB instance.
#read_replica_db_cluster_identifiers ⇒ Array<String>
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a Read Replica.
#read_replica_db_instance_identifiers ⇒ Array<String>
Contains one or more identifiers of the Read Replicas associated with this DB instance.
#read_replica_source_db_instance_identifier ⇒ String
Contains the identifier of the source DB instance if this DB instance is a Read Replica.
#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
Specifies whether the DB instance is encrypted.
#storage_type ⇒ String
Specifies the storage type associated with DB instance.
#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>
Provides a list of VPC security group elements that the DB instance belongs to.

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 = {}, &block) ⇒ 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

Overloads:

#initialize(id, options = {}) ⇒ DBInstance
Parameters:
- id (String)
Options Hash (options):
- :client (Client)
#initialize(options = {}) ⇒ DBInstance
Options Hash (options):
- :id (required, String)
- :client (Client)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 19

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @id = extract_id(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Instance Method Details

#allocated_storage ⇒ `Integer`

Specifies the allocated storage size specified in gibibytes.

Returns:

(Integer)



90
91
92

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 90

def allocated_storage
  data[:allocated_storage]
end

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

The AWS Identity and Access Management (IAM) roles associated with the DB instance.

Returns:

(Array<Types::DBInstanceRole>)



467
468
469

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 467

def associated_roles
  data[:associated_roles]
end

#auto_minor_version_upgrade ⇒ `Boolean`

Indicates that minor version patches are applied automatically.

Returns:

(Boolean)



186
187
188

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 186

def auto_minor_version_upgrade
  data[:auto_minor_version_upgrade]
end

#availability_zone ⇒ `String`

Specifies the name of the Availability Zone the DB instance is located in.

Returns:

(String)



138
139
140

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 138

def availability_zone
  data[:availability_zone]
end

#backup_retention_period ⇒ `Integer`

Specifies the number of days for which automatic DB snapshots are retained.

Returns:

(Integer)



111
112
113

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 111

def backup_retention_period
  data[:backup_retention_period]
end

#ca_certificate_identifier ⇒ `String`

The identifier of the CA certificate for this DB instance.

Returns:

(String)



318
319
320

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 318

def ca_certificate_identifier
  data[:ca_certificate_identifier]
end

#certificate ⇒ `Certificate`^?

Returns:

(Certificate, nil)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 2971

def certificate
  if data[:ca_certificate_identifier]
    Certificate.new(
      id: data[:ca_certificate_identifier],
      client: @client
    )
  else
    nil
  end
end

#character_set_name ⇒ `String`

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

Returns:

(String)



239
240
241

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 239

def character_set_name
  data[:character_set_name]
end

#client ⇒ `Client`

Returns:

(Client)



487
488
489

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 487

def client
  @client
end

#cluster ⇒ `DBCluster`^?

Returns:

(DBCluster, nil)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 2983

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`

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

Amazon Aurora

Not applicable. 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)



338
339
340

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 338

def copy_tags_to_snapshot
  data[:copy_tags_to_snapshot]
end

#create(options = {}) ⇒ `DBInstance`

Examples:

Request syntax with placeholder values


dbinstance = db_instance.create({
  db_name: "String",
  allocated_storage: 1,
  db_instance_class: "String", # required
  engine: "String", # required
  master_username: "String",
  master_user_password: "String",
  db_security_groups: ["String"],
  vpc_security_group_ids: ["String"],
  availability_zone: "String",
  db_subnet_group_name: "String",
  preferred_maintenance_window: "String",
  db_parameter_group_name: "String",
  backup_retention_period: 1,
  preferred_backup_window: "String",
  port: 1,
  multi_az: false,
  engine_version: "String",
  auto_minor_version_upgrade: false,
  license_model: "String",
  iops: 1,
  option_group_name: "String",
  character_set_name: "String",
  publicly_accessible: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  db_cluster_identifier: "String",
  storage_type: "String",
  tde_credential_arn: "String",
  tde_credential_password: "String",
  storage_encrypted: false,
  kms_key_id: "String",
  domain: "String",
  copy_tags_to_snapshot: false,
  monitoring_interval: 1,
  monitoring_role_arn: "String",
  domain_iam_role_name: "String",
  promotion_tier: 1,
  timezone: "String",
  enable_iam_database_authentication: false,
  enable_performance_insights: false,
  performance_insights_kms_key_id: "String",
  performance_insights_retention_period: 1,
  enable_cloudwatch_logs_exports: ["String"],
  processor_features: [
    {
      name: "String",
      value: "String",
    },
  ],
  deletion_protection: false,
  max_allocated_storage: 1,
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:db_name (String) —
The meaning of this parameter differs according to the database engine you use.

MySQL

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:
- Must contain 1 to 64 letters or numbers.
- Can't be a word reserved by the specified database engine
MariaDB

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:
- Must contain 1 to 64 letters or numbers.
- Can't be a word reserved by the specified database engine
PostgreSQL

The name of the database to create when the DB instance is created. If this parameter isn't specified, the default "postgres" database is created in the DB instance.

Constraints:
- Must contain 1 to 63 letters, numbers, or underscores.
- Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).
- Can't be a word reserved by the specified database engine
Oracle

The Oracle System ID (SID) of the created DB instance. If you specify null, the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName.

Default: ORCL

Constraints:
- Can't be longer than 8 characters
^

SQL Server

Not applicable. Must be null.

Amazon Aurora

The name of the database to create when the primary instance of the DB cluster is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:
- Must contain 1 to 64 letters or numbers.
- Can't be a word reserved by the specified database engine
:allocated_storage (Integer) —
The amount of storage (in gibibytes) to allocate for the DB instance.

Type: Integer

Amazon Aurora

Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.

MySQL

Constraints to the amount of storage for each storage type are the following:
- General Purpose (SSD) storage (gp2): Must be an integer from 20 to
- Provisioned IOPS storage (io1): Must be an integer from 100 to
- Magnetic storage (standard): Must be an integer from 5 to 3072.
MariaDB

Constraints to the amount of storage for each storage type are the following:
- General Purpose (SSD) storage (gp2): Must be an integer from 20 to
- Provisioned IOPS storage (io1): Must be an integer from 100 to
- Magnetic storage (standard): Must be an integer from 5 to 3072.
PostgreSQL

Constraints to the amount of storage for each storage type are the following:
- General Purpose (SSD) storage (gp2): Must be an integer from 20 to
- Provisioned IOPS storage (io1): Must be an integer from 100 to
- Magnetic storage (standard): Must be an integer from 5 to 3072.
Oracle

Constraints to the amount of storage for each storage type are the following:
- General Purpose (SSD) storage (gp2): Must be an integer from 20 to
- Provisioned IOPS storage (io1): Must be an integer from 100 to
- Magnetic storage (standard): Must be an integer from 10 to 3072.
SQL Server

Constraints to the amount of storage for each storage type are the following:
- General Purpose (SSD) storage (gp2):
  - Enterprise and Standard editions: Must be an integer from 200 to
  - Web and Express editions: Must be an integer from 20 to 16384.
- Provisioned IOPS storage (io1):
  - Enterprise and Standard editions: Must be an integer from 200 to
  - Web and Express editions: Must be an integer from 100 to 16384.
- Magnetic storage (standard):
  - Enterprise and Standard editions: Must be an integer from 200 to
  - Web and Express editions: Must be an integer from 20 to 1024.
:db_instance_class (required, String) —
The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
:engine (required, String) —
The name of the database engine to be used for this instance.

Not every database engine is available for every AWS Region.

Valid Values:
- aurora (for MySQL 5.6-compatible Aurora)
- aurora-mysql (for MySQL 5.7-compatible Aurora)
- aurora-postgresql
- mariadb
- mysql
- oracle-ee
- oracle-se2
- oracle-se1
- oracle-se
- postgres
- sqlserver-ee
- sqlserver-se
- sqlserver-ex
- sqlserver-web
:master_username (String) —
The name for the master user.

Amazon Aurora

Not applicable. The name for the master user is managed by the DB cluster.

MariaDB

Constraints:
- Required for MariaDB.
- Must be 1 to 16 letters or numbers.
- Can't be a reserved word for the chosen database engine.
Microsoft SQL Server

Constraints:
- Required for SQL Server.
- Must be 1 to 128 letters or numbers.
- The first character must be a letter.
- Can't be a reserved word for the chosen database engine.
MySQL

Constraints:
- Required for MySQL.
- Must be 1 to 16 letters or numbers.
- First character must be a letter.
- Can't be a reserved word for the chosen database engine.
Oracle

Constraints:
- Required for Oracle.
- Must be 1 to 30 letters or numbers.
- First character must be a letter.
- Can't be a reserved word for the chosen database engine.
PostgreSQL

Constraints:
- Required for PostgreSQL.
- Must be 1 to 63 letters or numbers.
- First character must be a letter.
- Can't be a reserved word for the chosen database engine.
:master_user_password (String) —
The password for the master user. The password can include any printable ASCII character except "/", """, or "@".

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster.

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.
:db_security_groups (Array<String>) —
A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.
:vpc_security_group_ids (Array<String>) —
A list of Amazon EC2 VPC security groups to associate with this DB instance.

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster.

Default: The default EC2 VPC security group for the DB subnet group's VPC.
:availability_zone (String) —
The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint.

If you're creating a DB instance in an RDS on VMware environment, specify the identifier of the custom Availability Zone to create the DB instance in.

For more information about RDS on VMware, see the RDS on VMware User Guide.
:db_subnet_group_name (String) —
A DB subnet group to associate with this DB instance.

If there is no DB subnet group, then it is a non-VPC DB instance.
:preferred_maintenance_window (String) —
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window.

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.
:db_parameter_group_name (String) —
The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then the default DB parameter group for the specified DB engine and version is used.

Constraints:
- Must be 1 to 255 letters, numbers, or hyphens.
- First character must be a letter
- Can't end with a hyphen or contain two consecutive hyphens
:backup_retention_period (Integer) —
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Amazon Aurora

Not applicable. The retention period for automated backups is managed by the DB cluster.

Default: 1

Constraints:
- Must be a value from 0 to 35
- Can't be set to 0 if the DB instance is a source to Read Replicas
:preferred_backup_window (String) —
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see The Backup Window in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide.

Constraints:
- Must be in the format hh24:mi-hh24:mi.
- Must be in Universal Coordinated Time (UTC).
- Must not conflict with the preferred maintenance window.
- Must be at least 30 minutes.
:port (Integer) —
The port number on which the database accepts connections.

MySQL

Default: 3306

Valid Values: 1150-65535

Type: Integer

MariaDB

Default: 3306

Valid Values: 1150-65535

Type: Integer

PostgreSQL

Default: 5432

Valid Values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid Values: 1150-65535

SQL Server

Default: 1433

Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.

Amazon Aurora

Default: 3306

Valid Values: 1150-65535

Type: Integer
:multi_az (Boolean) —
A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
:engine_version (String) —
The version number of the database engine to use.

For a list of valid engine versions, use the DescribeDBEngineVersions action.

The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.

Amazon Aurora

Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.

MariaDB

See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.

Microsoft SQL Server

See Version and Feature Support on Amazon RDS in the Amazon RDS User Guide.

MySQL

See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.

Oracle

See Oracle Database Engine Release Notes in the Amazon RDS User Guide.

PostgreSQL

See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.
:auto_minor_version_upgrade (Boolean) —
A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
:license_model (String) —
License model information for this DB instance.

Valid values: license-included | bring-your-own-license | general-public-license
:iops (Integer) —
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.
:option_group_name (String) —
Indicates that the DB instance should be associated with the specified option group.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
:character_set_name (String) —
For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.

Amazon Aurora

Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.
:publicly_accessible (Boolean) —
A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn't publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
- If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private.
- If the default VPC in the target region has an Internet gateway attached to it, the DB instance is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
- If the subnets are part of a VPC that doesn’t have an Internet gateway attached to it, the DB instance is private.
- If the subnets are part of a VPC that has an Internet gateway attached to it, the DB instance is public.
:tags (Array<Types::Tag>) —
Tags to assign to the DB instance.
:db_cluster_identifier (String) —
The identifier of the DB cluster that the instance will belong to.
:storage_type (String) —
Specifies the storage type to be associated with the DB instance.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise gp2
:tde_credential_arn (String) —
The ARN from the key store with which to associate the instance for TDE encryption.
:tde_credential_password (String) —
The password for the given ARN from the key store in order to access the device.
:storage_encrypted (Boolean) —
A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.

Amazon Aurora

Not applicable. The encryption for DB instances is managed by the DB cluster.
:kms_key_id (String) —
The AWS KMS key identifier for an encrypted DB instance.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

Amazon Aurora

Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.

If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
:domain (String) —
The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain.

For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.

For Oracle DB instance, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.
:copy_tags_to_snapshot (Boolean) —
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

Amazon Aurora

Not applicable. 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.
:monitoring_interval (Integer) —
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60
:monitoring_role_arn (String) —
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
:domain_iam_role_name (String) —
Specify the name of the IAM role to be used when making API calls to the Directory Service.
:promotion_tier (Integer) —
A value that specifies the order 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.

Default: 1

Valid Values: 0 - 15
:timezone (String) —
The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
:enable_iam_database_authentication (Boolean) —
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

You can enable IAM database authentication for the following database engines:

Amazon Aurora

Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.

MySQL
- For MySQL 5.6, minor version 5.6.34 or higher
- For MySQL 5.7, minor version 5.7.16 or higher
- For MySQL 8.0, minor version 8.0.16 or higher
PostgreSQL
- For PostgreSQL 9.5, minor version 9.5.15 or higher
- For PostgreSQL 9.6, minor version 9.6.11 or higher
- PostgreSQL 10.6, 10.7, and 10.9
For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
:enable_performance_insights (Boolean) —
A value that indicates whether to enable Performance Insights for the DB instance.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
:performance_insights_kms_key_id (String) —
The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
:performance_insights_retention_period (Integer) —
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
:enable_cloudwatch_logs_exports (Array<String>) —
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide.
: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.
:deletion_protection (Boolean) —
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.

Amazon Aurora

Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see CreateDBCluster. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
:max_allocated_storage (Integer) —
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

Returns:

(DBInstance)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 1472

def create(options = {})
  options = options.merge(db_instance_identifier: @id)
  resp = @client.create_db_instance(options)
  DBInstance.new(
    id: resp.data.db_instance.db_instance_identifier,
    data: resp.data.db_instance,
    client: @client
  )
end

#create_read_replica(options = {}) ⇒ `DBInstance`

Examples:

Request syntax with placeholder values


dbinstance = db_instance.create_read_replica({
  db_instance_identifier: "String", # required
  db_instance_class: "String",
  availability_zone: "String",
  port: 1,
  multi_az: false,
  auto_minor_version_upgrade: false,
  iops: 1,
  option_group_name: "String",
  db_parameter_group_name: "String",
  publicly_accessible: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  db_subnet_group_name: "String",
  vpc_security_group_ids: ["String"],
  storage_type: "String",
  copy_tags_to_snapshot: false,
  monitoring_interval: 1,
  monitoring_role_arn: "String",
  kms_key_id: "String",
  pre_signed_url: "String",
  enable_iam_database_authentication: false,
  enable_performance_insights: false,
  performance_insights_kms_key_id: "String",
  performance_insights_retention_period: 1,
  enable_cloudwatch_logs_exports: ["String"],
  processor_features: [
    {
      name: "String",
      value: "String",
    },
  ],
  use_default_processor_features: false,
  deletion_protection: false,
  domain: "String",
  domain_iam_role_name: "String",
  source_region: "String",
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:db_instance_identifier (required, String) —
The DB instance identifier of the Read Replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.
:db_instance_class (String) —
The compute and memory capacity of the Read Replica, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Default: Inherits from the source DB instance.
:availability_zone (String) —
The Availability Zone (AZ) where the Read Replica will be created.

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

Example: us-east-1d
:port (Integer) —
The port number that the DB instance uses for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535
:multi_az (Boolean) —
A value that indicates whether the Read Replica is in a Multi-AZ deployment.

You can create a Read Replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your Read Replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.
:auto_minor_version_upgrade (Boolean) —
A value that indicates whether minor engine upgrades are applied automatically to the Read Replica during the maintenance window.

Default: Inherits from the source DB instance
:iops (Integer) —
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
:option_group_name (String) —
The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.
:db_parameter_group_name (String) —
The name of the DB parameter group to associate with this DB instance.

If you do not specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of source DB instance for a same region Read Replica, or the default DBParameterGroup for the specified DB engine for a cross region Read Replica.

Currently, specifying a parameter group for this operation is only supported for Oracle DB instances.

Constraints:
- Must be 1 to 255 letters, numbers, or hyphens.
- First character must be a letter
- Can't end with a hyphen or contain two consecutive hyphens
:publicly_accessible (Boolean) —
A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn't publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.
:tags (Array<Types::Tag>) —
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
:db_subnet_group_name (String) —
Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.

Constraints:
- Can only be specified if the source DB instance identifier specifies a DB instance in another AWS Region.
- If supplied, must match the name of an existing DBSubnetGroup.
- The specified DB subnet group must be in the same AWS Region in which the operation is running.
- All Read Replicas in one AWS Region that are created from the same source DB instance must either:>
  - Specify DB subnet groups from the same VPC. All these Read Replicas are created in the same VPC.
  - Not specify a DB subnet group. All these Read Replicas are created outside of any VPC.
Example: mySubnetgroup
:vpc_security_group_ids (Array<String>) —
A list of EC2 VPC security groups to associate with the Read Replica.

Default: The default EC2 VPC security group for the DB subnet group's VPC.
:storage_type (String) —
Specifies the storage type to be associated with the Read Replica.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise gp2
:copy_tags_to_snapshot (Boolean) —
A value that indicates whether to copy all tags from the Read Replica to snapshots of the Read Replica. By default, tags are not copied.
:monitoring_interval (Integer) —
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60
:monitoring_role_arn (String) —
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
:kms_key_id (String) —
The AWS KMS key ID for an encrypted Read Replica. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you create an encrypted Read Replica in the same AWS Region as the source DB instance, then you do not have to specify a value for this parameter. The Read Replica is encrypted with the same KMS key as the source DB instance.

If you create an encrypted Read Replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.

You can't create an encrypted Read Replica from an unencrypted DB instance.
:pre_signed_url (String) —
The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source AWS Region that contains the source DB instance.

You must specify this parameter when you create an encrypted Read Replica from another AWS Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted Read Replica in the same AWS Region.

The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source AWS Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:
- DestinationRegion - The AWS Region that the encrypted Read Replica is created in. This AWS Region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL.
  
  For example, if you create an encrypted DB instance in the us-west-1 AWS Region, from a source DB instance in the us-east-2 AWS Region, then you call the CreateDBInstanceReadReplica action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.
- KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the Read Replica in the destination AWS Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination AWS Region, and the action contained in the presigned URL.
- SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 AWS Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region.
:enable_iam_database_authentication (Boolean) —
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance.

For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
:enable_performance_insights (Boolean) —
A value that indicates whether to enable Performance Insights for the Read Replica.

For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
:performance_insights_kms_key_id (String) —
The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
:performance_insights_retention_period (Integer) —
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
:enable_cloudwatch_logs_exports (Array<String>) —
The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
: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.
:use_default_processor_features (Boolean) —
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
:deletion_protection (Boolean) —
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
:domain (String) —
The Active Directory directory ID to create the DB instance in.

For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.
:domain_iam_role_name (String) —
Specify the name of the IAM role to be used when making API calls to the Directory Service.
:destination_region (String)
:source_region (String) —
The source region of the snapshot. This is only needed when the shapshot is encrypted and in a different region.

Returns:

(DBInstance)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 1829

def create_read_replica(options = {})
  options = options.merge(source_db_instance_identifier: @id)
  resp = @client.create_db_instance_read_replica(options)
  DBInstance.new(
    id: resp.data.db_instance.db_instance_identifier,
    data: resp.data.db_instance,
    client: @client
  )
end

#create_snapshot(options = {}) ⇒ `DBSnapshot`

Examples:

Request syntax with placeholder values


dbsnapshot = db_instance.create_snapshot({
  db_snapshot_identifier: "String", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:db_snapshot_identifier (required, String) —
The identifier for the DB snapshot.

Constraints:
- Can't be null, empty, or blank
- Must contain from 1 to 255 letters, numbers, or hyphens
- First character must be a letter
- Can't end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
:tags (Array<Types::Tag>) —
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

Returns:

(DBSnapshot)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 1873

def create_snapshot(options = {})
  options = options.merge(db_instance_identifier: @id)
  resp = @client.create_db_snapshot(options)
  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

#data ⇒ `Types::DBInstance`

Returns the data for this Aws::RDS::DBInstance. Calls Client#describe_db_instances if #data_loaded? is false.

Returns:

(Types::DBInstance) —
Returns the data for this Aws::RDS::DBInstance. Calls Client#describe_db_instances if #data_loaded? is false.

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 507

def data
  load unless @data
  @data
end

#data_loaded? ⇒ `Boolean`

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

(Boolean) —
Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



515
516
517

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 515

def data_loaded?
  !!@data
end

#db_cluster_identifier ⇒ `String`

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

Returns:

(String)



291
292
293

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 291

def db_cluster_identifier
  data[:db_cluster_identifier]
end

#db_instance_arn ⇒ `String`

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

Returns:

(String)



379
380
381

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 379

def db_instance_arn
  data[:db_instance_arn]
end

#db_instance_class ⇒ `String`

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

Returns:

(String)



38
39
40

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 38

def db_instance_class
  data[:db_instance_class]
end

#db_instance_port ⇒ `Integer`

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

Returns:

(Integer)



284
285
286

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 284

def db_instance_port
  data[:db_instance_port]
end

#db_instance_status ⇒ `String`

Specifies the current state of this database.

Returns:

(String)



51
52
53

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 51

def db_instance_status
  data[:db_instance_status]
end

#db_name ⇒ `String`

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

MySQL, MariaDB, SQL Server, PostgreSQL

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

Type: String

Oracle

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

Returns:

(String)



78
79
80

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 78

def db_name
  data[:db_name]
end

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

Provides the list of DB parameter groups applied to this DB instance.

Returns:

(Array<Types::DBParameterGroupStatus>)



131
132
133

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 131

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.

Returns:

(Array<Types::DBSecurityGroupMembership>)



118
119
120

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 118

def db_security_groups
  data[:db_security_groups]
end

#db_subnet_group ⇒ `Types::DBSubnetGroup`

Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

Returns:

(Types::DBSubnetGroup)



146
147
148

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 146

def db_subnet_group
  data[:db_subnet_group]
end

#dbi_resource_id ⇒ `String`

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

Returns:

(String)



312
313
314

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 312

def dbi_resource_id
  data[:dbi_resource_id]
end

#delete(options = {}) ⇒ `DBInstance`

Examples:

Request syntax with placeholder values


dbinstance = db_instance.delete({
  skip_final_snapshot: false,
  final_db_snapshot_identifier: "String",
  delete_automated_backups: false,
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:skip_final_snapshot (Boolean) —
A value that indicates whether to skip the creation of a final DB snapshot before the DB instance is deleted. If skip is specified, no DB snapshot is created. If skip isn't specified, a DB snapshot is created before the DB instance is deleted. By default, skip isn't specified, and the DB snapshot is created.

Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when skip is specified.

Specify skip when deleting a Read Replica.

The FinalDBSnapshotIdentifier parameter must be specified if skip isn't specified.
:final_db_snapshot_identifier (String) —
The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error.

Constraints:
- Must be 1 to 255 letters or numbers.
- First character must be a letter.
- Can't end with a hyphen or contain two consecutive hyphens.
- Can't be specified when deleting a Read Replica.
:delete_automated_backups (Boolean) —
A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.

Returns:

(DBInstance)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 1933

def delete(options = {})
  options = options.merge(db_instance_identifier: @id)
  resp = @client.delete_db_instance(options)
  DBInstance.new(
    id: resp.data.db_instance.db_instance_identifier,
    data: resp.data.db_instance,
    client: @client
  )
end

#deletion_protection ⇒ `Boolean`

Indicates if 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.

Returns:

(Boolean)



460
461
462

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 460

def deletion_protection
  data[:deletion_protection]
end

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

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

Returns:

(Array<Types::DomainMembership>)



325
326
327

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 325

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 Amazon RDS Database Log Files in the Amazon RDS User Guide.

Returns:

(Array<String>)



441
442
443

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 441

def enabled_cloudwatch_logs_exports
  data[:enabled_cloudwatch_logs_exports]
end

#endpoint ⇒ `Types::Endpoint`

Specifies the connection endpoint.

Returns:

(Types::Endpoint)



84
85
86

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 84

def endpoint
  data[:endpoint]
end

#engine ⇒ `String`

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

Returns:

(String)



45
46
47

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 45

def engine
  data[:engine]
end

#engine_version ⇒ `String`

Indicates the database engine version.

Returns:

(String)



180
181
182

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 180

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.

Returns:

(String)



353
354
355

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 353

def enhanced_monitoring_resource_arn
  data[:enhanced_monitoring_resource_arn]
end

#events(options = {}) ⇒ `Event::Collection`

Examples:

Request syntax with placeholder values


events = db_instance.events({
  start_time: Time.now,
  end_time: Time.now,
  duration: 1,
  event_categories: ["String"],
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:start_time (Time, DateTime, Date, Integer, String) —
The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z
:end_time (Time, DateTime, Date, Integer, String) —
The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z
:duration (Integer) —
The number of minutes to retrieve events for.

Default: 60
:event_categories (Array<String>) —
A list of event categories that trigger notifications for a event notification subscription.
:filters (Array<Types::Filter>) —
This parameter isn't currently supported.

Returns:

(Event::Collection)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 3039

def events(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(
      source_type: "db-instance",
      source_identifier: @id
    )
    resp = @client.describe_events(options)
    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`

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

IAM database authentication can be enabled for the following database engines

For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

Returns:

(Boolean)



404
405
406

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 404

def iam_database_authentication_enabled
  data[:iam_database_authentication_enabled]
end

#id ⇒ `String` Also known as: db_instance_identifier

Returns:

(String)



30
31
32

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 30

def id
  @id
end

#instance_create_time ⇒ `Time`

Provides the date and time the DB instance was created.

Returns:

(Time)



96
97
98

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 96

def instance_create_time
  data[:instance_create_time]
end

#iops ⇒ `Integer`

Specifies the Provisioned IOPS (I/O operations per second) value.

Returns:

(Integer)



226
227
228

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 226

def iops
  data[:iops]
end

#kms_key_id ⇒ `String`

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

Returns:

(String)



304
305
306

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 304

def kms_key_id
  data[:kms_key_id]
end

#latest_restorable_time ⇒ `Time`

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

Returns:

(Time)



168
169
170

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 168

def latest_restorable_time
  data[:latest_restorable_time]
end

#license_model ⇒ `String`

License model information for this DB instance.

Returns:

(String)



220
221
222

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 220

def license_model
  data[:license_model]
end

#listener_endpoint ⇒ `Types::Endpoint`

Specifies the listener connection endpoint for SQL Server Always On.

Returns:

(Types::Endpoint)



473
474
475

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 473

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

Returns:

(self)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 497

def load
  resp = @client.describe_db_instances(db_instance_identifier: @id)
  @data = resp.db_instances[0]
  self
end

#log_files(options = {}) ⇒ `DBLogFile::Collection`

Examples:

Request syntax with placeholder values


log_files = db_instance.log_files({
  filename_contains: "String",
  file_last_written: 1,
  file_size: 1,
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:filename_contains (String) —
Filters the available log files for log file names that contain the specified string.
:file_last_written (Integer) —
Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.
:file_size (Integer) —
Filters the available log files for files larger than the specified size.
:filters (Array<Types::Filter>) —
This parameter isn't currently supported.

Returns:

(DBLogFile::Collection)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 3088

def log_files(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(db_instance_identifier: @id)
    resp = @client.describe_db_log_files(options)
    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_username ⇒ `String`

Contains the master username for the DB instance.

Returns:

(String)



57
58
59

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 57

def master_username
  data[:master_username]
end

#max_allocated_storage ⇒ `Integer`

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

Returns:

(Integer)



480
481
482

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 480

def max_allocated_storage
  data[:max_allocated_storage]
end

#modify(options = {}) ⇒ `DBInstance`

Examples:

Request syntax with placeholder values


dbinstance = db_instance.modify({
  allocated_storage: 1,
  db_instance_class: "String",
  db_subnet_group_name: "String",
  db_security_groups: ["String"],
  vpc_security_group_ids: ["String"],
  apply_immediately: false,
  master_user_password: "String",
  db_parameter_group_name: "String",
  backup_retention_period: 1,
  preferred_backup_window: "String",
  preferred_maintenance_window: "String",
  multi_az: false,
  engine_version: "String",
  allow_major_version_upgrade: false,
  auto_minor_version_upgrade: false,
  license_model: "String",
  iops: 1,
  option_group_name: "String",
  new_db_instance_identifier: "String",
  storage_type: "String",
  tde_credential_arn: "String",
  tde_credential_password: "String",
  ca_certificate_identifier: "String",
  domain: "String",
  copy_tags_to_snapshot: false,
  monitoring_interval: 1,
  db_port_number: 1,
  publicly_accessible: false,
  monitoring_role_arn: "String",
  domain_iam_role_name: "String",
  promotion_tier: 1,
  enable_iam_database_authentication: false,
  enable_performance_insights: false,
  performance_insights_kms_key_id: "String",
  performance_insights_retention_period: 1,
  cloudwatch_logs_export_configuration: {
    enable_log_types: ["String"],
    disable_log_types: ["String"],
  },
  processor_features: [
    {
      name: "String",
      value: "String",
    },
  ],
  use_default_processor_features: false,
  deletion_protection: false,
  max_allocated_storage: 1,
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:allocated_storage (Integer) —
The new amount of storage (in gibibytes) to allocate for the DB instance.

For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

For the valid values for allocated storage for each engine, see CreateDBInstance.
:db_instance_class (String) —
The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is enabled for this request.

Default: Uses existing setting
:db_subnet_group_name (String) —
The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Updating the VPC for a DB Instance in the Amazon RDS User Guide.

Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable ApplyImmediately.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetGroup
:db_security_groups (Array<String>) —
A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.

Constraints:
- If supplied, must match existing DBSecurityGroups.
^
:vpc_security_group_ids (Array<String>) —
A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

Amazon Aurora

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:
- If supplied, must match existing VpcSecurityGroupIds.
^
:apply_immediately (Boolean) —
A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.

If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance in the Amazon RDS User Guide. to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to determine when the changes are applied.
:master_user_password (String) —
The new password for the master user. The password can include any printable ASCII character except "/", """, or "@".

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
:db_parameter_group_name (String) —
The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. In this case, the DB instance isn't rebooted automatically and the parameter changes isn't applied during the next maintenance window.

Default: Uses existing setting

Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
:backup_retention_period (Integer) —
The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

Amazon Aurora

Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

Constraints:
- Must be a value from 0 to 35
- Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6 or later
- Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5
- Can't be set to 0 if the DB instance is a source to Read Replicas
:preferred_backup_window (String) —
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:
- Must be in the format hh24:mi-hh24:mi
- Must be in Universal Time Coordinated (UTC)
- Must not conflict with the preferred maintenance window
- Must be at least 30 minutes
:preferred_maintenance_window (String) —
The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

Default: Uses existing setting

Format: ddd:hh24:mi-ddd:hh24:mi

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes
:multi_az (Boolean) —
A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.
:engine_version (String) —
The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is eanbled for this request.

For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.
:allow_major_version_upgrade (Boolean) —
A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
:auto_minor_version_upgrade (Boolean) —
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage results if this parameter is enabled during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.
:license_model (String) —
The license model for the DB instance.

Valid values: license-included | bring-your-own-license | general-public-license
:iops (Integer) —
The new Provisioned IOPS (I/O operations per second) value for the RDS instance.

Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Default: Uses existing setting
:option_group_name (String) —
Indicates that the DB instance should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
:new_db_instance_identifier (String) —
The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.

Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens.
- The first character must be a letter.
- Can't end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
:storage_type (String) —
Specifies the storage type to be associated with the DB instance.

If you specify Provisioned IOPS (io1), you must also include a value for the Iops parameter.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.

Valid values: standard | gp2 | io1

Default: io1 if the Iops parameter is specified, otherwise gp2
:tde_credential_arn (String) —
The ARN from the key store with which to associate the instance for TDE encryption.
:tde_credential_password (String) —
The password for the given ARN from the key store in order to access the device.
:ca_certificate_identifier (String) —
Indicates the certificate that needs to be associated with the instance.
:domain (String) —
The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. The domain must be created prior to this operation. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain.

For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.

For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.
:copy_tags_to_snapshot (Boolean) —
A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

Amazon Aurora

Not applicable. 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 ModifyDBCluster.
:monitoring_interval (Integer) —
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60
:db_port_number (Integer) —
The port number on which the database accepts connections.

The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.

Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.

MySQL

Default: 3306

Valid Values: 1150-65535

MariaDB

Default: 3306

Valid Values: 1150-65535

PostgreSQL

Default: 5432

Valid Values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid Values: 1150-65535

SQL Server

Default: 1433

Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.

Amazon Aurora

Default: 3306

Valid Values: 1150-65535
:publicly_accessible (Boolean) —
A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn't publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address.

PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.

Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.
:monitoring_role_arn (String) —
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
:domain_iam_role_name (String) —
The name of the IAM role to use when making API calls to the Directory Service.
:promotion_tier (Integer) —
A value that specifies the order 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.

Default: 1

Valid Values: 0 - 15
:enable_iam_database_authentication (Boolean) —
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance.

For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
:enable_performance_insights (Boolean) —
A value that indicates whether to enable Performance Insights for the DB instance.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
:performance_insights_kms_key_id (String) —
The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
:performance_insights_retention_period (Integer) —
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
:cloudwatch_logs_export_configuration (Types::CloudwatchLogsExportConfiguration) —
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.

A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect.
: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.
:use_default_processor_features (Boolean) —
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
:deletion_protection (Boolean) —
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
:max_allocated_storage (Integer) —
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

Returns:

(DBInstance)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 2536

def modify(options = {})
  options = options.merge(db_instance_identifier: @id)
  resp = @client.modify_db_instance(options)
  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.

Returns:

(Integer)



345
346
347

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 345

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.

Returns:

(String)



360
361
362

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 360

def monitoring_role_arn
  data[:monitoring_role_arn]
end

#multi_az ⇒ `Boolean`

Specifies if the DB instance is a Multi-AZ deployment.

Returns:

(Boolean)



174
175
176

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 174

def multi_az
  data[:multi_az]
end

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

Provides the list of option group memberships for this DB instance.

Returns:

(Array<Types::OptionGroupMembership>)



232
233
234

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 232

def option_group_memberships
  data[:option_group_memberships]
end

#option_groups ⇒ `OptionGroup::Collection`

Returns:

(OptionGroup::Collection)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 3109

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`

Returns:

(DBParameterGroup::Collection)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 3121

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`

Examples:

Request syntax with placeholder values


pending_maintenance_actions = db_instance.pending_maintenance_actions({
  resource_identifier: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  marker: "String",
  max_records: 1,
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:resource_identifier (String) —
The ARN of a resource to return pending maintenance actions for.
:filters (Array<Types::Filter>) —
A filter that specifies one or more resources to return pending maintenance actions for.

Supported filters:
- db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include pending maintenance actions for the DB clusters identified by these ARNs.
- db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list will only include pending maintenance actions for the DB instances identified by these ARNs.
:marker (String) —
An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.
:max_records (Integer) —
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

(PendingMaintenanceAction::Collection)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 3177

def pending_maintenance_actions(options = {})
  batches = Enumerator.new do |y|
    batch = []
    options = Aws::Util.deep_merge(options, filters: [{
      name: "db-instance-id",
      values: [@id]
    }])
    resp = @client.describe_pending_maintenance_actions(options)
    resp.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
  PendingMaintenanceAction::Collection.new(batches)
end

#pending_modified_values ⇒ `Types::PendingModifiedValues`

Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

Returns:

(Types::PendingModifiedValues)



161
162
163

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 161

def pending_modified_values
  data[:pending_modified_values]
end

#performance_insights_enabled ⇒ `Boolean`

True if Performance Insights is enabled for the DB instance, and otherwise false.

Returns:

(Boolean)



411
412
413

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 411

def performance_insights_enabled
  data[:performance_insights_enabled]
end

#performance_insights_kms_key_id ⇒ `String`

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

Returns:

(String)



419
420
421

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 419

def performance_insights_kms_key_id
  data[:performance_insights_kms_key_id]
end

#performance_insights_retention_period ⇒ `Integer`

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

Returns:

(Integer)



426
427
428

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 426

def performance_insights_retention_period
  data[:performance_insights_retention_period]
end

#preferred_backup_window ⇒ `String`

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

Returns:

(String)



104
105
106

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 104

def preferred_backup_window
  data[:preferred_backup_window]
end

#preferred_maintenance_window ⇒ `String`

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

Returns:

(String)



153
154
155

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 153

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.

Returns:

(Array<Types::ProcessorFeature>)



448
449
450

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 448

def processor_features
  data[:processor_features]
end

#promote(options = {}) ⇒ `DBInstance`

Examples:

Request syntax with placeholder values


dbinstance = db_instance.promote({
  backup_retention_period: 1,
  preferred_backup_window: "String",
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:backup_retention_period (Integer) —
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:
- Must be a value from 0 to 35.
- Can't be set to 0 if the DB instance is a source to Read Replicas.
:preferred_backup_window (String) —
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:
- Must be in the format hh24:mi-hh24:mi.
- Must be in Universal Coordinated Time (UTC).
- Must not conflict with the preferred maintenance window.
- Must be at least 30 minutes.

Returns:

(DBInstance)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 2589

def promote(options = {})
  options = options.merge(db_instance_identifier: @id)
  resp = @client.promote_read_replica(options)
  DBInstance.new(
    id: resp.data.db_instance.db_instance_identifier,
    data: resp.data.db_instance,
    client: @client
  )
end

#promotion_tier ⇒ `Integer`

A value that specifies the order 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.

Returns:

(Integer)



373
374
375

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 373

def promotion_tier
  data[:promotion_tier]
end

#publicly_accessible ⇒ `Boolean`

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Returns:

(Boolean)



256
257
258

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 256

def publicly_accessible
  data[:publicly_accessible]
end

#read_replica_db_cluster_identifiers ⇒ `Array<String>`

Contains one or more 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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora Read Replica is shown. This output does not contain information about cross region Aurora Read Replicas.

Currently, each RDS DB instance can have only one Aurora Read Replica.

Returns:

(Array<String>)



214
215
216

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 214

def read_replica_db_cluster_identifiers
  data[:read_replica_db_cluster_identifiers]
end

#read_replica_db_instance_identifiers ⇒ `Array<String>`

Contains one or more identifiers of the Read Replicas associated with this DB instance.

Returns:

(Array<String>)



200
201
202

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 200

def read_replica_db_instance_identifiers
  data[:read_replica_db_instance_identifiers]
end

#read_replica_source_db_instance_identifier ⇒ `String`

Contains the identifier of the source DB instance if this DB instance is a Read Replica.

Returns:

(String)



193
194
195

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 193

def read_replica_source_db_instance_identifier
  data[:read_replica_source_db_instance_identifier]
end

#read_replicas ⇒ `DBInstance::Collection`

Returns:

(DBInstance::Collection)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 3199

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`

Examples:

Request syntax with placeholder values


dbinstance = db_instance.reboot({
  force_failover: false,
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:force_failover (Boolean) —
A value that indicates whether the reboot is conducted through a Multi-AZ failover.

Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.

Returns:

(DBInstance)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 2612

def reboot(options = {})
  options = options.merge(db_instance_identifier: @id)
  resp = @client.reboot_db_instance(options)
  DBInstance.new(
    id: resp.data.db_instance.db_instance_identifier,
    data: resp.data.db_instance,
    client: @client
  )
end

#restore(options = {}) ⇒ `DBInstance`

Examples:

Request syntax with placeholder values


dbinstance = db_instance.restore({
  target_db_instance_identifier: "String", # required
  restore_time: Time.now,
  use_latest_restorable_time: false,
  db_instance_class: "String",
  port: 1,
  availability_zone: "String",
  db_subnet_group_name: "String",
  multi_az: false,
  publicly_accessible: false,
  auto_minor_version_upgrade: false,
  license_model: "String",
  db_name: "String",
  engine: "String",
  iops: 1,
  option_group_name: "String",
  copy_tags_to_snapshot: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  storage_type: "String",
  tde_credential_arn: "String",
  tde_credential_password: "String",
  vpc_security_group_ids: ["String"],
  domain: "String",
  domain_iam_role_name: "String",
  enable_iam_database_authentication: false,
  enable_cloudwatch_logs_exports: ["String"],
  processor_features: [
    {
      name: "String",
      value: "String",
    },
  ],
  use_default_processor_features: false,
  db_parameter_group_name: "String",
  deletion_protection: false,
  source_dbi_resource_id: "String",
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:target_db_instance_identifier (required, String) —
The name of the new DB instance to be created.

Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens
- First character must be a letter
- Can't end with a hyphen or contain two consecutive hyphens
:restore_time (Time, DateTime, Date, Integer, String) —
The date and time to restore from.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:
- Must be before the latest restorable time for the DB instance
- Can't be specified if the UseLatestRestorableTime parameter is enabled
Example: 2009-09-07T23:45:00Z
:use_latest_restorable_time (Boolean) —
A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.

Constraints: Can't be specified if the RestoreTime parameter is provided.
:db_instance_class (String) —
The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Default: The same DBInstanceClass as the original DB instance.
:port (Integer) —
The port number on which the database accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB instance.
:availability_zone (String) —
The Availability Zone (AZ) where the DB instance will be created.

Default: A random, system-chosen Availability Zone.

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

Example: us-east-1a
:db_subnet_group_name (String) —
The DB subnet group name to use for the new instance.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup
:multi_az (Boolean) —
A value that indicates whether the DB instance is a Multi-AZ deployment.

Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
:publicly_accessible (Boolean) —
A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn't publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.
:auto_minor_version_upgrade (Boolean) —
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
:license_model (String) —
License model information for the restored DB instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license
:db_name (String) —
The database name for the restored DB instance.

This parameter isn't used for the MySQL or MariaDB engines.
:engine (String) —
The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Valid Values:
- mariadb
- mysql
- oracle-ee
- oracle-se2
- oracle-se1
- oracle-se
- postgres
- sqlserver-ee
- sqlserver-se
- sqlserver-ex
- sqlserver-web
:iops (Integer) —
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

Constraints: Must be an integer greater than 1000.

SQL Server

Setting the IOPS value for the SQL Server database engine isn't supported.
:option_group_name (String) —
The name of the option group to be used for the restored DB instance.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
:copy_tags_to_snapshot (Boolean) —
A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.
:tags (Array<Types::Tag>) —
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
:storage_type (String) —
Specifies the storage type to be associated with the DB instance.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise gp2
:tde_credential_arn (String) —
The ARN from the key store with which to associate the instance for TDE encryption.
:tde_credential_password (String) —
The password for the given ARN from the key store in order to access the device.
:vpc_security_group_ids (Array<String>) —
A list of EC2 VPC security groups to associate with this DB instance.

Default: The default EC2 VPC security group for the DB subnet group's VPC.
:domain (String) —
Specify the Active Directory directory ID to restore the DB instance in. The domain must be created prior to this operation. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain.

For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.

For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.
:domain_iam_role_name (String) —
Specify the name of the IAM role to be used when making API calls to the Directory Service.
:enable_iam_database_authentication (Boolean) —
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance.

For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
:enable_cloudwatch_logs_exports (Array<String>) —
The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
: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.
:use_default_processor_features (Boolean) —
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
:db_parameter_group_name (String) —
The name of the DB parameter group to associate with this DB instance.

If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.

Constraints:
- If supplied, must match the name of an existing DBParameterGroup.
- Must be 1 to 255 letters, numbers, or hyphens.
- First character must be a letter.
- Can't end with a hyphen or contain two consecutive hyphens.
:deletion_protection (Boolean) —
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
:source_dbi_resource_id (String) —
The resource ID of the source DB instance from which to restore.

Returns:

(DBInstance)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 2918

def restore(options = {})
  options = options.merge(source_db_instance_identifier: @id)
  resp = @client.restore_db_instance_to_point_in_time(options)
  DBInstance.new(
    id: resp.data.db_instance.db_instance_identifier,
    data: resp.data.db_instance,
    client: @client
  )
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)



246
247
248

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 246

def secondary_availability_zone
  data[:secondary_availability_zone]
end

#security_groups ⇒ `DBSecurityGroup::Collection`

Returns:

(DBSecurityGroup::Collection)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 3211

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`

Examples:

Request syntax with placeholder values


snapshots = db_instance.snapshots({
  db_snapshot_identifier: "String",
  snapshot_type: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  include_shared: false,
  include_public: false,
  dbi_resource_id: "String",
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:db_snapshot_identifier (String) —
A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

Constraints:
- If supplied, must match the identifier of an existing DBSnapshot.
- If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
:snapshot_type (String) —
The type of snapshots to be returned. You can specify one of the following values:
- automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account.
- manual - Return all DB snapshots that have been taken by my AWS account.
- shared - Return all manual DB snapshots that have been shared to my AWS account.
- public - Return all DB snapshots that have been marked as public.
- awsbackup - Return the DB snapshots managed by the AWS Backup service.
  
  For information about AWS Backup, see the AWS Backup Developer Guide.
  
  The awsbackup type does not apply to Aurora.
If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.
:filters (Array<Types::Filter>) —
A filter that specifies one or more DB snapshots to describe.

Supported filters:
- db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).
- db-snapshot-id - Accepts DB snapshot identifiers.
- dbi-resource-id - Accepts identifiers of source DB instances.
- snapshot-type - Accepts types of DB snapshots.
- engine - Accepts names of database engines.
:include_shared (Boolean) —
A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.

You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.
:include_public (Boolean) —
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
:dbi_resource_id (String) —
A specific DB resource ID to describe.

Returns:

(DBSnapshot::Collection)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 3322

def snapshots(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(db_instance_identifier: @id)
    resp = @client.describe_db_snapshots(options)
    resp.each_page do |page|
      batch = []
      page.data.db_snapshots.each do |d|
        batch << DBSnapshot.new(
          instance_id: options[: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`^?

Returns:

(DBInstance, nil)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 3343

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 instance isn't a Read Replica, this is blank.

Returns:

(Array<Types::DBInstanceStatusInfo>)



263
264
265

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 263

def status_infos
  data[:status_infos]
end

#storage_encrypted ⇒ `Boolean`

Specifies whether the DB instance is encrypted.

Returns:

(Boolean)



297
298
299

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 297

def storage_encrypted
  data[:storage_encrypted]
end

#storage_type ⇒ `String`

Specifies the storage type associated with DB instance.

Returns:

(String)



269
270
271

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 269

def storage_type
  data[:storage_type]
end

#subnet_group ⇒ `DBSubnetGroup`^?

Returns:

(DBSubnetGroup, nil)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 3355

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`

Examples:

Request syntax with placeholder values


eventsubscription = db_instance.subscribe_to({
  subscription_name: "String", # required
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:subscription_name (required, String) —
The name of the RDS event notification subscription you want to add a source identifier to.

Returns:

(EventSubscription)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 2938

def subscribe_to(options = {})
  options = options.merge(source_identifier: @id)
  resp = @client.add_source_identifier_to_subscription(options)
  EventSubscription.new(
    name: resp.data.event_subscription.cust_subscription_id,
    data: resp.data.event_subscription,
    client: @client
  )
end

#tde_credential_arn ⇒ `String`

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

Returns:

(String)



276
277
278

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 276

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.

Returns:

(String)



387
388
389

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 387

def timezone
  data[:timezone]
end

#unsubscribe_from(options = {}) ⇒ `EventSubscription`

Examples:

Request syntax with placeholder values


eventsubscription = db_instance.unsubscribe_from({
  subscription_name: "String", # required
})

Parameters:

options (Hash) (defaults to: {}) —
({})

Options Hash (options):

:subscription_name (required, String) —
The name of the RDS event notification subscription you want to remove a source identifier from.

Returns:

(EventSubscription)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 2958

def unsubscribe_from(options = {})
  options = options.merge(source_identifier: @id)
  resp = @client.remove_source_identifier_from_subscription(options)
  EventSubscription.new(
    name: resp.data.event_subscription.cust_subscription_id,
    data: resp.data.event_subscription,
    client: @client
  )
end

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

Provides a list of VPC security group elements that the DB instance belongs to.

Returns:

(Array<Types::VpcSecurityGroupMembership>)



125
126
127

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 125

def vpc_security_groups
  data[:vpc_security_groups]
end

#wait_until(options = {}, &block) ⇒ `Resource`

Deprecated.

Use [Aws::RDS::Client] #wait_until instead

Note:

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(options) {|resource| condition}

Example

instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }

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

Parameters:

options (Hash) (defaults to: {}) —
a customizable set of options

Options Hash (options):

:max_attempts (Integer) — default: 10 —
Maximum number of
:delay (Integer) — default: 10 —
Delay between each
:before_attempt (Proc) — default: nil —
Callback
:before_wait (Proc) — default: nil —
Callback

Returns:

(Resource) —
if the waiter was successful

Raises:

(Aws::Waiters::Errors::FailureStateError) —
Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

yet successful.
(Aws::Waiters::Errors::UnexpectedError) —
Raised when an error is encountered while polling for a resource that is not expected.
(NotImplementedError) —
Raised when the resource does not

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_instance.rb', line 597

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Waiters::Waiter.new(options).wait({})
end

Class: Aws::RDS::DBInstance

Defined Under Namespace

Actions collapse

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, options = {}) ⇒ DBInstance #initialize(options = {}) ⇒ DBInstance

Instance Method Details

#allocated_storage ⇒ Integer

#associated_roles ⇒ Array<Types::DBInstanceRole>

#auto_minor_version_upgrade ⇒ Boolean

#availability_zone ⇒ String

#backup_retention_period ⇒ Integer

#ca_certificate_identifier ⇒ String

#certificate ⇒ Certificate?

#character_set_name ⇒ String

#client ⇒ Client

#cluster ⇒ DBCluster?

#copy_tags_to_snapshot ⇒ Boolean

#create(options = {}) ⇒ DBInstance

#create_read_replica(options = {}) ⇒ DBInstance

#create_snapshot(options = {}) ⇒ DBSnapshot

#data ⇒ Types::DBInstance

#data_loaded? ⇒ Boolean

#db_cluster_identifier ⇒ String

#db_instance_arn ⇒ String

#db_instance_class ⇒ 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

#dbi_resource_id ⇒ String

#delete(options = {}) ⇒ DBInstance

#deletion_protection ⇒ Boolean

#domain_memberships ⇒ Array<Types::DomainMembership>

#enabled_cloudwatch_logs_exports ⇒ Array<String>

#endpoint ⇒ Types::Endpoint

#engine ⇒ String

#engine_version ⇒ String

#enhanced_monitoring_resource_arn ⇒ String

#events(options = {}) ⇒ Event::Collection

#iam_database_authentication_enabled ⇒ Boolean

#id ⇒ String Also known as: db_instance_identifier

#instance_create_time ⇒ Time

#iops ⇒ Integer

#kms_key_id ⇒ String

#latest_restorable_time ⇒ Time

#license_model ⇒ String

#listener_endpoint ⇒ Types::Endpoint

#load ⇒ self Also known as: reload

#log_files(options = {}) ⇒ DBLogFile::Collection

#master_username ⇒ String

#max_allocated_storage ⇒ Integer

#modify(options = {}) ⇒ DBInstance

#monitoring_interval ⇒ Integer

#monitoring_role_arn ⇒ String

#multi_az ⇒ Boolean

#option_group_memberships ⇒ Array<Types::OptionGroupMembership>

#option_groups ⇒ OptionGroup::Collection

#parameter_groups ⇒ DBParameterGroup::Collection

#pending_maintenance_actions(options = {}) ⇒ PendingMaintenanceAction::Collection

#pending_modified_values ⇒ Types::PendingModifiedValues

#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>

#promote(options = {}) ⇒ DBInstance

#promotion_tier ⇒ Integer

#publicly_accessible ⇒ Boolean

#read_replica_db_cluster_identifiers ⇒ Array<String>

#read_replica_db_instance_identifiers ⇒ Array<String>

#read_replica_source_db_instance_identifier ⇒ String

#read_replicas ⇒ DBInstance::Collection

#reboot(options = {}) ⇒ DBInstance

#restore(options = {}) ⇒ DBInstance

#initialize(id, options = {}) ⇒ `DBInstance` #initialize(options = {}) ⇒ `DBInstance`

#allocated_storage ⇒ `Integer`

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

#auto_minor_version_upgrade ⇒ `Boolean`

#availability_zone ⇒ `String`

#backup_retention_period ⇒ `Integer`

#ca_certificate_identifier ⇒ `String`

#certificate ⇒ `Certificate`^?

#character_set_name ⇒ `String`

#client ⇒ `Client`

#cluster ⇒ `DBCluster`^?

#copy_tags_to_snapshot ⇒ `Boolean`

#create(options = {}) ⇒ `DBInstance`

#create_read_replica(options = {}) ⇒ `DBInstance`

#create_snapshot(options = {}) ⇒ `DBSnapshot`

#data ⇒ `Types::DBInstance`

#data_loaded? ⇒ `Boolean`

#db_cluster_identifier ⇒ `String`

#db_instance_arn ⇒ `String`

#db_instance_class ⇒ `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`

#dbi_resource_id ⇒ `String`

#delete(options = {}) ⇒ `DBInstance`

#deletion_protection ⇒ `Boolean`

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

#enabled_cloudwatch_logs_exports ⇒ `Array<String>`

#endpoint ⇒ `Types::Endpoint`

#engine ⇒ `String`

#engine_version ⇒ `String`

#enhanced_monitoring_resource_arn ⇒ `String`

#events(options = {}) ⇒ `Event::Collection`

#iam_database_authentication_enabled ⇒ `Boolean`

#id ⇒ `String` Also known as: db_instance_identifier

#instance_create_time ⇒ `Time`

#iops ⇒ `Integer`

#kms_key_id ⇒ `String`

#latest_restorable_time ⇒ `Time`

#license_model ⇒ `String`

#listener_endpoint ⇒ `Types::Endpoint`

#load ⇒ `self` Also known as: reload

#log_files(options = {}) ⇒ `DBLogFile::Collection`

#master_username ⇒ `String`

#max_allocated_storage ⇒ `Integer`

#modify(options = {}) ⇒ `DBInstance`

#monitoring_interval ⇒ `Integer`

#monitoring_role_arn ⇒ `String`

#multi_az ⇒ `Boolean`

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

#option_groups ⇒ `OptionGroup::Collection`

#parameter_groups ⇒ `DBParameterGroup::Collection`

#pending_maintenance_actions(options = {}) ⇒ `PendingMaintenanceAction::Collection`

#pending_modified_values ⇒ `Types::PendingModifiedValues`

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

#promote(options = {}) ⇒ `DBInstance`

#promotion_tier ⇒ `Integer`

#publicly_accessible ⇒ `Boolean`

#read_replica_db_cluster_identifiers ⇒ `Array<String>`

#read_replica_db_instance_identifiers ⇒ `Array<String>`

#read_replica_source_db_instance_identifier ⇒ `String`

#read_replicas ⇒ `DBInstance::Collection`

#reboot(options = {}) ⇒ `DBInstance`

#restore(options = {}) ⇒ `DBInstance`

#secondary_availability_zone ⇒ `String`

#security_groups ⇒ `DBSecurityGroup::Collection`

#snapshots(options = {}) ⇒ `DBSnapshot::Collection`

#source ⇒ `DBInstance`^?

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

#storage_encrypted ⇒ `Boolean`

#storage_type ⇒ `String`

#subnet_group ⇒ `DBSubnetGroup`^?