Class: Aws::RDS::Resource

#account_quotas(options = {}) ⇒ `AccountQuota::Collection`

Examples:

Request syntax with placeholder values


rds.account_quotas()

Parameters:

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

({})

Returns:

(AccountQuota::Collection)

# File 'lib/aws-sdk-rds/resource.rb', line 2783

def account_quotas(options = {})
  batches = Enumerator.new do |y|
    batch = []
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.describe_account_attributes(options)
    end
    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) ⇒ `Certificate`

Parameters:

id (String)

Returns:

(Certificate)

# File 'lib/aws-sdk-rds/resource.rb', line 2803

def certificate(id)
  Certificate.new(
    id: id,
    client: @client
  )
end

#certificates(options = {}) ⇒ `Certificate::Collection`

Examples:

Request syntax with placeholder values


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

Parameters:

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

({})

Options Hash (options):

:certificate_identifier (String) —
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.
^
:filters (Array<Types::Filter>) —

This parameter isn’t currently supported.

Returns:

(Certificate::Collection)

# File 'lib/aws-sdk-rds/resource.rb', line 2835

def certificates(options = {})
  batches = Enumerator.new do |y|
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.describe_certificates(options)
    end
    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 ⇒ `Client`

Returns:

(Client)



32
33
34

# File 'lib/aws-sdk-rds/resource.rb', line 32

def client
  @client
end

#create_db_cluster(options = {}) ⇒ `DBCluster`

Examples:

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,
  },
  rds_custom_cluster_configuration: {
    interconnect_subnet_id: "String",
    transit_gateway_multicast_domain_id: "String",
    replica_mode: "open-read-only", # accepts open-read-only, mounted
  },
  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,
  db_cluster_instance_class: "String",
  allocated_storage: 1,
  storage_type: "String",
  iops: 1,
  publicly_accessible: false,
  auto_minor_version_upgrade: false,
  monitoring_interval: 1,
  monitoring_role_arn: "String",
  enable_performance_insights: false,
  performance_insights_kms_key_id: "String",
  performance_insights_retention_period: 1,
  enable_limitless_database: false,
  serverless_v2_scaling_configuration: {
    min_capacity: 1.0,
    max_capacity: 1.0,
    seconds_until_auto_pause: 1,
  },
  network_type: "String",
  cluster_scalability_type: "standard", # accepts standard, limitless
  db_system_id: "String",
  manage_master_user_password: false,
  master_user_secret_kms_key_id: "String",
  enable_local_write_forwarding: false,
  ca_certificate_identifier: "String",
  engine_lifecycle_support: "String",
  source_region: "String",
})

Parameters:

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

({})

Options Hash (options):

:availability_zones (Array<String>) —
A list of Availability Zones (AZs) where you specifically want to create DB instances in the DB cluster.

For information on AZs, see [Availability Zones] in the *Amazon Aurora User Guide*.

Valid for Cluster Type: Aurora DB clusters only

Constraints:
- Can’t specify more than three AZs.
^

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html#Concepts.RegionsAndAvailabilityZones.AvailabilityZones
:backup_retention_period (Integer) —
The number of days for which automated backups are retained.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Default: ‘1`

Constraints:
- Must be a value from 1 to 35.
^
:character_set_name (String) —

The name of the character set (‘CharacterSet`) to associate the DB cluster with.

Valid for Cluster Type: Aurora DB clusters only
:database_name (String) —

The name for your database of up to 64 alphanumeric characters. A database named ‘postgres` is always created. If this parameter is specified, an additional database with this name is created.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
:db_cluster_identifier (required, String) —
The identifier for this DB cluster. This parameter is stored as a lowercase string.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Constraints:
- Must contain from 1 to 63 (for Aurora DB clusters) or 1 to 52 (for Multi-AZ DB clusters) letters, numbers, or hyphens.
- First character must be a letter.
- Can’t end with a hyphen or contain two consecutive hyphens.
Example: ‘my-cluster1`
:db_cluster_parameter_group_name (String) —
The name of the DB cluster parameter group to associate with this DB cluster. If you don’t specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Constraints:
- If supplied, must match the name of an existing DB cluster parameter group.
^
:vpc_security_group_ids (Array<String>) —

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

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
:db_subnet_group_name (String) —
A DB subnet group to associate with this DB cluster.

This setting is required to create a Multi-AZ DB cluster.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Constraints:
- Must match the name of an existing DB subnet group.
^

Example: ‘mydbsubnetgroup`
:engine (required, String) —
The database engine to use for this DB cluster.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Valid Values:
- ‘aurora-mysql`
- ‘aurora-postgresql`
- ‘mysql`
- ‘postgres`
- ‘neptune` - For information about using Amazon Neptune, see the [ *Amazon Neptune User Guide* ][1].
[1]: docs.aws.amazon.com/neptune/latest/userguide/intro.html
:engine_version (String) —
The version number of the database engine to use.

To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible), use the following command:

‘aws rds describe-db-engine-versions –engine aurora-mysql –query “DBEngineVersions[].EngineVersion”`

You can supply either ‘5.7` or `8.0` to use the default engine version for Aurora MySQL version 2 or version 3, respectively.

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

To list all of the available engine versions for RDS for MySQL, use the following command:

‘aws rds describe-db-engine-versions –engine mysql –query “DBEngineVersions[].EngineVersion”`

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

‘aws rds describe-db-engine-versions –engine postgres –query “DBEngineVersions[].EngineVersion”`

For information about a specific engine, see the following topics:
- Aurora MySQL - see [Database engine updates for Amazon Aurora MySQL] in the *Amazon Aurora User Guide*.
- Aurora PostgreSQL - see [Amazon Aurora PostgreSQL releases and engine versions] in the *Amazon Aurora User Guide*.
- RDS for MySQL - see [Amazon RDS for MySQL] in the *Amazon RDS User Guide*.
- RDS for PostgreSQL - see [Amazon RDS for PostgreSQL] in the *Amazon RDS User Guide*.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html [2]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html [3]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt [4]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
:port (Integer) —
The port number on which the instances in the DB cluster accept connections.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Valid Values: ‘1150-65535`

Default:
- RDS for MySQL and Aurora MySQL - ‘3306`
- RDS for PostgreSQL and Aurora PostgreSQL - ‘5432`
:master_username (String) —
The name of the master user for the DB cluster.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

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.
:master_user_password (String) —
The password for the master database user.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Constraints:
- Must contain from 8 to 41 characters.
- Can contain any printable ASCII character except “/”, “”“, or ”@“.
- Can’t be specified if ‘ManageMasterUserPassword` is turned on.
:option_group_name (String) —

The option group to associate the DB cluster with.

DB clusters are associated with a default option group that can’t be modified.
:preferred_backup_window (String) —
The daily time range during which automated backups are created if automated backups are enabled using the ‘BackupRetentionPeriod` parameter.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

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] 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]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow
:preferred_maintenance_window (String) —
The weekly time range during which system maintenance can occur.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

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

Constraints:
- Must be in the format ‘ddd:hh24:mi-ddd:hh24:mi`.
- Days must be one of ‘Mon | Tue | Wed | Thu | Fri | Sat | Sun`.
- Must be in Universal Coordinated Time (UTC).
- Must be at least 30 minutes.
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
:replication_source_identifier (String) —

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

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
:tags (Array<Types::Tag>) —

Tags to assign to the DB cluster.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
:storage_encrypted (Boolean) —

Specifies whether the DB cluster is encrypted.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
:kms_key_id (String) —
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 KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

When a KMS key isn’t specified in ‘KmsKeyId`:
- If ‘ReplicationSourceIdentifier` identifies an encrypted source, then Amazon RDS uses the KMS key used to encrypt the source. Otherwise, Amazon RDS uses your default KMS key.
- If the ‘StorageEncrypted` parameter is enabled and `ReplicationSourceIdentifier` isn’t specified, then Amazon RDS uses your default KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

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

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
:pre_signed_url (String) —
When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another, an URL that contains a Signature Version 4 signed request for the ‘CreateDBCluster` operation to be called in the source Amazon Web Services Region where the DB cluster is replicated from. Specify `PreSignedUrl` only when you are performing cross-Region replication from an encrypted DB cluster.

The presigned URL must be a valid request for the ‘CreateDBCluster` API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster to copy.

The presigned URL request must contain the following parameter values:
- ‘KmsKeyId` - The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the `CreateDBCluster` operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned 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)] and [ Signature Version 4 Signing Process].

<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 presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
```
</note>
```
Valid for Cluster Type: Aurora DB clusters only

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

Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn’t enabled.

For more information, see [ IAM Database Authentication] in the *Amazon Aurora User Guide* or [IAM database authentication for MariaDB, MySQL, and PostgreSQL] in the *Amazon RDS User Guide*.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html [2]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
:backtrack_window (Integer) —
The target backtrack window, in seconds. To disable backtracking, set this value to ‘0`.

Valid for Cluster Type: Aurora MySQL DB clusters only

Default: ‘0`

Constraints:
- If specified, this value must be set to a number from 0 to 259,200 (72 hours).
^
:enable_cloudwatch_logs_exports (Array<String>) —
The list of log types that need to be enabled for exporting to CloudWatch Logs.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

The following values are valid for each DB engine:
- Aurora MySQL - ‘audit | error | general | slowquery`
- Aurora PostgreSQL - ‘postgresql`
- RDS for MySQL - ‘error | general | slowquery`
- RDS for PostgreSQL - ‘postgresql | upgrade`
For more information about exporting CloudWatch Logs for Amazon RDS, see [Publishing Database Logs to Amazon CloudWatch Logs] in the *Amazon RDS User Guide*.

For more information about exporting CloudWatch Logs for Amazon Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs] in the *Amazon Aurora User Guide*.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch [2]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
:engine_mode (String) —
The DB engine mode of the DB cluster, either ‘provisioned` or `serverless`.

The ‘serverless` engine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use the `provisioned` engine mode.

For information about limitations and requirements for Serverless DB clusters, see the following sections in the *Amazon Aurora User Guide*:
- Limitations of Aurora Serverless v1][1
- Requirements for Aurora Serverless v2][2
Valid for Cluster Type: Aurora DB clusters only

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations [2]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html
:scaling_configuration (Types::ScalingConfiguration) —

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

Valid for Cluster Type: Aurora DB clusters only
:rds_custom_cluster_configuration (Types::RdsCustomClusterConfiguration) —

Reserved for future use.
:deletion_protection (Boolean) —

Specifies whether the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection isn’t enabled.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
:global_cluster_identifier (String) —

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

Valid for Cluster Type: Aurora DB clusters only
:enable_http_endpoint (Boolean) —
Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn’t enabled.

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

RDS Data API is supported with the following DB clusters:
- Aurora PostgreSQL Serverless v2 and provisioned
- Aurora PostgreSQL and Aurora MySQL Serverless v1
For more information, see [Using RDS Data API] in the *Amazon Aurora User Guide*.

Valid for Cluster Type: Aurora DB clusters only

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
:copy_tags_to_snapshot (Boolean) —

Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
:domain (String) —

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

Valid for Cluster Type: Aurora DB clusters only

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
:domain_iam_role_name (String) —

The name of the IAM role to use when making API calls to the Directory Service.

Valid for Cluster Type: Aurora DB clusters only
:enable_global_write_forwarding (Boolean) —

Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). 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 a global cluster API operation, but it does nothing until then.

Valid for Cluster Type: Aurora DB clusters only
:db_cluster_instance_class (String) —

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example ‘db.m6gd.xlarge`. 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] in the *Amazon RDS User Guide*.

This setting is required to create a Multi-AZ DB cluster.

Valid for Cluster Type: Multi-AZ DB clusters only

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
:allocated_storage (Integer) —

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

Valid for Cluster Type: Multi-AZ DB clusters only

This setting is required to create a Multi-AZ DB cluster.
:storage_type (String) —
The storage type to associate with the DB cluster.

For information on storage types for Aurora DB clusters, see [Storage configurations for Amazon Aurora DB clusters]. For information on storage types for Multi-AZ DB clusters, see [Settings for creating Multi-AZ DB clusters].

This setting is required to create a Multi-AZ DB cluster.

When specified for a Multi-AZ DB cluster, a value for the ‘Iops` parameter is required.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Valid Values:
- Aurora DB clusters - ‘aurora | aurora-iopt1`
- Multi-AZ DB clusters - ‘io1 | io2 | gp3`
Default:
- Aurora DB clusters - ‘aurora`
- Multi-AZ DB clusters - ‘io1`
<note markdown=“1”> When you create an Aurora DB cluster with the storage type set to ‘aurora-iopt1`, the storage type is returned in the response. The storage type isn’t returned when you set it to ‘aurora`.
```
</note>
```
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type [2]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings
:iops (Integer) —
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

For information about valid IOPS values, see [Provisioned IOPS storage] in the *Amazon RDS User Guide*.

This setting is required to create a Multi-AZ DB cluster.

Valid for Cluster Type: Multi-AZ DB clusters only

Constraints:
- Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
^

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
:publicly_accessible (Boolean) —
Specifies whether the DB cluster is publicly accessible.

When the DB cluster is publicly accessible and you connect from outside of the DB cluster’s virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn’t permitted if the security group assigned to the DB cluster doesn’t permit it.

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

Valid for Cluster Type: Multi-AZ DB clusters only

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 cluster is private.
- If the default VPC in the target Region has an internet gateway attached to it, the DB cluster 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 cluster is private.
- If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
:auto_minor_version_upgrade (Boolean) —

Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.

Valid for Cluster Type: Multi-AZ DB clusters only
:monitoring_interval (Integer) —

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify ‘0`.

If ‘MonitoringRoleArn` is specified, also set `MonitoringInterval` to a value other than `0`.

Valid for Cluster Type: Multi-AZ DB clusters only

Valid Values: ‘0 | 1 | 5 | 10 | 15 | 30 | 60`

Default: ‘0`
:monitoring_role_arn (String) —

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is ‘arn:aws:iam:123456789012:role/emaccess`. For information on creating a monitoring role, see [Setting up and enabling Enhanced Monitoring] in the *Amazon RDS User Guide*.

If ‘MonitoringInterval` is set to a value other than `0`, supply a `MonitoringRoleArn` value.

Valid for Cluster Type: Multi-AZ DB clusters only

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling
:enable_performance_insights (Boolean) —

Specifies whether to turn on Performance Insights for the DB cluster.

For more information, see [ Using Amazon Performance Insights] in the *Amazon RDS User Guide*.

Valid for Cluster Type: Multi-AZ DB clusters only

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
:performance_insights_kms_key_id (String) —

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

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you don’t specify a value for ‘PerformanceInsightsKMSKeyId`, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

Valid for Cluster Type: Multi-AZ DB clusters only
:performance_insights_retention_period (Integer) —
The number of days to retain Performance Insights data.

Valid for Cluster Type: Multi-AZ DB clusters only

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

If you specify a retention period that isn’t valid, such as ‘94`, Amazon RDS issues an error.
:enable_limitless_database (Boolean) —
Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.

Valid for: Aurora DB clusters only

<note markdown=“1”> This setting is no longer used. Instead use the ‘ClusterScalabilityType` setting.
```
</note>
```
:serverless_v2_scaling_configuration (Types::ServerlessV2ScalingConfiguration) —

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

For more information, see [Using Amazon Aurora Serverless v2] in the *Amazon Aurora User Guide*.

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
:network_type (String) —

The network type of the DB cluster.

The network type is determined by the ‘DBSubnetGroup` specified for the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (`DUAL`).

For more information, see [ Working with a DB instance in a VPC] in the *Amazon Aurora User Guide.*

Valid for Cluster Type: Aurora DB clusters only

Valid Values: ‘IPV4 | DUAL`

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
:cluster_scalability_type (String) —
Specifies the scalability mode of the Aurora DB cluster. When set to ‘limitless`, the cluster operates as an Aurora Limitless Database. When set to `standard` (the default), the cluster uses normal DB instance creation.

Valid for: Aurora DB clusters only

<note markdown=“1”> You can’t modify this setting after you create the DB cluster.
```
</note>
```
:db_system_id (String) —

Reserved for future use.
:manage_master_user_password (Boolean) —
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

For more information, see [Password management with Amazon Web Services Secrets Manager] in the *Amazon RDS User Guide* and

Password management with Amazon Web Services Secrets Manager][2

in

the *Amazon Aurora User Guide.*

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Constraints:
- Can’t manage the master user password with Amazon Web Services Secrets Manager if ‘MasterUserPassword` is specified.
^

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html [2]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html
:master_user_secret_kms_key_id (String) —

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster.

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

If you don’t specify ‘MasterUserSecretKmsKeyId`, then the `aws/secretsmanager` KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can’t use the ‘aws/secretsmanager` KMS key to encrypt the secret, and you must use a customer managed KMS key.

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

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
:enable_local_write_forwarding (Boolean) —

Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren’t allowed on reader DB instances.

Valid for: Aurora DB clusters only
:ca_certificate_identifier (String) —

The CA certificate identifier to use for the DB cluster’s server certificate.

For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the *Amazon RDS User Guide*.

Valid for Cluster Type: Multi-AZ DB clusters

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html
:engine_lifecycle_support (String) —
The life cycle type for this DB cluster.

<note markdown=“1”> By default, this value is set to ‘open-source-rds-extended-support`, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to `open-source-rds-extended-support-disabled`. In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date.
```
</note>
```
You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
- Amazon Aurora - [Using Amazon RDS Extended Support] in the *Amazon Aurora User Guide*
- Amazon RDS - [Using Amazon RDS Extended Support] in the *Amazon RDS User Guide*
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Valid Values: ‘open-source-rds-extended-support | open-source-rds-extended-support-disabled`

Default: ‘open-source-rds-extended-support`

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html [2]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html
:source_region (String) —

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

Returns:

(DBCluster)

# File 'lib/aws-sdk-rds/resource.rb', line 975

def create_db_cluster(options = {})
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.create_db_cluster(options)
  end
  DBCluster.new(
    id: resp.data.db_cluster.db_cluster_identifier,
    data: resp.data.db_cluster,
    client: @client
  )
end

#create_db_cluster_parameter_group(options = {}) ⇒ `DBClusterParameterGroup`

Examples:

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",
    },
  ],
})

Parameters:

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

({})

Options Hash (options):

:db_cluster_parameter_group_name (required, String) —
The name of the DB cluster parameter group.

Constraints:
- Must not match the name of an existing DB cluster parameter group.
^

<note markdown=“1”> This value is stored as a lowercase string.
```
</note>
```
:db_parameter_group_family (required, String) —
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: ‘aurora-mysql5.7`, `aurora-mysql8.0`

**Aurora PostgreSQL**

Example: ‘aurora-postgresql14`

**RDS for MySQL**

Example: ‘mysql8.0`

**RDS for PostgreSQL**

Example: ‘postgres13`

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-mysql`
- ‘aurora-postgresql`
- ‘mysql`
- ‘postgres`
:description (required, String) —

The description for the DB cluster parameter group.
:tags (Array<Types::Tag>) —

Tags to assign to the DB cluster parameter group.

Returns:

(DBClusterParameterGroup)

# File 'lib/aws-sdk-rds/resource.rb', line 1066

def create_db_cluster_parameter_group(options = {})
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.create_db_cluster_parameter_group(options)
  end
  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 = {}) ⇒ `DBInstance`

Examples:

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",
  domain_fqdn: "String",
  domain_ou: "String",
  domain_auth_secret_arn: "String",
  domain_dns_ips: ["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,
  custom_iam_instance_profile: "String",
  backup_target: "String",
  network_type: "String",
  storage_throughput: 1,
  manage_master_user_password: false,
  master_user_secret_kms_key_id: "String",
  ca_certificate_identifier: "String",
  db_system_id: "String",
  dedicated_log_volume: false,
  multi_tenant: false,
  engine_lifecycle_support: "String",
})

Parameters:

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

({})

Options Hash (options):

:db_name (String) —

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

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:

* Must contain 1 to 64 alphanumeric characters.

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

* 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. A database named
`postgres` is always created. If this parameter is specified, an
additional database with this name is created.

Constraints:

* It must contain 1 to 63 alphanumeric characters.

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

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

Amazon RDS Custom for Oracle

: The Oracle System ID (SID) of the created RDS Custom DB instance. If

you don't specify a value, the default value is `ORCL` for non-CDBs
and `RDSCDB` for CDBs.

Default: `ORCL`

Constraints:

* Must contain 1 to 8 alphanumeric characters.

* Must contain a letter.

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

Amazon RDS Custom for SQL Server

: Not applicable. Must be null.

RDS for Db2

: 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. In some cases, we recommend that you don't add a database
name. For more information, see [Additional considerations][1] in
the *Amazon RDS User Guide*.

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.

RDS for 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.

RDS for 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.

RDS for Oracle

: The Oracle System ID (SID) of the created DB instance. If you don’t

specify a value, the default value is `ORCL`. You can't specify the
string `null`, or any other reserved word, for `DBName`.

Default: `ORCL`

Constraints:

* Can't be longer than 8 characters.

^

RDS for PostgreSQL

: The name of the database to create when the DB instance is created.

A database named `postgres` is always created. If this parameter is
specified, an additional database with this name is created.

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.

RDS for SQL Server

: Not applicable. Must be null.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-db-instance-prereqs.html#db2-prereqs-additional-considerations

:db_instance_identifier (required, String) —
The identifier for this DB instance. 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`

:allocated_storage (Integer) —

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

This setting doesn’t apply to Amazon Aurora DB instances. 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.

Amazon RDS Custom