Class: Aws::RDS::DBCluster

Inherits:

Object

Object
Aws::RDS::DBCluster

show all

Extended by:: Deprecations

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

#activity_stream_kinesis_stream_name ⇒ String

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

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

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

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

‘AllocatedStorage` specifies the allocated storage size in gibibytes (GiB).
#associated_roles ⇒ Array<Types::DBClusterRole>

A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster.
#auto_minor_version_upgrade ⇒ Boolean

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

The time when a stopped DB cluster is restarted automatically.
#availability_zones ⇒ Array<String>

The list of Availability Zones (AZs) where instances in the DB cluster can be created.
#aws_backup_recovery_point_arn ⇒ String

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

The number of change records stored for Backtrack.
#backtrack_window ⇒ Integer

The target backtrack window, in seconds.
#backup_retention_period ⇒ Integer

The number of days for which automatic DB snapshots are retained.
#capacity ⇒ Integer

The current capacity of an Aurora Serverless v1 DB cluster.
#certificate_details ⇒ Types::CertificateDetails

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

If present, specifies the name of the character set that this cluster is associated with.
#clone_group_id ⇒ String

The ID of the clone group with which the DB cluster is associated.
#cluster_create_time ⇒ Time

The time when the DB cluster was created, in Universal Coordinated Time (UTC).
#cluster_scalability_type ⇒ String

The scalability mode of the Aurora DB cluster.
#copy_tags_to_snapshot ⇒ Boolean

Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
#cross_account_clone ⇒ Boolean

Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
#custom_endpoints ⇒ Array<String>

The custom endpoints associated with the DB cluster.
#database_insights_mode ⇒ String

The mode of Database Insights that is enabled for the DB cluster.
#database_name ⇒ String

The name of the initial database that was specified for the DB cluster when it was created, if one was provided.
#db_cluster_arn ⇒ String

The Amazon Resource Name (ARN) for the DB cluster.
#db_cluster_instance_class ⇒ String

The name of the compute and memory capacity class of the DB instance.
#db_cluster_members ⇒ Array<Types::DBClusterMember>

The list of DB instances that make up the DB cluster.
#db_cluster_option_group_memberships ⇒ Array<Types::DBClusterOptionGroupStatus>

The list of option group memberships for this DB cluster.
#db_cluster_parameter_group ⇒ String

The name of the DB cluster parameter group for the DB cluster.
#db_cluster_resource_id ⇒ String

The Amazon Web Services Region-unique, immutable identifier for the DB cluster.
#db_subnet_group ⇒ String

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

Reserved for future use.
#deletion_protection ⇒ Boolean

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

The Active Directory Domain membership records associated with the DB cluster.
#earliest_backtrack_time ⇒ Time

The earliest time to which a DB cluster can be backtracked.
#earliest_restorable_time ⇒ Time

The earliest time to which a database can be restored with point-in-time restore.
#enabled_cloudwatch_logs_exports ⇒ Array<String>

A list of log types that this DB cluster is configured to export to CloudWatch Logs.
#endpoint ⇒ String

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

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

The life cycle type for the DB cluster.
#engine_mode ⇒ String

The DB engine mode of the DB cluster, either ‘provisioned` or `serverless`.
#engine_version ⇒ String

The version of the database engine.
#global_write_forwarding_requested ⇒ Boolean

Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database.
#global_write_forwarding_status ⇒ String

The status of write forwarding for a secondary cluster in an Aurora global database.
#hosted_zone_id ⇒ String

The ID that Amazon Route 53 assigns when you create a hosted zone.
#http_endpoint_enabled ⇒ Boolean

Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.
#iam_database_authentication_enabled ⇒ Boolean

Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
#id ⇒ String (also: #db_cluster_identifier)
#io_optimized_next_allowed_modification_time ⇒ Time

The next time you can modify the DB cluster to use the ‘aurora-iopt1` storage type.
#iops ⇒ Integer

The Provisioned IOPS (I/O operations per second) value.
#kms_key_id ⇒ String

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

The latest time to which a database can be restored with point-in-time restore.
#limitless_database ⇒ Types::LimitlessDatabase

The details for Aurora Limitless Database.
#local_write_forwarding_status ⇒ String

Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
#master_user_secret ⇒ Types::MasterUserSecret

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

The master username for the DB cluster.
#monitoring_interval ⇒ Integer

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

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

Indicates whether the DB cluster has instances in multiple Availability Zones.
#network_type ⇒ String

The network type of the DB instance.
#pending_modified_values ⇒ Types::ClusterPendingModifiedValues

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

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

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

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

The number of days to retain Performance Insights data.
#port ⇒ Integer

The port that the database engine is listening on.
#preferred_backup_window ⇒ String

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

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

Indicates whether the DB cluster is publicly accessible.
#rds_custom_cluster_configuration ⇒ Types::RdsCustomClusterConfiguration

Reserved for future use.
#read_replica_identifiers ⇒ Array<String>

Contains one or more identifiers of the read replicas associated with this DB cluster.
#reader_endpoint ⇒ String

The reader endpoint for the DB cluster.
#replication_source_identifier ⇒ String

The identifier of the source DB cluster if this DB cluster is a read replica.
#scaling_configuration_info ⇒ Types::ScalingConfigurationInfo

The scaling configuration for an Aurora DB cluster in ‘serverless` DB engine mode.
#serverless_v2_scaling_configuration ⇒ Types::ServerlessV2ScalingConfigurationInfo

The scaling configuration for an Aurora Serverless v2 DB cluster.
#status ⇒ String

The current state of this DB cluster.
#status_infos ⇒ Array<Types::DBClusterStatusInfo>

Reserved for future use.
#storage_encrypted ⇒ Boolean

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

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

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

A list of tags.
#vpc_security_groups ⇒ Array<Types::VpcSecurityGroupMembership>

The list of VPC security groups that the DB cluster belongs to.

Actions collapse

#create(options = {}) ⇒ DBCluster
#create_snapshot(options = {}) ⇒ DBClusterSnapshot
#delete(options = {}) ⇒ DBCluster
#failover(options = {}) ⇒ DBCluster
#modify(options = {}) ⇒ DBCluster
#restore(options = {}) ⇒ DBCluster

Associations collapse

#events(options = {}) ⇒ Event::Collection
#identifiers ⇒ Object deprecated private Deprecated.
#members ⇒ DBInstance::Collection
#option_groups ⇒ OptionGroup::Collection
#parameter_group ⇒ DBClusterParameterGroup^?
#snapshots(options = {}) ⇒ DBClusterSnapshot::Collection
#subnet_group ⇒ DBSubnetGroup^?

Instance Method Summary collapse

#client ⇒ Client
#data ⇒ Types::DBCluster

Returns the data for this DBCluster.
#data_loaded? ⇒ Boolean

Returns ‘true` if this resource is loaded.
#initialize(*args) ⇒ DBCluster constructor

A new instance of DBCluster.
#load ⇒ self (also: #reload)

Loads, or reloads #data for the current DBCluster.
#wait_until(options = {}) {|resource| ... } ⇒ Resource deprecated Deprecated.

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

Constructor Details

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

Returns a new instance of DBCluster.

Overloads:

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

# File 'lib/aws-sdk-rds/db_cluster.rb', line 22

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

Instance Method Details

#activity_stream_kinesis_stream_name ⇒ `String`

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

Returns:

(String)



443
444
445

# File 'lib/aws-sdk-rds/db_cluster.rb', line 443

def activity_stream_kinesis_stream_name
  data[:activity_stream_kinesis_stream_name]
end

#activity_stream_kms_key_id ⇒ `String`

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

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

Returns:

(String)



436
437
438

# File 'lib/aws-sdk-rds/db_cluster.rb', line 436

def activity_stream_kms_key_id
  data[:activity_stream_kms_key_id]
end

#activity_stream_mode ⇒ `String`

The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

Returns:

(String)



420
421
422

# File 'lib/aws-sdk-rds/db_cluster.rb', line 420

def activity_stream_mode
  data[:activity_stream_mode]
end

#activity_stream_status ⇒ `String`

The status of the database activity stream.

Returns:

(String)



426
427
428

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

def activity_stream_status
  data[:activity_stream_status]
end

#allocated_storage ⇒ `Integer`

‘AllocatedStorage` specifies the allocated storage size in gibibytes (GiB). For Aurora, `AllocatedStorage` can vary because Aurora DB cluster storage size adjusts as needed.

Returns:

(Integer)



42
43
44

# File 'lib/aws-sdk-rds/db_cluster.rb', line 42

def allocated_storage
  data[:allocated_storage]
end

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

A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.

Returns:

(Array<Types::DBClusterRole>)



272
273
274

# File 'lib/aws-sdk-rds/db_cluster.rb', line 272

def associated_roles
  data[:associated_roles]
end

#auto_minor_version_upgrade ⇒ `Boolean`

Indicates whether minor version patches are applied automatically.

This setting is for Aurora DB clusters and Multi-AZ DB clusters.

Returns:

(Boolean)



556
557
558

# File 'lib/aws-sdk-rds/db_cluster.rb', line 556

def auto_minor_version_upgrade
  data[:auto_minor_version_upgrade]
end

#automatic_restart_time ⇒ `Time`

The time when a stopped DB cluster is restarted automatically.

Returns:

(Time)



95
96
97

# File 'lib/aws-sdk-rds/db_cluster.rb', line 95

def automatic_restart_time
  data[:automatic_restart_time]
end

#availability_zones ⇒ `Array<String>`

The list of Availability Zones (AZs) where instances in the DB cluster can be created.

Returns:

(Array<String>)



49
50
51

# File 'lib/aws-sdk-rds/db_cluster.rb', line 49

def availability_zones
  data[:availability_zones]
end

#aws_backup_recovery_point_arn ⇒ `String`

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

Returns:

(String)



700
701
702

# File 'lib/aws-sdk-rds/db_cluster.rb', line 700

def aws_backup_recovery_point_arn
  data[:aws_backup_recovery_point_arn]
end

#backtrack_consumed_change_records ⇒ `Integer`

The number of change records stored for Backtrack.

Returns:

(Integer)



323
324
325

# File 'lib/aws-sdk-rds/db_cluster.rb', line 323

def backtrack_consumed_change_records
  data[:backtrack_consumed_change_records]
end

#backtrack_window ⇒ `Integer`

The target backtrack window, in seconds. If this value is set to ‘0`, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.

Returns:

(Integer)



317
318
319

# File 'lib/aws-sdk-rds/db_cluster.rb', line 317

def backtrack_window
  data[:backtrack_window]
end

#backup_retention_period ⇒ `Integer`

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

Returns:

(Integer)



55
56
57

# File 'lib/aws-sdk-rds/db_cluster.rb', line 55

def backup_retention_period
  data[:backup_retention_period]
end

#capacity ⇒ `Integer`

The current capacity of an Aurora Serverless v1 DB cluster. The capacity is ‘0` (zero) when the cluster is paused.

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

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html

Returns:

(Integer)



352
353
354

# File 'lib/aws-sdk-rds/db_cluster.rb', line 352

def capacity
  data[:capacity]
end

#certificate_details ⇒ `Types::CertificateDetails`

The details of the DB instance’s server certificate.

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

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

Returns:

(Types::CertificateDetails)



741
742
743

# File 'lib/aws-sdk-rds/db_cluster.rb', line 741

def certificate_details
  data[:certificate_details]
end

#character_set_name ⇒ `String`

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

Returns:

(String)



62
63
64

# File 'lib/aws-sdk-rds/db_cluster.rb', line 62

def character_set_name
  data[:character_set_name]
end

#client ⇒ `Client`

Returns:

(Client)



756
757
758

# File 'lib/aws-sdk-rds/db_cluster.rb', line 756

def client
  @client
end

#clone_group_id ⇒ `String`

The ID of the clone group with which the DB cluster is associated. For newly created clusters, the ID is typically null.

If you clone a DB cluster when the ID is null, the operation populates the ID value for the source cluster and the clone because both clusters become part of the same clone group. Even if you delete the clone cluster, the clone group ID remains for the lifetime of the source cluster to show that it was used in a cloning operation.

For PITR, the clone group ID is inherited from the source cluster. For snapshot restore operations, the clone group ID isn’t inherited from the source cluster.

Returns:

(String)



296
297
298

# File 'lib/aws-sdk-rds/db_cluster.rb', line 296

def clone_group_id
  data[:clone_group_id]
end

#cluster_create_time ⇒ `Time`

The time when the DB cluster was created, in Universal Coordinated Time (UTC).

Returns:

(Time)



303
304
305

# File 'lib/aws-sdk-rds/db_cluster.rb', line 303

def cluster_create_time
  data[:cluster_create_time]
end

#cluster_scalability_type ⇒ `String`

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.

Returns:

(String)



725
726
727

# File 'lib/aws-sdk-rds/db_cluster.rb', line 725

def cluster_scalability_type
  data[:cluster_scalability_type]
end

#copy_tags_to_snapshot ⇒ `Boolean`

Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.

Returns:

(Boolean)



450
451
452

# File 'lib/aws-sdk-rds/db_cluster.rb', line 450

def copy_tags_to_snapshot
  data[:copy_tags_to_snapshot]
end

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

Examples:

Request syntax with placeholder values


dbcluster = db_cluster.create({
  availability_zones: ["String"],
  backup_retention_period: 1,
  character_set_name: "String",
  database_name: "String",
  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",
  database_insights_mode: "standard", # accepts standard, advanced
  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_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 | instance | slowquery`
- Aurora PostgreSQL - ‘instance | 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.

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: Aurora DB clusters and Multi-AZ DB cluster
: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: Aurora DB clusters and Multi-AZ DB clusters

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: Aurora DB clusters and Multi-AZ DB clusters

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

The mode of Database Insights to enable for the DB cluster.

If you set this value to ‘advanced`, you must also set the `PerformanceInsightsEnabled` parameter to `true` and the `PerformanceInsightsRetentionPeriod` parameter to 465.

Valid for Cluster Type: Aurora DB clusters only
: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: Aurora DB clusters and Multi-AZ DB clusters

[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: Aurora DB clusters and Multi-AZ DB clusters
:performance_insights_retention_period (Integer) —
The number of days to retain Performance Insights data.

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

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/db_cluster.rb', line 1814

def create(options = {})
  options = options.merge(db_cluster_identifier: @id)
  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_snapshot(options = {}) ⇒ `DBClusterSnapshot`

Examples:

Request syntax with placeholder values


dbclustersnapshot = db_cluster.create_snapshot({
  db_cluster_snapshot_identifier: "String", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Parameters:

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

({})

Options Hash (options):

:db_cluster_snapshot_identifier (required, String) —
The identifier of the DB cluster snapshot. 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-snapshot1`
:tags (Array<Types::Tag>) —

The tags to be assigned to the DB cluster snapshot.

Returns:

(DBClusterSnapshot)

# File 'lib/aws-sdk-rds/db_cluster.rb', line 1854

def create_snapshot(options = {})
  options = options.merge(db_cluster_identifier: @id)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.create_db_cluster_snapshot(options)
  end
  DBClusterSnapshot.new(
    cluster_id: resp.data.db_cluster_snapshot.db_cluster_identifier,
    snapshot_id: resp.data.db_cluster_snapshot.db_cluster_snapshot_identifier,
    data: resp.data.db_cluster_snapshot,
    client: @client
  )
end

#cross_account_clone ⇒ `Boolean`

Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

Returns:

(Boolean)



457
458
459

# File 'lib/aws-sdk-rds/db_cluster.rb', line 457

def cross_account_clone
  data[:cross_account_clone]
end

#custom_endpoints ⇒ `Array<String>`

The custom endpoints associated with the DB cluster.

Returns:

(Array<String>)



136
137
138

# File 'lib/aws-sdk-rds/db_cluster.rb', line 136

def custom_endpoints
  data[:custom_endpoints]
end

#data ⇒ `Types::DBCluster`

Returns the data for this Aws::RDS::DBCluster. Calls Client#describe_db_clusters if #data_loaded? is ‘false`.

Returns:

(Types::DBCluster) —

Returns the data for this Aws::RDS::DBCluster. Calls Client#describe_db_clusters if #data_loaded? is ‘false`.

# File 'lib/aws-sdk-rds/db_cluster.rb', line 778

def data
  load unless @data
  @data
end

#data_loaded? ⇒ `Boolean`

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

Returns:

(Boolean) —

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



786
787
788

# File 'lib/aws-sdk-rds/db_cluster.rb', line 786

def data_loaded?
  !!@data
end

#database_insights_mode ⇒ `String`

The mode of Database Insights that is enabled for the DB cluster.

Returns:

(String)



580
581
582

# File 'lib/aws-sdk-rds/db_cluster.rb', line 580

def database_insights_mode
  data[:database_insights_mode]
end

#database_name ⇒ `String`

The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.

Returns:

(String)



70
71
72

# File 'lib/aws-sdk-rds/db_cluster.rb', line 70

def database_name
  data[:database_name]
end

#db_cluster_arn ⇒ `String`

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

Returns:

(String)



263
264
265

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

def db_cluster_arn
  data[:db_cluster_arn]
end

#db_cluster_instance_class ⇒ `String`

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

This setting is only for non-Aurora Multi-AZ DB clusters.

Returns:

(String)



512
513
514

# File 'lib/aws-sdk-rds/db_cluster.rb', line 512

def db_cluster_instance_class
  data[:db_cluster_instance_class]
end

#db_cluster_members ⇒ `Array<Types::DBClusterMember>`

The list of DB instances that make up the DB cluster.

Returns:

(Array<Types::DBClusterMember>)



221
222
223

# File 'lib/aws-sdk-rds/db_cluster.rb', line 221

def db_cluster_members
  data[:db_cluster_members]
end

#db_cluster_option_group_memberships ⇒ `Array<Types::DBClusterOptionGroupStatus>`

The list of option group memberships for this DB cluster.

Returns:

(Array<Types::DBClusterOptionGroupStatus>)



180
181
182

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

def db_cluster_option_group_memberships
  data[:db_cluster_option_group_memberships]
end

#db_cluster_parameter_group ⇒ `String`

The name of the DB cluster parameter group for the DB cluster.

Returns:

(String)



76
77
78

# File 'lib/aws-sdk-rds/db_cluster.rb', line 76

def db_cluster_parameter_group
  data[:db_cluster_parameter_group]
end

#db_cluster_resource_id ⇒ `String`

The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

Returns:

(String)



257
258
259

# File 'lib/aws-sdk-rds/db_cluster.rb', line 257

def db_cluster_resource_id
  data[:db_cluster_resource_id]
end

#db_subnet_group ⇒ `String`

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

Returns:

(String)



83
84
85

# File 'lib/aws-sdk-rds/db_cluster.rb', line 83

def db_subnet_group
  data[:db_subnet_group]
end

#db_system_id ⇒ `String`

Reserved for future use.

Returns:

(String)



660
661
662

# File 'lib/aws-sdk-rds/db_cluster.rb', line 660

def db_system_id
  data[:db_system_id]
end

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

Examples:

Request syntax with placeholder values


dbcluster = db_cluster.delete({
  skip_final_snapshot: false,
  final_db_snapshot_identifier: "String",
  delete_automated_backups: false,
})

Parameters:

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

({})

Options Hash (options):

:skip_final_snapshot (Boolean) —
Specifies whether to skip the creation of a final DB cluster snapshot before RDS deletes the DB cluster. If you set this value to ‘true`, RDS doesn’t create a final DB cluster snapshot. If you set this value to ‘false` or don’t specify it, RDS creates a DB cluster snapshot before it deletes the DB cluster. By default, this parameter is disabled, so RDS creates a final DB cluster snapshot.

<note markdown=“1”> If ‘SkipFinalSnapshot` is disabled, you must specify a value for the `FinalDBSnapshotIdentifier` parameter.
```
</note>
```
:final_db_snapshot_identifier (String) —
The DB cluster snapshot identifier of the new DB cluster snapshot created when ‘SkipFinalSnapshot` is disabled.

<note markdown=“1”> If you specify this parameter and also skip the creation of a final DB cluster snapshot with the ‘SkipFinalShapshot` parameter, the request results in an error.
```
</note>
```
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
:delete_automated_backups (Boolean) —

Specifies whether to remove automated backups immediately after the DB cluster is deleted. This parameter isn’t case-sensitive. The default is to remove automated backups immediately after the DB cluster is deleted, unless the Amazon Web Services Backup policy specifies a point-in-time restore rule.

Returns:

(DBCluster)

# File 'lib/aws-sdk-rds/db_cluster.rb', line 1911

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

#deletion_protection ⇒ `Boolean`

Indicates whether the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled.

Returns:

(Boolean)



392
393
394

# File 'lib/aws-sdk-rds/db_cluster.rb', line 392

def deletion_protection
  data[:deletion_protection]
end

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

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

Returns:

(Array<Types::DomainMembership>)



464
465
466

# File 'lib/aws-sdk-rds/db_cluster.rb', line 464

def domain_memberships
  data[:domain_memberships]
end

#earliest_backtrack_time ⇒ `Time`

The earliest time to which a DB cluster can be backtracked.

Returns:

(Time)



309
310
311

# File 'lib/aws-sdk-rds/db_cluster.rb', line 309

def earliest_backtrack_time
  data[:earliest_backtrack_time]
end

#earliest_restorable_time ⇒ `Time`

The earliest time to which a database can be restored with point-in-time restore.

Returns:

(Time)



108
109
110

# File 'lib/aws-sdk-rds/db_cluster.rb', line 108

def earliest_restorable_time
  data[:earliest_restorable_time]
end

#enabled_cloudwatch_logs_exports ⇒ `Array<String>`

A list of log types that this DB cluster is configured to export to CloudWatch Logs.

Log types vary by DB engine. For information about the log types for each DB engine, see [Amazon RDS Database Log Files] in the *Amazon Aurora User Guide.*

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

Returns:

(Array<String>)



338
339
340

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

def enabled_cloudwatch_logs_exports
  data[:enabled_cloudwatch_logs_exports]
end

#endpoint ⇒ `String`

The connection endpoint for the primary instance of the DB cluster.

Returns:

(String)



114
115
116

# File 'lib/aws-sdk-rds/db_cluster.rb', line 114

def endpoint
  data[:endpoint]
end

#engine ⇒ `String`

The database engine used for this DB cluster.

Returns:

(String)



149
150
151

# File 'lib/aws-sdk-rds/db_cluster.rb', line 149

def engine
  data[:engine]
end

#engine_lifecycle_support ⇒ `String`

The life cycle type for the DB cluster.

For more information, see CreateDBCluster.

Returns:

(String)



749
750
751

# File 'lib/aws-sdk-rds/db_cluster.rb', line 749

def engine_lifecycle_support
  data[:engine_lifecycle_support]
end

#engine_mode ⇒ `String`

The DB engine mode of the DB cluster, either ‘provisioned` or `serverless`.

For more information, see [ CreateDBCluster].

[1]: docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html

Returns:

(String)



365
366
367

# File 'lib/aws-sdk-rds/db_cluster.rb', line 365

def engine_mode
  data[:engine_mode]
end

#engine_version ⇒ `String`

The version of the database engine.

Returns:

(String)



155
156
157

# File 'lib/aws-sdk-rds/db_cluster.rb', line 155

def engine_version
  data[:engine_version]
end

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

({})

Options Hash (options):

:start_time (Time, DateTime, Date, Integer, String) —

The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the

ISO8601 Wikipedia page.][1

Example: 2009-07-08T18:00Z

[1]: en.wikipedia.org/wiki/ISO_8601
:end_time (Time, DateTime, Date, Integer, String) —

The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the

ISO8601 Wikipedia page.][1

Example: 2009-07-08T18:00Z

[1]: en.wikipedia.org/wiki/ISO_8601
:duration (Integer) —

The number of minutes to retrieve events for.

Default: 60
:event_categories (Array<String>) —

A list of event categories that trigger notifications for a event notification subscription.
:filters (Array<Types::Filter>) —

This parameter isn’t currently supported.

Returns:

(Event::Collection)

# File 'lib/aws-sdk-rds/db_cluster.rb', line 3253

def events(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(
      source_type: "db-cluster",
      source_identifier: @id
    )
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.describe_events(options)
    end
    resp.each_page do |page|
      batch = []
      page.data.events.each do |e|
        batch << Event.new(
          source_id: e.source_identifier,
          date: e.date,
          data: e,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  Event::Collection.new(batches)
end

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

Examples:

Request syntax with placeholder values


dbcluster = db_cluster.failover({
  target_db_instance_identifier: "String",
})

Parameters:

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

({})

Options Hash (options):

:target_db_instance_identifier (String) —

The name of the DB instance to promote to the primary DB instance.

Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster, for example ‘mydbcluster-replica1`.

This setting isn’t supported for RDS for MySQL Multi-AZ DB clusters.

Returns:

(DBCluster)

# File 'lib/aws-sdk-rds/db_cluster.rb', line 1938

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

#global_write_forwarding_requested ⇒ `Boolean`

Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of ‘GlobalWriteForwardingStatus` to confirm that the request has completed before using the write forwarding feature for this cluster.

Returns:

(Boolean)



496
497
498

# File 'lib/aws-sdk-rds/db_cluster.rb', line 496

def global_write_forwarding_requested
  data[:global_write_forwarding_requested]
end

#global_write_forwarding_status ⇒ `String`

The status of write forwarding for a secondary cluster in an Aurora global database.

Returns:

(String)



486
487
488

# File 'lib/aws-sdk-rds/db_cluster.rb', line 486

def global_write_forwarding_status
  data[:global_write_forwarding_status]
end

#hosted_zone_id ⇒ `String`

The ID that Amazon Route 53 assigns when you create a hosted zone.

Returns:

(String)



233
234
235

# File 'lib/aws-sdk-rds/db_cluster.rb', line 233

def hosted_zone_id
  data[:hosted_zone_id]
end

#http_endpoint_enabled ⇒ `Boolean`

Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.

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.

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

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

Returns:

(Boolean)



411
412
413

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

def http_endpoint_enabled
  data[:http_endpoint_enabled]
end

#iam_database_authentication_enabled ⇒ `Boolean`

Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

Returns:

(Boolean)



279
280
281

# File 'lib/aws-sdk-rds/db_cluster.rb', line 279

def iam_database_authentication_enabled
  data[:iam_database_authentication_enabled]
end

#id ⇒ `String` Also known as: db_cluster_identifier

Returns:

(String)



33
34
35

# File 'lib/aws-sdk-rds/db_cluster.rb', line 33

def id
  @id
end

#identifiers ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated.



3440
3441
3442

# File 'lib/aws-sdk-rds/db_cluster.rb', line 3440

def identifiers
  { id: @id }
end

#io_optimized_next_allowed_modification_time ⇒ `Time`

The next time you can modify the DB cluster to use the ‘aurora-iopt1` storage type.

This setting is only for Aurora DB clusters.

Returns:

(Time)



686
687
688

# File 'lib/aws-sdk-rds/db_cluster.rb', line 686

def io_optimized_next_allowed_modification_time
  data[:io_optimized_next_allowed_modification_time]
end

#iops ⇒ `Integer`

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

This setting is only for non-Aurora Multi-AZ DB clusters.

Returns:

(Integer)



526
527
528

# File 'lib/aws-sdk-rds/db_cluster.rb', line 526

def iops
  data[:iops]
end

#kms_key_id ⇒ `String`

If ‘StorageEncrypted` is enabled, the Amazon Web Services KMS key identifier for the 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.

Returns:

(String)



249
250
251

# File 'lib/aws-sdk-rds/db_cluster.rb', line 249

def kms_key_id
  data[:kms_key_id]
end

#latest_restorable_time ⇒ `Time`

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

Returns:

(Time)



162
163
164

# File 'lib/aws-sdk-rds/db_cluster.rb', line 162

def latest_restorable_time
  data[:latest_restorable_time]
end

#limitless_database ⇒ `Types::LimitlessDatabase`

The details for Aurora Limitless Database.

Returns:

(Types::LimitlessDatabase)



706
707
708

# File 'lib/aws-sdk-rds/db_cluster.rb', line 706

def limitless_database
  data[:limitless_database]
end

#load ⇒ `self` Also known as: reload

Loads, or reloads #data for the current Aws::RDS::DBCluster. Returns ‘self` making it possible to chain methods.

db_cluster.reload.data

Returns:

(self)

# File 'lib/aws-sdk-rds/db_cluster.rb', line 766

def load
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.describe_db_clusters(db_cluster_identifier: @id)
  end
  @data = resp.db_clusters[0]
  self
end

#local_write_forwarding_status ⇒ `String`

Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.

Returns:

(String)



693
694
695

# File 'lib/aws-sdk-rds/db_cluster.rb', line 693

def local_write_forwarding_status
  data[:local_write_forwarding_status]
end

#master_user_secret ⇒ `Types::MasterUserSecret`

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

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

Password management with Amazon Web Services Secrets Manager][2: in

the *Amazon Aurora User Guide.*

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

Returns:

(Types::MasterUserSecret)



677
678
679

# File 'lib/aws-sdk-rds/db_cluster.rb', line 677

def master_user_secret
  data[:master_user_secret]
end

#master_username ⇒ `String`

The master username for the DB cluster.

Returns:

(String)



174
175
176

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

def master_username
  data[:master_username]
end

#members ⇒ `DBInstance::Collection`

Returns:

(DBInstance::Collection)

# File 'lib/aws-sdk-rds/db_cluster.rb', line 3279

def members
  batch = []
  data[:db_cluster_members].each do |d|
    batch << DBInstance.new(
      id: d[:db_instance_identifier],
      data: d,
      client: @client
    )
  end
  DBInstance::Collection.new([batch], size: batch.size)
end

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

Examples:

Request syntax with placeholder values


dbcluster = db_cluster.modify({
  new_db_cluster_identifier: "String",
  apply_immediately: false,
  backup_retention_period: 1,
  db_cluster_parameter_group_name: "String",
  vpc_security_group_ids: ["String"],
  port: 1,
  master_user_password: "String",
  option_group_name: "String",
  preferred_backup_window: "String",
  preferred_maintenance_window: "String",
  enable_iam_database_authentication: false,
  backtrack_window: 1,
  cloudwatch_logs_export_configuration: {
    enable_log_types: ["String"],
    disable_log_types: ["String"],
  },
  engine_version: "String",
  allow_major_version_upgrade: false,
  db_instance_parameter_group_name: "String",
  domain: "String",
  domain_iam_role_name: "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,
  enable_http_endpoint: false,
  copy_tags_to_snapshot: false,
  enable_global_write_forwarding: false,
  db_cluster_instance_class: "String",
  allocated_storage: 1,
  storage_type: "String",
  iops: 1,
  auto_minor_version_upgrade: false,
  monitoring_interval: 1,
  monitoring_role_arn: "String",
  database_insights_mode: "standard", # accepts standard, advanced
  enable_performance_insights: false,
  performance_insights_kms_key_id: "String",
  performance_insights_retention_period: 1,
  serverless_v2_scaling_configuration: {
    min_capacity: 1.0,
    max_capacity: 1.0,
    seconds_until_auto_pause: 1,
  },
  network_type: "String",
  manage_master_user_password: false,
  rotate_master_user_password: false,
  master_user_secret_kms_key_id: "String",
  engine_mode: "String",
  allow_engine_mode_change: false,
  enable_local_write_forwarding: false,
  aws_backup_recovery_point_arn: "AwsBackupRecoveryPointArn",
  enable_limitless_database: false,
  ca_certificate_identifier: "String",
})

Parameters:

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

({})

Options Hash (options):

:new_db_cluster_identifier (String) —
The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value 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 letters, numbers, or hyphens.
- The first character must be a letter.
- Can’t end with a hyphen or contain two consecutive hyphens.
Example: ‘my-cluster2`
:apply_immediately (Boolean) —

Specifies whether the modifications in this request are asynchronously applied as soon as possible, regardless of the ‘PreferredMaintenanceWindow` setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window.

Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them.

By default, this parameter is disabled.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
:backup_retention_period (Integer) —
The number of days for which automated backups are retained. Specify a minimum value of ‘1`.

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

Default: ‘1`

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

The name of the DB cluster parameter group to use for the DB cluster.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
: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
:port (Integer) —

The port number on which the DB cluster accepts connections.

Valid for Cluster Type: Aurora DB clusters only

Valid Values: ‘1150-65535`

Default: The same port as the original DB cluster.
:master_user_password (String) —
The new 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.

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

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

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, in Universal Coordinated Time (UTC).

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
: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).
^
:cloudwatch_logs_export_configuration (Types::CloudwatchLogsExportConfiguration) —
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

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 | instance | slowquery`
- Aurora PostgreSQL - ‘instance | 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_version (String) —

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ‘ApplyImmediately` is enabled.

If the cluster that you’re modifying has one or more read replicas, all replicas must be running an engine version that’s the same or later than the version you specify.

To list all of the available engine versions for Aurora MySQL, 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”`

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

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
:allow_major_version_upgrade (Boolean) —
Specifies whether major version upgrades are allowed.

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

Constraints:
- You must allow major version upgrades when specifying a value for the ‘EngineVersion` parameter that is a different major version than the DB cluster’s current version.
^
:db_instance_parameter_group_name (String) —
The name of the DB parameter group to apply to all instances of the DB cluster.

<note markdown=“1”> When you apply a parameter group using the ‘DBInstanceParameterGroupName` parameter, the DB cluster isn’t rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.
```
</note>
```
Valid for Cluster Type: Aurora DB clusters only

Default: The existing name setting

Constraints:
- The DB parameter group must be in the same DB parameter group family as this DB cluster.
- The ‘DBInstanceParameterGroupName` parameter is valid in combination with the `AllowMajorVersionUpgrade` parameter for a major version upgrade only.
:domain (String) —

The Active Directory directory ID to move the DB cluster to. Specify ‘none` to remove the cluster from its current domain. The domain must be created prior to this operation.

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
:scaling_configuration (Types::ScalingConfiguration) —

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in ‘serverless` DB engine mode.

Valid for Cluster Type: Aurora DB clusters only
: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
:enable_http_endpoint (Boolean) —
Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 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 Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the RDS query editor.

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

<note markdown=“1”> This parameter applies only to Aurora Serverless v1 DB clusters. To enable or disable the HTTP endpoint for an Aurora Serverless v2 or provisioned DB cluster, use the ‘EnableHttpEndpoint` and `DisableHttpEndpoint` operations.
```
</note>
```
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
: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*.

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

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`
[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 [Amazon RDS Provisioned IOPS storage] in the *Amazon RDS User Guide*.

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
: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: Aurora DB clusters and Multi-AZ DB clusters
: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 [To create an IAM role for Amazon RDS Enhanced Monitoring] in the *Amazon RDS User Guide.*

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

Valid for Cluster Type: Multi-AZ DB clusters only

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole
:database_insights_mode (String) —

Specifies the mode of Database Insights to enable for the DB cluster.

If you change the value from ‘standard` to `advanced`, you must set the `PerformanceInsightsEnabled` parameter to `true` and the `PerformanceInsightsRetentionPeriod` parameter to 465.

If you change the value from ‘advanced` to `standard`, you must set the `PerformanceInsightsEnabled` parameter to `false`.

Valid for Cluster Type: Aurora DB clusters only
: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: Aurora DB clusters and Multi-AZ DB clusters

[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: Aurora DB clusters and Multi-AZ DB clusters
:performance_insights_retention_period (Integer) —
The number of days to retain Performance Insights data.

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

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.
: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
:manage_master_user_password (Boolean) —

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

If the DB cluster doesn’t manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can’t specify ‘MasterUserPassword`.

If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify ‘MasterUserPassword`. In this case, RDS deletes the secret and uses the new password for the master user specified by `MasterUserPassword`.

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

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html [2]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html
:rotate_master_user_password (Boolean) —
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.

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 secret value contains the updated password.

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:
- You must apply the change immediately when rotating the master user password.
^

[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 both of the following conditions are met:
- The DB cluster doesn’t manage the master user password in Amazon Web Services Secrets Manager.
  
  If the DB cluster already manages the master user password in Amazon Web Services Secrets Manager, you can’t change the KMS key that is used to encrypt the secret.
- You are turning on ‘ManageMasterUserPassword` to manage the master user password in Amazon Web Services Secrets Manager.
  
  If you are turning on ‘ManageMasterUserPassword` and 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.
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.

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
:engine_mode (String) —
The DB engine mode of the DB cluster, either ‘provisioned` or `serverless`.

<note markdown=“1”> The DB engine mode can be modified only from ‘serverless` to `provisioned`.
```
</note>
```
For more information, see [ CreateDBCluster].

Valid for Cluster Type: Aurora DB clusters only

[1]: docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html
:allow_engine_mode_change (Boolean) —
Specifies whether engine mode changes from ‘serverless` to `provisioned` are allowed.

Valid for Cluster Type: Aurora Serverless v1 DB clusters only

Constraints:
- You must allow engine mode changes when specifying a different value for the ‘EngineMode` parameter from the DB cluster’s current engine mode.
^
: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
:aws_backup_recovery_point_arn (String) —

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
: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 when you create your Aurora Limitless Database DB cluster.
```
</note>
```
: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

Returns:

(DBCluster)

# File 'lib/aws-sdk-rds/db_cluster.rb', line 2673

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

#monitoring_interval ⇒ `Integer`

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

This setting is only for -Aurora DB clusters and Multi-AZ DB clusters.

Returns:

(Integer)



565
566
567

# File 'lib/aws-sdk-rds/db_cluster.rb', line 565

def monitoring_interval
  data[:monitoring_interval]
end

#monitoring_role_arn ⇒ `String`

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

This setting is only for Aurora DB clusters and Multi-AZ DB clusters.

Returns:

(String)



574
575
576

# File 'lib/aws-sdk-rds/db_cluster.rb', line 574

def monitoring_role_arn
  data[:monitoring_role_arn]
end

#multi_az ⇒ `Boolean`

Indicates whether the DB cluster has instances in multiple Availability Zones.

Returns:

(Boolean)



143
144
145

# File 'lib/aws-sdk-rds/db_cluster.rb', line 143

def multi_az
  data[:multi_az]
end

#network_type ⇒ `String`

The network type of the DB instance.

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

This setting is only for Aurora DB clusters.

Valid Values: ‘IPV4 | DUAL`

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

Returns:

(String)



654
655
656

# File 'lib/aws-sdk-rds/db_cluster.rb', line 654

def network_type
  data[:network_type]
end

#option_groups ⇒ `OptionGroup::Collection`

Returns:

(OptionGroup::Collection)

# File 'lib/aws-sdk-rds/db_cluster.rb', line 3292

def option_groups
  batch = []
  data[:db_cluster_option_group_memberships].each do |d|
    batch << OptionGroup.new(
      name: d[:db_cluster_option_group_name],
      data: d,
      client: @client
    )
  end
  OptionGroup::Collection.new([batch], size: batch.size)
end

#parameter_group ⇒ `DBClusterParameterGroup`^?

Returns:

(DBClusterParameterGroup, nil)

# File 'lib/aws-sdk-rds/db_cluster.rb', line 3305

def parameter_group
  if data[:db_cluster_parameter_group]
    DBClusterParameterGroup.new(
      name: data[:db_cluster_parameter_group],
      client: @client
    )
  else
    nil
  end
end

#pending_modified_values ⇒ `Types::ClusterPendingModifiedValues`

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

Returns:

(Types::ClusterPendingModifiedValues)



504
505
506

# File 'lib/aws-sdk-rds/db_cluster.rb', line 504

def pending_modified_values
  data[:pending_modified_values]
end

#percent_progress ⇒ `String`

The progress of the operation as a percentage.

Returns:

(String)



101
102
103

# File 'lib/aws-sdk-rds/db_cluster.rb', line 101

def percent_progress
  data[:percent_progress]
end

#performance_insights_enabled ⇒ `Boolean`

Indicates whether Performance Insights is enabled for the DB cluster.

This setting is only for Aurora DB clusters and Multi-AZ DB clusters.

Returns:

(Boolean)



588
589
590

# File 'lib/aws-sdk-rds/db_cluster.rb', line 588

def performance_insights_enabled
  data[:performance_insights_enabled]
end

#performance_insights_kms_key_id ⇒ `String`

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

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

This setting is only for Aurora DB clusters and Multi-AZ DB clusters.

Returns:

(String)



600
601
602

# File 'lib/aws-sdk-rds/db_cluster.rb', line 600

def performance_insights_kms_key_id
  data[:performance_insights_kms_key_id]
end

#performance_insights_retention_period ⇒ `Integer`

The number of days to retain Performance Insights data.

This setting is only for Aurora DB clusters and Multi-AZ DB clusters.

Valid Values:

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

Default: ‘7` days

Returns:

(Integer)



620
621
622

# File 'lib/aws-sdk-rds/db_cluster.rb', line 620

def performance_insights_retention_period
  data[:performance_insights_retention_period]
end

#port ⇒ `Integer`

The port that the database engine is listening on.

Returns:

(Integer)



168
169
170

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

def port
  data[:port]
end

#preferred_backup_window ⇒ `String`

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

Returns:

(String)



188
189
190

# File 'lib/aws-sdk-rds/db_cluster.rb', line 188

def preferred_backup_window
  data[:preferred_backup_window]
end

#preferred_maintenance_window ⇒ `String`

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

Returns:

(String)



195
196
197

# File 'lib/aws-sdk-rds/db_cluster.rb', line 195

def preferred_maintenance_window
  data[:preferred_maintenance_window]
end

#publicly_accessible ⇒ `Boolean`

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

For more information, see CreateDBCluster.

This setting is only for non-Aurora Multi-AZ DB clusters.

Returns:

(Boolean)



548
549
550

# File 'lib/aws-sdk-rds/db_cluster.rb', line 548

def publicly_accessible
  data[:publicly_accessible]
end

#rds_custom_cluster_configuration ⇒ `Types::RdsCustomClusterConfiguration`

Reserved for future use.

Returns:

(Types::RdsCustomClusterConfiguration)



385
386
387

# File 'lib/aws-sdk-rds/db_cluster.rb', line 385

def rds_custom_cluster_configuration
  data[:rds_custom_cluster_configuration]
end

#read_replica_identifiers ⇒ `Array<String>`

Contains one or more identifiers of the read replicas associated with this DB cluster.

Returns:

(Array<String>)



209
210
211

# File 'lib/aws-sdk-rds/db_cluster.rb', line 209

def read_replica_identifiers
  data[:read_replica_identifiers]
end

#reader_endpoint ⇒ `String`

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

Returns:

(String)



130
131
132

# File 'lib/aws-sdk-rds/db_cluster.rb', line 130

def reader_endpoint
  data[:reader_endpoint]
end

#replication_source_identifier ⇒ `String`

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

Returns:

(String)



202
203
204

# File 'lib/aws-sdk-rds/db_cluster.rb', line 202

def replication_source_identifier
  data[:replication_source_identifier]
end

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

Examples:

Request syntax with placeholder values


dbcluster = db_cluster.restore({
  db_cluster_identifier: "String", # required
  restore_type: "String",
  restore_to_time: Time.now,
  use_latest_restorable_time: false,
  port: 1,
  db_subnet_group_name: "String",
  option_group_name: "String",
  vpc_security_group_ids: ["String"],
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  kms_key_id: "String",
  enable_iam_database_authentication: false,
  backtrack_window: 1,
  enable_cloudwatch_logs_exports: ["String"],
  db_cluster_parameter_group_name: "String",
  deletion_protection: false,
  copy_tags_to_snapshot: false,
  domain: "String",
  domain_iam_role_name: "String",
  scaling_configuration: {
    min_capacity: 1,
    max_capacity: 1,
    auto_pause: false,
    seconds_until_auto_pause: 1,
    timeout_action: "String",
    seconds_before_timeout: 1,
  },
  engine_mode: "String",
  db_cluster_instance_class: "String",
  storage_type: "String",
  publicly_accessible: false,
  iops: 1,
  serverless_v2_scaling_configuration: {
    min_capacity: 1.0,
    max_capacity: 1.0,
    seconds_until_auto_pause: 1,
  },
  network_type: "String",
  source_db_cluster_resource_id: "String",
  rds_custom_cluster_configuration: {
    interconnect_subnet_id: "String",
    transit_gateway_multicast_domain_id: "String",
    replica_mode: "open-read-only", # accepts open-read-only, mounted
  },
  monitoring_interval: 1,
  monitoring_role_arn: "String",
  enable_performance_insights: false,
  performance_insights_kms_key_id: "String",
  performance_insights_retention_period: 1,
  engine_lifecycle_support: "String",
})

Parameters:

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

({})

Options Hash (options):

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

Constraints:
- Must contain from 1 to 63 letters, numbers, or hyphens
- First character must be a letter
- Can’t end with a hyphen or contain two consecutive hyphens
Valid for: Aurora DB clusters and Multi-AZ DB clusters
:restore_type (String) —
The type of restore to be performed. You can specify one of the following values:
- ‘full-copy` - The new DB cluster is restored as a full copy of the source DB cluster.
- ‘copy-on-write` - The new DB cluster is restored as a clone of the source DB cluster.
If you don’t specify a ‘RestoreType` value, then the new DB cluster is restored as a full copy of the source DB cluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters
:restore_to_time (Time, DateTime, Date, Integer, String) —
The date and time to restore the DB cluster to.

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

Constraints:
- Must be before the latest restorable time for the DB instance
- Must be specified if ‘UseLatestRestorableTime` parameter isn’t provided
- Can’t be specified if the ‘UseLatestRestorableTime` parameter is enabled
- Can’t be specified if the ‘RestoreType` parameter is `copy-on-write`
Example: ‘2015-03-07T23:45:00Z`

Valid for: Aurora DB clusters and Multi-AZ DB clusters
:use_latest_restorable_time (Boolean) —

Specifies whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn’t restored to the latest restorable backup time.

Constraints: Can’t be specified if ‘RestoreToTime` parameter is provided.

Valid for: Aurora DB clusters and Multi-AZ DB clusters
:port (Integer) —

The port number on which the new DB cluster accepts connections.

Constraints: A value from ‘1150-65535`.

Default: The default port for the engine.

Valid for: Aurora DB clusters and Multi-AZ DB clusters
:db_subnet_group_name (String) —

The DB subnet group name to use for the new DB cluster.

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

Example: ‘mydbsubnetgroup`

Valid for: Aurora DB clusters and Multi-AZ DB clusters
:option_group_name (String) —

The name of the option group for the new DB cluster.

DB clusters are associated with a default option group that can’t be modified.
:vpc_security_group_ids (Array<String>) —

A list of VPC security groups that the new DB cluster belongs to.

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

A list of tags.

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

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html [2]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html
:kms_key_id (String) —
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from 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.

You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the ‘KmsKeyId` parameter.

If you don’t specify a value for the ‘KmsKeyId` parameter, then the following occurs:
- If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
- If the DB cluster isn’t encrypted, then the restored DB cluster isn’t encrypted.
If ‘DBClusterIdentifier` refers to a DB cluster that isn’t encrypted, then the restore request is rejected.

Valid for: Aurora DB clusters and Multi-AZ DB clusters
: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: 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.

Default: 0

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

Valid for: Aurora MySQL DB clusters only
:enable_cloudwatch_logs_exports (Array<String>) —

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.

**RDS for MySQL**

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

**RDS for PostgreSQL**

Possible values are ‘postgresql` and `upgrade`.

**Aurora MySQL**

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

**Aurora PostgreSQL**

Possible value are ‘instance` and `postgresql`.

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

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

[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
:db_cluster_parameter_group_name (String) —
The name of the custom DB cluster parameter group to associate with this DB cluster.

If the ‘DBClusterParameterGroupName` parameter is omitted, the default DB cluster parameter group for the specified engine is used.

Constraints:
- If supplied, must match the name of an existing DB cluster parameter group.
- 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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
:deletion_protection (Boolean) —

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

Valid for: Aurora DB clusters and Multi-AZ DB clusters
:copy_tags_to_snapshot (Boolean) —

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

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

The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.

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: 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 be used when making API calls to the Directory Service.

Valid for: Aurora DB clusters only
:scaling_configuration (Types::ScalingConfiguration) —

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

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

The engine mode of the new cluster. Specify ‘provisioned` or `serverless`, depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or an encrypted provisioned cluster. To create a full copy that is an Aurora Serverless v1 cluster, specify the engine mode `serverless`.

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

The compute and memory capacity of the 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*.

Valid for: Multi-AZ DB clusters only

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

Specifies the storage type to be associated with the DB cluster.

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

Valid Values: ‘aurora`, `aurora-iopt1` (Aurora DB clusters); `io1` (Multi-AZ DB clusters)

Default: ‘aurora` (Aurora DB clusters); `io1` (Multi-AZ DB clusters)

Valid for: Aurora DB clusters and Multi-AZ DB clusters
:publicly_accessible (Boolean) —
Specifies whether the DB cluster is publicly accessible.

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster’s virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster’s VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not 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.

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.
Valid for: Multi-AZ DB clusters only
: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 [Amazon RDS Provisioned IOPS storage] in the *Amazon RDS User Guide*.

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

Valid for: Multi-AZ DB clusters only

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
: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.

Valid Values:
- ‘IPV4`
- ‘DUAL`
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: Aurora DB clusters only

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
:source_db_cluster_resource_id (String) —

The resource ID of the source DB cluster from which to restore.
:rds_custom_cluster_configuration (Types::RdsCustomClusterConfiguration) —

Reserved for future use.
: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 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`.

If ‘MonitoringInterval` is set to a value other than `0`, supply a `MonitoringRoleArn` value.
:enable_performance_insights (Boolean) —

Specifies whether to turn on Performance Insights for the DB cluster.
: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.
:performance_insights_retention_period (Integer) —
The number of days to retain Performance Insights data.

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

If you specify a retention period that isn’t valid, such as ‘94`, Amazon RDS issues an error.
: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, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine 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

Returns:

(DBCluster)

# File 'lib/aws-sdk-rds/db_cluster.rb', line 3194

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

#scaling_configuration_info ⇒ `Types::ScalingConfigurationInfo`

The scaling configuration for an Aurora DB cluster in ‘serverless` DB engine mode.

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

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html

Returns:

(Types::ScalingConfigurationInfo)



379
380
381

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

def scaling_configuration_info
  data[:scaling_configuration_info]
end

#serverless_v2_scaling_configuration ⇒ `Types::ServerlessV2ScalingConfigurationInfo`

The scaling configuration for 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

Returns:

(Types::ServerlessV2ScalingConfigurationInfo)



633
634
635

# File 'lib/aws-sdk-rds/db_cluster.rb', line 633

def serverless_v2_scaling_configuration
  data[:serverless_v2_scaling_configuration]
end

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

Examples:

Request syntax with placeholder values


snapshots = db_cluster.snapshots({
  db_cluster_snapshot_identifier: "String",
  snapshot_type: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  include_shared: false,
  include_public: false,
  db_cluster_resource_id: "String",
})

Parameters:

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

({})

Options Hash (options):

:db_cluster_snapshot_identifier (String) —
A specific DB cluster snapshot identifier to describe. This parameter can’t be used in conjunction with the ‘DBClusterIdentifier` parameter. This value is stored as a lowercase string.

Constraints:
- If supplied, must match the identifier of an existing DBClusterSnapshot.
- If this identifier is for an automated snapshot, the ‘SnapshotType` parameter must also be specified.
:snapshot_type (String) —
The type of DB cluster snapshots to be returned. You can specify one of the following values:
- ‘automated` - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.
- ‘manual` - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.
- ‘shared` - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.
- ‘public` - Return all DB cluster snapshots that have been marked as public.
If you don’t specify a ‘SnapshotType` value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the `IncludeShared` parameter. You can include public DB cluster snapshots with these results by enabling the `IncludePublic` parameter.

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

Supported filters:
- ‘db-cluster-id` - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
- ‘db-cluster-snapshot-id` - Accepts DB cluster snapshot identifiers.
- ‘snapshot-type` - Accepts types of DB cluster snapshots.
- ‘engine` - Accepts names of database engines.
:include_shared (Boolean) —

Specifies 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 cluster snapshot from another Amazon Web Services account by the ‘ModifyDBClusterSnapshotAttribute` API action.
:include_public (Boolean) —

Specifies 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 cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
:db_cluster_resource_id (String) —

A specific DB cluster resource ID to describe.

Returns:

(DBClusterSnapshot::Collection)

# File 'lib/aws-sdk-rds/db_cluster.rb', line 3404

def snapshots(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(db_cluster_identifier: @id)
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.describe_db_cluster_snapshots(options)
    end
    resp.each_page do |page|
      batch = []
      page.data.db_cluster_snapshots.each do |d|
        batch << DBClusterSnapshot.new(
          cluster_id: @id,
          snapshot_id: d.db_cluster_snapshot_identifier,
          data: d,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  DBClusterSnapshot::Collection.new(batches)
end

#status ⇒ `String`

The current state of this DB cluster.

Returns:

(String)



89
90
91

# File 'lib/aws-sdk-rds/db_cluster.rb', line 89

def status
  data[:status]
end

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

Reserved for future use.

Returns:

(Array<Types::DBClusterStatusInfo>)



215
216
217

# File 'lib/aws-sdk-rds/db_cluster.rb', line 215

def status_infos
  data[:status_infos]
end

#storage_encrypted ⇒ `Boolean`

Indicates whether the DB cluster is encrypted.

Returns:

(Boolean)



239
240
241

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

def storage_encrypted
  data[:storage_encrypted]
end

#storage_throughput ⇒ `Integer`

The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

This setting is only for non-Aurora Multi-AZ DB clusters.

Returns:

(Integer)



716
717
718

# File 'lib/aws-sdk-rds/db_cluster.rb', line 716

def storage_throughput
  data[:storage_throughput]
end

#storage_type ⇒ `String`

The storage type associated with the DB cluster.

Returns:

(String)



518
519
520

# File 'lib/aws-sdk-rds/db_cluster.rb', line 518

def storage_type
  data[:storage_type]
end

#subnet_group ⇒ `DBSubnetGroup`^?

Returns:

(DBSubnetGroup, nil)

# File 'lib/aws-sdk-rds/db_cluster.rb', line 3427

def subnet_group
  if data[:db_subnet_group]
    DBSubnetGroup.new(
      name: data[:db_subnet_group],
      client: @client
    )
  else
    nil
  end
end

A list of tags.

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

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

Returns:

(Array<Types::Tag>)



479
480
481

# File 'lib/aws-sdk-rds/db_cluster.rb', line 479

def tag_list
  data[:tag_list]
end

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

The list of VPC security groups that the DB cluster belongs to.

Returns:

(Array<Types::VpcSecurityGroupMembership>)



227
228
229

# File 'lib/aws-sdk-rds/db_cluster.rb', line 227

def vpc_security_groups
  data[:vpc_security_groups]
end

#wait_until(options = {}) {|resource| ... } ⇒ `Resource`

Deprecated.

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

Note:

The waiting operation is performed on a copy. The original resource remains unchanged.

Waiter polls an API operation until a resource enters a desired state.

## Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

## Example

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

## Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

## Callbacks

You can be notified before each polling attempt and before each delay. If you throw ‘:success` or `:failure` from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

## Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

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

a customizable set of options

Options Hash (options):

:max_attempts (Integer) — default: 10 —

Maximum number of
:delay (Integer) — default: 10 —

Delay between each
:before_attempt (Proc) — default: nil —

Callback
:before_wait (Proc) — default: nil —

Callback

Yield Parameters:

resource (Resource) —

to be used in the waiting condition.

Returns:

(Resource) —

if the waiter was successful

Raises:

(Aws::Waiters::Errors::FailureStateError) —

Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

yet successful.
(Aws::Waiters::Errors::UnexpectedError) —

Raised when an error is encountered while polling for a resource that is not expected.
(NotImplementedError) —

Raised when the resource does not

# File 'lib/aws-sdk-rds/db_cluster.rb', line 870

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

Class: Aws::RDS::DBCluster

Defined Under Namespace

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

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

Instance Method Details

#activity_stream_kinesis_stream_name ⇒ String

#activity_stream_kms_key_id ⇒ String

#activity_stream_mode ⇒ String

#activity_stream_status ⇒ String

#allocated_storage ⇒ Integer

#associated_roles ⇒ Array<Types::DBClusterRole>

#auto_minor_version_upgrade ⇒ Boolean

#automatic_restart_time ⇒ Time

#availability_zones ⇒ Array<String>

#aws_backup_recovery_point_arn ⇒ String

#backtrack_consumed_change_records ⇒ Integer

#backtrack_window ⇒ Integer

#backup_retention_period ⇒ Integer

#capacity ⇒ Integer

#certificate_details ⇒ Types::CertificateDetails

#character_set_name ⇒ String

#client ⇒ Client

#clone_group_id ⇒ String

#cluster_create_time ⇒ Time

#cluster_scalability_type ⇒ String

#copy_tags_to_snapshot ⇒ Boolean

#create(options = {}) ⇒ DBCluster

Examples:

Request syntax with placeholder values

#create_snapshot(options = {}) ⇒ DBClusterSnapshot

Examples:

Request syntax with placeholder values

#cross_account_clone ⇒ Boolean

#custom_endpoints ⇒ Array<String>

#data ⇒ Types::DBCluster

#data_loaded? ⇒ Boolean

#database_insights_mode ⇒ String

#database_name ⇒ String

#db_cluster_arn ⇒ String

#db_cluster_instance_class ⇒ String

#db_cluster_members ⇒ Array<Types::DBClusterMember>

#db_cluster_option_group_memberships ⇒ Array<Types::DBClusterOptionGroupStatus>

#db_cluster_parameter_group ⇒ String

#db_cluster_resource_id ⇒ String

#db_subnet_group ⇒ String

#db_system_id ⇒ String

#delete(options = {}) ⇒ DBCluster

Examples:

Request syntax with placeholder values

#deletion_protection ⇒ Boolean

#domain_memberships ⇒ Array<Types::DomainMembership>

#earliest_backtrack_time ⇒ Time

#earliest_restorable_time ⇒ Time

#enabled_cloudwatch_logs_exports ⇒ Array<String>

#endpoint ⇒ String

#engine ⇒ String

#engine_lifecycle_support ⇒ String

#engine_mode ⇒ String

#engine_version ⇒ String

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

Examples:

Request syntax with placeholder values

#failover(options = {}) ⇒ DBCluster

Examples:

Request syntax with placeholder values

#global_write_forwarding_requested ⇒ Boolean

#global_write_forwarding_status ⇒ String

#hosted_zone_id ⇒ String

#http_endpoint_enabled ⇒ Boolean

#iam_database_authentication_enabled ⇒ Boolean

#id ⇒ String Also known as: db_cluster_identifier

#identifiers ⇒ Object

#io_optimized_next_allowed_modification_time ⇒ Time

#iops ⇒ Integer

#kms_key_id ⇒ String

#latest_restorable_time ⇒ Time

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

#activity_stream_kinesis_stream_name ⇒ `String`

#activity_stream_kms_key_id ⇒ `String`

#activity_stream_mode ⇒ `String`

#activity_stream_status ⇒ `String`

#allocated_storage ⇒ `Integer`

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

#auto_minor_version_upgrade ⇒ `Boolean`

#automatic_restart_time ⇒ `Time`

#availability_zones ⇒ `Array<String>`

#aws_backup_recovery_point_arn ⇒ `String`

#backtrack_consumed_change_records ⇒ `Integer`

#backtrack_window ⇒ `Integer`

#backup_retention_period ⇒ `Integer`

#capacity ⇒ `Integer`

#certificate_details ⇒ `Types::CertificateDetails`

#character_set_name ⇒ `String`

#client ⇒ `Client`

#clone_group_id ⇒ `String`

#cluster_create_time ⇒ `Time`

#cluster_scalability_type ⇒ `String`

#copy_tags_to_snapshot ⇒ `Boolean`

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

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

#cross_account_clone ⇒ `Boolean`

#custom_endpoints ⇒ `Array<String>`

#data ⇒ `Types::DBCluster`

#data_loaded? ⇒ `Boolean`

#database_insights_mode ⇒ `String`

#database_name ⇒ `String`

#db_cluster_arn ⇒ `String`

#db_cluster_instance_class ⇒ `String`

#db_cluster_members ⇒ `Array<Types::DBClusterMember>`

#db_cluster_option_group_memberships ⇒ `Array<Types::DBClusterOptionGroupStatus>`

#db_cluster_parameter_group ⇒ `String`

#db_cluster_resource_id ⇒ `String`

#db_subnet_group ⇒ `String`

#db_system_id ⇒ `String`

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

#deletion_protection ⇒ `Boolean`

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

#earliest_backtrack_time ⇒ `Time`

#earliest_restorable_time ⇒ `Time`

#enabled_cloudwatch_logs_exports ⇒ `Array<String>`

#endpoint ⇒ `String`

#engine ⇒ `String`

#engine_lifecycle_support ⇒ `String`

#engine_mode ⇒ `String`

#engine_version ⇒ `String`

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

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

#global_write_forwarding_requested ⇒ `Boolean`

#global_write_forwarding_status ⇒ `String`

#hosted_zone_id ⇒ `String`

#http_endpoint_enabled ⇒ `Boolean`

#iam_database_authentication_enabled ⇒ `Boolean`

#id ⇒ `String` Also known as: db_cluster_identifier

#identifiers ⇒ `Object`

#io_optimized_next_allowed_modification_time ⇒ `Time`

#iops ⇒ `Integer`

#kms_key_id ⇒ `String`

#latest_restorable_time ⇒ `Time`

#limitless_database ⇒ `Types::LimitlessDatabase`

#load ⇒ `self` Also known as: reload

#local_write_forwarding_status ⇒ `String`

#master_user_secret ⇒ `Types::MasterUserSecret`

#master_username ⇒ `String`

#members ⇒ `DBInstance::Collection`

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

#monitoring_interval ⇒ `Integer`

#monitoring_role_arn ⇒ `String`

#multi_az ⇒ `Boolean`

#network_type ⇒ `String`

#option_groups ⇒ `OptionGroup::Collection`

#parameter_group ⇒ `DBClusterParameterGroup`^?

#pending_modified_values ⇒ `Types::ClusterPendingModifiedValues`

#percent_progress ⇒ `String`

#performance_insights_enabled ⇒ `Boolean`

#performance_insights_kms_key_id ⇒ `String`

#performance_insights_retention_period ⇒ `Integer`