Class: Aws::RDS::DBCluster

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

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):

  • #initialize(options = {}) ⇒ DBCluster

    Options Hash (options):

    • :id (required, String)
    • :client (Client)


22
23
24
25
26
27
28
# File 'gems/aws-sdk-rds/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_nameString

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

Returns:

  • (String)


427
428
429
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 427

def activity_stream_kinesis_stream_name
  data[:activity_stream_kinesis_stream_name]
end

#activity_stream_kms_key_idString

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)


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

def activity_stream_kms_key_id
  data[:activity_stream_kms_key_id]
end

#activity_stream_modeString

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)


404
405
406
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 404

def activity_stream_mode
  data[:activity_stream_mode]
end

#activity_stream_statusString

The status of the database activity stream.

Returns:

  • (String)


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

def activity_stream_status
  data[:activity_stream_status]
end

#allocated_storageInteger

For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

Returns:

  • (Integer)


43
44
45
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 43

def allocated_storage
  data[:allocated_storage]
end

#associated_rolesArray<Types::DBClusterRole>

Provides 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:



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

def associated_roles
  data[:associated_roles]
end

#auto_minor_version_upgradeBoolean

A value that indicates that minor version patches are applied automatically.

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

Returns:

  • (Boolean)


539
540
541
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 539

def auto_minor_version_upgrade
  data[:auto_minor_version_upgrade]
end

#automatic_restart_timeTime

The time when a stopped DB cluster is restarted automatically.

Returns:

  • (Time)


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

def automatic_restart_time
  data[:automatic_restart_time]
end

#availability_zonesArray<String>

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

Returns:

  • (Array<String>)


50
51
52
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 50

def availability_zones
  data[:availability_zones]
end

#backtrack_consumed_change_recordsInteger

The number of change records stored for Backtrack.

Returns:

  • (Integer)


313
314
315
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 313

def backtrack_consumed_change_records
  data[:backtrack_consumed_change_records]
end

#backtrack_windowInteger

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)


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

def backtrack_window
  data[:backtrack_window]
end

#backup_retention_periodInteger

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

Returns:

  • (Integer)


57
58
59
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 57

def backup_retention_period
  data[:backup_retention_period]
end

#capacityInteger

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

For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

Returns:

  • (Integer)


342
343
344
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 342

def capacity
  data[:capacity]
end

#character_set_nameString

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

Returns:

  • (String)


64
65
66
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 64

def character_set_name
  data[:character_set_name]
end

#clientClient

Returns:



594
595
596
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 594

def client
  @client
end

#clone_group_idString

Identifies the clone group to which the DB cluster is associated.

Returns:

  • (String)


286
287
288
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 286

def clone_group_id
  data[:clone_group_id]
end

#cluster_create_timeTime

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

Returns:

  • (Time)


293
294
295
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 293

def cluster_create_time
  data[:cluster_create_time]
end

#copy_tags_to_snapshotBoolean

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

Returns:

  • (Boolean)


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

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,
  },
  deletion_protection: false,
  global_cluster_identifier: "String",
  enable_http_endpoint: false,
  copy_tags_to_snapshot: false,
  domain: "String",
  domain_iam_role_name: "String",
  enable_global_write_forwarding: false,
  db_cluster_instance_class: "String",
  allocated_storage: 1,
  storage_type: "String",
  iops: 1,
  publicly_accessible: false,
  auto_minor_version_upgrade: false,
  monitoring_interval: 1,
  monitoring_role_arn: "String",
  enable_performance_insights: false,
  performance_insights_kms_key_id: "String",
  performance_insights_retention_period: 1,
  source_region: "String",
})

Parameters:

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

    ({})

Options Hash (options):

  • :availability_zones (Array<String>)

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

    For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.

    Valid for: Aurora DB clusters only

  • :backup_retention_period (Integer)

    The number of days for which automated backups are retained.

    Default: 1

    Constraints:

    • Must be a value from 1 to 35

    ^

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

  • :character_set_name (String)

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

    Valid for: Aurora DB clusters only

  • :database_name (String)

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

    Valid for: 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 do not specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.

    Constraints:

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

    ^

    Valid for: 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: 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.

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

    Example: mySubnetgroup

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

  • :engine (required, String)

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

    Valid Values:

    • aurora (for MySQL 5.6-compatible Aurora)

    • aurora-mysql (for MySQL 5.7-compatible Aurora)

    • aurora-postgresql

    • mysql

    • postgres

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

  • :engine_version (String)

    The version number of the database engine to use.

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

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

    To list all of the available engine versions for MySQL 5.7-compatible Aurora, use the following command:

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

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

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

    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"

    Aurora MySQL

    For information, see MySQL on Amazon RDS Versions in the Amazon Aurora User Guide.

    Aurora PostgreSQL

    For information, see Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.

    MySQL

    For information, see MySQL on Amazon RDS Versions in the Amazon RDS User Guide.

    PostgreSQL

    For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.

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

  • :port (Integer)

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

    RDS for MySQL and Aurora MySQL

    Default: 3306

    Valid values: 1150-65535

    RDS for PostgreSQL and Aurora PostgreSQL

    Default: 5432

    Valid values: 1150-65535

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

  • :master_username (String)

    The name of the master user for the DB cluster.

    Constraints:

    • Must be 1 to 16 letters or numbers.

    • First character must be a letter.

    • Can't be a reserved word for the chosen database engine.

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

  • :master_user_password (String)

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

    Constraints: Must contain from 8 to 41 characters.

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

  • :option_group_name (String)

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

    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.

    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.

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

  • :preferred_maintenance_window (String)

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

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

    The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

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

    Constraints: Minimum 30-minute window.

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

  • :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: Aurora DB clusters only

  • :tags (Array<Types::Tag>)

    Tags to assign to the DB cluster.

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

  • :storage_encrypted (Boolean)

    A value that indicates whether the DB cluster is encrypted.

    Valid for: 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 will use the KMS key used to encrypt the source. Otherwise, Amazon RDS will use your default KMS key.

    • If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS will use 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, you must 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: Aurora DB clusters and Multi-AZ DB clusters

  • :pre_signed_url (String)

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

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

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

    • KmsKeyId - The Amazon Web Services KMS key identifier for the 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 action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.

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

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

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

    If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.

    Valid for: Aurora DB clusters only

  • :enable_iam_database_authentication (Boolean)

    A value that indicates 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.

    Valid for: Aurora DB clusters only

  • :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 log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

    Aurora MySQL

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

    Aurora PostgreSQL

    Possible value is postgresql.

    Valid for: Aurora DB clusters only

  • :engine_mode (String)

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

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

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

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

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

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

    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

  • :deletion_protection (Boolean)

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

    Valid for: 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: Aurora DB clusters only

  • :enable_http_endpoint (Boolean)

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

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

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

    Valid for: Aurora DB clusters only

  • :copy_tags_to_snapshot (Boolean)

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

    Valid for: Aurora DB clusters only

  • :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: Aurora DB clusters only

  • :domain_iam_role_name (String)

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

    Valid for: Aurora DB clusters only

  • :enable_global_write_forwarding (Boolean)

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

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

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

  • :allocated_storage (Integer)

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

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

    Valid for: Multi-AZ DB clusters only

  • :storage_type (String)

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

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

    Valid values: standard | gp2 | io1

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

    Default: io1 if the Iops parameter is specified, otherwise gp2

    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 to improve performance in the Amazon RDS User Guide.

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

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

    Valid for: Multi-AZ DB clusters only

  • :publicly_accessible (Boolean)

    A value that indicates 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 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.

    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

  • :auto_minor_version_upgrade (Boolean)

    A value that indicates 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: Multi-AZ DB clusters only

  • :monitoring_interval (Integer)

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

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

    Valid Values: 0, 1, 5, 10, 15, 30, 60

    Valid for: Multi-AZ DB clusters only

  • :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: Multi-AZ DB clusters only

  • :enable_performance_insights (Boolean)

    A value that indicates 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: Multi-AZ DB clusters only

  • :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: Multi-AZ DB clusters only

  • :performance_insights_retention_period (Integer)

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

    Valid for: Multi-AZ DB clusters only

  • :source_region (String)

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

Returns:



1425
1426
1427
1428
1429
1430
1431
1432
1433
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 1425

def create(options = {})
  options = options.merge(db_cluster_identifier: @id)
  resp = @client.create_db_cluster(options)
  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:



1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 1463

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

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

Returns:

  • (Boolean)


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

def 
  data[:cross_account_clone]
end

#custom_endpointsArray<String>

Identifies all custom endpoints associated with the cluster.

Returns:

  • (Array<String>)


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

def custom_endpoints
  data[:custom_endpoints]
end

#dataTypes::DBCluster

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

Returns:



614
615
616
617
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 614

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.



622
623
624
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 622

def data_loaded?
  !!@data
end

#database_nameString

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

Returns:

  • (String)


72
73
74
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 72

def database_name
  data[:database_name]
end

#db_cluster_arnString

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

Returns:

  • (String)


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

def db_cluster_arn
  data[:db_cluster_arn]
end

#db_cluster_instance_classString

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)


493
494
495
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 493

def db_cluster_instance_class
  data[:db_cluster_instance_class]
end

#db_cluster_membersArray<Types::DBClusterMember>

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

Returns:



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

def db_cluster_members
  data[:db_cluster_members]
end

#db_cluster_option_group_membershipsArray<Types::DBClusterOptionGroupStatus>

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



185
186
187
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 185

def db_cluster_option_group_memberships
  data[:db_cluster_option_group_memberships]
end

#db_cluster_parameter_groupString

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

Returns:

  • (String)


79
80
81
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 79

def db_cluster_parameter_group
  data[:db_cluster_parameter_group]
end

#db_cluster_resource_idString

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 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 257

def db_cluster_resource_id
  data[:db_cluster_resource_id]
end

#db_subnet_groupString

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

Returns:

  • (String)


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

def db_subnet_group
  data[:db_subnet_group]
end

#delete(options = {}) ⇒ DBCluster

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (options):

  • :skip_final_snapshot (Boolean)

    A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted. If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. By default, this parameter is disabled.

    You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.

  • :final_db_snapshot_identifier (String)

    The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled.

    Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter results in an error.

    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

Returns:



1511
1512
1513
1514
1515
1516
1517
1518
1519
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 1511

def delete(options = {})
  options = options.merge(db_cluster_identifier: @id)
  resp = @client.delete_db_cluster(options)
  DBCluster.new(
    id: resp.data.db_cluster.db_cluster_identifier,
    data: resp.data.db_cluster,
    client: @client
  )
end

#deletion_protectionBoolean

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

Returns:

  • (Boolean)


376
377
378
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 376

def deletion_protection
  data[:deletion_protection]
end

#domain_membershipsArray<Types::DomainMembership>

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

Returns:



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

def domain_memberships
  data[:domain_memberships]
end

#earliest_backtrack_timeTime

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

Returns:

  • (Time)


299
300
301
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 299

def earliest_backtrack_time
  data[:earliest_backtrack_time]
end

#earliest_restorable_timeTime

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

Returns:

  • (Time)


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

def earliest_restorable_time
  data[:earliest_restorable_time]
end

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

Returns:

  • (Array<String>)


328
329
330
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 328

def enabled_cloudwatch_logs_exports
  data[:enabled_cloudwatch_logs_exports]
end

#endpointString

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

Returns:

  • (String)


119
120
121
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 119

def endpoint
  data[:endpoint]
end

#engineString

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

Returns:

  • (String)


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

def engine
  data[:engine]
end

#engine_modeString

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

For more information, see CreateDBCluster.

Returns:

  • (String)


355
356
357
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 355

def engine_mode
  data[:engine_mode]
end

#engine_versionString

Indicates the database engine version.

Returns:

  • (String)


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

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.

    Example: 2009-07-08T18:00Z

  • :end_time (Time, DateTime, Date, Integer, String)

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

    Example: 2009-07-08T18:00Z

  • :duration (Integer)

    The number of minutes to retrieve events for.

    Default: 60

  • :event_categories (Array<String>)

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

  • :filters (Array<Types::Filter>)

    This parameter isn't currently supported.

Returns:



2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 2405

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

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



1536
1537
1538
1539
1540
1541
1542
1543
1544
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 1536

def failover(options = {})
  options = options.merge(db_cluster_identifier: @id)
  resp = @client.failover_db_cluster(options)
  DBCluster.new(
    id: resp.data.db_cluster.db_cluster_identifier,
    data: resp.data.db_cluster,
    client: @client
  )
end

#global_write_forwarding_requestedBoolean

Specifies whether you have requested to enable write forwarding 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)


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

def global_write_forwarding_requested
  data[:global_write_forwarding_requested]
end

#global_write_forwarding_statusString

Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

Returns:

  • (String)


467
468
469
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 467

def global_write_forwarding_status
  data[:global_write_forwarding_status]
end

#hosted_zone_idString

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

Returns:

  • (String)


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

def hosted_zone_id
  data[:hosted_zone_id]
end

#http_endpoint_enabledBoolean

A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

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

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

Returns:

  • (Boolean)


395
396
397
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 395

def http_endpoint_enabled
  data[:http_endpoint_enabled]
end

#iam_database_authentication_enabledBoolean

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

Returns:

  • (Boolean)


280
281
282
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 280

def iam_database_authentication_enabled
  data[:iam_database_authentication_enabled]
end

#idString Also known as: db_cluster_identifier

Returns:

  • (String)


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

def id
  @id
end

#iopsInteger

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

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

Returns:

  • (Integer)


509
510
511
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 509

def iops
  data[:iops]
end

#kms_key_idString

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 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 249

def kms_key_id
  data[:kms_key_id]
end

#latest_restorable_timeTime

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

Returns:

  • (Time)


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

def latest_restorable_time
  data[:latest_restorable_time]
end

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


604
605
606
607
608
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 604

def load
  resp = @client.describe_db_clusters(db_cluster_identifier: @id)
  @data = resp.db_clusters[0]
  self
end

#master_usernameString

Contains the master username for the DB cluster.

Returns:

  • (String)


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

def master_username
  data[:master_username]
end

#membersDBInstance::Collection



2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 2429

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",
  enable_performance_insights: false,
  performance_insights_kms_key_id: "String",
  performance_insights_retention_period: 1,
})

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.

    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

    Valid for: Aurora DB clusters only

  • :apply_immediately (Boolean)

    A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window.

    The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

    By default, this parameter is disabled.

    Valid for: 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.

    Default: 1

    Constraints:

    • Must be a value from 1 to 35

    ^

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

  • :db_cluster_parameter_group_name (String)

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

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

  • :vpc_security_group_ids (Array<String>)

    A list of VPC security groups that the DB cluster will belong to.

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

  • :port (Integer)

    The port number on which the DB cluster accepts connections.

    Constraints: Value must be 1150-65535

    Default: The same port as the original DB cluster.

    Valid for: Aurora DB clusters only

  • :master_user_password (String)

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

    Constraints: Must contain from 8 to 41 characters.

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

  • :option_group_name (String)

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

    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.

    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.

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

  • :preferred_maintenance_window (String)

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

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

    The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

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

    Constraints: Minimum 30-minute window.

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

  • :enable_iam_database_authentication (Boolean)

    A value that indicates 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.

    Valid for: Aurora DB clusters only

  • :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

  • :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: Aurora DB clusters only

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

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

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

    To list all of the available engine versions for MySQL 5.7-compatible Aurora, use the following command:

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

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

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

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

  • :allow_major_version_upgrade (Boolean)

    A value that indicates whether major version upgrades are allowed.

    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.

    Valid for: Aurora DB clusters only

  • :db_instance_parameter_group_name (String)

    The name of the DB parameter group to apply to all instances of the DB cluster.

    When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes aren't applied during the next maintenance window but instead are applied immediately.

    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 only valid in combination with the AllowMajorVersionUpgrade parameter.

    Valid for: Aurora DB clusters 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: Aurora DB clusters only

  • :domain_iam_role_name (String)

    Specify 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)

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

    Valid for: Aurora DB clusters only

  • :deletion_protection (Boolean)

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

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

  • :enable_http_endpoint (Boolean)

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

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

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

    Valid for: Aurora DB clusters only

  • :copy_tags_to_snapshot (Boolean)

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

    Valid for: Aurora DB clusters only

  • :enable_global_write_forwarding (Boolean)

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

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

    Valid for: 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.m6g.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

  • :allocated_storage (Integer)

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

    Type: Integer

    Valid for: Multi-AZ DB clusters only

  • :storage_type (String)

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

    Valid values: standard | gp2 | io1

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

    Default: io1 if the Iops parameter is specified, otherwise gp2

    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 to Improve Performance in the Amazon RDS User Guide.

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

    Valid for: Multi-AZ DB clusters only

  • :auto_minor_version_upgrade (Boolean)

    A value that indicates 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: Multi-AZ DB clusters only

  • :monitoring_interval (Integer)

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

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

    Valid Values: 0, 1, 5, 10, 15, 30, 60

    Valid for: Multi-AZ DB clusters only

  • :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: Multi-AZ DB clusters only

  • :enable_performance_insights (Boolean)

    A value that indicates 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: Multi-AZ DB clusters only

  • :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: Multi-AZ DB clusters only

  • :performance_insights_retention_period (Integer)

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

    Valid for: Multi-AZ DB clusters only

Returns:



1995
1996
1997
1998
1999
2000
2001
2002
2003
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 1995

def modify(options = {})
  options = options.merge(db_cluster_identifier: @id)
  resp = @client.modify_db_cluster(options)
  DBCluster.new(
    id: resp.data.db_cluster.db_cluster_identifier,
    data: resp.data.db_cluster,
    client: @client
  )
end

#monitoring_intervalInteger

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

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

Returns:

  • (Integer)


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

def monitoring_interval
  data[:monitoring_interval]
end

#monitoring_role_arnString

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

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

Returns:

  • (String)


557
558
559
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 557

def monitoring_role_arn
  data[:monitoring_role_arn]
end

#multi_azBoolean

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

Returns:

  • (Boolean)


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

def multi_az
  data[:multi_az]
end

#option_groupsOptionGroup::Collection



2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 2442

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

Returns:



2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 2455

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_valuesTypes::ClusterPendingModifiedValues

A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.



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

def pending_modified_values
  data[:pending_modified_values]
end

#percent_progressString

Specifies the progress of the operation as a percentage.

Returns:

  • (String)


105
106
107
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 105

def percent_progress
  data[:percent_progress]
end

#performance_insights_enabledBoolean

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

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

Returns:

  • (Boolean)


566
567
568
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 566

def performance_insights_enabled
  data[:performance_insights_enabled]
end

#performance_insights_kms_key_idString

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 non-Aurora Multi-AZ DB clusters.

Returns:

  • (String)


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

def performance_insights_kms_key_id
  data[:performance_insights_kms_key_id]
end

#performance_insights_retention_periodInteger

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

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

Returns:

  • (Integer)


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

def performance_insights_retention_period
  data[:performance_insights_retention_period]
end

#portInteger

Specifies the port that the database engine is listening on.

Returns:

  • (Integer)


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

def port
  data[:port]
end

#preferred_backup_windowString

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

Returns:

  • (String)


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

def preferred_backup_window
  data[:preferred_backup_window]
end

#preferred_maintenance_windowString

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

Returns:

  • (String)


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

def preferred_maintenance_window
  data[:preferred_maintenance_window]
end

#publicly_accessibleBoolean

Specifies the accessibility options for the DB instance.

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

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

For more information, see CreateDBInstance.

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

Returns:

  • (Boolean)


530
531
532
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 530

def publicly_accessible
  data[:publicly_accessible]
end

#read_replica_identifiersArray<String>

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

Returns:

  • (Array<String>)


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

def read_replica_identifiers
  data[:read_replica_identifiers]
end

#reader_endpointString

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)


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

def reader_endpoint
  data[:reader_endpoint]
end

#replication_source_identifierString

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

Returns:

  • (String)


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

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

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.

    Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

    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)

    A value that indicates 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: mySubnetgroup

    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.

  • :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)

    A value that indicates 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.

    Valid for: Aurora DB clusters only

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

    For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

    Valid for: Aurora DB clusters only

  • :db_cluster_parameter_group_name (String)

    The name of the DB cluster parameter group to associate with this DB cluster. If this argument 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)

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

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

  • :copy_tags_to_snapshot (Boolean)

    A value that indicates 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 only

  • :domain (String)

    Specify 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

  • :domain_iam_role_name (String)

    Specify 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 clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless cluster. To create a clone that is an Aurora Serverless cluster, the original cluster must be an Aurora Serverless cluster or an encrypted provisioned cluster.

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

  • :storage_type (String)

    Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.

    Valid values: standard | gp2 | io1

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

    Default: io1 if the Iops parameter is specified, otherwise gp2

    Valid for: Multi-AZ DB clusters only

  • :publicly_accessible (Boolean)

    A value that indicates 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 to improve performance 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

Returns:



2348
2349
2350
2351
2352
2353
2354
2355
2356
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 2348

def restore(options = {})
  options = options.merge(source_db_cluster_identifier: @id)
  resp = @client.restore_db_cluster_to_point_in_time(options)
  DBCluster.new(
    id: resp.data.db_cluster.db_cluster_identifier,
    data: resp.data.db_cluster,
    client: @client
  )
end

#scaling_configuration_infoTypes::ScalingConfigurationInfo

Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.



369
370
371
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 369

def scaling_configuration_info
  data[:scaling_configuration_info]
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,
})

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)

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

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

  • :include_public (Boolean)

    A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any 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.

Returns:



2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 2551

def snapshots(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(db_cluster_identifier: @id)
    resp = @client.describe_db_cluster_snapshots(options)
    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

#statusString

Specifies the current state of this DB cluster.

Returns:

  • (String)


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

def status
  data[:status]
end

#storage_encryptedBoolean

Specifies whether the DB cluster is encrypted.

Returns:

  • (Boolean)


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

def storage_encrypted
  data[:storage_encrypted]
end

#storage_typeString

The storage type associated with DB instance.

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

Returns:

  • (String)


501
502
503
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 501

def storage_type
  data[:storage_type]
end

#subnet_groupDBSubnetGroup?

Returns:



2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 2572

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

#tag_listArray<Types::Tag>

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

Returns:



459
460
461
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 459

def tag_list
  data[:tag_list]
end

#vpc_security_groupsArray<Types::VpcSecurityGroupMembership>

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



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

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



706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_cluster.rb', line 706

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