class Aws::RDS::Resource

This class provides a resource oriented interface for RDS. To create a resource object:

resource = Aws::RDS::Resource.new(region: 'us-west-2')

You can supply a client object with custom configuration that will be used for all resource operations. If you do not pass `:client`, a default client will be constructed.

client = Aws::RDS::Client.new(region: 'us-west-2')
resource = Aws::RDS::Resource.new(client: client)

Public Class Methods

new(options = {}) click to toggle source

@param options ({}) @option options [Client] :client

# File lib/aws-sdk-rds/resource.rb, line 27
def initialize(options = {})
  @client = options[:client] || Client.new(options)
end

Public Instance Methods

account_quotas(options = {}) click to toggle source

@example Request syntax with placeholder values

rds.account_quotas()

@param [Hash] options ({}) @return [AccountQuota::Collection]

# File lib/aws-sdk-rds/resource.rb, line 1845
def account_quotas(options = {})
  batches = Enumerator.new do |y|
    batch = []
    resp = @client.describe_account_attributes(options)
    resp.data.account_quotas.each do |a|
      batch << AccountQuota.new(
        name: a.account_quota_name,
        data: a,
        client: @client
      )
    end
    y.yield(batch)
  end
  AccountQuota::Collection.new(batches)
end
certificate(id) click to toggle source

@param [String] id @return [Certificate]

# File lib/aws-sdk-rds/resource.rb, line 1863
def certificate(id)
  Certificate.new(
    id: id,
    client: @client
  )
end
certificates(options = {}) click to toggle source

@example Request syntax with placeholder values

certificates = rds.certificates({
  certificate_identifier: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
})

@param [Hash] options ({}) @option options [String] :certificate_identifier

The user-supplied certificate identifier. If this parameter is
specified, information for only the identified certificate is
returned. This parameter isn't case-sensitive.

Constraints:

* Must match an existing CertificateIdentifier.

^

@option options [Array<Types::Filter>] :filters

This parameter isn't currently supported.

@return [Certificate::Collection]

# File lib/aws-sdk-rds/resource.rb, line 1895
def certificates(options = {})
  batches = Enumerator.new do |y|
    resp = @client.describe_certificates(options)
    resp.each_page do |page|
      batch = []
      page.data.certificates.each do |c|
        batch << Certificate.new(
          id: c.certificate_identifier,
          data: c,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  Certificate::Collection.new(batches)
end
client() click to toggle source

@return [Client]

# File lib/aws-sdk-rds/resource.rb, line 32
def client
  @client
end
create_db_cluster(options = {}) click to toggle source

@example Request syntax with placeholder values

dbcluster = rds.create_db_cluster({
  availability_zones: ["String"],
  backup_retention_period: 1,
  character_set_name: "String",
  database_name: "String",
  db_cluster_identifier: "String", # required
  db_cluster_parameter_group_name: "String",
  vpc_security_group_ids: ["String"],
  db_subnet_group_name: "String",
  engine: "String", # required
  engine_version: "String",
  port: 1,
  master_username: "String",
  master_user_password: "String",
  option_group_name: "String",
  preferred_backup_window: "String",
  preferred_maintenance_window: "String",
  replication_source_identifier: "String",
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  storage_encrypted: false,
  kms_key_id: "String",
  pre_signed_url: "String",
  enable_iam_database_authentication: false,
  backtrack_window: 1,
  enable_cloudwatch_logs_exports: ["String"],
  engine_mode: "String",
  scaling_configuration: {
    min_capacity: 1,
    max_capacity: 1,
    auto_pause: false,
    seconds_until_auto_pause: 1,
    timeout_action: "String",
    seconds_before_timeout: 1,
  },
  deletion_protection: false,
  global_cluster_identifier: "String",
  enable_http_endpoint: false,
  copy_tags_to_snapshot: false,
  domain: "String",
  domain_iam_role_name: "String",
  enable_global_write_forwarding: false,
  source_region: "String",
})

@param [Hash] options ({}) @option options [Array<String>] :availability_zones

A list of Availability Zones (AZs) where instances in the DB cluster
can be created. For information on Amazon Web Services Regions and
Availability Zones, see [Choosing the Regions and Availability
Zones][1] in the *Amazon Aurora User Guide*.

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html

@option options [Integer] :backup_retention_period

The number of days for which automated backups are retained.

Default: 1

Constraints:

* Must be a value from 1 to 35

^

@option options [String] :character_set_name

A value that indicates that the DB cluster should be associated with
the specified CharacterSet.

@option options [String] :database_name

The name for your database of up to 64 alphanumeric characters. If you
do not provide a name, Amazon RDS doesn't create a database in the DB
cluster you are creating.

@option options [required, String] :db_cluster_identifier

The DB cluster identifier. This parameter is stored as a lowercase
string.

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.

Example: `my-cluster1`

@option options [String] :db_cluster_parameter_group_name

The name of the DB cluster parameter group to associate with this DB
cluster. If you do not specify a value, then the default DB cluster
parameter group for the specified DB engine and version is used.

Constraints:

* If supplied, must match the name of an existing DB cluster parameter
  group.

^

@option options [Array<String>] :vpc_security_group_ids

A list of EC2 VPC security groups to associate with this DB cluster.

@option options [String] :db_subnet_group_name

A DB subnet group to associate with this DB cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must
not be default.

Example: `mySubnetgroup`

@option options [required, String] :engine

The name of the database engine to be used for this DB cluster.

Valid Values: `aurora` (for MySQL 5.6-compatible Aurora),
`aurora-mysql` (for MySQL 5.7-compatible Aurora), and
`aurora-postgresql`

@option options [String] :engine_version

The version number of the database engine to use.

To list all of the available engine versions for `aurora` (for MySQL
5.6-compatible Aurora), use the following command:

`aws rds describe-db-engine-versions --engine aurora --query
"DBEngineVersions[].EngineVersion"`

To list all of the available engine versions for `aurora-mysql` (for
MySQL 5.7-compatible Aurora), use the following command:

`aws rds describe-db-engine-versions --engine aurora-mysql --query
"DBEngineVersions[].EngineVersion"`

To list all of the available engine versions for `aurora-postgresql`,
use the following command:

`aws rds describe-db-engine-versions --engine aurora-postgresql
--query "DBEngineVersions[].EngineVersion"`

**Aurora MySQL**

Example: `5.6.10a`, `5.6.mysql_aurora.1.19.2`, `5.7.12`,
`5.7.mysql_aurora.2.04.5`

**Aurora PostgreSQL**

Example: `9.6.3`, `10.7`

@option options [Integer] :port

The port number on which the instances in the DB cluster accept
connections.

Default: `3306` if engine is set as aurora or `5432` if set to
aurora-postgresql.

@option options [String] :master_username

The name of the master user for the DB cluster.

Constraints:

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

@option options [String] :master_user_password

The password for the master database user. This password can contain
any printable ASCII character except "/", """, or "@".

Constraints: Must contain from 8 to 41 characters.

@option options [String] :option_group_name

A value that indicates that the DB cluster should be associated with
the specified option group.

Permanent options can't be removed from an option group. The option
group can't be removed from a DB cluster once it is associated with a
DB cluster.

@option options [String] :preferred_backup_window

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 Amazon Web Services Region. To view the time
blocks available, see [ Backup window][1] in the *Amazon Aurora 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.

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow

@option options [String] :preferred_maintenance_window

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

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 Amazon Web Services Region, occurring on a
random day of the week. To see the time blocks available, see [
Adjusting the Preferred DB Cluster Maintenance Window][1] in the
*Amazon Aurora User Guide.*

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

Constraints: Minimum 30-minute window.

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora

@option options [String] :replication_source_identifier

The Amazon Resource Name (ARN) of the source DB instance or DB cluster
if this DB cluster is created as a read replica.

@option options [Array<Types::Tag>] :tags

Tags to assign to the DB cluster.

@option options [Boolean] :storage_encrypted

A value that indicates whether the DB cluster is encrypted.

@option options [String] :kms_key_id

The Amazon Web Services KMS key identifier for an encrypted DB
cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID,
alias ARN, or alias name for the Amazon Web Services KMS customer
master key (CMK). To use a CMK in a different Amazon Web Services
account, specify the key ARN or alias ARN.

When a CMK isn't specified in `KmsKeyId`\:

* If `ReplicationSourceIdentifier` identifies an encrypted source,
  then Amazon RDS will use the CMK used to encrypt the source.
  Otherwise, Amazon RDS will use your default CMK.

* If the `StorageEncrypted` parameter is enabled and
  `ReplicationSourceIdentifier` isn't specified, then Amazon RDS will
  use your default CMK.

There is a default CMK for your Amazon Web Services account. Your
Amazon Web Services account has a different default CMK for each
Amazon Web Services Region.

If you create a read replica of an encrypted DB cluster in another
Amazon Web Services Region, you must set `KmsKeyId` to a Amazon Web
Services KMS key identifier that is valid in the destination Amazon
Web Services Region. This CMK is used to encrypt the read replica in
that Amazon Web Services Region.

@option options [String] :pre_signed_url

A URL that contains a Signature Version 4 signed request for the
`CreateDBCluster` action to be called in the source Amazon Web
Services Region where the DB cluster is replicated from. You only need
to specify `PreSignedUrl` when you are performing cross-region
replication from an encrypted DB cluster.

The pre-signed URL must be a valid request for the `CreateDBCluster`
API action that can be executed in the source Amazon Web Services
Region that contains the encrypted DB cluster to be copied.

The pre-signed URL request must contain the following parameter
values:

* `KmsKeyId` - The Amazon Web Services KMS key identifier for the key
  to use to encrypt the copy of the DB cluster in the destination
  Amazon Web Services Region. This should refer to the same Amazon Web
  Services KMS CMK for both the `CreateDBCluster` action that is
  called in the destination Amazon Web Services Region, and the action
  contained in the pre-signed URL.

* `DestinationRegion` - The name of the Amazon Web Services Region
  that Aurora read replica will be created in.

* `ReplicationSourceIdentifier` - The DB cluster identifier for the
  encrypted DB cluster to be copied. This identifier must be in the
  Amazon Resource Name (ARN) format for the source Amazon Web Services
  Region. For example, if you are copying an encrypted DB cluster from
  the us-west-2 Amazon Web Services Region, then your
  `ReplicationSourceIdentifier` would look like Example:
  `arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1`.

To learn how to generate a Signature Version 4 signed request, see [
Authenticating Requests: Using Query Parameters (Amazon Web Services
Signature Version 4)][1] and [ Signature Version 4 Signing
Process][2].

<note markdown="1"> If you are using an Amazon Web Services SDK tool or the CLI, you can
specify `SourceRegion` (or `--source-region` for the 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 Amazon Web Services
Region.

 </note>

[1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
[2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html

@option options [Boolean] :enable_iam_database_authentication

A value that indicates whether to enable mapping of Amazon Web
Services Identity and Access Management (IAM) accounts to database
accounts. By default, mapping is disabled.

For more information, see [ IAM Database Authentication][1] in the
*Amazon Aurora User Guide.*

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html

@option options [Integer] :backtrack_window

The target backtrack window, in seconds. To disable backtracking, set
this value to 0.

<note markdown="1"> Currently, Backtrack is only supported for Aurora MySQL DB clusters.

 </note>

Default: 0

Constraints:

* If specified, this value must be set to a number from 0 to 259,200
  (72 hours).

^

@option options [Array<String>] :enable_cloudwatch_logs_exports

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][1] in the *Amazon Aurora User Guide*.

**Aurora MySQL**

Possible values are `audit`, `error`, `general`, and `slowquery`.

**Aurora PostgreSQL**

Possible value is `postgresql`.

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch

@option options [String] :engine_mode

The DB engine mode of the DB cluster, either `provisioned`,
`serverless`, `parallelquery`, `global`, or `multimaster`.

The `parallelquery` engine mode isn't required for Aurora MySQL
version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x
versions.

The `global` engine mode isn't required for Aurora MySQL version 1.22
and higher 1.x versions, and `global` engine mode isn't required for
any 2.x versions.

The `multimaster` engine mode only applies for DB clusters created
with Aurora MySQL version 5.6.10a.

For Aurora PostgreSQL, the `global` engine mode isn't required, and
both the `parallelquery` and the `multimaster` engine modes currently
aren't supported.

Limitations and requirements apply to some DB engine modes. For more
information, see the following sections in the *Amazon Aurora User
Guide*\:

* [ Limitations of Aurora Serverless][1]

* [ Limitations of Parallel Query][2]

* [ Limitations of Aurora Global Databases][3]

* [ Limitations of Multi-Master Clusters][4]

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations
[2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations
[3]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations
[4]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-multi-master.html#aurora-multi-master-limitations

@option options [Types::ScalingConfiguration] :scaling_configuration

For DB clusters in `serverless` DB engine mode, the scaling properties
of the DB cluster.

@option options [Boolean] :deletion_protection

A value that indicates whether the DB cluster has deletion protection
enabled. The database can't be deleted when deletion protection is
enabled. By default, deletion protection is disabled.

@option options [String] :global_cluster_identifier

The global cluster ID of an Aurora cluster that becomes the primary
cluster in the new global database cluster.

@option options [Boolean] :enable_http_endpoint

A value that indicates whether to enable the HTTP endpoint for an
Aurora Serverless DB cluster. By default, the HTTP endpoint is
disabled.

When enabled, the HTTP endpoint provides a connectionless web service
API for running SQL queries on the Aurora Serverless DB cluster. You
can also query your database from inside the RDS console with the
query editor.

For more information, see [Using the Data API for Aurora
Serverless][1] in the *Amazon Aurora User Guide*.

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html

@option options [Boolean] :copy_tags_to_snapshot

A value that indicates whether to copy all tags from the DB cluster to
snapshots of the DB cluster. The default is not to copy them.

@option options [String] :domain

The Active Directory directory ID to create the DB cluster in.

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
Authentication to authenticate users that connect to the DB cluster.
For more information, see [Kerberos Authentication][1] in the *Amazon
Aurora User Guide*.

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html

@option options [String] :domain_iam_role_name

Specify the name of the IAM role to be used when making API calls to
the Directory Service.

@option options [Boolean] :enable_global_write_forwarding

A value that indicates whether to enable this DB cluster to forward
write operations to the primary cluster of an Aurora global database
(GlobalCluster). By default, write operations are not allowed on
Aurora DB clusters that are secondary clusters in an Aurora global
database.

You can set this value only on Aurora DB clusters that are members of
an Aurora global database. With this parameter enabled, a secondary
cluster can forward writes to the current primary cluster and the
resulting changes are replicated back to this cluster. For the primary
DB cluster of an Aurora global database, this value is used
immediately if the primary is demoted by the FailoverGlobalCluster API
operation, but it does nothing until then.

@option options [String] :source_region

The source region of the snapshot. This is only needed when the
shapshot is encrypted and in a different region.

@return [DBCluster]

# File lib/aws-sdk-rds/resource.rb, line 480
def create_db_cluster(options = {})
  resp = @client.create_db_cluster(options)
  DBCluster.new(
    id: options[:db_cluster][:db_cluster_identifier],
    data: resp.data.db_cluster,
    client: @client
  )
end
create_db_cluster_parameter_group(options = {}) click to toggle source

@example Request syntax with placeholder values

dbclusterparametergroup = rds.create_db_cluster_parameter_group({
  db_cluster_parameter_group_name: "String", # required
  db_parameter_group_family: "String", # required
  description: "String", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

@param [Hash] options ({}) @option options [required, String] :db_cluster_parameter_group_name

The name of the DB cluster parameter group.

Constraints:

* Must match the name of an existing DB cluster parameter group.

^

<note markdown="1"> This value is stored as a lowercase string.

 </note>

@option options [required, String] :db_parameter_group_family

The DB cluster parameter group family name. A DB cluster parameter
group can be associated with one and only one DB cluster parameter
group family, and can be applied only to a DB cluster running a
database engine and engine version compatible with that DB cluster
parameter group family.

**Aurora MySQL**

Example: `aurora5.6`, `aurora-mysql5.7`

**Aurora PostgreSQL**

Example: `aurora-postgresql9.6`

To list all of the available parameter group families for a DB engine,
use the following command:

`aws rds describe-db-engine-versions --query
"DBEngineVersions[].DBParameterGroupFamily" --engine <engine>`

For example, to list all of the available parameter group families for
the Aurora PostgreSQL DB engine, use the following command:

`aws rds describe-db-engine-versions --query
"DBEngineVersions[].DBParameterGroupFamily" --engine
aurora-postgresql`

<note markdown="1"> The output contains duplicates.

 </note>

The following are the valid DB engine values:

* `aurora` (for MySQL 5.6-compatible Aurora)

* `aurora-mysql` (for MySQL 5.7-compatible Aurora)

* `aurora-postgresql`

@option options [required, String] :description

The description for the DB cluster parameter group.

@option options [Array<Types::Tag>] :tags

Tags to assign to the DB cluster parameter group.

@return [DBClusterParameterGroup]

# File lib/aws-sdk-rds/resource.rb, line 559
def create_db_cluster_parameter_group(options = {})
  resp = @client.create_db_cluster_parameter_group(options)
  DBClusterParameterGroup.new(
    name: resp.data.db_cluster_parameter_group.db_cluster_parameter_group_name,
    data: resp.data.db_cluster_parameter_group,
    client: @client
  )
end
create_db_instance(options = {}) click to toggle source

@example Request syntax with placeholder values

dbinstance = rds.create_db_instance({
  db_name: "String",
  db_instance_identifier: "String", # required
  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",
  nchar_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,
  enable_customer_owned_ip: false,
})

@param [Hash] options ({}) @option options [String] :db_name

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.

* Must begin with a letter. Subsequent characters can be letters,
  underscores, or digits (0-9).

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

* Must begin with a letter. Subsequent characters can be letters,
  underscores, or digits (0-9).

* 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, a database named `postgres` is
created in the DB instance.

Constraints:

* Must contain 1 to 63 letters, numbers, or underscores.

* Must begin with a letter. 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 MySQL**

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

Constraints:

* It must contain 1 to 64 alphanumeric characters.

* It can't be a word reserved by the database engine.

**Amazon Aurora PostgreSQL**

The name of the database to create when the primary DB instance of the
Aurora PostgreSQL DB cluster is created. If this parameter isn't
specified for an Aurora PostgreSQL DB cluster, a database named
`postgres` is created in the DB cluster.

Constraints:

* It must contain 1 to 63 alphanumeric characters.

* It must begin with a letter or an underscore. Subsequent characters
  can be letters, underscores, or digits (0 to 9).

* It can't be a word reserved by the database engine.

@option options [required, String] :db_instance_identifier

The DB instance identifier. This parameter is stored as a lowercase
string.

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.

Example: `mydbinstance`

@option options [Integer] :allocated_storage

The amount of storage in gibibytes (GiB) 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
  65536.

* Provisioned IOPS storage (io1): Must be an integer from 100 to
  65536.

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

* Provisioned IOPS storage (io1): Must be an integer from 100 to
  65536.

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

* Provisioned IOPS storage (io1): Must be an integer from 100 to
  65536.

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

* Provisioned IOPS storage (io1): Must be an integer from 100 to
  65536.

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

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

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

  * Web and Express editions: Must be an integer from 20 to 1024.

@option options [required, String] :db_instance_class

The compute and memory capacity of the DB instance, for example,
`db.m4.large`. Not all DB instance classes are available in all Amazon
Web Services Regions, or for all database engines. For the full list
of DB instance classes, and availability for your engine, see [DB
Instance Class][1] in the *Amazon RDS User Guide.*

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html

@option options [required, String] :engine

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

Not every database engine is available for every Amazon Web Services
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-ee-cdb`

* `oracle-se2`

* `oracle-se2-cdb`

* `postgres`

* `sqlserver-ee`

* `sqlserver-se`

* `sqlserver-ex`

* `sqlserver-web`

@option options [String] :master_username

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.

@option options [String] :master_user_password

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.

@option options [Array<String>] :db_security_groups

A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.

@option options [Array<String>] :vpc_security_group_ids

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.

@option options [String] :availability_zone

The Availability Zone (AZ) where the database will be created. For
information on Amazon Web Services Regions and Availability Zones, see
[Regions and Availability Zones][1].

Default: A random, system-chosen Availability Zone in the endpoint's
Amazon Web Services 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 Amazon Web Services Region as the current
endpoint.

<note markdown="1"> 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.][2]

 </note>

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html
[2]: https://docs.aws.amazon.com/AmazonRDS/latest/RDSonVMwareUserGuide/rds-on-vmware.html

@option options [String] :db_subnet_group_name

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.

@option options [String] :preferred_maintenance_window

The time range each week during which system maintenance can occur, in
Universal Coordinated Time (UTC). For more information, see [Amazon
RDS Maintenance Window][1].

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 Amazon Web Services Region, occurring on a
random day of the week.

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

Constraints: Minimum 30-minute window.

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance

@option options [String] :db_parameter_group_name

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

@option options [Integer] :backup_retention_period

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

@option options [String] :preferred_backup_window

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 Amazon Web Services Region. For more
information, see [Backup window][1] in the *Amazon RDS User Guide*.

**Amazon Aurora**

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

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.

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow

@option options [Integer] :port

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 `1234`, `1434`, `3260`, `3343`,
`3389`, `47001`, and `49152-49156`.

**Amazon Aurora**

Default: `3306`

Valid values: `1150-65535`

Type: Integer

@option options [Boolean] :multi_az

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.

@option options [String] :engine_version

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 Amazon Web Services
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][1] in the *Amazon RDS User
Guide.*

**Microsoft SQL Server**

See [Microsoft SQL Server Versions on Amazon RDS][2] in the *Amazon
RDS User Guide.*

**MySQL**

See [MySQL on Amazon RDS Versions][3] in the *Amazon RDS User Guide.*

**Oracle**

See [Oracle Database Engine Release Notes][4] in the *Amazon RDS User
Guide.*

**PostgreSQL**

See [Amazon RDS for PostgreSQL versions and extensions][5] in the
*Amazon RDS User Guide.*

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt
[2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport
[3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt
[4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html
[5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts

@option options [Boolean] :auto_minor_version_upgrade

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.

@option options [String] :license_model

License model information for this DB instance.

Valid values: `license-included` \| `bring-your-own-license` \|
`general-public-license`

@option options [Integer] :iops

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

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

@option options [String] :option_group_name

A value that 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. Also, that option group
can't be removed from a DB instance once it is associated with a DB
instance

@option options [String] :character_set_name

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

@option options [String] :nchar_character_set_name

The name of the NCHAR character set for the Oracle DB instance.

@option options [Boolean] :publicly_accessible

A value that indicates whether the DB instance is publicly accessible.

When the DB instance is publicly accessible, its DNS endpoint resolves
to the private IP address from within the DB instance's VPC, and to
the public IP address from outside of the DB instance's VPC. Access
to the DB instance is ultimately controlled by the security group it
uses, and that public access is not permitted if the security group
assigned to the DB instance doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB
instance with a DNS name that resolves to a private IP address.

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.

@option options [Array<Types::Tag>] :tags

Tags to assign to the DB instance.

@option options [String] :db_cluster_identifier

The identifier of the DB cluster that the instance will belong to.

@option options [String] :storage_type

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`

@option options [String] :tde_credential_arn

The ARN from the key store with which to associate the instance for
TDE encryption.

@option options [String] :tde_credential_password

The password for the given ARN from the key store in order to access
the device.

@option options [Boolean] :storage_encrypted

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.

@option options [String] :kms_key_id

The Amazon Web Services KMS key identifier for an encrypted DB
instance.

The Amazon Web Services KMS key identifier is the key ARN, key ID,
alias ARN, or alias name for the Amazon Web Services KMS customer
master key (CMK). To use a CMK in a different Amazon Web Services
account, specify the key ARN or alias ARN.

**Amazon Aurora**

Not applicable. The Amazon Web Services 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 uses your default CMK. There
is a default CMK for your Amazon Web Services account. Your Amazon Web
Services account has a different default CMK for each Amazon Web
Services Region.

@option options [String] :domain

The Active Directory directory ID to create the DB instance in.
Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
instances can be created in an Active Directory Domain.

For more information, see [ Kerberos Authentication][1] in the *Amazon
RDS User Guide*.

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html

@option options [Boolean] :copy_tags_to_snapshot

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.

@option options [Integer] :monitoring_interval

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`

@option options [String] :monitoring_role_arn

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][1] in the *Amazon RDS User Guide*.

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

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling

@option options [String] :domain_iam_role_name

Specify the name of the IAM role to be used when making API calls to
the Directory Service.

@option options [Integer] :promotion_tier

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][1] in the *Amazon Aurora User Guide*.

Default: 1

Valid Values: 0 - 15

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

@option options [String] :timezone

The time zone of the DB instance. The time zone parameter is currently
supported only by [Microsoft SQL Server][1].

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone

@option options [Boolean] :enable_iam_database_authentication

A value that indicates whether to enable mapping of Amazon Web
Services Identity and Access Management (IAM) accounts to database
accounts. By default, mapping is disabled.

This setting doesn't apply to Amazon Aurora. Mapping Amazon Web
Services IAM accounts to database accounts is managed by the DB
cluster.

For more information, see [ IAM Database Authentication for MySQL and
PostgreSQL][1] in the *Amazon RDS User Guide.*

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html

@option options [Boolean] :enable_performance_insights

A value that indicates whether to enable Performance Insights for the
DB instance.

For more information, see [Using Amazon Performance Insights][1] in
the *Amazon Relational Database Service User Guide*.

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

@option options [String] :performance_insights_kms_key_id

The Amazon Web Services KMS key identifier for encryption of
Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID,
alias ARN, or alias name for the Amazon Web Services KMS customer
master key (CMK).

If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
Amazon RDS uses your default CMK. There is a default CMK for your
Amazon Web Services account. Your Amazon Web Services account has a
different default CMK for each Amazon Web Services Region.

@option options [Integer] :performance_insights_retention_period

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

@option options [Array<String>] :enable_cloudwatch_logs_exports

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 ][1] in the *Amazon Relational Database Service User
Guide*.

**Amazon Aurora**

Not applicable. CloudWatch Logs exports are managed by the DB cluster.

**MariaDB**

Possible values are `audit`, `error`, `general`, and `slowquery`.

**Microsoft SQL Server**

Possible values are `agent` and `error`.

**MySQL**

Possible values are `audit`, `error`, `general`, and `slowquery`.

**Oracle**

Possible values are `alert`, `audit`, `listener`, `trace`, and
`oemagent`.

**PostgreSQL**

Possible values are `postgresql` and `upgrade`.

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch

@option options [Array<Types::ProcessorFeature>] :processor_features

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

@option options [Boolean] :deletion_protection

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

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

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

@option options [Integer] :max_allocated_storage

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

For more information about this setting, including limitations that
apply to it, see [ Managing capacity automatically with Amazon RDS
storage autoscaling][1] in the *Amazon RDS User Guide*.

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

@option options [Boolean] :enable_customer_owned_ip

A value that indicates whether to enable a customer-owned IP address
(CoIP) for an RDS on Outposts DB instance.

A *CoIP* provides local or external connectivity to resources in your
Outpost subnets through your on-premises network. For some use cases,
a CoIP can provide lower latency for connections to the DB instance
from outside of its virtual private cloud (VPC) on your local network.

For more information about RDS on Outposts, see [Working with Amazon
RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
Guide*.

For more information about CoIPs, see [Customer-owned IP addresses][2]
in the *Amazon Web Services Outposts User Guide*.

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

@return [DBInstance]

# File lib/aws-sdk-rds/resource.rb, line 1494
def create_db_instance(options = {})
  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_db_parameter_group(options = {}) click to toggle source

@example Request syntax with placeholder values

dbparametergroup = rds.create_db_parameter_group({
  db_parameter_group_name: "String", # required
  db_parameter_group_family: "String", # required
  description: "String", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

@param [Hash] options ({}) @option options [required, String] :db_parameter_group_name

The name of the DB parameter group.

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

<note markdown="1"> This value is stored as a lowercase string.

 </note>

@option options [required, String] :db_parameter_group_family

The DB parameter group family name. A DB parameter group can be
associated with one and only one DB parameter group family, and can be
applied only to a DB instance running a database engine and engine
version compatible with that DB parameter group family.

To list all of the available parameter group families for a DB engine,
use the following command:

`aws rds describe-db-engine-versions --query
"DBEngineVersions[].DBParameterGroupFamily" --engine <engine>`

For example, to list all of the available parameter group families for
the MySQL DB engine, use the following command:

`aws rds describe-db-engine-versions --query
"DBEngineVersions[].DBParameterGroupFamily" --engine mysql`

<note markdown="1"> The output contains duplicates.

 </note>

The following are the valid DB engine values:

* `aurora` (for MySQL 5.6-compatible Aurora)

* `aurora-mysql` (for MySQL 5.7-compatible Aurora)

* `aurora-postgresql`

* `mariadb`

* `mysql`

* `oracle-ee`

* `oracle-ee-cdb`

* `oracle-se2`

* `oracle-se2-cdb`

* `postgres`

* `sqlserver-ee`

* `sqlserver-se`

* `sqlserver-ex`

* `sqlserver-web`

@option options [required, String] :description

The description for the DB parameter group.

@option options [Array<Types::Tag>] :tags

Tags to assign to the DB parameter group.

@return [DBParameterGroup]

# File lib/aws-sdk-rds/resource.rb, line 1587
def create_db_parameter_group(options = {})
  resp = @client.create_db_parameter_group(options)
  DBParameterGroup.new(
    name: resp.data.db_parameter_group.db_parameter_group_name,
    data: resp.data.db_parameter_group,
    client: @client
  )
end
create_db_security_group(options = {}) click to toggle source

@example Request syntax with placeholder values

dbsecuritygroup = rds.create_db_security_group({
  db_security_group_name: "String", # required
  db_security_group_description: "String", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

@param [Hash] options ({}) @option options [required, String] :db_security_group_name

The name for the DB security group. This value is stored as a
lowercase string.

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

* Must not be "Default"

Example: `mysecuritygroup`

@option options [required, String] :db_security_group_description

The description for the DB security group.

@option options [Array<Types::Tag>] :tags

Tags to assign to the DB security group.

@return [DBSecurityGroup]

# File lib/aws-sdk-rds/resource.rb, line 1629
def create_db_security_group(options = {})
  resp = @client.create_db_security_group(options)
  DBSecurityGroup.new(
    name: resp.data.db_security_group.db_security_group_name,
    data: resp.data.db_security_group,
    client: @client
  )
end
create_db_subnet_group(options = {}) click to toggle source

@example Request syntax with placeholder values

dbsubnetgroup = rds.create_db_subnet_group({
  db_subnet_group_name: "String", # required
  db_subnet_group_description: "String", # required
  subnet_ids: ["String"], # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

@param [Hash] options ({}) @option options [required, String] :db_subnet_group_name

The name for the DB subnet group. This value is stored as a lowercase
string.

Constraints: Must contain no more than 255 letters, numbers, periods,
underscores, spaces, or hyphens. Must not be default.

Example: `mySubnetgroup`

@option options [required, String] :db_subnet_group_description

The description for the DB subnet group.

@option options [required, Array<String>] :subnet_ids

The EC2 Subnet IDs for the DB subnet group.

@option options [Array<Types::Tag>] :tags

Tags to assign to the DB subnet group.

@return [DBSubnetGroup]

# File lib/aws-sdk-rds/resource.rb, line 1667
def create_db_subnet_group(options = {})
  resp = @client.create_db_subnet_group(options)
  DBSubnetGroup.new(
    name: resp.data.db_subnet_group.db_subnet_group_name,
    data: resp.data.db_subnet_group,
    client: @client
  )
end
create_event_subscription(options = {}) click to toggle source

@example Request syntax with placeholder values

eventsubscription = rds.create_event_subscription({
  subscription_name: "String", # required
  sns_topic_arn: "String", # required
  source_type: "String",
  event_categories: ["String"],
  source_ids: ["String"],
  enabled: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

@param [Hash] options ({}) @option options [required, String] :subscription_name

The name of the subscription.

Constraints: The name must be less than 255 characters.

@option options [required, String] :sns_topic_arn

The Amazon Resource Name (ARN) of the SNS topic created for event
notification. The ARN is created by Amazon SNS when you create a topic
and subscribe to it.

@option options [String] :source_type

The type of source that is generating the events. For example, if you
want to be notified of events generated by a DB instance, you set this
parameter to `db-instance`. If this value isn't specified, all events
are returned.

Valid values: `db-instance` \| `db-cluster` \| `db-parameter-group` \|
`db-security-group` \| `db-snapshot` \| `db-cluster-snapshot`

@option options [Array<String>] :event_categories

A list of event categories for a particular source type (`SourceType`)
that you want to subscribe to. You can see a list of the categories
for a given source type in [Events][1] in the *Amazon RDS User Guide*
or by using the `DescribeEventCategories` operation.

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

@option options [Array<String>] :source_ids

The list of identifiers of the event sources for which events are
returned. If not specified, then all sources are included in the
response. An identifier must begin with a letter and must contain only
ASCII letters, digits, and hyphens. It can't end with a hyphen or
contain two consecutive hyphens.

Constraints:

* If `SourceIds` are supplied, `SourceType` must also be provided.

* If the source type is a DB instance, a `DBInstanceIdentifier` value
  must be supplied.

* If the source type is a DB cluster, a `DBClusterIdentifier` value
  must be supplied.

* If the source type is a DB parameter group, a `DBParameterGroupName`
  value must be supplied.

* If the source type is a DB security group, a `DBSecurityGroupName`
  value must be supplied.

* If the source type is a DB snapshot, a `DBSnapshotIdentifier` value
  must be supplied.

* If the source type is a DB cluster snapshot, a
  `DBClusterSnapshotIdentifier` value must be supplied.

@option options [Boolean] :enabled

A value that indicates whether to activate the subscription. If the
event notification subscription isn't activated, the subscription is
created but not active.

@option options [Array<Types::Tag>] :tags

A list of tags. For more information, see [Tagging Amazon RDS
Resources][1] in the *Amazon RDS User Guide.*

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

@return [EventSubscription]

# File lib/aws-sdk-rds/resource.rb, line 1758
def create_event_subscription(options = {})
  resp = @client.create_event_subscription(options)
  EventSubscription.new(
    name: resp.data.event_subscription.cust_subscription_id,
    data: resp.data.event_subscription,
    client: @client
  )
end
create_option_group(options = {}) click to toggle source

@example Request syntax with placeholder values

optiongroup = rds.create_option_group({
  option_group_name: "String", # required
  engine_name: "String", # required
  major_engine_version: "String", # required
  option_group_description: "String", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

@param [Hash] options ({}) @option options [required, String] :option_group_name

Specifies the name of the option group to be created.

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

Example: `myoptiongroup`

@option options [required, String] :engine_name

Specifies the name of the engine that this option group should be
associated with.

Valid Values:

* `mariadb`

* `mysql`

* `oracle-ee`

* `oracle-ee-cdb`

* `oracle-se2`

* `oracle-se2-cdb`

* `postgres`

* `sqlserver-ee`

* `sqlserver-se`

* `sqlserver-ex`

* `sqlserver-web`

@option options [required, String] :major_engine_version

Specifies the major version of the engine that this option group
should be associated with.

@option options [required, String] :option_group_description

The description of the option group.

@option options [Array<Types::Tag>] :tags

Tags to assign to the option group.

@return [OptionGroup]

# File lib/aws-sdk-rds/resource.rb, line 1829
def create_option_group(options = {})
  resp = @client.create_option_group(options)
  OptionGroup.new(
    name: resp.data.option_group.option_group_name,
    data: resp.data.option_group,
    client: @client
  )
end
db_cluster(id) click to toggle source

@param [String] id @return [DBCluster]

# File lib/aws-sdk-rds/resource.rb, line 1915
def db_cluster(id)
  DBCluster.new(
    id: id,
    client: @client
  )
end
db_cluster_parameter_group(name) click to toggle source

@param [String] name @return [DBClusterParameterGroup]

# File lib/aws-sdk-rds/resource.rb, line 1924
def db_cluster_parameter_group(name)
  DBClusterParameterGroup.new(
    name: name,
    client: @client
  )
end
db_cluster_parameter_groups(options = {}) click to toggle source

@example Request syntax with placeholder values

db_cluster_parameter_groups = rds.db_cluster_parameter_groups({
  db_cluster_parameter_group_name: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
})

@param [Hash] options ({}) @option options [String] :db_cluster_parameter_group_name

The name of a specific DB cluster parameter group to return details
for.

Constraints:

* If supplied, must match the name of an existing
  DBClusterParameterGroup.

^

@option options [Array<Types::Filter>] :filters

This parameter isn't currently supported.

@return [DBClusterParameterGroup::Collection]

# File lib/aws-sdk-rds/resource.rb, line 1956
def db_cluster_parameter_groups(options = {})
  batches = Enumerator.new do |y|
    resp = @client.describe_db_cluster_parameter_groups(options)
    resp.each_page do |page|
      batch = []
      page.data.db_cluster_parameter_groups.each do |d|
        batch << DBClusterParameterGroup.new(
          name: d.db_cluster_parameter_group_name,
          data: d,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  DBClusterParameterGroup::Collection.new(batches)
end
db_clusters(options = {}) click to toggle source

@example Request syntax with placeholder values

db_clusters = rds.db_clusters({
  db_cluster_identifier: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  include_shared: false,
})

@param [Hash] options ({}) @option options [String] :db_cluster_identifier

The user-supplied DB cluster identifier. If this parameter is
specified, information from only the specific DB cluster is returned.
This parameter isn't case-sensitive.

Constraints:

* If supplied, must match an existing DBClusterIdentifier.

^

@option options [Array<Types::Filter>] :filters

A filter that specifies one or more DB clusters to describe.

Supported filters:

* `clone-group-id` - Accepts clone group identifiers. The results list
  will only include information about the DB clusters associated with
  these clone groups.

* `db-cluster-id` - Accepts DB cluster identifiers and DB cluster
  Amazon Resource Names (ARNs). The results list will only include
  information about the DB clusters identified by these ARNs.

* `domain` - Accepts Active Directory directory IDs. The results list
  will only include information about the DB clusters associated with
  these domains.

* `engine` - Accepts engine names. The results list will only include
  information about the DB clusters for these engines.

@option options [Boolean] :include_shared

Optional Boolean parameter that specifies whether the output includes
information about clusters shared from other Amazon Web Services
accounts.

@return [DBCluster::Collection]

# File lib/aws-sdk-rds/resource.rb, line 2021
def db_clusters(options = {})
  batches = Enumerator.new do |y|
    resp = @client.describe_db_clusters(options)
    resp.each_page do |page|
      batch = []
      page.data.db_clusters.each do |d|
        batch << DBCluster.new(
          id: d.db_cluster_identifier,
          data: d,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  DBCluster::Collection.new(batches)
end
db_engine(name) click to toggle source

@param [String] name @return [DBEngine]

# File lib/aws-sdk-rds/resource.rb, line 2041
def db_engine(name)
  DBEngine.new(
    name: name,
    client: @client
  )
end
db_engine_version(engine_name, version) click to toggle source

@param [String] engine_name @param [String] version @return [DBEngineVersion]

# File lib/aws-sdk-rds/resource.rb, line 2051
def db_engine_version(engine_name, version)
  DBEngineVersion.new(
    engine_name: engine_name,
    version: version,
    client: @client
  )
end
db_engine_versions(options = {}) click to toggle source

@example Request syntax with placeholder values

db_engine_versions = rds.db_engine_versions({
  engine: "String",
  engine_version: "String",
  db_parameter_group_family: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  default_only: false,
  list_supported_character_sets: false,
  list_supported_timezones: false,
  include_all: false,
})

@param [Hash] options ({}) @option options [String] :engine

The database engine to return.

Valid Values:

* `aurora` (for MySQL 5.6-compatible Aurora)

* `aurora-mysql` (for MySQL 5.7-compatible Aurora)

* `aurora-postgresql`

* `mariadb`

* `mysql`

* `oracle-ee`

* `oracle-ee-cdb`

* `oracle-se2`

* `oracle-se2-cdb`

* `postgres`

* `sqlserver-ee`

* `sqlserver-se`

* `sqlserver-ex`

* `sqlserver-web`

@option options [String] :engine_version

The database engine version to return.

Example: `5.1.49`

@option options [String] :db_parameter_group_family

The name of a specific DB parameter group family to return details
for.

Constraints:

* If supplied, must match an existing DBParameterGroupFamily.

^

@option options [Array<Types::Filter>] :filters

This parameter isn't currently supported.

@option options [Boolean] :default_only

A value that indicates whether only the default version of the
specified engine or engine and major version combination is returned.

@option options [Boolean] :list_supported_character_sets

A value that indicates whether to list the supported character sets
for each engine version.

If this parameter is enabled and the requested engine supports the
`CharacterSetName` parameter for `CreateDBInstance`, the response
includes a list of supported character sets for each engine version.

@option options [Boolean] :list_supported_timezones

A value that indicates whether to list the supported time zones for
each engine version.

If this parameter is enabled and the requested engine supports the
`TimeZone` parameter for `CreateDBInstance`, the response includes a
list of supported time zones for each engine version.

@option options [Boolean] :include_all

A value that indicates whether to include engine versions that aren't
available in the list. The default is to list only available engine
versions.

@return [DBEngineVersion::Collection]

# File lib/aws-sdk-rds/resource.rb, line 2146
def db_engine_versions(options = {})
  batches = Enumerator.new do |y|
    resp = @client.describe_db_engine_versions(options)
    resp.each_page do |page|
      batch = []
      page.data.db_engine_versions.each do |d|
        batch << DBEngineVersion.new(
          engine_name: d.engine,
          version: d.engine_version,
          data: d,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  DBEngineVersion::Collection.new(batches)
end
db_instance(id) click to toggle source

@param [String] id @return [DBInstance]

# File lib/aws-sdk-rds/resource.rb, line 2167
def db_instance(id)
  DBInstance.new(
    id: id,
    client: @client
  )
end
db_instances(options = {}) click to toggle source

@example Request syntax with placeholder values

db_instances = rds.db_instances({
  db_instance_identifier: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
})

@param [Hash] options ({}) @option options [String] :db_instance_identifier

The user-supplied instance identifier. If this parameter is specified,
information from only the specific DB instance is returned. This
parameter isn't case-sensitive.

Constraints:

* If supplied, must match the identifier of an existing DBInstance.

^

@option options [Array<Types::Filter>] :filters

A filter that specifies one or more DB instances to describe.

Supported filters:

* `db-cluster-id` - Accepts DB cluster identifiers and DB cluster
  Amazon Resource Names (ARNs). The results list will only include
  information about the DB instances associated with the DB clusters
  identified by these ARNs.

* `db-instance-id` - Accepts DB instance identifiers and DB instance
  Amazon Resource Names (ARNs). The results list will only include
  information about the DB instances identified by these ARNs.

* `dbi-resource-id` - Accepts DB instance resource identifiers. The
  results list will only include information about the DB instances
  identified by these DB instance resource identifiers.

* `domain` - Accepts Active Directory directory IDs. The results list
  will only include information about the DB instances associated with
  these domains.

* `engine` - Accepts engine names. The results list will only include
  information about the DB instances for these engines.

@return [DBInstance::Collection]

# File lib/aws-sdk-rds/resource.rb, line 2221
def db_instances(options = {})
  batches = Enumerator.new do |y|
    resp = @client.describe_db_instances(options)
    resp.each_page do |page|
      batch = []
      page.data.db_instances.each do |d|
        batch << DBInstance.new(
          id: d.db_instance_identifier,
          data: d,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  DBInstance::Collection.new(batches)
end
db_parameter_group(name) click to toggle source

@param [String] name @return [DBParameterGroup]

# File lib/aws-sdk-rds/resource.rb, line 2241
def db_parameter_group(name)
  DBParameterGroup.new(
    name: name,
    client: @client
  )
end
db_parameter_group_family(name) click to toggle source

@param [String] name @return [DBParameterGroupFamily]

# File lib/aws-sdk-rds/resource.rb, line 2250
def db_parameter_group_family(name)
  DBParameterGroupFamily.new(
    name: name,
    client: @client
  )
end
db_parameter_groups(options = {}) click to toggle source

@example Request syntax with placeholder values

db_parameter_groups = rds.db_parameter_groups({
  db_parameter_group_name: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
})

@param [Hash] options ({}) @option options [String] :db_parameter_group_name

The name of a specific DB parameter group to return details for.

Constraints:

* If supplied, must match the name of an existing
  DBClusterParameterGroup.

^

@option options [Array<Types::Filter>] :filters

This parameter isn't currently supported.

@return [DBParameterGroup::Collection]

# File lib/aws-sdk-rds/resource.rb, line 2281
def db_parameter_groups(options = {})
  batches = Enumerator.new do |y|
    resp = @client.describe_db_parameter_groups(options)
    resp.each_page do |page|
      batch = []
      page.data.db_parameter_groups.each do |d|
        batch << DBParameterGroup.new(
          name: d.db_parameter_group_name,
          data: d,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  DBParameterGroup::Collection.new(batches)
end
db_security_group(name) click to toggle source

@param [String] name @return [DBSecurityGroup]

# File lib/aws-sdk-rds/resource.rb, line 2301
def db_security_group(name)
  DBSecurityGroup.new(
    name: name,
    client: @client
  )
end
db_security_groups(options = {}) click to toggle source

@example Request syntax with placeholder values

db_security_groups = rds.db_security_groups({
  db_security_group_name: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
})

@param [Hash] options ({}) @option options [String] :db_security_group_name

The name of the DB security group to return details for.

@option options [Array<Types::Filter>] :filters

This parameter isn't currently supported.

@return [DBSecurityGroup::Collection]

# File lib/aws-sdk-rds/resource.rb, line 2325
def db_security_groups(options = {})
  batches = Enumerator.new do |y|
    resp = @client.describe_db_security_groups(options)
    resp.each_page do |page|
      batch = []
      page.data.db_security_groups.each do |d|
        batch << DBSecurityGroup.new(
          name: d.db_security_group_name,
          data: d,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  DBSecurityGroup::Collection.new(batches)
end
db_snapshots(options = {}) click to toggle source

@example Request syntax with placeholder values

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

@param [Hash] options ({}) @option options [String] :db_instance_identifier

The ID of the DB instance to retrieve the list of DB snapshots for.
This parameter can't be used in conjunction with
`DBSnapshotIdentifier`. This parameter isn't case-sensitive.

Constraints:

* If supplied, must match the identifier of an existing DBInstance.

^

@option options [String] :db_snapshot_identifier

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.

@option options [String] :snapshot_type

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 Amazon Web Services account.

* `manual` - Return all DB snapshots that have been taken by my Amazon
  Web Services account.

* `shared` - Return all manual DB snapshots that have been shared to
  my Amazon Web Services account.

* `public` - Return all DB snapshots that have been marked as public.

* `awsbackup` - Return the DB snapshots managed by the Amazon Web
  Services Backup service.

  For information about Amazon Web Services Backup, see the [ *Amazon
  Web Services Backup Developer Guide.* ][1]

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

[1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html

@option options [Array<Types::Filter>] :filters

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.

@option options [Boolean] :include_shared

A value that indicates whether to include shared manual DB cluster
snapshots from other Amazon Web Services accounts that this Amazon Web
Services account has been given permission to copy or restore. By
default, these snapshots are not included.

You can give an Amazon Web Services account permission to restore a
manual DB snapshot from another Amazon Web Services account by using
the `ModifyDBSnapshotAttribute` API action.

@option options [Boolean] :include_public

A value that indicates whether to include manual DB cluster snapshots
that are public and can be copied or restored by any Amazon Web
Services account. By default, the public snapshots are not included.

You can share a manual DB snapshot as public by using the
ModifyDBSnapshotAttribute API.

@option options [String] :dbi_resource_id

A specific DB resource ID to describe.

@return [DBSnapshot::Collection]

# File lib/aws-sdk-rds/resource.rb, line 2454
def db_snapshots(options = {})
  batches = Enumerator.new do |y|
    resp = @client.describe_db_snapshots(options)
    resp.each_page do |page|
      batch = []
      page.data.db_snapshots.each do |d|
        batch << DBSnapshot.new(
          instance_id: d.db_instance_identifier,
          snapshot_id: d.db_snapshot_identifier,
          data: d,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  DBSnapshot::Collection.new(batches)
end
db_subnet_group(name) click to toggle source

@param [String] name @return [DBSubnetGroup]

# File lib/aws-sdk-rds/resource.rb, line 2475
def db_subnet_group(name)
  DBSubnetGroup.new(
    name: name,
    client: @client
  )
end
db_subnet_groups(options = {}) click to toggle source

@example Request syntax with placeholder values

db_subnet_groups = rds.db_subnet_groups({
  db_subnet_group_name: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
})

@param [Hash] options ({}) @option options [String] :db_subnet_group_name

The name of the DB subnet group to return details for.

@option options [Array<Types::Filter>] :filters

This parameter isn't currently supported.

@return [DBSubnetGroup::Collection]

# File lib/aws-sdk-rds/resource.rb, line 2499
def db_subnet_groups(options = {})
  batches = Enumerator.new do |y|
    resp = @client.describe_db_subnet_groups(options)
    resp.each_page do |page|
      batch = []
      page.data.db_subnet_groups.each do |d|
        batch << DBSubnetGroup.new(
          name: d.db_subnet_group_name,
          data: d,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  DBSubnetGroup::Collection.new(batches)
end
event_category_map(source_type) click to toggle source

@param [String] source_type @return [EventCategoryMap]

# File lib/aws-sdk-rds/resource.rb, line 2519
def event_category_map(source_type)
  EventCategoryMap.new(
    source_type: source_type,
    client: @client
  )
end
event_category_maps(options = {}) click to toggle source

@example Request syntax with placeholder values

event_category_maps = rds.event_category_maps({
  source_type: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
})

@param [Hash] options ({}) @option options [String] :source_type

The type of source that is generating the events.

Valid values: `db-instance` \| `db-cluster` \| `db-parameter-group` \|
`db-security-group` \| `db-snapshot` \| `db-cluster-snapshot`

@option options [Array<Types::Filter>] :filters

This parameter isn't currently supported.

@return [EventCategoryMap::Collection]

# File lib/aws-sdk-rds/resource.rb, line 2546
def event_category_maps(options = {})
  batches = Enumerator.new do |y|
    batch = []
    resp = @client.describe_event_categories(options)
    resp.data.event_categories_map_list.each do |e|
      batch << EventCategoryMap.new(
        source_type: e.source_type,
        data: e,
        client: @client
      )
    end
    y.yield(batch)
  end
  EventCategoryMap::Collection.new(batches)
end
event_subscription(name) click to toggle source

@param [String] name @return [EventSubscription]

# File lib/aws-sdk-rds/resource.rb, line 2564
def event_subscription(name)
  EventSubscription.new(
    name: name,
    client: @client
  )
end
event_subscriptions(options = {}) click to toggle source

@example Request syntax with placeholder values

event_subscriptions = rds.event_subscriptions({
  subscription_name: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
})

@param [Hash] options ({}) @option options [String] :subscription_name

The name of the RDS event notification subscription you want to
describe.

@option options [Array<Types::Filter>] :filters

This parameter isn't currently supported.

@return [EventSubscription::Collection]

# File lib/aws-sdk-rds/resource.rb, line 2589
def event_subscriptions(options = {})
  batches = Enumerator.new do |y|
    resp = @client.describe_event_subscriptions(options)
    resp.each_page do |page|
      batch = []
      page.data.event_subscriptions_list.each do |e|
        batch << EventSubscription.new(
          name: e.cust_subscription_id,
          data: e,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  EventSubscription::Collection.new(batches)
end
events(options = {}) click to toggle source

@example Request syntax with placeholder values

events = rds.events({
  source_identifier: "String",
  source_type: "db-instance", # accepts db-instance, db-parameter-group, db-security-group, db-snapshot, db-cluster, db-cluster-snapshot
  start_time: Time.now,
  end_time: Time.now,
  duration: 1,
  event_categories: ["String"],
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
})

@param [Hash] options ({}) @option options [String] :source_identifier

The identifier of the event source for which events are returned. If
not specified, then all sources are included in the response.

Constraints:

* If `SourceIdentifier` is supplied, `SourceType` must also be
  provided.

* If the source type is a DB instance, a `DBInstanceIdentifier` value
  must be supplied.

* If the source type is a DB cluster, a `DBClusterIdentifier` value
  must be supplied.

* If the source type is a DB parameter group, a `DBParameterGroupName`
  value must be supplied.

* If the source type is a DB security group, a `DBSecurityGroupName`
  value must be supplied.

* If the source type is a DB snapshot, a `DBSnapshotIdentifier` value
  must be supplied.

* If the source type is a DB cluster snapshot, a
  `DBClusterSnapshotIdentifier` value must be supplied.

* Can't end with a hyphen or contain two consecutive hyphens.

@option options [String] :source_type

The event source to retrieve events for. If no value is specified, all
events are returned.

@option options [Time,DateTime,Date,Integer,String] :start_time

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

Example: 2009-07-08T18:00Z

[1]: http://en.wikipedia.org/wiki/ISO_8601

@option options [Time,DateTime,Date,Integer,String] :end_time

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

Example: 2009-07-08T18:00Z

[1]: http://en.wikipedia.org/wiki/ISO_8601

@option options [Integer] :duration

The number of minutes to retrieve events for.

Default: 60

@option options [Array<String>] :event_categories

A list of event categories that trigger notifications for a event
notification subscription.

@option options [Array<Types::Filter>] :filters

This parameter isn't currently supported.

@return [Event::Collection]

# File lib/aws-sdk-rds/resource.rb, line 2685
def events(options = {})
  batches = Enumerator.new do |y|
    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
option_group(name) click to toggle source

@param [String] name @return [OptionGroup]

# File lib/aws-sdk-rds/resource.rb, line 2706
def option_group(name)
  OptionGroup.new(
    name: name,
    client: @client
  )
end
option_groups(options = {}) click to toggle source

@example Request syntax with placeholder values

option_groups = rds.option_groups({
  option_group_name: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  engine_name: "String",
  major_engine_version: "String",
})

@param [Hash] options ({}) @option options [String] :option_group_name

The name of the option group to describe. Can't be supplied together
with EngineName or MajorEngineVersion.

@option options [Array<Types::Filter>] :filters

This parameter isn't currently supported.

@option options [String] :engine_name

Filters the list of option groups to only include groups associated
with a specific database engine.

Valid Values:

* `mariadb`

* `mysql`

* `oracle-ee`

* `oracle-ee-cdb`

* `oracle-se2`

* `oracle-se2-cdb`

* `postgres`

* `sqlserver-ee`

* `sqlserver-se`

* `sqlserver-ex`

* `sqlserver-web`

@option options [String] :major_engine_version

Filters the list of option groups to only include groups associated
with a specific database engine version. If specified, then EngineName
must also be specified.

@return [OptionGroup::Collection]

# File lib/aws-sdk-rds/resource.rb, line 2764
def option_groups(options = {})
  batches = Enumerator.new do |y|
    resp = @client.describe_option_groups(options)
    resp.each_page do |page|
      batch = []
      page.data.option_groups_list.each do |o|
        batch << OptionGroup.new(
          name: o.option_group_name,
          data: o,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  OptionGroup::Collection.new(batches)
end
pending_maintenance_action(target_arn, name) click to toggle source

@param [String] target_arn @param [String] name @return [PendingMaintenanceAction]

# File lib/aws-sdk-rds/resource.rb, line 2785
def pending_maintenance_action(target_arn, name)
  PendingMaintenanceAction.new(
    target_arn: target_arn,
    name: name,
    client: @client
  )
end
reserved_db_instance(id) click to toggle source

@param [String] id @return [ReservedDBInstance]

# File lib/aws-sdk-rds/resource.rb, line 2795
def reserved_db_instance(id)
  ReservedDBInstance.new(
    id: id,
    client: @client
  )
end
reserved_db_instances(options = {}) click to toggle source

@example Request syntax with placeholder values

reserved_db_instances = rds.reserved_db_instances({
  reserved_db_instance_id: "String",
  reserved_db_instances_offering_id: "String",
  db_instance_class: "String",
  duration: "String",
  product_description: "String",
  offering_type: "String",
  multi_az: false,
  lease_id: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
})

@param [Hash] options ({}) @option options [String] :reserved_db_instance_id

The reserved DB instance identifier filter value. Specify this
parameter to show only the reservation that matches the specified
reservation ID.

@option options [String] :reserved_db_instances_offering_id

The offering identifier filter value. Specify this parameter to show
only purchased reservations matching the specified offering
identifier.

@option options [String] :db_instance_class

The DB instance class filter value. Specify this parameter to show
only those reservations matching the specified DB instances class.

@option options [String] :duration

The duration filter value, specified in years or seconds. Specify this
parameter to show only reservations for this duration.

Valid Values: `1 | 3 | 31536000 | 94608000`

@option options [String] :product_description

The product description filter value. Specify this parameter to show
only those reservations matching the specified product description.

@option options [String] :offering_type

The offering type filter value. Specify this parameter to show only
the available offerings matching the specified offering type.

Valid Values: `"Partial Upfront" | "All Upfront" | "No Upfront" `

@option options [Boolean] :multi_az

A value that indicates whether to show only those reservations that
support Multi-AZ.

@option options [String] :lease_id

The lease identifier filter value. Specify this parameter to show only
the reservation that matches the specified lease ID.

<note markdown="1"> Amazon Web Services Support might request the lease ID for an issue
related to a reserved DB instance.

 </note>

@option options [Array<Types::Filter>] :filters

This parameter isn't currently supported.

@return [ReservedDBInstance::Collection]

# File lib/aws-sdk-rds/resource.rb, line 2859
def reserved_db_instances(options = {})
  batches = Enumerator.new do |y|
    resp = @client.describe_reserved_db_instances(options)
    resp.each_page do |page|
      batch = []
      page.data.reserved_db_instances.each do |r|
        batch << ReservedDBInstance.new(
          id: r.reserved_db_instance_id,
          data: r,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  ReservedDBInstance::Collection.new(batches)
end
reserved_db_instances_offering(id) click to toggle source

@param [String] id @return [ReservedDBInstancesOffering]

# File lib/aws-sdk-rds/resource.rb, line 2879
def reserved_db_instances_offering(id)
  ReservedDBInstancesOffering.new(
    id: id,
    client: @client
  )
end
reserved_db_instances_offerings(options = {}) click to toggle source

@example Request syntax with placeholder values

reserved_db_instances_offerings = rds.reserved_db_instances_offerings({
  reserved_db_instances_offering_id: "String",
  db_instance_class: "String",
  duration: "String",
  product_description: "String",
  offering_type: "String",
  multi_az: false,
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
})

@param [Hash] options ({}) @option options [String] :reserved_db_instances_offering_id

The offering identifier filter value. Specify this parameter to show
only the available offering that matches the specified reservation
identifier.

Example: `438012d3-4052-4cc7-b2e3-8d3372e0e706`

@option options [String] :db_instance_class

The DB instance class filter value. Specify this parameter to show
only the available offerings matching the specified DB instance class.

@option options [String] :duration

Duration filter value, specified in years or seconds. Specify this
parameter to show only reservations for this duration.

Valid Values: `1 | 3 | 31536000 | 94608000`

@option options [String] :product_description

Product description filter value. Specify this parameter to show only
the available offerings that contain the specified product
description.

<note markdown="1"> The results show offerings that partially match the filter value.

 </note>

@option options [String] :offering_type

The offering type filter value. Specify this parameter to show only
the available offerings matching the specified offering type.

Valid Values: `"Partial Upfront" | "All Upfront" | "No Upfront" `

@option options [Boolean] :multi_az

A value that indicates whether to show only those reservations that
support Multi-AZ.

@option options [Array<Types::Filter>] :filters

This parameter isn't currently supported.

@return [ReservedDBInstancesOffering::Collection]

# File lib/aws-sdk-rds/resource.rb, line 2936
def reserved_db_instances_offerings(options = {})
  batches = Enumerator.new do |y|
    resp = @client.describe_reserved_db_instances_offerings(options)
    resp.each_page do |page|
      batch = []
      page.data.reserved_db_instances_offerings.each do |r|
        batch << ReservedDBInstancesOffering.new(
          id: r.reserved_db_instances_offering_id,
          data: r,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  ReservedDBInstancesOffering::Collection.new(batches)
end
resource_with_pending_maintenance_actions(arn) click to toggle source

@param [String] arn @return [ResourcePendingMaintenanceActionList]

# File lib/aws-sdk-rds/resource.rb, line 2956
def resource_with_pending_maintenance_actions(arn)
  ResourcePendingMaintenanceActionList.new(
    arn: arn,
    client: @client
  )
end
resources_with_pending_maintenance_actions(options = {}) click to toggle source

@example Request syntax with placeholder values

resources_with_pending_maintenance_actions = rds.resources_with_pending_maintenance_actions({
  resource_identifier: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
})

@param [Hash] options ({}) @option options [String] :resource_identifier

The ARN of a resource to return pending maintenance actions for.

@option options [Array<Types::Filter>] :filters

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.

@return [ResourcePendingMaintenanceActionList::Collection]

# File lib/aws-sdk-rds/resource.rb, line 2992
def resources_with_pending_maintenance_actions(options = {})
  batches = Enumerator.new do |y|
    resp = @client.describe_pending_maintenance_actions(options)
    resp.each_page do |page|
      batch = []
      page.data.pending_maintenance_actions.each do |p|
        batch << ResourcePendingMaintenanceActionList.new(
          arn: p.resource_identifier,
          data: p,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  ResourcePendingMaintenanceActionList::Collection.new(batches)
end